############################ Copyrights and license ############################ # # # Copyright 2024 Pasha Fateev # # Copyright 2025 Enrico Minack # # # # This file is part of PyGithub. # # http://pygithub.readthedocs.io/ # # # # PyGithub is free software: you can redistribute it and/or modify it under # # the terms of the GNU Lesser General Public License as published by the Free # # Software Foundation, either version 3 of the License, or (at your option) # # any later version. # # # # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # # details. # # # # You should have received a copy of the GNU Lesser General Public License # # along with PyGithub. If not, see . # # # ################################################################################ from __future__ import annotations from typing import TYPE_CHECKING, Any import github.CopilotSeat from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet from github.PaginatedList import PaginatedList if TYPE_CHECKING: from github.CopilotSeat import CopilotSeat from github.Requester import Requester class Copilot(NonCompletableGithubObject): def __init__(self, requester: Requester, org_name: str) -> None: super().__init__(requester, {}, {"org_name": org_name}) def _initAttributes(self) -> None: self._org_name: Attribute[str] = NotSet def _useAttributes(self, attributes: dict[str, Any]) -> None: if "org_name" in attributes: # pragma no branch self._org_name = self._makeStringAttribute(attributes["org_name"]) def __repr__(self) -> str: return self.get__repr__({"org_name": self._org_name.value if self._org_name is not NotSet else NotSet}) @property def org_name(self) -> str: return self._org_name.value def get_seats(self) -> PaginatedList[CopilotSeat]: """ :calls: `GET /orgs/{org}/copilot/billing/seats `_ """ url = f"/orgs/{self._org_name.value}/copilot/billing/seats" return PaginatedList( github.CopilotSeat.CopilotSeat, self._requester, url, None, list_item="seats", ) def add_seats(self, selected_usernames: list[str]) -> int: """ :calls: `POST /orgs/{org}/copilot/billing/selected_users `_ :param selected_usernames: List of usernames to add Copilot seats for :rtype: int :return: Number of seats created """ url = f"/orgs/{self._org_name.value}/copilot/billing/selected_users" _, data = self._requester.requestJsonAndCheck( "POST", url, input={"selected_usernames": selected_usernames}, ) return data["seats_created"] def remove_seats(self, selected_usernames: list[str]) -> int: """ :calls: `DELETE /orgs/{org}/copilot/billing/selected_users `_ :param selected_usernames: List of usernames to remove Copilot seats for :rtype: int :return: Number of seats cancelled """ url = f"/orgs/{self._org_name.value}/copilot/billing/selected_users" _, data = self._requester.requestJsonAndCheck( "DELETE", url, input={"selected_usernames": selected_usernames}, ) return data["seats_cancelled"]