octocrab 0.54.7

A modern, extensible GitHub API client.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use super::*;
use crate::params::teams::Permission;

#[derive(serde::Serialize)]
pub struct ListCollaboratorsBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r RepoHandler<'octo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    per_page: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    page: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    permission: Option<Permission>,
}

impl<'octo, 'r> ListCollaboratorsBuilder<'octo, 'r> {
    pub fn new(handler: &'r RepoHandler<'octo>) -> Self {
        Self {
            handler,
            per_page: None,
            page: None,
            permission: None,
        }
    }

    /// Results per page (max 100).
    pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
        self.per_page = Some(per_page.into());
        self
    }

    /// Page number of the results to fetch.
    pub fn page(mut self, page: impl Into<u32>) -> Self {
        self.page = Some(page.into());
        self
    }

    /// Filter collaborators by the permissions they have on the repository.
    /// If not specified, all collaborators will be returned.
    /// Can be one of: pull, triage, push, maintain, admin
    pub fn permission(mut self, permission: Permission) -> Self {
        self.permission = Some(permission);
        self
    }

    /// Sends the actual request.
    pub async fn send(self) -> crate::Result<crate::Page<crate::models::Collaborator>> {
        let route = format!("/{}/collaborators", self.handler.repo);
        self.handler.crab.get(route, Some(&self)).await
    }
}

#[derive(serde::Serialize)]
pub struct GetCollaboratorPermissionBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r RepoHandler<'octo>,
    /// The handle for the GitHub user account.
    #[serde(skip)]
    username: String,
}

impl<'octo, 'r> GetCollaboratorPermissionBuilder<'octo, 'r> {
    pub fn new(handler: &'r RepoHandler<'octo>, username: impl Into<String>) -> Self {
        Self {
            handler,
            username: username.into(),
        }
    }

    /// Sends the actual request.
    pub async fn send(self) -> crate::Result<crate::models::repos::RepoPermission> {
        let route = format!(
            "/{}/collaborators/{}/permission",
            self.handler.repo, self.username
        );
        self.handler.crab.get(route, Some(&self)).await
    }
}

/// A builder pattern struct for adding a collaborator to a repository.
///
/// Created by [`RepoHandler::add_collaborator`].
#[derive(serde::Serialize)]
pub struct AddCollaboratorBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r RepoHandler<'octo>,
    /// The handle for the GitHub user account.
    #[serde(skip)]
    username: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    permission: Option<Permission>,
}

impl<'octo, 'r> AddCollaboratorBuilder<'octo, 'r> {
    pub fn new(handler: &'r RepoHandler<'octo>, username: impl Into<String>) -> Self {
        Self {
            handler,
            username: username.into(),
            permission: None,
        }
    }

    /// The permission to grant the collaborator. Only valid on organization-owned repositories.
    /// Can be one of: pull, triage, push, maintain, admin
    pub fn permission(mut self, permission: Permission) -> Self {
        self.permission = Some(permission);
        self
    }

    /// Sends the actual request.
    ///
    /// Returns `Ok(Some(invitation))` when a new invitation is created (`201 Created`),
    /// or `Ok(None)` when an existing collaborator or organization member is added (`204 No Content`).
    pub async fn send(self) -> crate::Result<Option<crate::models::repos::RepositoryInvitation>> {
        let route = format!("/{}/collaborators/{}", self.handler.repo, self.username);
        let response = self.handler.crab._put(route, Some(&self)).await?;
        let response = crate::map_github_error(response).await?;
        if response.status() == http::StatusCode::NO_CONTENT {
            return Ok(None);
        }
        <crate::models::repos::RepositoryInvitation as crate::FromResponse>::from_response(response)
            .await
            .map(Some)
    }
}