Skip to content

Commit ae5f76d

Browse files
albertsolaalbertsola
authored
MPT-16437 Reorganise resource billing mixins structure (#202)
2 parents 5ce922c + e81d45a commit ae5f76d

File tree

13 files changed

+1119
-1063
lines changed

13 files changed

+1119
-1063
lines changed

‎mpt_api_client/resources/billing/mixins.py‎

Lines changed: 0 additions & 426 deletions
This file was deleted.

‎mpt_api_client/resources/billing/mixins/__init__.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
from mpt_api_client.resources.billing.mixins.acceptable_mixin import (
2+
AcceptableMixin,
3+
AsyncAcceptableMixin,
4+
)
5+
from mpt_api_client.resources.billing.mixins.attachment_mixin import (
6+
AsyncAttachmentMixin,
7+
AttachmentMixin,
8+
)
9+
from mpt_api_client.resources.billing.mixins.issuable_mixin import (
10+
AsyncIssuableMixin,
11+
IssuableMixin,
12+
)
13+
from mpt_api_client.resources.billing.mixins.recalculatable_mixin import (
14+
AsyncRecalculatableMixin,
15+
RecalculatableMixin,
16+
)
17+
from mpt_api_client.resources.billing.mixins.regeneratable_mixin import (
18+
AsyncRegeneratableMixin,
19+
RegeneratableMixin,
20+
)
21+
22+
__all__ = [ # noqa: WPS410
23+
"AcceptableMixin",
24+
"AsyncAcceptableMixin",
25+
"AsyncAttachmentMixin",
26+
"AsyncIssuableMixin",
27+
"AsyncRecalculatableMixin",
28+
"AsyncRegeneratableMixin",
29+
"AttachmentMixin",
30+
"IssuableMixin",
31+
"RecalculatableMixin",
32+
"RegeneratableMixin",
33+
]

‎mpt_api_client/resources/billing/mixins/acceptable_mixin.py‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
from mpt_api_client.models import ResourceData
2+
3+
4+
class AcceptableMixin[Model]:
5+
"""Acceptable mixin adds the ability to accept resources."""
6+
7+
def accept(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
8+
"""Accept resource.
9+
10+
Args:
11+
resource_id: Resource ID
12+
resource_data: Resource data will be updated
13+
"""
14+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
15+
resource_id, "POST", "accept", json=resource_data
16+
)
17+
18+
def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
19+
"""Queue resource.
20+
21+
Args:
22+
resource_id: Resource ID
23+
resource_data: Resource data will be updated
24+
"""
25+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
26+
resource_id, "POST", "queue", json=resource_data
27+
)
28+
29+
30+
class AsyncAcceptableMixin[Model]:
31+
"""Acceptable mixin adds the ability to accept resources."""
32+
33+
async def accept(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
34+
"""Accept resource.
35+
36+
Args:
37+
resource_id: Resource ID
38+
resource_data: Resource data will be updated
39+
"""
40+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
41+
resource_id, "POST", "accept", json=resource_data
42+
)
43+
44+
async def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
45+
"""Queue resource.
46+
47+
Args:
48+
resource_id: Resource ID
49+
resource_data: Resource data will be updated
50+
"""
51+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
52+
resource_id, "POST", "queue", json=resource_data
53+
)

‎mpt_api_client/resources/billing/mixins/attachment_mixin.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
from mpt_api_client.http.mixins import (
2+
AsyncCreateFileMixin,
3+
AsyncDeleteMixin,
4+
AsyncDownloadFileMixin,
5+
AsyncGetMixin,
6+
AsyncUpdateMixin,
7+
CreateFileMixin,
8+
DeleteMixin,
9+
DownloadFileMixin,
10+
GetMixin,
11+
UpdateMixin,
12+
)
13+
14+
15+
class AttachmentMixin[Model](
16+
CreateFileMixin[Model],
17+
UpdateMixin[Model],
18+
DeleteMixin,
19+
DownloadFileMixin[Model],
20+
GetMixin[Model],
21+
):
22+
"""Attachment mixin."""
23+
24+
25+
class AsyncAttachmentMixin[Model](
26+
AsyncCreateFileMixin[Model],
27+
AsyncUpdateMixin[Model],
28+
AsyncDeleteMixin,
29+
AsyncDownloadFileMixin[Model],
30+
AsyncGetMixin[Model],
31+
):
32+
"""Async Attachment mixin."""

