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
|
# -*- 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._promotion_code import PromotionCode
from stripe._request_options import RequestOptions
from stripe.params._promotion_code_create_params import (
PromotionCodeCreateParams,
)
from stripe.params._promotion_code_list_params import (
PromotionCodeListParams,
)
from stripe.params._promotion_code_retrieve_params import (
PromotionCodeRetrieveParams,
)
from stripe.params._promotion_code_update_params import (
PromotionCodeUpdateParams,
)
class PromotionCodeService(StripeService):
def list(
self,
params: Optional["PromotionCodeListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[PromotionCode]":
"""
Returns a list of your promotion codes.
"""
return cast(
"ListObject[PromotionCode]",
self._request(
"get",
"/v1/promotion_codes",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["PromotionCodeListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[PromotionCode]":
"""
Returns a list of your promotion codes.
"""
return cast(
"ListObject[PromotionCode]",
await self._request_async(
"get",
"/v1/promotion_codes",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "PromotionCodeCreateParams",
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
"""
return cast(
"PromotionCode",
self._request(
"post",
"/v1/promotion_codes",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "PromotionCodeCreateParams",
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
"""
return cast(
"PromotionCode",
await self._request_async(
"post",
"/v1/promotion_codes",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
promotion_code: str,
params: Optional["PromotionCodeRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
"""
return cast(
"PromotionCode",
self._request(
"get",
"/v1/promotion_codes/{promotion_code}".format(
promotion_code=sanitize_id(promotion_code),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
promotion_code: str,
params: Optional["PromotionCodeRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
"""
return cast(
"PromotionCode",
await self._request_async(
"get",
"/v1/promotion_codes/{promotion_code}".format(
promotion_code=sanitize_id(promotion_code),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
promotion_code: str,
params: Optional["PromotionCodeUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
"""
return cast(
"PromotionCode",
self._request(
"post",
"/v1/promotion_codes/{promotion_code}".format(
promotion_code=sanitize_id(promotion_code),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
promotion_code: str,
params: Optional["PromotionCodeUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PromotionCode":
"""
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
"""
return cast(
"PromotionCode",
await self._request_async(
"post",
"/v1/promotion_codes/{promotion_code}".format(
promotion_code=sanitize_id(promotion_code),
),
base_address="api",
params=params,
options=options,
),
)
|
