-
Notifications
You must be signed in to change notification settings - Fork 719
/
PromotionCodesResource.d.ts
209 lines (178 loc) · 7.19 KB
/
PromotionCodesResource.d.ts
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
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface PromotionCodeCreateParams {
/**
* The coupon for this promotion code.
*/
coupon: string;
/**
* Whether the promotion code is currently active.
*/
active?: boolean;
/**
* The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
*/
code?: string;
/**
* The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
*/
customer?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
*/
expires_at?: number;
/**
* A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
*/
max_redemptions?: number;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* Settings that restrict the redemption of the promotion code.
*/
restrictions?: PromotionCodeCreateParams.Restrictions;
}
namespace PromotionCodeCreateParams {
interface Restrictions {
/**
* Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
*/
currency_options?: {
[key: string]: Restrictions.CurrencyOptions;
};
/**
* A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
*/
first_time_transaction?: boolean;
/**
* Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
*/
minimum_amount?: number;
/**
* Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
*/
minimum_amount_currency?: string;
}
namespace Restrictions {
interface CurrencyOptions {
/**
* Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
*/
minimum_amount?: number;
}
}
}
interface PromotionCodeRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface PromotionCodeUpdateParams {
/**
* Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
*/
active?: boolean;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Settings that restrict the redemption of the promotion code.
*/
restrictions?: PromotionCodeUpdateParams.Restrictions;
}
namespace PromotionCodeUpdateParams {
interface Restrictions {
/**
* Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
*/
currency_options?: {
[key: string]: Restrictions.CurrencyOptions;
};
}
namespace Restrictions {
interface CurrencyOptions {
/**
* Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
*/
minimum_amount?: number;
}
}
}
interface PromotionCodeListParams extends PaginationParams {
/**
* Filter promotion codes by whether they are active.
*/
active?: boolean;
/**
* Only return promotion codes that have this case-insensitive code.
*/
code?: string;
/**
* Only return promotion codes for this coupon.
*/
coupon?: string;
/**
* A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
*/
created?: Stripe.RangeQueryParam | number;
/**
* Only return promotion codes that are restricted to this customer.
*/
customer?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
class PromotionCodesResource {
/**
* A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
*/
create(
params: PromotionCodeCreateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.PromotionCode>>;
/**
* Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
*/
retrieve(
id: string,
params?: PromotionCodeRetrieveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.PromotionCode>>;
retrieve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.PromotionCode>>;
/**
* Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
*/
update(
id: string,
params?: PromotionCodeUpdateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.PromotionCode>>;
/**
* Returns a list of your promotion codes.
*/
list(
params?: PromotionCodeListParams,
options?: RequestOptions
): ApiListPromise<Stripe.PromotionCode>;
list(options?: RequestOptions): ApiListPromise<Stripe.PromotionCode>;
}
}
}