‎mpt_api_client/resources/billing/mixins/issuable_mixin.py‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
from mpt_api_client.models import ResourceData
2+
3+
4+
class IssuableMixin[Model]:
5+
"""Issuable mixin adds the ability to issue resources."""
6+
7+
def issue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
8+
"""Issue resource.
9+
10+
Args:
11+
resource_id: Resource ID
12+
resource_data: Resource data will be updated
13+
"""
14+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
15+
resource_id, "POST", "issue", json=resource_data
16+
)
17+
18+
def cancel(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
19+
"""Cancel resource.
20+
21+
Args:
22+
resource_id: Resource ID
23+
resource_data: Resource data will be updated
24+
"""
25+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
26+
resource_id, "POST", "cancel", json=resource_data
27+
)
28+
29+
def error(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
30+
"""Error resource.
31+
32+
Args:
33+
resource_id: Resource ID
34+
resource_data: Resource data will be updated
35+
"""
36+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
37+
resource_id, "POST", "error", json=resource_data
38+
)
39+
40+
def pending(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
41+
"""Pending resource.
42+
43+
Args:
44+
resource_id: Resource ID
45+
resource_data: Resource data will be updated
46+
"""
47+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
48+
resource_id, "POST", "pending", json=resource_data
49+
)
50+
51+
def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
52+
"""Queue resource.
53+
54+
Args:
55+
resource_id: Resource ID
56+
resource_data: Resource data will be updated
57+
"""
58+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
59+
resource_id, "POST", "queue", json=resource_data
60+
)
61+
62+
def retry(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
63+
"""Retry resource.
64+
65+
Args:
66+
resource_id: Resource ID
67+
resource_data: Resource data will be updated
68+
"""
69+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
70+
resource_id, "POST", "retry", json=resource_data
71+
)
72+
73+
def recalculate(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
74+
"""Recalculate resource.
75+
76+
Args:
77+
resource_id: Resource ID
78+
resource_data: Resource data will be updated
79+
"""
80+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
81+
resource_id, "POST", "recalculate", json=resource_data
82+
)
83+
84+
85+
class AsyncIssuableMixin[Model]:
86+
"""Issuable mixin adds the ability to issue resources."""
87+
88+
async def issue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
89+
"""Issue resource.
90+
91+
Args:
92+
resource_id: Resource ID
93+
resource_data: Resource data will be updated
94+
"""
95+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
96+
resource_id, "POST", "issue", json=resource_data
97+
)
98+
99+
async def cancel(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
100+
"""Cancel resource.
101+
102+
Args:
103+
resource_id: Resource ID
104+
resource_data: Resource data will be updated
105+
"""
106+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
107+
resource_id, "POST", "cancel", json=resource_data
108+
)
109+
110+
async def error(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
111+
"""Error resource.
112+
113+
Args:
114+
resource_id: Resource ID
115+
resource_data: Resource data will be updated
116+
"""
117+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
118+
resource_id, "POST", "error", json=resource_data
119+
)
120+
121+
async def pending(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
122+
"""Pending resource.
123+
124+
Args:
125+
resource_id: Resource ID
126+
resource_data: Resource data will be updated
127+
"""
128+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
129+
resource_id, "POST", "pending", json=resource_data
130+
)
131+
132+
async def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
133+
"""Queue resource.
134+
135+
Args:
136+
resource_id: Resource ID
137+
resource_data: Resource data will be updated
138+
"""
139+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
140+
resource_id, "POST", "queue", json=resource_data
141+
)
142+
143+
async def retry(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
144+
"""Retry resource.
145+
146+
Args:
147+
resource_id: Resource ID
148+
resource_data: Resource data will be updated
149+
"""
150+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
151+
resource_id, "POST", "retry", json=resource_data
152+
)
153+
154+
async def recalculate(
155+
self, resource_id: str, resource_data: ResourceData | None = None
156+
) -> Model:
157+
"""Recalculate resource.
158+
159+
Args:
160+
resource_id: Resource ID
161+
resource_data: Resource data will be updated
162+
"""
163+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
164+
resource_id, "POST", "recalculate", json=resource_data
165+
)

‎mpt_api_client/resources/billing/mixins/recalculatable_mixin.py‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
from mpt_api_client.models import ResourceData
2+
3+
4+
class RecalculatableMixin[Model]:
5+
"""Recalculatable mixin adds the ability to recalculate resources."""
6+
7+
def recalculate(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
8+
"""Recalculate resource.
9+
10+
Args:
11+
resource_id: Resource ID
12+
resource_data: Resource data will be updated
13+
"""
14+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
15+
resource_id, "POST", "recalculate", json=resource_data
16+
)
17+
18+
def accept(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
19+
"""Accept resource.
20+
21+
Args:
22+
resource_id: Resource ID
23+
resource_data: Resource data will be updated
24+
"""
25+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
26+
resource_id, "POST", "accept", json=resource_data
27+
)
28+
29+
def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
30+
"""Queue resource.
31+
32+
Args:
33+
resource_id: Resource ID
34+
resource_data: Resource data will be updated
35+
"""
36+
return self._resource_action( # type: ignore[attr-defined, no-any-return]
37+
resource_id, "POST", "queue", json=resource_data
38+
)
39+
40+
41+
class AsyncRecalculatableMixin[Model]:
42+
"""Recalculatable mixin adds the ability to recalculate resources."""
43+
44+
async def recalculate(
45+
self, resource_id: str, resource_data: ResourceData | None = None
46+
) -> Model:
47+
"""Recalculate resource.
48+
49+
Args:
50+
resource_id: Resource ID
51+
resource_data: Resource data will be updated
52+
"""
53+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
54+
resource_id, "POST", "recalculate", json=resource_data
55+
)
56+
57+
async def accept(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
58+
"""Accept resource.
59+
60+
Args:
61+
resource_id: Resource ID
62+
resource_data: Resource data will be updated
63+
"""
64+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
65+
resource_id, "POST", "accept", json=resource_data
66+
)
67+
68+
async def queue(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
69+
"""Queue resource.
70+
71+
Args:
72+
resource_id: Resource ID
73+
resource_data: Resource data will be updated
74+
"""
75+
return await self._resource_action( # type: ignore[attr-defined, no-any-return]
76+
resource_id, "POST", "queue", json=resource_data
77+
)

0 commit comments

Comments
 (0)