############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2021 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Trim21 # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # # # 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 datetime import datetime from typing import TYPE_CHECKING, Any import github.AuthorizationApplication import github.GithubObject from github.GithubObject import Attribute, NotSet, Opt, _NotSetType if TYPE_CHECKING: from github.AuthorizationApplication import AuthorizationApplication class Authorization(github.GithubObject.CompletableGithubObject): """ This class represents Authorizations. The reference can be found here https://docs.github.com/en/enterprise-server@3.0/rest/reference/oauth-authorizations """ def _initAttributes(self) -> None: self._app: Attribute[AuthorizationApplication] = NotSet self._created_at: Attribute[datetime] = NotSet self._id: Attribute[int] = NotSet self._note: Attribute[str | None] = NotSet self._note_url: Attribute[str | None] = NotSet self._scopes: Attribute[str] = NotSet self._token: Attribute[str] = NotSet self._updated_at: Attribute[datetime] = NotSet self._url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"scopes": self._scopes.value}) @property def app(self) -> AuthorizationApplication: self._completeIfNotSet(self._app) return self._app.value @property def created_at(self) -> datetime: """ :type: datetime.datetime """ self._completeIfNotSet(self._created_at) return self._created_at.value @property def id(self) -> int: self._completeIfNotSet(self._id) return self._id.value @property def note(self) -> str | None: self._completeIfNotSet(self._note) return self._note.value @property def note_url(self) -> str | None: self._completeIfNotSet(self._note_url) return self._note_url.value @property def scopes(self) -> str: self._completeIfNotSet(self._scopes) return self._scopes.value @property def token(self) -> str: self._completeIfNotSet(self._token) return self._token.value @property def updated_at(self) -> datetime: self._completeIfNotSet(self._updated_at) return self._updated_at.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value def delete(self) -> None: """ :calls: `DELETE /authorizations/{id} `_ """ headers, data = self._requester.requestJsonAndCheck("DELETE", self.url) def edit( self, scopes: Opt[list[str]] = NotSet, add_scopes: Opt[list[str]] = NotSet, remove_scopes: Opt[list[str]] = NotSet, note: Opt[str] = NotSet, note_url: Opt[str] = NotSet, ) -> None: """ :calls: `PATCH /authorizations/{id} `_ :param scopes: list of string :param add_scopes: list of string :param remove_scopes: list of string :param note: string :param note_url: string :rtype: None """ assert isinstance(scopes, _NotSetType) or all(isinstance(element, str) for element in scopes), scopes assert isinstance(add_scopes, _NotSetType) or all( isinstance(element, str) for element in add_scopes ), add_scopes assert isinstance(remove_scopes, _NotSetType) or all( isinstance(element, str) for element in remove_scopes ), remove_scopes assert isinstance(note, (_NotSetType, str)), note assert isinstance(note_url, (_NotSetType, str)), note_url post_parameters = NotSet.remove_unset_items( { "scopes": scopes, "add_scopes": add_scopes, "remove_scopes": remove_scopes, "note": note, "note_url": note_url, } ) headers, data = self._requester.requestJsonAndCheck("PATCH", self.url, input=post_parameters) self._useAttributes(data) def _useAttributes(self, attributes: dict[str, Any]) -> None: if "app" in attributes: # pragma no branch self._app = self._makeClassAttribute( github.AuthorizationApplication.AuthorizationApplication, attributes["app"], ) if "created_at" in attributes: # pragma no branch self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) if "id" in attributes: # pragma no branch self._id = self._makeIntAttribute(attributes["id"]) if "note" in attributes: # pragma no branch self._note = self._makeStringAttribute(attributes["note"]) if "note_url" in attributes: # pragma no branch self._note_url = self._makeStringAttribute(attributes["note_url"]) if "scopes" in attributes: # pragma no branch self._scopes = self._makeListOfStringsAttribute(attributes["scopes"]) if "token" in attributes: # pragma no branch self._token = self._makeStringAttribute(attributes["token"]) if "updated_at" in attributes: # pragma no branch self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"]) if "url" in attributes: # pragma no branch self._url = self._makeStringAttribute(attributes["url"])