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
|
# -*- 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 typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._reversal import Reversal
from stripe.params._transfer_reversal_create_params import (
TransferReversalCreateParams,
)
from stripe.params._transfer_reversal_list_params import (
TransferReversalListParams,
)
from stripe.params._transfer_reversal_retrieve_params import (
TransferReversalRetrieveParams,
)
from stripe.params._transfer_reversal_update_params import (
TransferReversalUpdateParams,
)
class TransferReversalService(StripeService):
def list(
self,
id: str,
params: Optional["TransferReversalListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Reversal]":
"""
You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.
"""
return cast(
"ListObject[Reversal]",
self._request(
"get",
"/v1/transfers/{id}/reversals".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
id: str,
params: Optional["TransferReversalListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Reversal]":
"""
You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.
"""
return cast(
"ListObject[Reversal]",
await self._request_async(
"get",
"/v1/transfers/{id}/reversals".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
id: str,
params: Optional["TransferReversalCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
When you create a new reversal, you must specify a transfer to create it on.
When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
"""
return cast(
"Reversal",
self._request(
"post",
"/v1/transfers/{id}/reversals".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
id: str,
params: Optional["TransferReversalCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
When you create a new reversal, you must specify a transfer to create it on.
When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
"""
return cast(
"Reversal",
await self._request_async(
"post",
"/v1/transfers/{id}/reversals".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
transfer: str,
id: str,
params: Optional["TransferReversalRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
"""
return cast(
"Reversal",
self._request(
"get",
"/v1/transfers/{transfer}/reversals/{id}".format(
transfer=sanitize_id(transfer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
transfer: str,
id: str,
params: Optional["TransferReversalRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
"""
return cast(
"Reversal",
await self._request_async(
"get",
"/v1/transfers/{transfer}/reversals/{id}".format(
transfer=sanitize_id(transfer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
transfer: str,
id: str,
params: Optional["TransferReversalUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata and description as arguments.
"""
return cast(
"Reversal",
self._request(
"post",
"/v1/transfers/{transfer}/reversals/{id}".format(
transfer=sanitize_id(transfer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
transfer: str,
id: str,
params: Optional["TransferReversalUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reversal":
"""
Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata and description as arguments.
"""
return cast(
"Reversal",
await self._request_async(
"post",
"/v1/transfers/{transfer}/reversals/{id}".format(
transfer=sanitize_id(transfer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
|
