@stigg/typescript 0.1.0-beta.10 → 0.1.0-beta.14
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 +32 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +167 -193
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +167 -193
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +1 -4
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +1 -4
- package/resources/v1/addons/addons.mjs.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/customers/customers.d.mts +5 -5
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +5 -5
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +3 -3
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +3 -3
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +1 -1
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +1 -1
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/index.d.mts +2 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +2 -2
- 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/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 +333 -6
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +333 -6
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/v1.d.mts +4 -4
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +4 -4
- 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/resources/v1-beta/customers/customers.d.mts +2 -2
- package/resources/v1-beta/customers/customers.d.mts.map +1 -1
- package/resources/v1-beta/customers/customers.d.ts +2 -2
- package/resources/v1-beta/customers/customers.d.ts.map +1 -1
- package/resources/v1-beta/customers/entities.d.mts +45 -34
- package/resources/v1-beta/customers/entities.d.mts.map +1 -1
- package/resources/v1-beta/customers/entities.d.ts +45 -34
- package/resources/v1-beta/customers/entities.d.ts.map +1 -1
- package/resources/v1-beta/customers/entities.js +2 -2
- package/resources/v1-beta/customers/entities.mjs +2 -2
- package/resources/v1-beta/customers/index.d.mts +1 -1
- package/resources/v1-beta/customers/index.d.mts.map +1 -1
- package/resources/v1-beta/customers/index.d.ts +1 -1
- package/resources/v1-beta/customers/index.d.ts.map +1 -1
- package/src/resources/v1/addons/addons.ts +458 -487
- package/src/resources/v1/addons/index.ts +2 -2
- package/src/resources/v1/customers/customers.ts +15 -5
- package/src/resources/v1/customers/integrations.ts +8 -2
- package/src/resources/v1/customers/payment-method.ts +3 -1
- package/src/resources/v1/index.ts +6 -2
- package/src/resources/v1/plans/index.ts +4 -0
- package/src/resources/v1/plans/plans.ts +1100 -8
- package/src/resources/v1/v1.ts +12 -4
- package/src/resources/v1-beta/customers/customers.ts +4 -4
- package/src/resources/v1-beta/customers/entities.ts +50 -38
- package/src/resources/v1-beta/customers/index.ts +2 -2
- 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
|
@@ -79,11 +79,12 @@ export class Addons extends APIResource {
|
|
|
79
79
|
id: string,
|
|
80
80
|
query: AddonListChargesParams | null | undefined = {},
|
|
81
81
|
options?: RequestOptions,
|
|
82
|
-
): PagePromise<
|
|
83
|
-
return this._client.getAPIList(
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
82
|
+
): PagePromise<AddonListChargesResponsesMyCursorIDPage, AddonListChargesResponse> {
|
|
83
|
+
return this._client.getAPIList(
|
|
84
|
+
path`/api/v1/addons/${id}/charges`,
|
|
85
|
+
MyCursorIDPage<AddonListChargesResponse>,
|
|
86
|
+
{ query, ...options },
|
|
87
|
+
);
|
|
87
88
|
}
|
|
88
89
|
|
|
89
90
|
/**
|
|
@@ -103,7 +104,7 @@ export class Addons extends APIResource {
|
|
|
103
104
|
|
|
104
105
|
export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
|
|
105
106
|
|
|
106
|
-
export type
|
|
107
|
+
export type AddonListChargesResponsesMyCursorIDPage = MyCursorIDPage<AddonListChargesResponse>;
|
|
107
108
|
|
|
108
109
|
/**
|
|
109
110
|
* Response object
|
|
@@ -212,150 +213,383 @@ export namespace Addon {
|
|
|
212
213
|
}
|
|
213
214
|
|
|
214
215
|
/**
|
|
215
|
-
*
|
|
216
|
+
* Addon configuration object
|
|
216
217
|
*/
|
|
217
|
-
export interface
|
|
218
|
-
|
|
218
|
+
export interface AddonListResponse {
|
|
219
|
+
/**
|
|
220
|
+
* The unique identifier for the entity
|
|
221
|
+
*/
|
|
222
|
+
id: string;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* The unique identifier for the entity in the billing provider
|
|
226
|
+
*/
|
|
227
|
+
billingId: string | null;
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Timestamp of when the record was created
|
|
231
|
+
*/
|
|
232
|
+
createdAt: string;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* List of addons the addon is dependant on
|
|
236
|
+
*/
|
|
237
|
+
dependencies: Array<string> | null;
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* The description of the package
|
|
241
|
+
*/
|
|
242
|
+
description: string | null;
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* The display name of the package
|
|
246
|
+
*/
|
|
247
|
+
displayName: string;
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* List of entitlements of the package
|
|
251
|
+
*/
|
|
252
|
+
entitlements: Array<AddonListResponse.Entitlement>;
|
|
253
|
+
|
|
254
|
+
/**
|
|
255
|
+
* Indicates if the package is the latest version
|
|
256
|
+
*/
|
|
257
|
+
isLatest: boolean | null;
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* The maximum quantity of this addon that can be added to a subscription
|
|
261
|
+
*/
|
|
262
|
+
maxQuantity: number | null;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Metadata associated with the entity
|
|
266
|
+
*/
|
|
267
|
+
metadata: { [key: string]: string };
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* The pricing type of the package
|
|
271
|
+
*/
|
|
272
|
+
pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* The product id of the package
|
|
276
|
+
*/
|
|
277
|
+
productId: string;
|
|
219
278
|
|
|
220
279
|
/**
|
|
221
|
-
*
|
|
280
|
+
* The status of the package
|
|
281
|
+
*/
|
|
282
|
+
status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Timestamp of when the record was last updated
|
|
286
|
+
*/
|
|
287
|
+
updatedAt: string;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* The version number of the package
|
|
222
291
|
*/
|
|
223
|
-
|
|
292
|
+
versionNumber: number;
|
|
224
293
|
}
|
|
225
294
|
|
|
226
|
-
export namespace
|
|
295
|
+
export namespace AddonListResponse {
|
|
227
296
|
/**
|
|
228
|
-
*
|
|
229
|
-
* billingModel, billingCadence, billingCountryCode) combination. Plans and addons
|
|
230
|
-
* own many of these — one per currency / billing period / feature.
|
|
297
|
+
* Entitlement reference with type and identifier
|
|
231
298
|
*/
|
|
232
|
-
export interface
|
|
299
|
+
export interface Entitlement {
|
|
233
300
|
/**
|
|
234
|
-
*
|
|
301
|
+
* The unique identifier for the entity
|
|
235
302
|
*/
|
|
236
303
|
id: string;
|
|
237
304
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
billingCadence: 'RECURRING' | 'ONE_OFF';
|
|
305
|
+
type: 'FEATURE' | 'CREDIT';
|
|
306
|
+
}
|
|
307
|
+
}
|
|
242
308
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
309
|
+
/**
|
|
310
|
+
* A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
|
|
311
|
+
* billingModel, billingCadence, billingCountryCode) combination. Plans and addons
|
|
312
|
+
* own many of these — one per currency / billing period / feature.
|
|
313
|
+
*/
|
|
314
|
+
export interface AddonListChargesResponse {
|
|
315
|
+
/**
|
|
316
|
+
* Unique identifier of the charge
|
|
317
|
+
*/
|
|
318
|
+
id: string;
|
|
247
319
|
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
320
|
+
/**
|
|
321
|
+
* The billing cadence (RECURRING or ONE_OFF)
|
|
322
|
+
*/
|
|
323
|
+
billingCadence: 'RECURRING' | 'ONE_OFF';
|
|
252
324
|
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
325
|
+
/**
|
|
326
|
+
* The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
|
|
327
|
+
*/
|
|
328
|
+
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
257
329
|
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
330
|
+
/**
|
|
331
|
+
* The billing period (MONTHLY or ANNUALLY)
|
|
332
|
+
*/
|
|
333
|
+
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
262
334
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
335
|
+
/**
|
|
336
|
+
* Timestamp when the charge was created
|
|
337
|
+
*/
|
|
338
|
+
createdAt: string;
|
|
267
339
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
340
|
+
/**
|
|
341
|
+
* ISO country code for localized pricing, if any
|
|
342
|
+
*/
|
|
343
|
+
billingCountryCode?: string | null;
|
|
272
344
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
345
|
+
/**
|
|
346
|
+
* Identifier in the external billing integration (e.g. Stripe price id), if any
|
|
347
|
+
*/
|
|
348
|
+
billingId?: string | null;
|
|
277
349
|
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
350
|
+
/**
|
|
351
|
+
* Block size for usage-based pricing
|
|
352
|
+
*/
|
|
353
|
+
blockSize?: number | null;
|
|
282
354
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
355
|
+
/**
|
|
356
|
+
* When credits are granted (for credit-based pricing)
|
|
357
|
+
*/
|
|
358
|
+
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
|
|
287
359
|
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
360
|
+
/**
|
|
361
|
+
* Credit rate configuration for credit-based pricing
|
|
362
|
+
*/
|
|
363
|
+
creditRate?: AddonListChargesResponse.CreditRate | null;
|
|
292
364
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
365
|
+
/**
|
|
366
|
+
* Identifier in the linked CRM, if any
|
|
367
|
+
*/
|
|
368
|
+
crmId?: string | null;
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Deep link to the charge in the linked CRM, if any
|
|
372
|
+
*/
|
|
373
|
+
crmLinkUrl?: string | null;
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* The feature this charge meters, if metered
|
|
377
|
+
*/
|
|
378
|
+
featureId?: string | null;
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Maximum unit quantity that can be purchased
|
|
382
|
+
*/
|
|
383
|
+
maxUnitQuantity?: number | null;
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Minimum unit quantity that can be purchased
|
|
387
|
+
*/
|
|
388
|
+
minUnitQuantity?: number | null;
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* The flat price amount and currency, when applicable
|
|
392
|
+
*/
|
|
393
|
+
price?: AddonListChargesResponse.Price | null;
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* Tiered pricing rows when the charge is tiered
|
|
397
|
+
*/
|
|
398
|
+
tiers?: Array<AddonListChargesResponse.Tier> | null;
|
|
399
|
+
|
|
400
|
+
/**
|
|
401
|
+
* Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
|
|
402
|
+
*/
|
|
403
|
+
tiersMode?: 'VOLUME' | 'GRADUATED' | null;
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* Custom currency identifier for top-up pricing, if any
|
|
407
|
+
*/
|
|
408
|
+
topUpCustomCurrencyId?: string | null;
|
|
297
409
|
|
|
410
|
+
/**
|
|
411
|
+
* True if this charge is referenced by at least one subscription
|
|
412
|
+
*/
|
|
413
|
+
usedInSubscriptions?: boolean | null;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
export namespace AddonListChargesResponse {
|
|
417
|
+
/**
|
|
418
|
+
* Credit rate configuration for credit-based pricing
|
|
419
|
+
*/
|
|
420
|
+
export interface CreditRate {
|
|
298
421
|
/**
|
|
299
|
-
*
|
|
422
|
+
* Credit rate amount
|
|
300
423
|
*/
|
|
301
|
-
|
|
424
|
+
amount: number;
|
|
302
425
|
|
|
303
426
|
/**
|
|
304
|
-
*
|
|
427
|
+
* Custom currency identifier
|
|
305
428
|
*/
|
|
306
|
-
|
|
429
|
+
currencyId: string;
|
|
307
430
|
|
|
308
431
|
/**
|
|
309
|
-
*
|
|
432
|
+
* Optional cost formula expression
|
|
310
433
|
*/
|
|
311
|
-
|
|
434
|
+
costFormula?: string | null;
|
|
435
|
+
}
|
|
312
436
|
|
|
437
|
+
/**
|
|
438
|
+
* The flat price amount and currency, when applicable
|
|
439
|
+
*/
|
|
440
|
+
export interface Price {
|
|
313
441
|
/**
|
|
314
|
-
*
|
|
442
|
+
* The price amount
|
|
315
443
|
*/
|
|
316
|
-
|
|
444
|
+
amount: number;
|
|
317
445
|
|
|
318
446
|
/**
|
|
319
|
-
*
|
|
447
|
+
* ISO 4217 currency code
|
|
320
448
|
*/
|
|
321
|
-
|
|
449
|
+
currency:
|
|
450
|
+
| 'usd'
|
|
451
|
+
| 'aed'
|
|
452
|
+
| 'all'
|
|
453
|
+
| 'amd'
|
|
454
|
+
| 'ang'
|
|
455
|
+
| 'aud'
|
|
456
|
+
| 'awg'
|
|
457
|
+
| 'azn'
|
|
458
|
+
| 'bam'
|
|
459
|
+
| 'bbd'
|
|
460
|
+
| 'bdt'
|
|
461
|
+
| 'bgn'
|
|
462
|
+
| 'bif'
|
|
463
|
+
| 'bmd'
|
|
464
|
+
| 'bnd'
|
|
465
|
+
| 'bsd'
|
|
466
|
+
| 'bwp'
|
|
467
|
+
| 'byn'
|
|
468
|
+
| 'bzd'
|
|
469
|
+
| 'brl'
|
|
470
|
+
| 'cad'
|
|
471
|
+
| 'cdf'
|
|
472
|
+
| 'chf'
|
|
473
|
+
| 'cny'
|
|
474
|
+
| 'czk'
|
|
475
|
+
| 'dkk'
|
|
476
|
+
| 'dop'
|
|
477
|
+
| 'dzd'
|
|
478
|
+
| 'egp'
|
|
479
|
+
| 'etb'
|
|
480
|
+
| 'eur'
|
|
481
|
+
| 'fjd'
|
|
482
|
+
| 'gbp'
|
|
483
|
+
| 'gel'
|
|
484
|
+
| 'gip'
|
|
485
|
+
| 'gmd'
|
|
486
|
+
| 'gyd'
|
|
487
|
+
| 'hkd'
|
|
488
|
+
| 'hrk'
|
|
489
|
+
| 'htg'
|
|
490
|
+
| 'idr'
|
|
491
|
+
| 'ils'
|
|
492
|
+
| 'inr'
|
|
493
|
+
| 'isk'
|
|
494
|
+
| 'jmd'
|
|
495
|
+
| 'jpy'
|
|
496
|
+
| 'kes'
|
|
497
|
+
| 'kgs'
|
|
498
|
+
| 'khr'
|
|
499
|
+
| 'kmf'
|
|
500
|
+
| 'krw'
|
|
501
|
+
| 'kyd'
|
|
502
|
+
| 'kzt'
|
|
503
|
+
| 'lbp'
|
|
504
|
+
| 'lkr'
|
|
505
|
+
| 'lrd'
|
|
506
|
+
| 'lsl'
|
|
507
|
+
| 'mad'
|
|
508
|
+
| 'mdl'
|
|
509
|
+
| 'mga'
|
|
510
|
+
| 'mkd'
|
|
511
|
+
| 'mmk'
|
|
512
|
+
| 'mnt'
|
|
513
|
+
| 'mop'
|
|
514
|
+
| 'mro'
|
|
515
|
+
| 'mvr'
|
|
516
|
+
| 'mwk'
|
|
517
|
+
| 'mxn'
|
|
518
|
+
| 'myr'
|
|
519
|
+
| 'mzn'
|
|
520
|
+
| 'nad'
|
|
521
|
+
| 'ngn'
|
|
522
|
+
| 'nok'
|
|
523
|
+
| 'npr'
|
|
524
|
+
| 'nzd'
|
|
525
|
+
| 'pgk'
|
|
526
|
+
| 'php'
|
|
527
|
+
| 'pkr'
|
|
528
|
+
| 'pln'
|
|
529
|
+
| 'qar'
|
|
530
|
+
| 'ron'
|
|
531
|
+
| 'rsd'
|
|
532
|
+
| 'rub'
|
|
533
|
+
| 'rwf'
|
|
534
|
+
| 'sar'
|
|
535
|
+
| 'sbd'
|
|
536
|
+
| 'scr'
|
|
537
|
+
| 'sek'
|
|
538
|
+
| 'sgd'
|
|
539
|
+
| 'sle'
|
|
540
|
+
| 'sll'
|
|
541
|
+
| 'sos'
|
|
542
|
+
| 'szl'
|
|
543
|
+
| 'thb'
|
|
544
|
+
| 'tjs'
|
|
545
|
+
| 'top'
|
|
546
|
+
| 'try'
|
|
547
|
+
| 'ttd'
|
|
548
|
+
| 'tzs'
|
|
549
|
+
| 'uah'
|
|
550
|
+
| 'uzs'
|
|
551
|
+
| 'vnd'
|
|
552
|
+
| 'vuv'
|
|
553
|
+
| 'wst'
|
|
554
|
+
| 'xaf'
|
|
555
|
+
| 'xcd'
|
|
556
|
+
| 'yer'
|
|
557
|
+
| 'zar'
|
|
558
|
+
| 'zmw'
|
|
559
|
+
| 'clp'
|
|
560
|
+
| 'djf'
|
|
561
|
+
| 'gnf'
|
|
562
|
+
| 'ugx'
|
|
563
|
+
| 'pyg'
|
|
564
|
+
| 'xof'
|
|
565
|
+
| 'xpf';
|
|
566
|
+
}
|
|
322
567
|
|
|
568
|
+
/**
|
|
569
|
+
* A single tier within a tiered charge
|
|
570
|
+
*/
|
|
571
|
+
export interface Tier {
|
|
323
572
|
/**
|
|
324
|
-
*
|
|
573
|
+
* Flat price for this tier
|
|
325
574
|
*/
|
|
326
|
-
|
|
575
|
+
flatPrice?: Tier.FlatPrice | null;
|
|
327
576
|
|
|
328
577
|
/**
|
|
329
|
-
*
|
|
578
|
+
* Per-unit price in this tier
|
|
330
579
|
*/
|
|
331
|
-
|
|
332
|
-
}
|
|
580
|
+
unitPrice?: Tier.UnitPrice | null;
|
|
333
581
|
|
|
334
|
-
export namespace Data {
|
|
335
582
|
/**
|
|
336
|
-
*
|
|
583
|
+
* Upper bound of this tier (null for unlimited)
|
|
337
584
|
*/
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
* Credit rate amount
|
|
341
|
-
*/
|
|
342
|
-
amount: number;
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
* Custom currency identifier
|
|
346
|
-
*/
|
|
347
|
-
currencyId: string;
|
|
348
|
-
|
|
349
|
-
/**
|
|
350
|
-
* Optional cost formula expression
|
|
351
|
-
*/
|
|
352
|
-
costFormula?: string | null;
|
|
353
|
-
}
|
|
585
|
+
upTo?: number | null;
|
|
586
|
+
}
|
|
354
587
|
|
|
588
|
+
export namespace Tier {
|
|
355
589
|
/**
|
|
356
|
-
*
|
|
590
|
+
* Flat price for this tier
|
|
357
591
|
*/
|
|
358
|
-
export interface
|
|
592
|
+
export interface FlatPrice {
|
|
359
593
|
/**
|
|
360
594
|
* The price amount
|
|
361
595
|
*/
|
|
@@ -484,399 +718,136 @@ export namespace ChargeList {
|
|
|
484
718
|
}
|
|
485
719
|
|
|
486
720
|
/**
|
|
487
|
-
*
|
|
721
|
+
* Per-unit price in this tier
|
|
488
722
|
*/
|
|
489
|
-
export interface
|
|
490
|
-
/**
|
|
491
|
-
* Flat price for this tier
|
|
492
|
-
*/
|
|
493
|
-
flatPrice?: Tier.FlatPrice | null;
|
|
494
|
-
|
|
723
|
+
export interface UnitPrice {
|
|
495
724
|
/**
|
|
496
|
-
*
|
|
497
|
-
*/
|
|
498
|
-
unitPrice?: Tier.UnitPrice | null;
|
|
499
|
-
|
|
500
|
-
/**
|
|
501
|
-
* Upper bound of this tier (null for unlimited)
|
|
725
|
+
* The price amount
|
|
502
726
|
*/
|
|
503
|
-
|
|
504
|
-
}
|
|
727
|
+
amount: number;
|
|
505
728
|
|
|
506
|
-
export namespace Tier {
|
|
507
729
|
/**
|
|
508
|
-
*
|
|
730
|
+
* ISO 4217 currency code
|
|
509
731
|
*/
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
| 'zar'
|
|
628
|
-
| 'zmw'
|
|
629
|
-
| 'clp'
|
|
630
|
-
| 'djf'
|
|
631
|
-
| 'gnf'
|
|
632
|
-
| 'ugx'
|
|
633
|
-
| 'pyg'
|
|
634
|
-
| 'xof'
|
|
635
|
-
| 'xpf';
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
/**
|
|
639
|
-
* Per-unit price in this tier
|
|
640
|
-
*/
|
|
641
|
-
export interface UnitPrice {
|
|
642
|
-
/**
|
|
643
|
-
* The price amount
|
|
644
|
-
*/
|
|
645
|
-
amount: number;
|
|
646
|
-
|
|
647
|
-
/**
|
|
648
|
-
* ISO 4217 currency code
|
|
649
|
-
*/
|
|
650
|
-
currency:
|
|
651
|
-
| 'usd'
|
|
652
|
-
| 'aed'
|
|
653
|
-
| 'all'
|
|
654
|
-
| 'amd'
|
|
655
|
-
| 'ang'
|
|
656
|
-
| 'aud'
|
|
657
|
-
| 'awg'
|
|
658
|
-
| 'azn'
|
|
659
|
-
| 'bam'
|
|
660
|
-
| 'bbd'
|
|
661
|
-
| 'bdt'
|
|
662
|
-
| 'bgn'
|
|
663
|
-
| 'bif'
|
|
664
|
-
| 'bmd'
|
|
665
|
-
| 'bnd'
|
|
666
|
-
| 'bsd'
|
|
667
|
-
| 'bwp'
|
|
668
|
-
| 'byn'
|
|
669
|
-
| 'bzd'
|
|
670
|
-
| 'brl'
|
|
671
|
-
| 'cad'
|
|
672
|
-
| 'cdf'
|
|
673
|
-
| 'chf'
|
|
674
|
-
| 'cny'
|
|
675
|
-
| 'czk'
|
|
676
|
-
| 'dkk'
|
|
677
|
-
| 'dop'
|
|
678
|
-
| 'dzd'
|
|
679
|
-
| 'egp'
|
|
680
|
-
| 'etb'
|
|
681
|
-
| 'eur'
|
|
682
|
-
| 'fjd'
|
|
683
|
-
| 'gbp'
|
|
684
|
-
| 'gel'
|
|
685
|
-
| 'gip'
|
|
686
|
-
| 'gmd'
|
|
687
|
-
| 'gyd'
|
|
688
|
-
| 'hkd'
|
|
689
|
-
| 'hrk'
|
|
690
|
-
| 'htg'
|
|
691
|
-
| 'idr'
|
|
692
|
-
| 'ils'
|
|
693
|
-
| 'inr'
|
|
694
|
-
| 'isk'
|
|
695
|
-
| 'jmd'
|
|
696
|
-
| 'jpy'
|
|
697
|
-
| 'kes'
|
|
698
|
-
| 'kgs'
|
|
699
|
-
| 'khr'
|
|
700
|
-
| 'kmf'
|
|
701
|
-
| 'krw'
|
|
702
|
-
| 'kyd'
|
|
703
|
-
| 'kzt'
|
|
704
|
-
| 'lbp'
|
|
705
|
-
| 'lkr'
|
|
706
|
-
| 'lrd'
|
|
707
|
-
| 'lsl'
|
|
708
|
-
| 'mad'
|
|
709
|
-
| 'mdl'
|
|
710
|
-
| 'mga'
|
|
711
|
-
| 'mkd'
|
|
712
|
-
| 'mmk'
|
|
713
|
-
| 'mnt'
|
|
714
|
-
| 'mop'
|
|
715
|
-
| 'mro'
|
|
716
|
-
| 'mvr'
|
|
717
|
-
| 'mwk'
|
|
718
|
-
| 'mxn'
|
|
719
|
-
| 'myr'
|
|
720
|
-
| 'mzn'
|
|
721
|
-
| 'nad'
|
|
722
|
-
| 'ngn'
|
|
723
|
-
| 'nok'
|
|
724
|
-
| 'npr'
|
|
725
|
-
| 'nzd'
|
|
726
|
-
| 'pgk'
|
|
727
|
-
| 'php'
|
|
728
|
-
| 'pkr'
|
|
729
|
-
| 'pln'
|
|
730
|
-
| 'qar'
|
|
731
|
-
| 'ron'
|
|
732
|
-
| 'rsd'
|
|
733
|
-
| 'rub'
|
|
734
|
-
| 'rwf'
|
|
735
|
-
| 'sar'
|
|
736
|
-
| 'sbd'
|
|
737
|
-
| 'scr'
|
|
738
|
-
| 'sek'
|
|
739
|
-
| 'sgd'
|
|
740
|
-
| 'sle'
|
|
741
|
-
| 'sll'
|
|
742
|
-
| 'sos'
|
|
743
|
-
| 'szl'
|
|
744
|
-
| 'thb'
|
|
745
|
-
| 'tjs'
|
|
746
|
-
| 'top'
|
|
747
|
-
| 'try'
|
|
748
|
-
| 'ttd'
|
|
749
|
-
| 'tzs'
|
|
750
|
-
| 'uah'
|
|
751
|
-
| 'uzs'
|
|
752
|
-
| 'vnd'
|
|
753
|
-
| 'vuv'
|
|
754
|
-
| 'wst'
|
|
755
|
-
| 'xaf'
|
|
756
|
-
| 'xcd'
|
|
757
|
-
| 'yer'
|
|
758
|
-
| 'zar'
|
|
759
|
-
| 'zmw'
|
|
760
|
-
| 'clp'
|
|
761
|
-
| 'djf'
|
|
762
|
-
| 'gnf'
|
|
763
|
-
| 'ugx'
|
|
764
|
-
| 'pyg'
|
|
765
|
-
| 'xof'
|
|
766
|
-
| 'xpf';
|
|
767
|
-
}
|
|
732
|
+
currency:
|
|
733
|
+
| 'usd'
|
|
734
|
+
| 'aed'
|
|
735
|
+
| 'all'
|
|
736
|
+
| 'amd'
|
|
737
|
+
| 'ang'
|
|
738
|
+
| 'aud'
|
|
739
|
+
| 'awg'
|
|
740
|
+
| 'azn'
|
|
741
|
+
| 'bam'
|
|
742
|
+
| 'bbd'
|
|
743
|
+
| 'bdt'
|
|
744
|
+
| 'bgn'
|
|
745
|
+
| 'bif'
|
|
746
|
+
| 'bmd'
|
|
747
|
+
| 'bnd'
|
|
748
|
+
| 'bsd'
|
|
749
|
+
| 'bwp'
|
|
750
|
+
| 'byn'
|
|
751
|
+
| 'bzd'
|
|
752
|
+
| 'brl'
|
|
753
|
+
| 'cad'
|
|
754
|
+
| 'cdf'
|
|
755
|
+
| 'chf'
|
|
756
|
+
| 'cny'
|
|
757
|
+
| 'czk'
|
|
758
|
+
| 'dkk'
|
|
759
|
+
| 'dop'
|
|
760
|
+
| 'dzd'
|
|
761
|
+
| 'egp'
|
|
762
|
+
| 'etb'
|
|
763
|
+
| 'eur'
|
|
764
|
+
| 'fjd'
|
|
765
|
+
| 'gbp'
|
|
766
|
+
| 'gel'
|
|
767
|
+
| 'gip'
|
|
768
|
+
| 'gmd'
|
|
769
|
+
| 'gyd'
|
|
770
|
+
| 'hkd'
|
|
771
|
+
| 'hrk'
|
|
772
|
+
| 'htg'
|
|
773
|
+
| 'idr'
|
|
774
|
+
| 'ils'
|
|
775
|
+
| 'inr'
|
|
776
|
+
| 'isk'
|
|
777
|
+
| 'jmd'
|
|
778
|
+
| 'jpy'
|
|
779
|
+
| 'kes'
|
|
780
|
+
| 'kgs'
|
|
781
|
+
| 'khr'
|
|
782
|
+
| 'kmf'
|
|
783
|
+
| 'krw'
|
|
784
|
+
| 'kyd'
|
|
785
|
+
| 'kzt'
|
|
786
|
+
| 'lbp'
|
|
787
|
+
| 'lkr'
|
|
788
|
+
| 'lrd'
|
|
789
|
+
| 'lsl'
|
|
790
|
+
| 'mad'
|
|
791
|
+
| 'mdl'
|
|
792
|
+
| 'mga'
|
|
793
|
+
| 'mkd'
|
|
794
|
+
| 'mmk'
|
|
795
|
+
| 'mnt'
|
|
796
|
+
| 'mop'
|
|
797
|
+
| 'mro'
|
|
798
|
+
| 'mvr'
|
|
799
|
+
| 'mwk'
|
|
800
|
+
| 'mxn'
|
|
801
|
+
| 'myr'
|
|
802
|
+
| 'mzn'
|
|
803
|
+
| 'nad'
|
|
804
|
+
| 'ngn'
|
|
805
|
+
| 'nok'
|
|
806
|
+
| 'npr'
|
|
807
|
+
| 'nzd'
|
|
808
|
+
| 'pgk'
|
|
809
|
+
| 'php'
|
|
810
|
+
| 'pkr'
|
|
811
|
+
| 'pln'
|
|
812
|
+
| 'qar'
|
|
813
|
+
| 'ron'
|
|
814
|
+
| 'rsd'
|
|
815
|
+
| 'rub'
|
|
816
|
+
| 'rwf'
|
|
817
|
+
| 'sar'
|
|
818
|
+
| 'sbd'
|
|
819
|
+
| 'scr'
|
|
820
|
+
| 'sek'
|
|
821
|
+
| 'sgd'
|
|
822
|
+
| 'sle'
|
|
823
|
+
| 'sll'
|
|
824
|
+
| 'sos'
|
|
825
|
+
| 'szl'
|
|
826
|
+
| 'thb'
|
|
827
|
+
| 'tjs'
|
|
828
|
+
| 'top'
|
|
829
|
+
| 'try'
|
|
830
|
+
| 'ttd'
|
|
831
|
+
| 'tzs'
|
|
832
|
+
| 'uah'
|
|
833
|
+
| 'uzs'
|
|
834
|
+
| 'vnd'
|
|
835
|
+
| 'vuv'
|
|
836
|
+
| 'wst'
|
|
837
|
+
| 'xaf'
|
|
838
|
+
| 'xcd'
|
|
839
|
+
| 'yer'
|
|
840
|
+
| 'zar'
|
|
841
|
+
| 'zmw'
|
|
842
|
+
| 'clp'
|
|
843
|
+
| 'djf'
|
|
844
|
+
| 'gnf'
|
|
845
|
+
| 'ugx'
|
|
846
|
+
| 'pyg'
|
|
847
|
+
| 'xof'
|
|
848
|
+
| 'xpf';
|
|
768
849
|
}
|
|
769
850
|
}
|
|
770
|
-
|
|
771
|
-
/**
|
|
772
|
-
* Pagination metadata including cursors for navigating through results
|
|
773
|
-
*/
|
|
774
|
-
export interface Pagination {
|
|
775
|
-
/**
|
|
776
|
-
* Cursor for fetching the next page of results, or null if no additional pages
|
|
777
|
-
* exist
|
|
778
|
-
*/
|
|
779
|
-
next: string | null;
|
|
780
|
-
|
|
781
|
-
/**
|
|
782
|
-
* Cursor for fetching the previous page of results, or null if at the beginning
|
|
783
|
-
*/
|
|
784
|
-
prev: string | null;
|
|
785
|
-
}
|
|
786
|
-
}
|
|
787
|
-
|
|
788
|
-
/**
|
|
789
|
-
* Addon configuration object
|
|
790
|
-
*/
|
|
791
|
-
export interface AddonListResponse {
|
|
792
|
-
/**
|
|
793
|
-
* The unique identifier for the entity
|
|
794
|
-
*/
|
|
795
|
-
id: string;
|
|
796
|
-
|
|
797
|
-
/**
|
|
798
|
-
* The unique identifier for the entity in the billing provider
|
|
799
|
-
*/
|
|
800
|
-
billingId: string | null;
|
|
801
|
-
|
|
802
|
-
/**
|
|
803
|
-
* Timestamp of when the record was created
|
|
804
|
-
*/
|
|
805
|
-
createdAt: string;
|
|
806
|
-
|
|
807
|
-
/**
|
|
808
|
-
* List of addons the addon is dependant on
|
|
809
|
-
*/
|
|
810
|
-
dependencies: Array<string> | null;
|
|
811
|
-
|
|
812
|
-
/**
|
|
813
|
-
* The description of the package
|
|
814
|
-
*/
|
|
815
|
-
description: string | null;
|
|
816
|
-
|
|
817
|
-
/**
|
|
818
|
-
* The display name of the package
|
|
819
|
-
*/
|
|
820
|
-
displayName: string;
|
|
821
|
-
|
|
822
|
-
/**
|
|
823
|
-
* List of entitlements of the package
|
|
824
|
-
*/
|
|
825
|
-
entitlements: Array<AddonListResponse.Entitlement>;
|
|
826
|
-
|
|
827
|
-
/**
|
|
828
|
-
* Indicates if the package is the latest version
|
|
829
|
-
*/
|
|
830
|
-
isLatest: boolean | null;
|
|
831
|
-
|
|
832
|
-
/**
|
|
833
|
-
* The maximum quantity of this addon that can be added to a subscription
|
|
834
|
-
*/
|
|
835
|
-
maxQuantity: number | null;
|
|
836
|
-
|
|
837
|
-
/**
|
|
838
|
-
* Metadata associated with the entity
|
|
839
|
-
*/
|
|
840
|
-
metadata: { [key: string]: string };
|
|
841
|
-
|
|
842
|
-
/**
|
|
843
|
-
* The pricing type of the package
|
|
844
|
-
*/
|
|
845
|
-
pricingType: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
846
|
-
|
|
847
|
-
/**
|
|
848
|
-
* The product id of the package
|
|
849
|
-
*/
|
|
850
|
-
productId: string;
|
|
851
|
-
|
|
852
|
-
/**
|
|
853
|
-
* The status of the package
|
|
854
|
-
*/
|
|
855
|
-
status: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
856
|
-
|
|
857
|
-
/**
|
|
858
|
-
* Timestamp of when the record was last updated
|
|
859
|
-
*/
|
|
860
|
-
updatedAt: string;
|
|
861
|
-
|
|
862
|
-
/**
|
|
863
|
-
* The version number of the package
|
|
864
|
-
*/
|
|
865
|
-
versionNumber: number;
|
|
866
|
-
}
|
|
867
|
-
|
|
868
|
-
export namespace AddonListResponse {
|
|
869
|
-
/**
|
|
870
|
-
* Entitlement reference with type and identifier
|
|
871
|
-
*/
|
|
872
|
-
export interface Entitlement {
|
|
873
|
-
/**
|
|
874
|
-
* The unique identifier for the entity
|
|
875
|
-
*/
|
|
876
|
-
id: string;
|
|
877
|
-
|
|
878
|
-
type: 'FEATURE' | 'CREDIT';
|
|
879
|
-
}
|
|
880
851
|
}
|
|
881
852
|
|
|
882
853
|
/**
|
|
@@ -2426,12 +2397,12 @@ Addons.Entitlements = Entitlements;
|
|
|
2426
2397
|
export declare namespace Addons {
|
|
2427
2398
|
export {
|
|
2428
2399
|
type Addon as Addon,
|
|
2429
|
-
type ChargeList as ChargeList,
|
|
2430
2400
|
type AddonListResponse as AddonListResponse,
|
|
2401
|
+
type AddonListChargesResponse as AddonListChargesResponse,
|
|
2431
2402
|
type AddonPublishResponse as AddonPublishResponse,
|
|
2432
2403
|
type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
|
|
2433
2404
|
type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
|
|
2434
|
-
type
|
|
2405
|
+
type AddonListChargesResponsesMyCursorIDPage as AddonListChargesResponsesMyCursorIDPage,
|
|
2435
2406
|
type AddonCreateParams as AddonCreateParams,
|
|
2436
2407
|
type AddonUpdateParams as AddonUpdateParams,
|
|
2437
2408
|
type AddonListParams as AddonListParams,
|