@stigg/typescript 0.1.0-alpha.21 → 0.1.0-alpha.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +37 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +493 -970
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +493 -970
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +0 -6
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +0 -6
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +28 -0
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +28 -0
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/index.d.mts +1 -1
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +1 -1
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/addons/index.js.map +1 -1
- package/resources/v1/addons/index.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +3 -3
- package/resources/v1/coupons.d.ts +3 -3
- package/resources/v1/customers/customers.d.mts +935 -5
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +935 -5
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +7 -0
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +7 -0
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +1 -1
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +1 -1
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/events/credits/credits.d.mts +1 -1
- package/resources/v1/events/credits/credits.d.mts.map +1 -1
- package/resources/v1/events/credits/credits.d.ts +1 -1
- package/resources/v1/events/credits/credits.d.ts.map +1 -1
- package/resources/v1/events/credits/credits.js.map +1 -1
- package/resources/v1/events/credits/credits.mjs.map +1 -1
- package/resources/v1/events/credits/grants.d.mts +1 -1
- package/resources/v1/events/credits/grants.d.ts +1 -1
- package/resources/v1/features.d.mts +9 -0
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +9 -0
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/index.d.mts +3 -3
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +3 -3
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +28 -0
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +28 -0
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/index.d.mts +1 -1
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +1 -1
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +392 -391
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +392 -391
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +0 -7
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +0 -7
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +9 -5
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +9 -5
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +31 -21
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +31 -21
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/usage.d.mts +1 -1
- package/resources/v1/usage.d.ts +1 -1
- package/resources/v1/v1.d.mts +6 -6
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +6 -6
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/addons/addons.ts +1111 -2508
- package/src/resources/v1/addons/entitlements.ts +33 -0
- package/src/resources/v1/addons/index.ts +0 -3
- package/src/resources/v1/coupons.ts +3 -3
- package/src/resources/v1/customers/customers.ts +2064 -4
- package/src/resources/v1/customers/index.ts +2 -0
- package/src/resources/v1/events/credits/credits.ts +3 -1
- package/src/resources/v1/events/credits/grants.ts +1 -1
- package/src/resources/v1/features.ts +9 -0
- package/src/resources/v1/index.ts +2 -4
- package/src/resources/v1/plans/entitlements.ts +33 -0
- package/src/resources/v1/plans/index.ts +0 -1
- package/src/resources/v1/plans/plans.ts +924 -930
- package/src/resources/v1/products.ts +9 -5
- package/src/resources/v1/subscriptions/subscriptions.ts +28 -22
- package/src/resources/v1/usage.ts +1 -1
- package/src/resources/v1/v1.ts +4 -8
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -43,10 +43,6 @@ export declare class Addons extends APIResource {
|
|
|
43
43
|
* Removes a draft version of an addon.
|
|
44
44
|
*/
|
|
45
45
|
removeDraft(id: string, options?: RequestOptions): APIPromise<AddonRemoveDraftResponse>;
|
|
46
|
-
/**
|
|
47
|
-
* Sets the pricing configuration for an addon.
|
|
48
|
-
*/
|
|
49
|
-
setPricing(id: string, body: AddonSetPricingParams, options?: RequestOptions): APIPromise<SetPackagePricingResponse>;
|
|
50
46
|
}
|
|
51
47
|
export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
|
|
52
48
|
/**
|
|
@@ -140,192 +136,332 @@ export declare namespace Addon {
|
|
|
140
136
|
}
|
|
141
137
|
}
|
|
142
138
|
/**
|
|
143
|
-
*
|
|
139
|
+
* Addon configuration object
|
|
144
140
|
*/
|
|
145
|
-
export interface
|
|
141
|
+
export interface AddonListResponse {
|
|
142
|
+
/**
|
|
143
|
+
* The unique identifier for the entity
|
|
144
|
+
*/
|
|
145
|
+
id: string;
|
|
146
|
+
/**
|
|
147
|
+
* The unique identifier for the entity in the billing provider
|
|
148
|
+
*/
|
|
149
|
+
billingId: string | null;
|
|
150
|
+
/**
|
|
151
|
+
* Timestamp of when the record was created
|
|
152
|
+
*/
|
|
153
|
+
createdAt: string;
|
|
154
|
+
/**
|
|
155
|
+
* List of addons the addon is dependant on
|
|
156
|
+
*/
|
|
157
|
+
dependencies: Array<string> | null;
|
|
158
|
+
/**
|
|
159
|
+
* The description of the package
|
|
160
|
+
*/
|
|
161
|
+
description: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* The display name of the package
|
|
164
|
+
*/
|
|
165
|
+
displayName: string;
|
|
166
|
+
/**
|
|
167
|
+
* List of entitlements of the package
|
|
168
|
+
*/
|
|
169
|
+
entitlements: Array<AddonListResponse.Entitlement>;
|
|
146
170
|
/**
|
|
147
|
-
*
|
|
171
|
+
* Indicates if the package is the latest version
|
|
172
|
+
*/
|
|
173
|
+
isLatest: boolean | null;
|
|
174
|
+
/**
|
|
175
|
+
* The maximum quantity of this addon that can be added to a subscription
|
|
176
|
+
*/
|
|
177
|
+
maxQuantity: number | null;
|
|
178
|
+
/**
|
|
179
|
+
* Metadata associated with the entity
|
|
148
180
|
*/
|
|
149
|
-
|
|
181
|
+
metadata: {
|
|
182
|
+
[key: string]: string;
|
|
183
|
+
};
|
|
150
184
|
/**
|
|
151
|
-
*
|
|
185
|
+
* The pricing type of the package
|
|
152
186
|
*/
|
|
153
|
-
|
|
187
|
+
pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
154
188
|
/**
|
|
155
|
-
*
|
|
189
|
+
* The product id of the package
|
|
156
190
|
*/
|
|
157
|
-
|
|
191
|
+
productId: string;
|
|
158
192
|
/**
|
|
159
|
-
*
|
|
193
|
+
* The status of the package
|
|
160
194
|
*/
|
|
161
|
-
|
|
195
|
+
status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
162
196
|
/**
|
|
163
|
-
*
|
|
197
|
+
* Timestamp of when the record was last updated
|
|
164
198
|
*/
|
|
165
|
-
|
|
199
|
+
updatedAt: string;
|
|
166
200
|
/**
|
|
167
|
-
*
|
|
201
|
+
* The version number of the package
|
|
168
202
|
*/
|
|
169
|
-
|
|
203
|
+
versionNumber: number;
|
|
170
204
|
}
|
|
171
|
-
export declare namespace
|
|
205
|
+
export declare namespace AddonListResponse {
|
|
172
206
|
/**
|
|
173
|
-
*
|
|
207
|
+
* Entitlement reference with type and identifier
|
|
174
208
|
*/
|
|
175
|
-
interface
|
|
209
|
+
interface Entitlement {
|
|
176
210
|
/**
|
|
177
|
-
* The
|
|
211
|
+
* The unique identifier for the entity
|
|
178
212
|
*/
|
|
179
|
-
|
|
213
|
+
id: string;
|
|
214
|
+
type: 'FEATURE' | 'CREDIT';
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Response containing task ID for publish operation
|
|
219
|
+
*/
|
|
220
|
+
export interface AddonPublishResponse {
|
|
221
|
+
data: AddonPublishResponse.Data;
|
|
222
|
+
}
|
|
223
|
+
export declare namespace AddonPublishResponse {
|
|
224
|
+
interface Data {
|
|
180
225
|
/**
|
|
181
|
-
*
|
|
226
|
+
* Task ID for tracking the async publish operation
|
|
182
227
|
*/
|
|
183
|
-
|
|
228
|
+
taskId: string | null;
|
|
184
229
|
}
|
|
185
|
-
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Response confirming the addon draft was removed.
|
|
233
|
+
*/
|
|
234
|
+
export interface AddonRemoveDraftResponse {
|
|
235
|
+
data: AddonRemoveDraftResponse.Data;
|
|
236
|
+
}
|
|
237
|
+
export declare namespace AddonRemoveDraftResponse {
|
|
238
|
+
interface Data {
|
|
186
239
|
/**
|
|
187
|
-
* The
|
|
240
|
+
* The unique identifier for the entity
|
|
188
241
|
*/
|
|
189
|
-
|
|
190
|
-
/**
|
|
191
|
-
* The price amount
|
|
192
|
-
*/
|
|
193
|
-
amount: number;
|
|
194
|
-
/**
|
|
195
|
-
* The price currency
|
|
196
|
-
*/
|
|
197
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
198
|
-
}
|
|
242
|
+
id: string;
|
|
199
243
|
}
|
|
244
|
+
}
|
|
245
|
+
export interface AddonCreateParams {
|
|
246
|
+
/**
|
|
247
|
+
* The unique identifier for the entity
|
|
248
|
+
*/
|
|
249
|
+
id: string;
|
|
250
|
+
/**
|
|
251
|
+
* The display name of the package
|
|
252
|
+
*/
|
|
253
|
+
displayName: string;
|
|
254
|
+
/**
|
|
255
|
+
* The product id of the package
|
|
256
|
+
*/
|
|
257
|
+
productId: string;
|
|
258
|
+
/**
|
|
259
|
+
* The unique identifier for the entity in the billing provider
|
|
260
|
+
*/
|
|
261
|
+
billingId?: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* The description of the package
|
|
264
|
+
*/
|
|
265
|
+
description?: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* The maximum quantity of this addon that can be added to a subscription
|
|
268
|
+
*/
|
|
269
|
+
maxQuantity?: number | null;
|
|
270
|
+
/**
|
|
271
|
+
* Metadata associated with the entity
|
|
272
|
+
*/
|
|
273
|
+
metadata?: {
|
|
274
|
+
[key: string]: string;
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* The pricing type of the package
|
|
278
|
+
*/
|
|
279
|
+
pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
280
|
+
/**
|
|
281
|
+
* The status of the package
|
|
282
|
+
*/
|
|
283
|
+
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
284
|
+
}
|
|
285
|
+
export interface AddonUpdateParams {
|
|
286
|
+
/**
|
|
287
|
+
* The unique identifier for the entity in the billing provider
|
|
288
|
+
*/
|
|
289
|
+
billingId?: string | null;
|
|
290
|
+
/**
|
|
291
|
+
* Pricing configuration to set on the addon draft
|
|
292
|
+
*/
|
|
293
|
+
charges?: AddonUpdateParams.Charges;
|
|
294
|
+
/**
|
|
295
|
+
* List of addons the addon is dependant on
|
|
296
|
+
*/
|
|
297
|
+
dependencies?: Array<string> | null;
|
|
298
|
+
/**
|
|
299
|
+
* The description of the package
|
|
300
|
+
*/
|
|
301
|
+
description?: string | null;
|
|
302
|
+
/**
|
|
303
|
+
* The display name of the package
|
|
304
|
+
*/
|
|
305
|
+
displayName?: string;
|
|
306
|
+
/**
|
|
307
|
+
* The maximum quantity of this addon that can be added to a subscription
|
|
308
|
+
*/
|
|
309
|
+
maxQuantity?: number | null;
|
|
310
|
+
/**
|
|
311
|
+
* Metadata associated with the entity
|
|
312
|
+
*/
|
|
313
|
+
metadata?: {
|
|
314
|
+
[key: string]: string;
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* The status of the package
|
|
318
|
+
*/
|
|
319
|
+
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
320
|
+
}
|
|
321
|
+
export declare namespace AddonUpdateParams {
|
|
200
322
|
/**
|
|
201
|
-
*
|
|
323
|
+
* Pricing configuration to set on the addon draft
|
|
202
324
|
*/
|
|
203
|
-
interface
|
|
325
|
+
interface Charges {
|
|
204
326
|
/**
|
|
205
|
-
* The
|
|
327
|
+
* The pricing type (FREE, PAID, or CUSTOM)
|
|
206
328
|
*/
|
|
207
|
-
|
|
329
|
+
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
208
330
|
/**
|
|
209
|
-
*
|
|
331
|
+
* Deprecated: billing integration ID
|
|
210
332
|
*/
|
|
211
|
-
|
|
333
|
+
billingId?: string;
|
|
212
334
|
/**
|
|
213
|
-
*
|
|
335
|
+
* Minimum spend configuration per billing period
|
|
214
336
|
*/
|
|
215
|
-
|
|
337
|
+
minimumSpend?: Array<Charges.MinimumSpend> | null;
|
|
216
338
|
/**
|
|
217
|
-
*
|
|
339
|
+
* When overage charges are billed
|
|
218
340
|
*/
|
|
219
|
-
|
|
341
|
+
overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
|
|
220
342
|
/**
|
|
221
|
-
*
|
|
343
|
+
* Array of overage pricing model configurations
|
|
222
344
|
*/
|
|
223
|
-
|
|
345
|
+
overagePricingModels?: Array<Charges.OveragePricingModel>;
|
|
224
346
|
/**
|
|
225
|
-
*
|
|
347
|
+
* Array of pricing model configurations
|
|
226
348
|
*/
|
|
227
|
-
|
|
349
|
+
pricingModels?: Array<Charges.PricingModel>;
|
|
228
350
|
}
|
|
229
|
-
namespace
|
|
351
|
+
namespace Charges {
|
|
230
352
|
/**
|
|
231
|
-
*
|
|
353
|
+
* Minimum spend configuration for a billing period.
|
|
232
354
|
*/
|
|
233
|
-
interface
|
|
355
|
+
interface MinimumSpend {
|
|
234
356
|
/**
|
|
235
|
-
* The billing period
|
|
357
|
+
* The billing period
|
|
236
358
|
*/
|
|
237
359
|
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
238
360
|
/**
|
|
239
|
-
*
|
|
361
|
+
* The minimum spend amount
|
|
362
|
+
*/
|
|
363
|
+
minimum: MinimumSpend.Minimum;
|
|
364
|
+
}
|
|
365
|
+
namespace MinimumSpend {
|
|
366
|
+
/**
|
|
367
|
+
* The minimum spend amount
|
|
368
|
+
*/
|
|
369
|
+
interface Minimum {
|
|
370
|
+
/**
|
|
371
|
+
* The price amount
|
|
372
|
+
*/
|
|
373
|
+
amount: number;
|
|
374
|
+
/**
|
|
375
|
+
* The price currency
|
|
376
|
+
*/
|
|
377
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Overage pricing model configuration.
|
|
382
|
+
*/
|
|
383
|
+
interface OveragePricingModel {
|
|
384
|
+
/**
|
|
385
|
+
* The billing model for overages
|
|
240
386
|
*/
|
|
241
|
-
|
|
387
|
+
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
242
388
|
/**
|
|
243
|
-
*
|
|
389
|
+
* Price periods for overage pricing
|
|
244
390
|
*/
|
|
245
|
-
|
|
391
|
+
pricePeriods: Array<OveragePricingModel.PricePeriod>;
|
|
246
392
|
/**
|
|
247
|
-
*
|
|
393
|
+
* The billing cadence for overages
|
|
248
394
|
*/
|
|
249
|
-
|
|
395
|
+
billingCadence?: 'RECURRING' | 'ONE_OFF';
|
|
250
396
|
/**
|
|
251
|
-
*
|
|
397
|
+
* Entitlement configuration for the overage feature
|
|
252
398
|
*/
|
|
253
|
-
|
|
399
|
+
entitlement?: OveragePricingModel.Entitlement;
|
|
254
400
|
/**
|
|
255
|
-
* The
|
|
401
|
+
* The feature ID for overage pricing
|
|
256
402
|
*/
|
|
257
|
-
|
|
403
|
+
featureId?: string;
|
|
258
404
|
/**
|
|
259
|
-
*
|
|
405
|
+
* Custom currency ID for overage top-up
|
|
260
406
|
*/
|
|
261
|
-
|
|
407
|
+
topUpCustomCurrencyId?: string;
|
|
262
408
|
}
|
|
263
|
-
namespace
|
|
409
|
+
namespace OveragePricingModel {
|
|
264
410
|
/**
|
|
265
|
-
*
|
|
411
|
+
* Price configuration for a specific billing period.
|
|
266
412
|
*/
|
|
267
|
-
interface
|
|
268
|
-
/**
|
|
269
|
-
* The credit rate amount
|
|
270
|
-
*/
|
|
271
|
-
amount: number;
|
|
413
|
+
interface PricePeriod {
|
|
272
414
|
/**
|
|
273
|
-
* The
|
|
415
|
+
* The billing period (MONTHLY or ANNUALLY)
|
|
274
416
|
*/
|
|
275
|
-
|
|
417
|
+
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
276
418
|
/**
|
|
277
|
-
*
|
|
419
|
+
* ISO country code for localized pricing
|
|
278
420
|
*/
|
|
279
|
-
|
|
280
|
-
}
|
|
281
|
-
/**
|
|
282
|
-
* The price amount and currency
|
|
283
|
-
*/
|
|
284
|
-
interface Price {
|
|
421
|
+
billingCountryCode?: string;
|
|
285
422
|
/**
|
|
286
|
-
*
|
|
423
|
+
* Block size for usage-based pricing
|
|
287
424
|
*/
|
|
288
|
-
|
|
425
|
+
blockSize?: number;
|
|
289
426
|
/**
|
|
290
|
-
*
|
|
427
|
+
* When credits are granted
|
|
291
428
|
*/
|
|
292
|
-
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* A tier in tiered pricing.
|
|
296
|
-
*/
|
|
297
|
-
interface Tier {
|
|
429
|
+
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
298
430
|
/**
|
|
299
|
-
*
|
|
431
|
+
* Credit rate configuration for credit-based pricing
|
|
300
432
|
*/
|
|
301
|
-
|
|
433
|
+
creditRate?: PricePeriod.CreditRate;
|
|
302
434
|
/**
|
|
303
|
-
*
|
|
435
|
+
* The price amount and currency
|
|
304
436
|
*/
|
|
305
|
-
|
|
437
|
+
price?: PricePeriod.Price;
|
|
306
438
|
/**
|
|
307
|
-
*
|
|
439
|
+
* Tiered pricing configuration
|
|
308
440
|
*/
|
|
309
|
-
|
|
441
|
+
tiers?: Array<PricePeriod.Tier>;
|
|
310
442
|
}
|
|
311
|
-
namespace
|
|
443
|
+
namespace PricePeriod {
|
|
312
444
|
/**
|
|
313
|
-
*
|
|
445
|
+
* Credit rate configuration for credit-based pricing
|
|
314
446
|
*/
|
|
315
|
-
interface
|
|
447
|
+
interface CreditRate {
|
|
316
448
|
/**
|
|
317
|
-
* The
|
|
449
|
+
* The credit rate amount
|
|
318
450
|
*/
|
|
319
451
|
amount: number;
|
|
320
452
|
/**
|
|
321
|
-
* The
|
|
453
|
+
* The custom currency ID
|
|
322
454
|
*/
|
|
323
|
-
|
|
455
|
+
currencyId: string;
|
|
456
|
+
/**
|
|
457
|
+
* Optional cost formula expression
|
|
458
|
+
*/
|
|
459
|
+
costFormula?: string;
|
|
324
460
|
}
|
|
325
461
|
/**
|
|
326
|
-
*
|
|
462
|
+
* The price amount and currency
|
|
327
463
|
*/
|
|
328
|
-
interface
|
|
464
|
+
interface Price {
|
|
329
465
|
/**
|
|
330
466
|
* The price amount
|
|
331
467
|
*/
|
|
@@ -335,698 +471,228 @@ export declare namespace SetPackagePricing {
|
|
|
335
471
|
*/
|
|
336
472
|
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
337
473
|
}
|
|
474
|
+
/**
|
|
475
|
+
* A tier in tiered pricing.
|
|
476
|
+
*/
|
|
477
|
+
interface Tier {
|
|
478
|
+
/**
|
|
479
|
+
* Flat price for this tier
|
|
480
|
+
*/
|
|
481
|
+
flatPrice?: Tier.FlatPrice;
|
|
482
|
+
/**
|
|
483
|
+
* Per-unit price in this tier
|
|
484
|
+
*/
|
|
485
|
+
unitPrice?: Tier.UnitPrice;
|
|
486
|
+
/**
|
|
487
|
+
* Upper bound of this tier (null for unlimited)
|
|
488
|
+
*/
|
|
489
|
+
upTo?: number;
|
|
490
|
+
}
|
|
491
|
+
namespace Tier {
|
|
492
|
+
/**
|
|
493
|
+
* Flat price for this tier
|
|
494
|
+
*/
|
|
495
|
+
interface FlatPrice {
|
|
496
|
+
/**
|
|
497
|
+
* The price amount
|
|
498
|
+
*/
|
|
499
|
+
amount: number;
|
|
500
|
+
/**
|
|
501
|
+
* The price currency
|
|
502
|
+
*/
|
|
503
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* Per-unit price in this tier
|
|
507
|
+
*/
|
|
508
|
+
interface UnitPrice {
|
|
509
|
+
/**
|
|
510
|
+
* The price amount
|
|
511
|
+
*/
|
|
512
|
+
amount: number;
|
|
513
|
+
/**
|
|
514
|
+
* The price currency
|
|
515
|
+
*/
|
|
516
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
517
|
+
}
|
|
518
|
+
}
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Entitlement configuration for the overage feature
|
|
522
|
+
*/
|
|
523
|
+
interface Entitlement {
|
|
524
|
+
/**
|
|
525
|
+
* The feature ID for the entitlement
|
|
526
|
+
*/
|
|
527
|
+
featureId: string;
|
|
528
|
+
/**
|
|
529
|
+
* Whether the limit is soft (allows overage)
|
|
530
|
+
*/
|
|
531
|
+
hasSoftLimit?: boolean;
|
|
532
|
+
/**
|
|
533
|
+
* Whether usage is unlimited
|
|
534
|
+
*/
|
|
535
|
+
hasUnlimitedUsage?: boolean;
|
|
536
|
+
/**
|
|
537
|
+
* Monthly reset configuration
|
|
538
|
+
*/
|
|
539
|
+
monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
|
|
540
|
+
/**
|
|
541
|
+
* The usage reset period
|
|
542
|
+
*/
|
|
543
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
544
|
+
/**
|
|
545
|
+
* The usage limit before overage kicks in
|
|
546
|
+
*/
|
|
547
|
+
usageLimit?: number;
|
|
548
|
+
/**
|
|
549
|
+
* Weekly reset configuration
|
|
550
|
+
*/
|
|
551
|
+
weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
|
|
552
|
+
/**
|
|
553
|
+
* Yearly reset configuration
|
|
554
|
+
*/
|
|
555
|
+
yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
|
|
556
|
+
}
|
|
557
|
+
namespace Entitlement {
|
|
558
|
+
/**
|
|
559
|
+
* Monthly reset configuration
|
|
560
|
+
*/
|
|
561
|
+
interface MonthlyResetPeriodConfiguration {
|
|
562
|
+
/**
|
|
563
|
+
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
564
|
+
*/
|
|
565
|
+
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* Weekly reset configuration
|
|
569
|
+
*/
|
|
570
|
+
interface WeeklyResetPeriodConfiguration {
|
|
571
|
+
/**
|
|
572
|
+
* Reset anchor (SubscriptionStart or specific day)
|
|
573
|
+
*/
|
|
574
|
+
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
* Yearly reset configuration
|
|
578
|
+
*/
|
|
579
|
+
interface YearlyResetPeriodConfiguration {
|
|
580
|
+
/**
|
|
581
|
+
* Reset anchor (SubscriptionStart)
|
|
582
|
+
*/
|
|
583
|
+
accordingTo: 'SubscriptionStart';
|
|
584
|
+
}
|
|
338
585
|
}
|
|
339
586
|
}
|
|
340
587
|
/**
|
|
341
|
-
*
|
|
588
|
+
* A pricing model configuration with billing details and price periods.
|
|
342
589
|
*/
|
|
343
|
-
interface
|
|
590
|
+
interface PricingModel {
|
|
591
|
+
/**
|
|
592
|
+
* The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
|
|
593
|
+
*/
|
|
594
|
+
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
595
|
+
/**
|
|
596
|
+
* Array of price period configurations (at least one required)
|
|
597
|
+
*/
|
|
598
|
+
pricePeriods: Array<PricingModel.PricePeriod>;
|
|
599
|
+
/**
|
|
600
|
+
* The billing cadence (RECURRING or ONE_OFF)
|
|
601
|
+
*/
|
|
602
|
+
billingCadence?: 'RECURRING' | 'ONE_OFF';
|
|
344
603
|
/**
|
|
345
|
-
* The feature ID
|
|
604
|
+
* The feature ID this pricing model is associated with
|
|
346
605
|
*/
|
|
347
|
-
featureId
|
|
606
|
+
featureId?: string;
|
|
348
607
|
/**
|
|
349
|
-
*
|
|
608
|
+
* Maximum number of units (max 999999)
|
|
350
609
|
*/
|
|
351
|
-
|
|
610
|
+
maxUnitQuantity?: number;
|
|
352
611
|
/**
|
|
353
|
-
*
|
|
612
|
+
* Minimum number of units
|
|
354
613
|
*/
|
|
355
|
-
|
|
614
|
+
minUnitQuantity?: number;
|
|
356
615
|
/**
|
|
357
|
-
* Monthly reset configuration
|
|
616
|
+
* Monthly reset period configuration
|
|
358
617
|
*/
|
|
359
|
-
monthlyResetPeriodConfiguration?:
|
|
618
|
+
monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
|
|
360
619
|
/**
|
|
361
620
|
* The usage reset period
|
|
362
621
|
*/
|
|
363
622
|
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
364
623
|
/**
|
|
365
|
-
* The
|
|
624
|
+
* The tiered pricing mode (VOLUME or GRADUATED)
|
|
366
625
|
*/
|
|
367
|
-
|
|
626
|
+
tiersMode?: 'VOLUME' | 'GRADUATED';
|
|
368
627
|
/**
|
|
369
|
-
*
|
|
628
|
+
* The custom currency ID for top-up pricing
|
|
370
629
|
*/
|
|
371
|
-
|
|
630
|
+
topUpCustomCurrencyId?: string;
|
|
372
631
|
/**
|
|
373
|
-
*
|
|
632
|
+
* Weekly reset period configuration
|
|
374
633
|
*/
|
|
375
|
-
|
|
376
|
-
}
|
|
377
|
-
namespace Entitlement {
|
|
634
|
+
weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
|
|
378
635
|
/**
|
|
379
|
-
*
|
|
636
|
+
* Yearly reset period configuration
|
|
380
637
|
*/
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
384
|
-
*/
|
|
385
|
-
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
386
|
-
}
|
|
387
|
-
/**
|
|
388
|
-
* Weekly reset configuration
|
|
389
|
-
*/
|
|
390
|
-
interface WeeklyResetPeriodConfiguration {
|
|
391
|
-
/**
|
|
392
|
-
* Reset anchor (SubscriptionStart or specific day)
|
|
393
|
-
*/
|
|
394
|
-
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
395
|
-
}
|
|
396
|
-
/**
|
|
397
|
-
* Yearly reset configuration
|
|
398
|
-
*/
|
|
399
|
-
interface YearlyResetPeriodConfiguration {
|
|
400
|
-
/**
|
|
401
|
-
* Reset anchor (SubscriptionStart)
|
|
402
|
-
*/
|
|
403
|
-
accordingTo: 'SubscriptionStart';
|
|
404
|
-
}
|
|
405
|
-
}
|
|
406
|
-
}
|
|
407
|
-
/**
|
|
408
|
-
* A pricing model configuration with billing details and price periods.
|
|
409
|
-
*/
|
|
410
|
-
interface PricingModel {
|
|
411
|
-
/**
|
|
412
|
-
* The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)
|
|
413
|
-
*/
|
|
414
|
-
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
415
|
-
/**
|
|
416
|
-
* Array of price period configurations (at least one required)
|
|
417
|
-
*/
|
|
418
|
-
pricePeriods: Array<PricingModel.PricePeriod>;
|
|
419
|
-
/**
|
|
420
|
-
* The billing cadence (RECURRING or ONE_OFF)
|
|
421
|
-
*/
|
|
422
|
-
billingCadence?: 'RECURRING' | 'ONE_OFF';
|
|
423
|
-
/**
|
|
424
|
-
* The feature ID this pricing model is associated with
|
|
425
|
-
*/
|
|
426
|
-
featureId?: string;
|
|
427
|
-
/**
|
|
428
|
-
* Maximum number of units (max 999999)
|
|
429
|
-
*/
|
|
430
|
-
maxUnitQuantity?: number;
|
|
431
|
-
/**
|
|
432
|
-
* Minimum number of units
|
|
433
|
-
*/
|
|
434
|
-
minUnitQuantity?: number;
|
|
435
|
-
/**
|
|
436
|
-
* Monthly reset period configuration
|
|
437
|
-
*/
|
|
438
|
-
monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
|
|
439
|
-
/**
|
|
440
|
-
* The usage reset period
|
|
441
|
-
*/
|
|
442
|
-
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
443
|
-
/**
|
|
444
|
-
* The tiered pricing mode (VOLUME or GRADUATED)
|
|
445
|
-
*/
|
|
446
|
-
tiersMode?: 'VOLUME' | 'GRADUATED';
|
|
447
|
-
/**
|
|
448
|
-
* The custom currency ID for top-up pricing
|
|
449
|
-
*/
|
|
450
|
-
topUpCustomCurrencyId?: string;
|
|
451
|
-
/**
|
|
452
|
-
* Weekly reset period configuration
|
|
453
|
-
*/
|
|
454
|
-
weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
|
|
455
|
-
/**
|
|
456
|
-
* Yearly reset period configuration
|
|
457
|
-
*/
|
|
458
|
-
yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
|
|
459
|
-
}
|
|
460
|
-
namespace PricingModel {
|
|
461
|
-
/**
|
|
462
|
-
* Price configuration for a specific billing period.
|
|
463
|
-
*/
|
|
464
|
-
interface PricePeriod {
|
|
465
|
-
/**
|
|
466
|
-
* The billing period (MONTHLY or ANNUALLY)
|
|
467
|
-
*/
|
|
468
|
-
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
469
|
-
/**
|
|
470
|
-
* ISO country code for localized pricing
|
|
471
|
-
*/
|
|
472
|
-
billingCountryCode?: string;
|
|
473
|
-
/**
|
|
474
|
-
* Block size for usage-based pricing
|
|
475
|
-
*/
|
|
476
|
-
blockSize?: number;
|
|
477
|
-
/**
|
|
478
|
-
* When credits are granted
|
|
479
|
-
*/
|
|
480
|
-
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
481
|
-
/**
|
|
482
|
-
* Credit rate configuration for credit-based pricing
|
|
483
|
-
*/
|
|
484
|
-
creditRate?: PricePeriod.CreditRate;
|
|
485
|
-
/**
|
|
486
|
-
* The price amount and currency
|
|
487
|
-
*/
|
|
488
|
-
price?: PricePeriod.Price;
|
|
489
|
-
/**
|
|
490
|
-
* Tiered pricing configuration
|
|
491
|
-
*/
|
|
492
|
-
tiers?: Array<PricePeriod.Tier>;
|
|
493
|
-
}
|
|
494
|
-
namespace PricePeriod {
|
|
495
|
-
/**
|
|
496
|
-
* Credit rate configuration for credit-based pricing
|
|
497
|
-
*/
|
|
498
|
-
interface CreditRate {
|
|
499
|
-
/**
|
|
500
|
-
* The credit rate amount
|
|
501
|
-
*/
|
|
502
|
-
amount: number;
|
|
503
|
-
/**
|
|
504
|
-
* The custom currency ID
|
|
505
|
-
*/
|
|
506
|
-
currencyId: string;
|
|
507
|
-
/**
|
|
508
|
-
* Optional cost formula expression
|
|
509
|
-
*/
|
|
510
|
-
costFormula?: string;
|
|
511
|
-
}
|
|
512
|
-
/**
|
|
513
|
-
* The price amount and currency
|
|
514
|
-
*/
|
|
515
|
-
interface Price {
|
|
516
|
-
/**
|
|
517
|
-
* The price amount
|
|
518
|
-
*/
|
|
519
|
-
amount: number;
|
|
520
|
-
/**
|
|
521
|
-
* The price currency
|
|
522
|
-
*/
|
|
523
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
524
|
-
}
|
|
525
|
-
/**
|
|
526
|
-
* A tier in tiered pricing.
|
|
527
|
-
*/
|
|
528
|
-
interface Tier {
|
|
529
|
-
/**
|
|
530
|
-
* Flat price for this tier
|
|
531
|
-
*/
|
|
532
|
-
flatPrice?: Tier.FlatPrice;
|
|
533
|
-
/**
|
|
534
|
-
* Per-unit price in this tier
|
|
535
|
-
*/
|
|
536
|
-
unitPrice?: Tier.UnitPrice;
|
|
537
|
-
/**
|
|
538
|
-
* Upper bound of this tier (null for unlimited)
|
|
539
|
-
*/
|
|
540
|
-
upTo?: number;
|
|
541
|
-
}
|
|
542
|
-
namespace Tier {
|
|
543
|
-
/**
|
|
544
|
-
* Flat price for this tier
|
|
545
|
-
*/
|
|
546
|
-
interface FlatPrice {
|
|
547
|
-
/**
|
|
548
|
-
* The price amount
|
|
549
|
-
*/
|
|
550
|
-
amount: number;
|
|
551
|
-
/**
|
|
552
|
-
* The price currency
|
|
553
|
-
*/
|
|
554
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
555
|
-
}
|
|
556
|
-
/**
|
|
557
|
-
* Per-unit price in this tier
|
|
558
|
-
*/
|
|
559
|
-
interface UnitPrice {
|
|
560
|
-
/**
|
|
561
|
-
* The price amount
|
|
562
|
-
*/
|
|
563
|
-
amount: number;
|
|
564
|
-
/**
|
|
565
|
-
* The price currency
|
|
566
|
-
*/
|
|
567
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
568
|
-
}
|
|
569
|
-
}
|
|
570
|
-
}
|
|
571
|
-
/**
|
|
572
|
-
* Monthly reset period configuration
|
|
573
|
-
*/
|
|
574
|
-
interface MonthlyResetPeriodConfiguration {
|
|
575
|
-
/**
|
|
576
|
-
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
577
|
-
*/
|
|
578
|
-
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
579
|
-
}
|
|
580
|
-
/**
|
|
581
|
-
* Weekly reset period configuration
|
|
582
|
-
*/
|
|
583
|
-
interface WeeklyResetPeriodConfiguration {
|
|
584
|
-
/**
|
|
585
|
-
* Reset anchor (SubscriptionStart or specific day)
|
|
586
|
-
*/
|
|
587
|
-
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
588
|
-
}
|
|
589
|
-
/**
|
|
590
|
-
* Yearly reset period configuration
|
|
591
|
-
*/
|
|
592
|
-
interface YearlyResetPeriodConfiguration {
|
|
593
|
-
/**
|
|
594
|
-
* Reset anchor (SubscriptionStart)
|
|
595
|
-
*/
|
|
596
|
-
accordingTo: 'SubscriptionStart';
|
|
597
|
-
}
|
|
598
|
-
}
|
|
599
|
-
}
|
|
600
|
-
/**
|
|
601
|
-
* Response object
|
|
602
|
-
*/
|
|
603
|
-
export interface SetPackagePricingResponse {
|
|
604
|
-
/**
|
|
605
|
-
* Result of setting package pricing.
|
|
606
|
-
*/
|
|
607
|
-
data: SetPackagePricingResponse.Data;
|
|
608
|
-
}
|
|
609
|
-
export declare namespace SetPackagePricingResponse {
|
|
610
|
-
/**
|
|
611
|
-
* Result of setting package pricing.
|
|
612
|
-
*/
|
|
613
|
-
interface Data {
|
|
614
|
-
/**
|
|
615
|
-
* The package identifier (refId)
|
|
616
|
-
*/
|
|
617
|
-
id: string;
|
|
618
|
-
/**
|
|
619
|
-
* The pricing type that was set
|
|
620
|
-
*/
|
|
621
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
622
|
-
}
|
|
623
|
-
}
|
|
624
|
-
/**
|
|
625
|
-
* Addon configuration object
|
|
626
|
-
*/
|
|
627
|
-
export interface AddonListResponse {
|
|
628
|
-
/**
|
|
629
|
-
* The unique identifier for the entity
|
|
630
|
-
*/
|
|
631
|
-
id: string;
|
|
632
|
-
/**
|
|
633
|
-
* The unique identifier for the entity in the billing provider
|
|
634
|
-
*/
|
|
635
|
-
billingId: string | null;
|
|
636
|
-
/**
|
|
637
|
-
* Timestamp of when the record was created
|
|
638
|
-
*/
|
|
639
|
-
createdAt: string;
|
|
640
|
-
/**
|
|
641
|
-
* List of addons the addon is dependant on
|
|
642
|
-
*/
|
|
643
|
-
dependencies: Array<string> | null;
|
|
644
|
-
/**
|
|
645
|
-
* The description of the package
|
|
646
|
-
*/
|
|
647
|
-
description: string | null;
|
|
648
|
-
/**
|
|
649
|
-
* The display name of the package
|
|
650
|
-
*/
|
|
651
|
-
displayName: string;
|
|
652
|
-
/**
|
|
653
|
-
* List of entitlements of the package
|
|
654
|
-
*/
|
|
655
|
-
entitlements: Array<AddonListResponse.Entitlement>;
|
|
656
|
-
/**
|
|
657
|
-
* Indicates if the package is the latest version
|
|
658
|
-
*/
|
|
659
|
-
isLatest: boolean | null;
|
|
660
|
-
/**
|
|
661
|
-
* The maximum quantity of this addon that can be added to a subscription
|
|
662
|
-
*/
|
|
663
|
-
maxQuantity: number | null;
|
|
664
|
-
/**
|
|
665
|
-
* Metadata associated with the entity
|
|
666
|
-
*/
|
|
667
|
-
metadata: {
|
|
668
|
-
[key: string]: string;
|
|
669
|
-
};
|
|
670
|
-
/**
|
|
671
|
-
* The pricing type of the package
|
|
672
|
-
*/
|
|
673
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
674
|
-
/**
|
|
675
|
-
* The product id of the package
|
|
676
|
-
*/
|
|
677
|
-
productId: string;
|
|
678
|
-
/**
|
|
679
|
-
* The status of the package
|
|
680
|
-
*/
|
|
681
|
-
status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
682
|
-
/**
|
|
683
|
-
* Timestamp of when the record was last updated
|
|
684
|
-
*/
|
|
685
|
-
updatedAt: string;
|
|
686
|
-
/**
|
|
687
|
-
* The version number of the package
|
|
688
|
-
*/
|
|
689
|
-
versionNumber: number;
|
|
690
|
-
}
|
|
691
|
-
export declare namespace AddonListResponse {
|
|
692
|
-
/**
|
|
693
|
-
* Entitlement reference with type and identifier
|
|
694
|
-
*/
|
|
695
|
-
interface Entitlement {
|
|
696
|
-
/**
|
|
697
|
-
* The unique identifier for the entity
|
|
698
|
-
*/
|
|
699
|
-
id: string;
|
|
700
|
-
type: 'FEATURE' | 'CREDIT';
|
|
701
|
-
}
|
|
702
|
-
}
|
|
703
|
-
/**
|
|
704
|
-
* Response containing task ID for publish operation
|
|
705
|
-
*/
|
|
706
|
-
export interface AddonPublishResponse {
|
|
707
|
-
data: AddonPublishResponse.Data;
|
|
708
|
-
}
|
|
709
|
-
export declare namespace AddonPublishResponse {
|
|
710
|
-
interface Data {
|
|
711
|
-
/**
|
|
712
|
-
* Task ID for tracking the async publish operation
|
|
713
|
-
*/
|
|
714
|
-
taskId: string | null;
|
|
715
|
-
}
|
|
716
|
-
}
|
|
717
|
-
/**
|
|
718
|
-
* Response confirming the addon draft was removed.
|
|
719
|
-
*/
|
|
720
|
-
export interface AddonRemoveDraftResponse {
|
|
721
|
-
data: AddonRemoveDraftResponse.Data;
|
|
722
|
-
}
|
|
723
|
-
export declare namespace AddonRemoveDraftResponse {
|
|
724
|
-
interface Data {
|
|
725
|
-
/**
|
|
726
|
-
* The unique identifier for the entity
|
|
727
|
-
*/
|
|
728
|
-
id: string;
|
|
729
|
-
}
|
|
730
|
-
}
|
|
731
|
-
export interface AddonCreateParams {
|
|
732
|
-
/**
|
|
733
|
-
* The unique identifier for the entity
|
|
734
|
-
*/
|
|
735
|
-
id: string;
|
|
736
|
-
/**
|
|
737
|
-
* The display name of the package
|
|
738
|
-
*/
|
|
739
|
-
displayName: string;
|
|
740
|
-
/**
|
|
741
|
-
* The product id of the package
|
|
742
|
-
*/
|
|
743
|
-
productId: string;
|
|
744
|
-
/**
|
|
745
|
-
* The unique identifier for the entity in the billing provider
|
|
746
|
-
*/
|
|
747
|
-
billingId?: string | null;
|
|
748
|
-
/**
|
|
749
|
-
* The description of the package
|
|
750
|
-
*/
|
|
751
|
-
description?: string | null;
|
|
752
|
-
/**
|
|
753
|
-
* The maximum quantity of this addon that can be added to a subscription
|
|
754
|
-
*/
|
|
755
|
-
maxQuantity?: number | null;
|
|
756
|
-
/**
|
|
757
|
-
* Metadata associated with the entity
|
|
758
|
-
*/
|
|
759
|
-
metadata?: {
|
|
760
|
-
[key: string]: string;
|
|
761
|
-
};
|
|
762
|
-
/**
|
|
763
|
-
* The pricing type of the package
|
|
764
|
-
*/
|
|
765
|
-
pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
766
|
-
/**
|
|
767
|
-
* The status of the package
|
|
768
|
-
*/
|
|
769
|
-
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
770
|
-
}
|
|
771
|
-
export interface AddonUpdateParams {
|
|
772
|
-
/**
|
|
773
|
-
* The unique identifier for the entity in the billing provider
|
|
774
|
-
*/
|
|
775
|
-
billingId?: string | null;
|
|
776
|
-
/**
|
|
777
|
-
* List of addons the addon is dependant on
|
|
778
|
-
*/
|
|
779
|
-
dependencies?: Array<string> | null;
|
|
780
|
-
/**
|
|
781
|
-
* The description of the package
|
|
782
|
-
*/
|
|
783
|
-
description?: string | null;
|
|
784
|
-
/**
|
|
785
|
-
* The display name of the package
|
|
786
|
-
*/
|
|
787
|
-
displayName?: string;
|
|
788
|
-
/**
|
|
789
|
-
* The maximum quantity of this addon that can be added to a subscription
|
|
790
|
-
*/
|
|
791
|
-
maxQuantity?: number | null;
|
|
792
|
-
/**
|
|
793
|
-
* Metadata associated with the entity
|
|
794
|
-
*/
|
|
795
|
-
metadata?: {
|
|
796
|
-
[key: string]: string;
|
|
797
|
-
};
|
|
798
|
-
/**
|
|
799
|
-
* The status of the package
|
|
800
|
-
*/
|
|
801
|
-
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
802
|
-
}
|
|
803
|
-
export interface AddonListParams extends MyCursorIDPageParams {
|
|
804
|
-
/**
|
|
805
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
806
|
-
*/
|
|
807
|
-
createdAt?: AddonListParams.CreatedAt;
|
|
808
|
-
/**
|
|
809
|
-
* Filter by product ID
|
|
810
|
-
*/
|
|
811
|
-
productId?: string;
|
|
812
|
-
/**
|
|
813
|
-
* Filter by status. Supports comma-separated values for multiple statuses
|
|
814
|
-
*/
|
|
815
|
-
status?: string;
|
|
816
|
-
}
|
|
817
|
-
export declare namespace AddonListParams {
|
|
818
|
-
/**
|
|
819
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
820
|
-
*/
|
|
821
|
-
interface CreatedAt {
|
|
822
|
-
/**
|
|
823
|
-
* Greater than the specified createdAt value
|
|
824
|
-
*/
|
|
825
|
-
gt?: string;
|
|
826
|
-
/**
|
|
827
|
-
* Greater than or equal to the specified createdAt value
|
|
828
|
-
*/
|
|
829
|
-
gte?: string;
|
|
830
|
-
/**
|
|
831
|
-
* Less than the specified createdAt value
|
|
832
|
-
*/
|
|
833
|
-
lt?: string;
|
|
834
|
-
/**
|
|
835
|
-
* Less than or equal to the specified createdAt value
|
|
836
|
-
*/
|
|
837
|
-
lte?: string;
|
|
838
|
-
}
|
|
839
|
-
}
|
|
840
|
-
export interface AddonPublishParams {
|
|
841
|
-
/**
|
|
842
|
-
* The migration type of the package
|
|
843
|
-
*/
|
|
844
|
-
migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
|
|
845
|
-
}
|
|
846
|
-
export interface AddonSetPricingParams {
|
|
847
|
-
/**
|
|
848
|
-
* The pricing type (FREE, PAID, or CUSTOM)
|
|
849
|
-
*/
|
|
850
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM';
|
|
851
|
-
/**
|
|
852
|
-
* Deprecated: billing integration ID
|
|
853
|
-
*/
|
|
854
|
-
billingId?: string;
|
|
855
|
-
/**
|
|
856
|
-
* Minimum spend configuration per billing period
|
|
857
|
-
*/
|
|
858
|
-
minimumSpend?: Array<AddonSetPricingParams.MinimumSpend> | null;
|
|
859
|
-
/**
|
|
860
|
-
* When overage charges are billed
|
|
861
|
-
*/
|
|
862
|
-
overageBillingPeriod?: 'ON_SUBSCRIPTION_RENEWAL' | 'MONTHLY';
|
|
863
|
-
/**
|
|
864
|
-
* Array of overage pricing model configurations
|
|
865
|
-
*/
|
|
866
|
-
overagePricingModels?: Array<AddonSetPricingParams.OveragePricingModel>;
|
|
867
|
-
/**
|
|
868
|
-
* Array of pricing model configurations
|
|
869
|
-
*/
|
|
870
|
-
pricingModels?: Array<AddonSetPricingParams.PricingModel>;
|
|
871
|
-
}
|
|
872
|
-
export declare namespace AddonSetPricingParams {
|
|
873
|
-
/**
|
|
874
|
-
* Minimum spend configuration for a billing period.
|
|
875
|
-
*/
|
|
876
|
-
interface MinimumSpend {
|
|
877
|
-
/**
|
|
878
|
-
* The billing period
|
|
879
|
-
*/
|
|
880
|
-
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
881
|
-
/**
|
|
882
|
-
* The minimum spend amount
|
|
883
|
-
*/
|
|
884
|
-
minimum: MinimumSpend.Minimum;
|
|
885
|
-
}
|
|
886
|
-
namespace MinimumSpend {
|
|
887
|
-
/**
|
|
888
|
-
* The minimum spend amount
|
|
889
|
-
*/
|
|
890
|
-
interface Minimum {
|
|
891
|
-
/**
|
|
892
|
-
* The price amount
|
|
893
|
-
*/
|
|
894
|
-
amount: number;
|
|
895
|
-
/**
|
|
896
|
-
* The price currency
|
|
897
|
-
*/
|
|
898
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
899
|
-
}
|
|
900
|
-
}
|
|
901
|
-
/**
|
|
902
|
-
* Overage pricing model configuration.
|
|
903
|
-
*/
|
|
904
|
-
interface OveragePricingModel {
|
|
905
|
-
/**
|
|
906
|
-
* The billing model for overages
|
|
907
|
-
*/
|
|
908
|
-
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
909
|
-
/**
|
|
910
|
-
* Price periods for overage pricing
|
|
911
|
-
*/
|
|
912
|
-
pricePeriods: Array<OveragePricingModel.PricePeriod>;
|
|
913
|
-
/**
|
|
914
|
-
* The billing cadence for overages
|
|
915
|
-
*/
|
|
916
|
-
billingCadence?: 'RECURRING' | 'ONE_OFF';
|
|
917
|
-
/**
|
|
918
|
-
* Entitlement configuration for the overage feature
|
|
919
|
-
*/
|
|
920
|
-
entitlement?: OveragePricingModel.Entitlement;
|
|
921
|
-
/**
|
|
922
|
-
* The feature ID for overage pricing
|
|
923
|
-
*/
|
|
924
|
-
featureId?: string;
|
|
925
|
-
/**
|
|
926
|
-
* Custom currency ID for overage top-up
|
|
927
|
-
*/
|
|
928
|
-
topUpCustomCurrencyId?: string;
|
|
929
|
-
}
|
|
930
|
-
namespace OveragePricingModel {
|
|
931
|
-
/**
|
|
932
|
-
* Price configuration for a specific billing period.
|
|
933
|
-
*/
|
|
934
|
-
interface PricePeriod {
|
|
935
|
-
/**
|
|
936
|
-
* The billing period (MONTHLY or ANNUALLY)
|
|
937
|
-
*/
|
|
938
|
-
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
939
|
-
/**
|
|
940
|
-
* ISO country code for localized pricing
|
|
941
|
-
*/
|
|
942
|
-
billingCountryCode?: string;
|
|
943
|
-
/**
|
|
944
|
-
* Block size for usage-based pricing
|
|
945
|
-
*/
|
|
946
|
-
blockSize?: number;
|
|
947
|
-
/**
|
|
948
|
-
* When credits are granted
|
|
949
|
-
*/
|
|
950
|
-
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
951
|
-
/**
|
|
952
|
-
* Credit rate configuration for credit-based pricing
|
|
953
|
-
*/
|
|
954
|
-
creditRate?: PricePeriod.CreditRate;
|
|
955
|
-
/**
|
|
956
|
-
* The price amount and currency
|
|
957
|
-
*/
|
|
958
|
-
price?: PricePeriod.Price;
|
|
959
|
-
/**
|
|
960
|
-
* Tiered pricing configuration
|
|
961
|
-
*/
|
|
962
|
-
tiers?: Array<PricePeriod.Tier>;
|
|
638
|
+
yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
|
|
963
639
|
}
|
|
964
|
-
namespace
|
|
640
|
+
namespace PricingModel {
|
|
965
641
|
/**
|
|
966
|
-
*
|
|
642
|
+
* Price configuration for a specific billing period.
|
|
967
643
|
*/
|
|
968
|
-
interface
|
|
969
|
-
/**
|
|
970
|
-
* The credit rate amount
|
|
971
|
-
*/
|
|
972
|
-
amount: number;
|
|
644
|
+
interface PricePeriod {
|
|
973
645
|
/**
|
|
974
|
-
* The
|
|
646
|
+
* The billing period (MONTHLY or ANNUALLY)
|
|
975
647
|
*/
|
|
976
|
-
|
|
648
|
+
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
977
649
|
/**
|
|
978
|
-
*
|
|
650
|
+
* ISO country code for localized pricing
|
|
979
651
|
*/
|
|
980
|
-
|
|
981
|
-
}
|
|
982
|
-
/**
|
|
983
|
-
* The price amount and currency
|
|
984
|
-
*/
|
|
985
|
-
interface Price {
|
|
652
|
+
billingCountryCode?: string;
|
|
986
653
|
/**
|
|
987
|
-
*
|
|
654
|
+
* Block size for usage-based pricing
|
|
988
655
|
*/
|
|
989
|
-
|
|
656
|
+
blockSize?: number;
|
|
990
657
|
/**
|
|
991
|
-
*
|
|
658
|
+
* When credits are granted
|
|
992
659
|
*/
|
|
993
|
-
|
|
994
|
-
}
|
|
995
|
-
/**
|
|
996
|
-
* A tier in tiered pricing.
|
|
997
|
-
*/
|
|
998
|
-
interface Tier {
|
|
660
|
+
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
999
661
|
/**
|
|
1000
|
-
*
|
|
662
|
+
* Credit rate configuration for credit-based pricing
|
|
1001
663
|
*/
|
|
1002
|
-
|
|
664
|
+
creditRate?: PricePeriod.CreditRate;
|
|
1003
665
|
/**
|
|
1004
|
-
*
|
|
666
|
+
* The price amount and currency
|
|
1005
667
|
*/
|
|
1006
|
-
|
|
668
|
+
price?: PricePeriod.Price;
|
|
1007
669
|
/**
|
|
1008
|
-
*
|
|
670
|
+
* Tiered pricing configuration
|
|
1009
671
|
*/
|
|
1010
|
-
|
|
672
|
+
tiers?: Array<PricePeriod.Tier>;
|
|
1011
673
|
}
|
|
1012
|
-
namespace
|
|
674
|
+
namespace PricePeriod {
|
|
1013
675
|
/**
|
|
1014
|
-
*
|
|
676
|
+
* Credit rate configuration for credit-based pricing
|
|
1015
677
|
*/
|
|
1016
|
-
interface
|
|
678
|
+
interface CreditRate {
|
|
1017
679
|
/**
|
|
1018
|
-
* The
|
|
680
|
+
* The credit rate amount
|
|
1019
681
|
*/
|
|
1020
682
|
amount: number;
|
|
1021
683
|
/**
|
|
1022
|
-
* The
|
|
684
|
+
* The custom currency ID
|
|
1023
685
|
*/
|
|
1024
|
-
|
|
686
|
+
currencyId: string;
|
|
687
|
+
/**
|
|
688
|
+
* Optional cost formula expression
|
|
689
|
+
*/
|
|
690
|
+
costFormula?: string;
|
|
1025
691
|
}
|
|
1026
692
|
/**
|
|
1027
|
-
*
|
|
693
|
+
* The price amount and currency
|
|
1028
694
|
*/
|
|
1029
|
-
interface
|
|
695
|
+
interface Price {
|
|
1030
696
|
/**
|
|
1031
697
|
* The price amount
|
|
1032
698
|
*/
|
|
@@ -1036,48 +702,54 @@ export declare namespace AddonSetPricingParams {
|
|
|
1036
702
|
*/
|
|
1037
703
|
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1038
704
|
}
|
|
705
|
+
/**
|
|
706
|
+
* A tier in tiered pricing.
|
|
707
|
+
*/
|
|
708
|
+
interface Tier {
|
|
709
|
+
/**
|
|
710
|
+
* Flat price for this tier
|
|
711
|
+
*/
|
|
712
|
+
flatPrice?: Tier.FlatPrice;
|
|
713
|
+
/**
|
|
714
|
+
* Per-unit price in this tier
|
|
715
|
+
*/
|
|
716
|
+
unitPrice?: Tier.UnitPrice;
|
|
717
|
+
/**
|
|
718
|
+
* Upper bound of this tier (null for unlimited)
|
|
719
|
+
*/
|
|
720
|
+
upTo?: number;
|
|
721
|
+
}
|
|
722
|
+
namespace Tier {
|
|
723
|
+
/**
|
|
724
|
+
* Flat price for this tier
|
|
725
|
+
*/
|
|
726
|
+
interface FlatPrice {
|
|
727
|
+
/**
|
|
728
|
+
* The price amount
|
|
729
|
+
*/
|
|
730
|
+
amount: number;
|
|
731
|
+
/**
|
|
732
|
+
* The price currency
|
|
733
|
+
*/
|
|
734
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
735
|
+
}
|
|
736
|
+
/**
|
|
737
|
+
* Per-unit price in this tier
|
|
738
|
+
*/
|
|
739
|
+
interface UnitPrice {
|
|
740
|
+
/**
|
|
741
|
+
* The price amount
|
|
742
|
+
*/
|
|
743
|
+
amount: number;
|
|
744
|
+
/**
|
|
745
|
+
* The price currency
|
|
746
|
+
*/
|
|
747
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
748
|
+
}
|
|
749
|
+
}
|
|
1039
750
|
}
|
|
1040
|
-
}
|
|
1041
|
-
/**
|
|
1042
|
-
* Entitlement configuration for the overage feature
|
|
1043
|
-
*/
|
|
1044
|
-
interface Entitlement {
|
|
1045
|
-
/**
|
|
1046
|
-
* The feature ID for the entitlement
|
|
1047
|
-
*/
|
|
1048
|
-
featureId: string;
|
|
1049
|
-
/**
|
|
1050
|
-
* Whether the limit is soft (allows overage)
|
|
1051
|
-
*/
|
|
1052
|
-
hasSoftLimit?: boolean;
|
|
1053
|
-
/**
|
|
1054
|
-
* Whether usage is unlimited
|
|
1055
|
-
*/
|
|
1056
|
-
hasUnlimitedUsage?: boolean;
|
|
1057
|
-
/**
|
|
1058
|
-
* Monthly reset configuration
|
|
1059
|
-
*/
|
|
1060
|
-
monthlyResetPeriodConfiguration?: Entitlement.MonthlyResetPeriodConfiguration;
|
|
1061
|
-
/**
|
|
1062
|
-
* The usage reset period
|
|
1063
|
-
*/
|
|
1064
|
-
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
1065
|
-
/**
|
|
1066
|
-
* The usage limit before overage kicks in
|
|
1067
|
-
*/
|
|
1068
|
-
usageLimit?: number;
|
|
1069
|
-
/**
|
|
1070
|
-
* Weekly reset configuration
|
|
1071
|
-
*/
|
|
1072
|
-
weeklyResetPeriodConfiguration?: Entitlement.WeeklyResetPeriodConfiguration;
|
|
1073
|
-
/**
|
|
1074
|
-
* Yearly reset configuration
|
|
1075
|
-
*/
|
|
1076
|
-
yearlyResetPeriodConfiguration?: Entitlement.YearlyResetPeriodConfiguration;
|
|
1077
|
-
}
|
|
1078
|
-
namespace Entitlement {
|
|
1079
751
|
/**
|
|
1080
|
-
* Monthly reset configuration
|
|
752
|
+
* Monthly reset period configuration
|
|
1081
753
|
*/
|
|
1082
754
|
interface MonthlyResetPeriodConfiguration {
|
|
1083
755
|
/**
|
|
@@ -1086,7 +758,7 @@ export declare namespace AddonSetPricingParams {
|
|
|
1086
758
|
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
1087
759
|
}
|
|
1088
760
|
/**
|
|
1089
|
-
* Weekly reset configuration
|
|
761
|
+
* Weekly reset period configuration
|
|
1090
762
|
*/
|
|
1091
763
|
interface WeeklyResetPeriodConfiguration {
|
|
1092
764
|
/**
|
|
@@ -1095,7 +767,7 @@ export declare namespace AddonSetPricingParams {
|
|
|
1095
767
|
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
1096
768
|
}
|
|
1097
769
|
/**
|
|
1098
|
-
* Yearly reset configuration
|
|
770
|
+
* Yearly reset period configuration
|
|
1099
771
|
*/
|
|
1100
772
|
interface YearlyResetPeriodConfiguration {
|
|
1101
773
|
/**
|
|
@@ -1105,201 +777,52 @@ export declare namespace AddonSetPricingParams {
|
|
|
1105
777
|
}
|
|
1106
778
|
}
|
|
1107
779
|
}
|
|
780
|
+
}
|
|
781
|
+
export interface AddonListParams extends MyCursorIDPageParams {
|
|
1108
782
|
/**
|
|
1109
|
-
*
|
|
783
|
+
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
1110
784
|
*/
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
*/
|
|
1127
|
-
featureId?: string;
|
|
1128
|
-
/**
|
|
1129
|
-
* Maximum number of units (max 999999)
|
|
1130
|
-
*/
|
|
1131
|
-
maxUnitQuantity?: number;
|
|
1132
|
-
/**
|
|
1133
|
-
* Minimum number of units
|
|
1134
|
-
*/
|
|
1135
|
-
minUnitQuantity?: number;
|
|
1136
|
-
/**
|
|
1137
|
-
* Monthly reset period configuration
|
|
1138
|
-
*/
|
|
1139
|
-
monthlyResetPeriodConfiguration?: PricingModel.MonthlyResetPeriodConfiguration;
|
|
1140
|
-
/**
|
|
1141
|
-
* The usage reset period
|
|
1142
|
-
*/
|
|
1143
|
-
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
1144
|
-
/**
|
|
1145
|
-
* The tiered pricing mode (VOLUME or GRADUATED)
|
|
1146
|
-
*/
|
|
1147
|
-
tiersMode?: 'VOLUME' | 'GRADUATED';
|
|
1148
|
-
/**
|
|
1149
|
-
* The custom currency ID for top-up pricing
|
|
1150
|
-
*/
|
|
1151
|
-
topUpCustomCurrencyId?: string;
|
|
1152
|
-
/**
|
|
1153
|
-
* Weekly reset period configuration
|
|
1154
|
-
*/
|
|
1155
|
-
weeklyResetPeriodConfiguration?: PricingModel.WeeklyResetPeriodConfiguration;
|
|
1156
|
-
/**
|
|
1157
|
-
* Yearly reset period configuration
|
|
1158
|
-
*/
|
|
1159
|
-
yearlyResetPeriodConfiguration?: PricingModel.YearlyResetPeriodConfiguration;
|
|
1160
|
-
}
|
|
1161
|
-
namespace PricingModel {
|
|
785
|
+
createdAt?: AddonListParams.CreatedAt;
|
|
786
|
+
/**
|
|
787
|
+
* Filter by product ID
|
|
788
|
+
*/
|
|
789
|
+
productId?: string;
|
|
790
|
+
/**
|
|
791
|
+
* Filter by status. Supports comma-separated values for multiple statuses
|
|
792
|
+
*/
|
|
793
|
+
status?: string;
|
|
794
|
+
}
|
|
795
|
+
export declare namespace AddonListParams {
|
|
796
|
+
/**
|
|
797
|
+
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
798
|
+
*/
|
|
799
|
+
interface CreatedAt {
|
|
1162
800
|
/**
|
|
1163
|
-
*
|
|
801
|
+
* Greater than the specified createdAt value
|
|
1164
802
|
*/
|
|
1165
|
-
|
|
1166
|
-
/**
|
|
1167
|
-
* The billing period (MONTHLY or ANNUALLY)
|
|
1168
|
-
*/
|
|
1169
|
-
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
1170
|
-
/**
|
|
1171
|
-
* ISO country code for localized pricing
|
|
1172
|
-
*/
|
|
1173
|
-
billingCountryCode?: string;
|
|
1174
|
-
/**
|
|
1175
|
-
* Block size for usage-based pricing
|
|
1176
|
-
*/
|
|
1177
|
-
blockSize?: number;
|
|
1178
|
-
/**
|
|
1179
|
-
* When credits are granted
|
|
1180
|
-
*/
|
|
1181
|
-
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
1182
|
-
/**
|
|
1183
|
-
* Credit rate configuration for credit-based pricing
|
|
1184
|
-
*/
|
|
1185
|
-
creditRate?: PricePeriod.CreditRate;
|
|
1186
|
-
/**
|
|
1187
|
-
* The price amount and currency
|
|
1188
|
-
*/
|
|
1189
|
-
price?: PricePeriod.Price;
|
|
1190
|
-
/**
|
|
1191
|
-
* Tiered pricing configuration
|
|
1192
|
-
*/
|
|
1193
|
-
tiers?: Array<PricePeriod.Tier>;
|
|
1194
|
-
}
|
|
1195
|
-
namespace PricePeriod {
|
|
1196
|
-
/**
|
|
1197
|
-
* Credit rate configuration for credit-based pricing
|
|
1198
|
-
*/
|
|
1199
|
-
interface CreditRate {
|
|
1200
|
-
/**
|
|
1201
|
-
* The credit rate amount
|
|
1202
|
-
*/
|
|
1203
|
-
amount: number;
|
|
1204
|
-
/**
|
|
1205
|
-
* The custom currency ID
|
|
1206
|
-
*/
|
|
1207
|
-
currencyId: string;
|
|
1208
|
-
/**
|
|
1209
|
-
* Optional cost formula expression
|
|
1210
|
-
*/
|
|
1211
|
-
costFormula?: string;
|
|
1212
|
-
}
|
|
1213
|
-
/**
|
|
1214
|
-
* The price amount and currency
|
|
1215
|
-
*/
|
|
1216
|
-
interface Price {
|
|
1217
|
-
/**
|
|
1218
|
-
* The price amount
|
|
1219
|
-
*/
|
|
1220
|
-
amount: number;
|
|
1221
|
-
/**
|
|
1222
|
-
* The price currency
|
|
1223
|
-
*/
|
|
1224
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1225
|
-
}
|
|
1226
|
-
/**
|
|
1227
|
-
* A tier in tiered pricing.
|
|
1228
|
-
*/
|
|
1229
|
-
interface Tier {
|
|
1230
|
-
/**
|
|
1231
|
-
* Flat price for this tier
|
|
1232
|
-
*/
|
|
1233
|
-
flatPrice?: Tier.FlatPrice;
|
|
1234
|
-
/**
|
|
1235
|
-
* Per-unit price in this tier
|
|
1236
|
-
*/
|
|
1237
|
-
unitPrice?: Tier.UnitPrice;
|
|
1238
|
-
/**
|
|
1239
|
-
* Upper bound of this tier (null for unlimited)
|
|
1240
|
-
*/
|
|
1241
|
-
upTo?: number;
|
|
1242
|
-
}
|
|
1243
|
-
namespace Tier {
|
|
1244
|
-
/**
|
|
1245
|
-
* Flat price for this tier
|
|
1246
|
-
*/
|
|
1247
|
-
interface FlatPrice {
|
|
1248
|
-
/**
|
|
1249
|
-
* The price amount
|
|
1250
|
-
*/
|
|
1251
|
-
amount: number;
|
|
1252
|
-
/**
|
|
1253
|
-
* The price currency
|
|
1254
|
-
*/
|
|
1255
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1256
|
-
}
|
|
1257
|
-
/**
|
|
1258
|
-
* Per-unit price in this tier
|
|
1259
|
-
*/
|
|
1260
|
-
interface UnitPrice {
|
|
1261
|
-
/**
|
|
1262
|
-
* The price amount
|
|
1263
|
-
*/
|
|
1264
|
-
amount: number;
|
|
1265
|
-
/**
|
|
1266
|
-
* The price currency
|
|
1267
|
-
*/
|
|
1268
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1269
|
-
}
|
|
1270
|
-
}
|
|
1271
|
-
}
|
|
803
|
+
gt?: string;
|
|
1272
804
|
/**
|
|
1273
|
-
*
|
|
805
|
+
* Greater than or equal to the specified createdAt value
|
|
1274
806
|
*/
|
|
1275
|
-
|
|
1276
|
-
/**
|
|
1277
|
-
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
1278
|
-
*/
|
|
1279
|
-
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
1280
|
-
}
|
|
807
|
+
gte?: string;
|
|
1281
808
|
/**
|
|
1282
|
-
*
|
|
809
|
+
* Less than the specified createdAt value
|
|
1283
810
|
*/
|
|
1284
|
-
|
|
1285
|
-
/**
|
|
1286
|
-
* Reset anchor (SubscriptionStart or specific day)
|
|
1287
|
-
*/
|
|
1288
|
-
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
1289
|
-
}
|
|
811
|
+
lt?: string;
|
|
1290
812
|
/**
|
|
1291
|
-
*
|
|
813
|
+
* Less than or equal to the specified createdAt value
|
|
1292
814
|
*/
|
|
1293
|
-
|
|
1294
|
-
/**
|
|
1295
|
-
* Reset anchor (SubscriptionStart)
|
|
1296
|
-
*/
|
|
1297
|
-
accordingTo: 'SubscriptionStart';
|
|
1298
|
-
}
|
|
815
|
+
lte?: string;
|
|
1299
816
|
}
|
|
1300
817
|
}
|
|
818
|
+
export interface AddonPublishParams {
|
|
819
|
+
/**
|
|
820
|
+
* The migration type of the package
|
|
821
|
+
*/
|
|
822
|
+
migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
|
|
823
|
+
}
|
|
1301
824
|
export declare namespace Addons {
|
|
1302
|
-
export { type Addon as Addon, type
|
|
825
|
+
export { type Addon as Addon, type AddonListResponse as AddonListResponse, type AddonPublishResponse as AddonPublishResponse, type AddonRemoveDraftResponse as AddonRemoveDraftResponse, type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage, type AddonCreateParams as AddonCreateParams, type AddonUpdateParams as AddonUpdateParams, type AddonListParams as AddonListParams, type AddonPublishParams as AddonPublishParams, };
|
|
1303
826
|
export { Entitlements as Entitlements, type AddonPackageEntitlement as AddonPackageEntitlement, type EntitlementCreateResponse as EntitlementCreateResponse, type EntitlementListResponse as EntitlementListResponse, type EntitlementCreateParams as EntitlementCreateParams, type EntitlementUpdateParams as EntitlementUpdateParams, type EntitlementDeleteParams as EntitlementDeleteParams, };
|
|
1304
827
|
}
|
|
1305
828
|
//# sourceMappingURL=addons.d.ts.map
|