octocrab 0.54.2

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
126
127
128
129
130
131
132
133

use std::marker::PhantomData;

use super::*;

pub struct CopilotSeatHandler<'octo, 'r> {
    crab: &'octo Octocrab,
    owner: String,
    _phantom: PhantomData<&'r ()>,
}

#[derive(serde::Serialize)]
struct SelectedTeams {
    selected_teams: Vec<String>,
}

#[derive(serde::Serialize)]
struct SelectedUsernames {
    selected_usernames: Vec<String>,
}

impl<'octo, 'r> CopilotSeatHandler<'octo, 'r> {
    pub fn new(handler: &'r OrgHandler<'octo>) -> Self {
        Self {
            crab: handler.crab,
            owner: handler.owner.clone(),
            _phantom: PhantomData,
        }
    }

    pub(crate) fn new_with_owner(crab: &'octo Octocrab, owner: String) -> Self {
        Self {
            crab,
            owner,
            _phantom: PhantomData,
        }
    }

    /// Adds the specified teams from copilot seats.
    /// Note that this adds new seats immediately to your billing cycle.
    pub async fn add_teams(
        self,
        teams: Vec<String>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::SeatsCreated> {
        let route = format!(
            "/orgs/{org}/copilot/billing/selected_teams",
            org = self.owner,
        );
        let teams = SelectedTeams {
            selected_teams: teams,
        };

        self.crab.post(route, Some(&teams)).await
    }

    /// Removes the specified teams from copilot seats.
    /// Note that the seat removal takes effect the next billing cycle.
    pub async fn remove_teams(
        self,
        teams: Vec<String>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::SeatsCancelled> {
        let route = format!(
            "/orgs/{org}/copilot/billing/selected_teams",
            org = self.owner,
        );
        let teams = SelectedTeams {
            selected_teams: teams,
        };

        self.crab.delete(route, Some(&teams)).await
    }

    /// Adds the specified usernames from copilot seats.
    /// Note that this adds new seats immediately to your billing cycle.
    pub async fn add_usernames(
        self,
        usernames: Vec<String>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::SeatsCreated> {
        let route = format!(
            "/orgs/{org}/copilot/billing/selected_users",
            org = self.owner,
        );
        let usernames = SelectedUsernames {
            selected_usernames: usernames,
        };

        self.crab.post(route, Some(&usernames)).await
    }

    /// Removes the specified users from copilot seats.
    /// Note that the seat removal takes effect the next billing cycle.
    pub async fn remove_usernames(
        self,
        usernames: Vec<String>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::SeatsCancelled> {
        let route = format!(
            "/orgs/{org}/copilot/billing/selected_users",
            org = self.owner,
        );
        let usernames = SelectedUsernames {
            selected_usernames: usernames,
        };

        self.crab.delete(route, Some(&usernames)).await
    }

    /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
    ///
    /// Note: You can also retrieve user seat details directly via [`CopilotHandler::seat_assignment`][crate::api::orgs::copilot::CopilotHandler::seat_assignment].
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/copilot/copilot-user-management?apiVersion=2022-11-28#get-copilot-seat-assignment-details-for-a-user)
    pub async fn get_user(
        &self,
        username: impl AsRef<str>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::CopilotSeat> {
        let route = format!(
            "/orgs/{org}/members/{username}/copilot",
            org = self.owner,
            username = username.as_ref(),
        );

        self.crab.get(route, None::<&()>).await
    }

    /// Shortcut for [`Self::get_user`].
    ///
    /// Note: You can also retrieve user seat details directly via [`CopilotHandler::seat_assignment`][crate::api::orgs::copilot::CopilotHandler::seat_assignment].
    pub async fn seat_assignment(
        &self,
        username: impl AsRef<str>,
    ) -> crate::Result<crate::models::orgs_copilot::billing::CopilotSeat> {
        self.get_user(username).await
    }
}