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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
# -*- 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.params.radar._value_list_create_params import (
ValueListCreateParams,
)
from stripe.params.radar._value_list_delete_params import (
ValueListDeleteParams,
)
from stripe.params.radar._value_list_list_params import ValueListListParams
from stripe.params.radar._value_list_retrieve_params import (
ValueListRetrieveParams,
)
from stripe.params.radar._value_list_update_params import (
ValueListUpdateParams,
)
from stripe.radar._value_list import ValueList
class ValueListService(StripeService):
def delete(
self,
value_list: str,
params: Optional["ValueListDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
return cast(
"ValueList",
self._request(
"delete",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
value_list: str,
params: Optional["ValueListDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
return cast(
"ValueList",
await self._request_async(
"delete",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
value_list: str,
params: Optional["ValueListRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Retrieves a ValueList object.
"""
return cast(
"ValueList",
self._request(
"get",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
value_list: str,
params: Optional["ValueListRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Retrieves a ValueList object.
"""
return cast(
"ValueList",
await self._request_async(
"get",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
value_list: str,
params: Optional["ValueListUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
"""
return cast(
"ValueList",
self._request(
"post",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
value_list: str,
params: Optional["ValueListUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
"""
return cast(
"ValueList",
await self._request_async(
"post",
"/v1/radar/value_lists/{value_list}".format(
value_list=sanitize_id(value_list),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["ValueListListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[ValueList]":
"""
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
return cast(
"ListObject[ValueList]",
self._request(
"get",
"/v1/radar/value_lists",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["ValueListListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[ValueList]":
"""
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
return cast(
"ListObject[ValueList]",
await self._request_async(
"get",
"/v1/radar/value_lists",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "ValueListCreateParams",
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Creates a new ValueList object, which can then be referenced in rules.
"""
return cast(
"ValueList",
self._request(
"post",
"/v1/radar/value_lists",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "ValueListCreateParams",
options: Optional["RequestOptions"] = None,
) -> "ValueList":
"""
Creates a new ValueList object, which can then be referenced in rules.
"""
return cast(
"ValueList",
await self._request_async(
"post",
"/v1/radar/value_lists",
base_address="api",
params=params,
options=options,
),
)
|
