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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
# -*- 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._product import Product
from stripe._product_feature_service import ProductFeatureService
from stripe._request_options import RequestOptions
from stripe._search_result_object import SearchResultObject
from stripe.params._product_create_params import ProductCreateParams
from stripe.params._product_delete_params import ProductDeleteParams
from stripe.params._product_list_params import ProductListParams
from stripe.params._product_retrieve_params import ProductRetrieveParams
from stripe.params._product_search_params import ProductSearchParams
from stripe.params._product_update_params import ProductUpdateParams
_subservices = {
"features": ["stripe._product_feature_service", "ProductFeatureService"],
}
class ProductService(StripeService):
features: "ProductFeatureService"
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 delete(
self,
id: str,
params: Optional["ProductDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
"""
return cast(
"Product",
self._request(
"delete",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
id: str,
params: Optional["ProductDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
"""
return cast(
"Product",
await self._request_async(
"delete",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
id: str,
params: Optional["ProductRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
"""
return cast(
"Product",
self._request(
"get",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
id: str,
params: Optional["ProductRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
"""
return cast(
"Product",
await self._request_async(
"get",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
id: str,
params: Optional["ProductUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Product",
self._request(
"post",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
id: str,
params: Optional["ProductUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Product",
await self._request_async(
"post",
"/v1/products/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["ProductListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Product]":
"""
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
"""
return cast(
"ListObject[Product]",
self._request(
"get",
"/v1/products",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["ProductListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Product]":
"""
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
"""
return cast(
"ListObject[Product]",
await self._request_async(
"get",
"/v1/products",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "ProductCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Creates a new product object.
"""
return cast(
"Product",
self._request(
"post",
"/v1/products",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "ProductCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Product":
"""
Creates a new product object.
"""
return cast(
"Product",
await self._request_async(
"post",
"/v1/products",
base_address="api",
params=params,
options=options,
),
)
def search(
self,
params: "ProductSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Product]":
"""
Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Product]",
self._request(
"get",
"/v1/products/search",
base_address="api",
params=params,
options=options,
),
)
async def search_async(
self,
params: "ProductSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Product]":
"""
Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Product]",
await self._request_async(
"get",
"/v1/products/search",
base_address="api",
params=params,
options=options,
),
)
|
