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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._transfer import Transfer
from stripe._transfer_reversal_service import TransferReversalService
from stripe.params._transfer_create_params import TransferCreateParams
from stripe.params._transfer_list_params import TransferListParams
from stripe.params._transfer_retrieve_params import TransferRetrieveParams
from stripe.params._transfer_update_params import TransferUpdateParams
_subservices = {
"reversals": [
"stripe._transfer_reversal_service",
"TransferReversalService",
],
}
class TransferService(StripeService):
reversals: "TransferReversalService"
def __init__(self, requestor):
super().__init__(requestor)
def __getattr__(self, name):
try:
import_from, service = _subservices[name]
service_class = getattr(
import_module(import_from),
service,
)
setattr(
self,
name,
service_class(self._requestor),
)
return getattr(self, name)
except KeyError:
raise AttributeError()
def list(
self,
params: Optional["TransferListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Transfer]":
"""
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
"""
return cast(
"ListObject[Transfer]",
self._request(
"get",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["TransferListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Transfer]":
"""
Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
"""
return cast(
"ListObject[Transfer]",
await self._request_async(
"get",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "TransferCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
"""
return cast(
"Transfer",
self._request(
"post",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "TransferCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
"""
return cast(
"Transfer",
await self._request_async(
"post",
"/v1/transfers",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
transfer: str,
params: Optional["TransferRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
"""
return cast(
"Transfer",
self._request(
"get",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
transfer: str,
params: Optional["TransferRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
"""
return cast(
"Transfer",
await self._request_async(
"get",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
transfer: str,
params: Optional["TransferUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
"""
return cast(
"Transfer",
self._request(
"post",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
transfer: str,
params: Optional["TransferUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Transfer":
"""
Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
"""
return cast(
"Transfer",
await self._request_async(
"post",
"/v1/transfers/{transfer}".format(
transfer=sanitize_id(transfer),
),
base_address="api",
params=params,
options=options,
),
)
|
