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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._capability import Capability
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import NotRequired, TypedDict
class AccountCapabilityService(StripeService):
class ListParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
requested: NotRequired[bool]
"""
To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.
If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
"""
def list(
self,
account: str,
params: "AccountCapabilityService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Capability]:
"""
Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
"""
return cast(
ListObject[Capability],
self._request(
"get",
"/v1/accounts/{account}/capabilities".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
account: str,
params: "AccountCapabilityService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Capability]:
"""
Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
"""
return cast(
ListObject[Capability],
await self._request_async(
"get",
"/v1/accounts/{account}/capabilities".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
account: str,
capability: str,
params: "AccountCapabilityService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Capability:
"""
Retrieves information about the specified Account Capability.
"""
return cast(
Capability,
self._request(
"get",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
account: str,
capability: str,
params: "AccountCapabilityService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Capability:
"""
Retrieves information about the specified Account Capability.
"""
return cast(
Capability,
await self._request_async(
"get",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
account: str,
capability: str,
params: "AccountCapabilityService.UpdateParams" = {},
options: RequestOptions = {},
) -> Capability:
"""
Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
"""
return cast(
Capability,
self._request(
"post",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
account: str,
capability: str,
params: "AccountCapabilityService.UpdateParams" = {},
options: RequestOptions = {},
) -> Capability:
"""
Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
"""
return cast(
Capability,
await self._request_async(
"post",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
base_address="api",
params=params,
options=options,
),
)
|
