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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from stripe.treasury._inbound_transfer import InboundTransfer
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class InboundTransferService(StripeService):
class FailParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
failure_details: NotRequired[
"InboundTransferService.FailParamsFailureDetails"
]
"""
Details about a failed InboundTransfer.
"""
class FailParamsFailureDetails(TypedDict):
code: NotRequired[
Literal[
"account_closed",
"account_frozen",
"bank_account_restricted",
"bank_ownership_changed",
"debit_not_authorized",
"incorrect_account_holder_address",
"incorrect_account_holder_name",
"incorrect_account_holder_tax_id",
"insufficient_funds",
"invalid_account_number",
"invalid_currency",
"no_account",
"other",
]
]
"""
Reason for the failure.
"""
class ReturnInboundTransferParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class SucceedParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def fail(
self,
id: str,
params: "InboundTransferService.FailParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
"""
return cast(
InboundTransfer,
self._request(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/fail".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def fail_async(
self,
id: str,
params: "InboundTransferService.FailParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
"""
return cast(
InboundTransfer,
await self._request_async(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/fail".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def return_inbound_transfer(
self,
id: str,
params: "InboundTransferService.ReturnInboundTransferParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
"""
return cast(
InboundTransfer,
self._request(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/return".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def return_inbound_transfer_async(
self,
id: str,
params: "InboundTransferService.ReturnInboundTransferParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
"""
return cast(
InboundTransfer,
await self._request_async(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/return".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def succeed(
self,
id: str,
params: "InboundTransferService.SucceedParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
"""
return cast(
InboundTransfer,
self._request(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/succeed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def succeed_async(
self,
id: str,
params: "InboundTransferService.SucceedParams" = {},
options: RequestOptions = {},
) -> InboundTransfer:
"""
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
"""
return cast(
InboundTransfer,
await self._request_async(
"post",
"/v1/test_helpers/treasury/inbound_transfers/{id}/succeed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
|
