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
|
############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 AKFish <akfish@gmail.com> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2021 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 YugoHino <henom06@gmail.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# #
# 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 <http://www.gnu.org/licenses/>. #
# #
################################################################################
from typing import Any, Dict
from github.GithubObject import Attribute, CompletableGithubObject, NotSet
from github.NamedEnterpriseUser import NamedEnterpriseUser
from github.PaginatedList import PaginatedList
class EnterpriseConsumedLicenses(CompletableGithubObject):
"""
This class represents license consumed by enterprises.
The reference can be found here
https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/license#list-enterprise-consumed-licenses
"""
def _initAttributes(self) -> None:
self._enterprise: Attribute[str] = NotSet
self._total_seats_consumed: Attribute[int] = NotSet
self._total_seats_purchased: Attribute[int] = NotSet
self._url: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"enterprise": self._enterprise.value})
@property
def enterprise(self) -> str:
self._completeIfNotSet(self._enterprise)
return self._enterprise.value
@property
def total_seats_consumed(self) -> int:
return self._total_seats_consumed.value
@property
def total_seats_purchased(self) -> int:
return self._total_seats_purchased.value
@property
def url(self) -> str:
self._completeIfNotSet(self._url)
return self._url.value
def get_users(self) -> PaginatedList[NamedEnterpriseUser]:
"""
:calls: `GET /enterprises/{enterprise}/consumed-licenses <https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/license#list-enterprise-consumed-licenses>`_
"""
url_parameters: Dict[str, Any] = {}
return PaginatedList(
NamedEnterpriseUser,
self._requester,
self.url,
url_parameters,
headers=None,
list_item="users",
firstData=self.raw_data,
firstHeaders=self.raw_headers,
)
def _useAttributes(self, attributes: Dict[str, Any]) -> None:
if "enterprise" in attributes: # pragma no branch
self._enterprise = self._makeStringAttribute(attributes["enterprise"])
if "total_seats_consumed" in attributes: # pragma no branch
self._total_seats_consumed = self._makeIntAttribute(attributes["total_seats_consumed"])
if "total_seats_purchased" in attributes: # pragma no branch
self._total_seats_purchased = self._makeIntAttribute(attributes["total_seats_purchased"])
if "url" in attributes: # pragma no branch
self._url = self._makeStringAttribute(attributes["url"])
|
