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
|
# -*- 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._dispute import Dispute
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.params._dispute_close_params import DisputeCloseParams
from stripe.params._dispute_list_params import DisputeListParams
from stripe.params._dispute_retrieve_params import DisputeRetrieveParams
from stripe.params._dispute_update_params import DisputeUpdateParams
class DisputeService(StripeService):
def list(
self,
params: Optional["DisputeListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Dispute]":
"""
Returns a list of your disputes.
"""
return cast(
"ListObject[Dispute]",
self._request(
"get",
"/v1/disputes",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["DisputeListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Dispute]":
"""
Returns a list of your disputes.
"""
return cast(
"ListObject[Dispute]",
await self._request_async(
"get",
"/v1/disputes",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
dispute: str,
params: Optional["DisputeRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
Retrieves the dispute with the given ID.
"""
return cast(
"Dispute",
self._request(
"get",
"/v1/disputes/{dispute}".format(dispute=sanitize_id(dispute)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
dispute: str,
params: Optional["DisputeRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
Retrieves the dispute with the given ID.
"""
return cast(
"Dispute",
await self._request_async(
"get",
"/v1/disputes/{dispute}".format(dispute=sanitize_id(dispute)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
dispute: str,
params: Optional["DisputeUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
"""
return cast(
"Dispute",
self._request(
"post",
"/v1/disputes/{dispute}".format(dispute=sanitize_id(dispute)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
dispute: str,
params: Optional["DisputeUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
"""
return cast(
"Dispute",
await self._request_async(
"post",
"/v1/disputes/{dispute}".format(dispute=sanitize_id(dispute)),
base_address="api",
params=params,
options=options,
),
)
def close(
self,
dispute: str,
params: Optional["DisputeCloseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
"""
return cast(
"Dispute",
self._request(
"post",
"/v1/disputes/{dispute}/close".format(
dispute=sanitize_id(dispute),
),
base_address="api",
params=params,
options=options,
),
)
async def close_async(
self,
dispute: str,
params: Optional["DisputeCloseParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Dispute":
"""
Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
"""
return cast(
"Dispute",
await self._request_async(
"post",
"/v1/disputes/{dispute}/close".format(
dispute=sanitize_id(dispute),
),
base_address="api",
params=params,
options=options,
),
)
|
