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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from typing import ClassVar, Dict, List
from typing_extensions import Literal, NotRequired, Unpack
class CountrySpec(ListableAPIResource["CountrySpec"]):
"""
Stripe needs to collect certain pieces of information about each account
created. These requirements can differ depending on the account's country. The
Country Specs API makes these rules available to your integration.
You can also view the information from this API call as [an online
guide](https://stripe.com/docs/connect/required-verification-information).
"""
OBJECT_NAME: ClassVar[Literal["country_spec"]] = "country_spec"
class VerificationFields(StripeObject):
class Company(StripeObject):
additional: List[str]
"""
Additional fields which are only required for some users.
"""
minimum: List[str]
"""
Fields which every account must eventually provide.
"""
class Individual(StripeObject):
additional: List[str]
"""
Additional fields which are only required for some users.
"""
minimum: List[str]
"""
Fields which every account must eventually provide.
"""
company: Company
individual: Individual
_inner_class_types = {"company": Company, "individual": Individual}
class ListParams(RequestOptions):
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
default_currency: str
"""
The default currency for this country. This applies to both payment methods and bank accounts.
"""
id: str
"""
Unique identifier for the object. Represented as the ISO country code for this country.
"""
object: Literal["country_spec"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
supported_bank_account_currencies: Dict[str, List[str]]
"""
Currencies that can be accepted in the specific country (for transfers).
"""
supported_payment_currencies: List[str]
"""
Currencies that can be accepted in the specified country (for payments).
"""
supported_payment_methods: List[str]
"""
Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
"""
supported_transfer_countries: List[str]
"""
Countries that can accept transfers from the specified country.
"""
verification_fields: VerificationFields
@classmethod
def list(
cls, **params: Unpack["CountrySpec.ListParams"]
) -> ListObject["CountrySpec"]:
"""
Lists all Country Spec objects available in the API.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["CountrySpec.ListParams"]
) -> ListObject["CountrySpec"]:
"""
Lists all Country Spec objects available in the API.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def retrieve(
cls, id: str, **params: Unpack["CountrySpec.RetrieveParams"]
) -> "CountrySpec":
"""
Returns a Country Spec for a given Country code.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["CountrySpec.RetrieveParams"]
) -> "CountrySpec":
"""
Returns a Country Spec for a given Country code.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
_inner_class_types = {"verification_fields": VerificationFields}
|
