@stigg/typescript 0.1.0-beta.3 → 0.1.0-beta.31
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 +236 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +12 -1
- package/client.js.map +1 -1
- package/client.mjs +12 -1
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +1 -1
- package/pagination.d.mts +1 -0
- package/pagination.d.mts.map +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.mjs +1 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/v1/addons/addons.d.mts +313 -32
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +313 -32
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +114 -15
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +114 -15
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +92 -5
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +92 -5
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +49 -8
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +49 -8
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +2 -2
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +2 -2
- 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/addons.d.mts.map +1 -1
- package/resources/v1/addons.d.ts.map +1 -1
- package/resources/v1/addons.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +80 -20
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +80 -20
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +60 -9
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +60 -9
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +114 -25
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +114 -25
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +36 -5
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +36 -5
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +96 -23
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +96 -23
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +76 -12
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +76 -12
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +60 -23
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +60 -23
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +35 -5
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +35 -5
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/index.d.mts +2 -2
- package/resources/v1/credits/index.d.mts.map +1 -1
- package/resources/v1/credits/index.d.ts +2 -2
- package/resources/v1/credits/index.d.ts.map +1 -1
- package/resources/v1/credits/index.js.map +1 -1
- package/resources/v1/credits/index.mjs.map +1 -1
- package/resources/v1/credits.d.mts.map +1 -1
- package/resources/v1/credits.d.ts.map +1 -1
- package/resources/v1/credits.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +170 -53
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +170 -53
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +124 -19
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +124 -19
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- 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 +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +67 -12
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +67 -12
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +57 -9
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +57 -9
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +32 -8
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +32 -8
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +26 -4
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +26 -4
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +38 -6
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +38 -6
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/customers.d.mts.map +1 -1
- package/resources/v1/customers.d.ts.map +1 -1
- package/resources/v1/customers.mjs.map +1 -1
- package/resources/v1/events/beta/beta.d.mts +10 -0
- package/resources/v1/events/beta/beta.d.mts.map +1 -0
- package/resources/v1/events/beta/beta.d.ts +10 -0
- package/resources/v1/events/beta/beta.d.ts.map +1 -0
- package/resources/v1/events/beta/beta.js +17 -0
- package/resources/v1/events/beta/beta.js.map +1 -0
- package/resources/v1/events/beta/beta.mjs +12 -0
- package/resources/v1/events/beta/beta.mjs.map +1 -0
- package/resources/v1/events/beta/customers.d.mts +160 -0
- package/resources/v1/events/beta/customers.d.mts.map +1 -0
- package/resources/v1/events/beta/customers.d.ts +160 -0
- package/resources/v1/events/beta/customers.d.ts.map +1 -0
- package/resources/v1/events/beta/customers.js +32 -0
- package/resources/v1/events/beta/customers.js.map +1 -0
- package/resources/v1/events/beta/customers.mjs +28 -0
- package/resources/v1/events/beta/customers.mjs.map +1 -0
- package/resources/v1/events/beta/index.d.mts +3 -0
- package/resources/v1/events/beta/index.d.mts.map +1 -0
- package/resources/v1/events/beta/index.d.ts +3 -0
- package/resources/v1/events/beta/index.d.ts.map +1 -0
- package/resources/v1/events/beta/index.js +9 -0
- package/resources/v1/events/beta/index.js.map +1 -0
- package/resources/v1/events/beta/index.mjs +4 -0
- package/resources/v1/events/beta/index.mjs.map +1 -0
- package/resources/v1/events/beta.d.mts +2 -0
- package/resources/v1/events/beta.d.mts.map +1 -0
- package/resources/v1/events/beta.d.ts +2 -0
- package/resources/v1/events/beta.d.ts.map +1 -0
- package/resources/v1/events/beta.js +6 -0
- package/resources/v1/events/beta.js.map +1 -0
- package/resources/v1/events/beta.mjs +3 -0
- package/resources/v1/events/beta.mjs.map +1 -0
- package/resources/v1/events/data-export/data-export.d.mts +211 -0
- package/resources/v1/events/data-export/data-export.d.mts.map +1 -0
- package/resources/v1/events/data-export/data-export.d.ts +211 -0
- package/resources/v1/events/data-export/data-export.d.ts.map +1 -0
- package/resources/v1/events/data-export/data-export.js +71 -0
- package/resources/v1/events/data-export/data-export.js.map +1 -0
- package/resources/v1/events/data-export/data-export.mjs +66 -0
- package/resources/v1/events/data-export/data-export.mjs.map +1 -0
- package/resources/v1/events/data-export/destinations.d.mts +215 -0
- package/resources/v1/events/data-export/destinations.d.mts.map +1 -0
- package/resources/v1/events/data-export/destinations.d.ts +215 -0
- package/resources/v1/events/data-export/destinations.d.ts.map +1 -0
- package/resources/v1/events/data-export/destinations.js +46 -0
- package/resources/v1/events/data-export/destinations.js.map +1 -0
- package/resources/v1/events/data-export/destinations.mjs +42 -0
- package/resources/v1/events/data-export/destinations.mjs.map +1 -0
- package/resources/v1/events/data-export/index.d.mts +3 -0
- package/resources/v1/events/data-export/index.d.mts.map +1 -0
- package/resources/v1/events/data-export/index.d.ts +3 -0
- package/resources/v1/events/data-export/index.d.ts.map +1 -0
- package/resources/v1/events/data-export/index.js +9 -0
- package/resources/v1/events/data-export/index.js.map +1 -0
- package/resources/v1/events/data-export/index.mjs +4 -0
- package/resources/v1/events/data-export/index.mjs.map +1 -0
- package/resources/v1/events/data-export.d.mts +2 -0
- package/resources/v1/events/data-export.d.mts.map +1 -0
- package/resources/v1/events/data-export.d.ts +2 -0
- package/resources/v1/events/data-export.d.ts.map +1 -0
- package/resources/v1/events/data-export.js +6 -0
- package/resources/v1/events/data-export.js.map +1 -0
- package/resources/v1/events/data-export.mjs +3 -0
- package/resources/v1/events/data-export.mjs.map +1 -0
- package/resources/v1/events/events.d.mts +85 -0
- package/resources/v1/events/events.d.mts.map +1 -0
- package/resources/v1/events/events.d.ts +85 -0
- package/resources/v1/events/events.d.ts.map +1 -0
- package/resources/v1/events/events.js +43 -0
- package/resources/v1/events/events.js.map +1 -0
- package/resources/v1/events/events.mjs +38 -0
- package/resources/v1/events/events.mjs.map +1 -0
- package/resources/v1/events/index.d.mts +4 -0
- package/resources/v1/events/index.d.mts.map +1 -0
- package/resources/v1/events/index.d.ts +4 -0
- package/resources/v1/events/index.d.ts.map +1 -0
- package/resources/v1/events/index.js +11 -0
- package/resources/v1/events/index.js.map +1 -0
- package/resources/v1/events/index.mjs +5 -0
- package/resources/v1/events/index.mjs.map +1 -0
- package/resources/v1/events.d.mts +1 -65
- package/resources/v1/events.d.mts.map +1 -1
- package/resources/v1/events.d.ts +1 -65
- package/resources/v1/events.d.ts.map +1 -1
- package/resources/v1/events.js +2 -15
- package/resources/v1/events.js.map +1 -1
- package/resources/v1/events.mjs +1 -13
- package/resources/v1/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +108 -30
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +108 -30
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +72 -11
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +72 -11
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +8 -8
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +8 -8
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +6 -6
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +92 -5
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +92 -5
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +49 -8
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +49 -8
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +2 -2
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +2 -2
- 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 +496 -32
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +496 -32
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +135 -16
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +135 -16
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/plans.d.mts.map +1 -1
- package/resources/v1/plans.d.ts.map +1 -1
- package/resources/v1/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +97 -23
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +97 -23
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +73 -11
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +73 -11
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +29 -3
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +29 -3
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +25 -4
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +25 -4
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -4
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -4
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +15 -2
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +15 -2
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +13 -2
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +13 -2
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +258 -79
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +258 -79
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +126 -19
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +128 -21
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +29 -4
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +29 -4
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +26 -4
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +26 -4
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions.mjs.map +1 -1
- package/resources/v1/usage.d.mts +52 -2
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +52 -2
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +26 -4
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +26 -4
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +16 -16
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +16 -16
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +2 -2
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +2 -2
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1-beta/customers/assignments.d.mts +245 -0
- package/resources/v1-beta/customers/assignments.d.mts.map +1 -0
- package/resources/v1-beta/customers/assignments.d.ts +245 -0
- package/resources/v1-beta/customers/assignments.d.ts.map +1 -0
- package/resources/v1-beta/customers/assignments.js +84 -0
- package/resources/v1-beta/customers/assignments.js.map +1 -0
- package/resources/v1-beta/customers/assignments.mjs +80 -0
- package/resources/v1-beta/customers/assignments.mjs.map +1 -0
- package/resources/v1-beta/customers/customers.d.mts +18 -0
- package/resources/v1-beta/customers/customers.d.mts.map +1 -0
- package/resources/v1-beta/customers/customers.d.ts +18 -0
- package/resources/v1-beta/customers/customers.d.ts.map +1 -0
- package/resources/v1-beta/customers/customers.js +25 -0
- package/resources/v1-beta/customers/customers.js.map +1 -0
- package/resources/v1-beta/customers/customers.mjs +20 -0
- package/resources/v1-beta/customers/customers.mjs.map +1 -0
- package/resources/v1-beta/customers/entities.d.mts +351 -0
- package/resources/v1-beta/customers/entities.d.mts.map +1 -0
- package/resources/v1-beta/customers/entities.d.ts +351 -0
- package/resources/v1-beta/customers/entities.d.ts.map +1 -0
- package/resources/v1-beta/customers/entities.js +150 -0
- package/resources/v1-beta/customers/entities.js.map +1 -0
- package/resources/v1-beta/customers/entities.mjs +146 -0
- package/resources/v1-beta/customers/entities.mjs.map +1 -0
- package/resources/v1-beta/customers/entitlements.d.mts +261 -0
- package/resources/v1-beta/customers/entitlements.d.mts.map +1 -0
- package/resources/v1-beta/customers/entitlements.d.ts +261 -0
- package/resources/v1-beta/customers/entitlements.d.ts.map +1 -0
- package/resources/v1-beta/customers/entitlements.js +36 -0
- package/resources/v1-beta/customers/entitlements.js.map +1 -0
- package/resources/v1-beta/customers/entitlements.mjs +32 -0
- package/resources/v1-beta/customers/entitlements.mjs.map +1 -0
- package/resources/v1-beta/customers/index.d.mts +5 -0
- package/resources/v1-beta/customers/index.d.mts.map +1 -0
- package/resources/v1-beta/customers/index.d.ts +5 -0
- package/resources/v1-beta/customers/index.d.ts.map +1 -0
- package/resources/v1-beta/customers/index.js +13 -0
- package/resources/v1-beta/customers/index.js.map +1 -0
- package/resources/v1-beta/customers/index.mjs +6 -0
- package/resources/v1-beta/customers/index.mjs.map +1 -0
- package/resources/v1-beta/customers.d.mts +2 -0
- package/resources/v1-beta/customers.d.mts.map +1 -0
- package/resources/v1-beta/customers.d.ts +2 -0
- package/resources/v1-beta/customers.d.ts.map +1 -0
- package/resources/v1-beta/customers.js +6 -0
- package/resources/v1-beta/customers.js.map +1 -0
- package/resources/v1-beta/customers.mjs +3 -0
- package/resources/v1-beta/customers.mjs.map +1 -0
- package/resources/v1-beta/entity-types.d.mts +165 -0
- package/resources/v1-beta/entity-types.d.mts.map +1 -0
- package/resources/v1-beta/entity-types.d.ts +165 -0
- package/resources/v1-beta/entity-types.d.ts.map +1 -0
- package/resources/v1-beta/entity-types.js +75 -0
- package/resources/v1-beta/entity-types.js.map +1 -0
- package/resources/v1-beta/entity-types.mjs +71 -0
- package/resources/v1-beta/entity-types.mjs.map +1 -0
- package/resources/v1-beta/index.d.mts +4 -0
- package/resources/v1-beta/index.d.mts.map +1 -0
- package/resources/v1-beta/index.d.ts +4 -0
- package/resources/v1-beta/index.d.ts.map +1 -0
- package/resources/v1-beta/index.js +11 -0
- package/resources/v1-beta/index.js.map +1 -0
- package/resources/v1-beta/index.mjs +5 -0
- package/resources/v1-beta/index.mjs.map +1 -0
- package/resources/v1-beta/v1-beta.d.mts +14 -0
- package/resources/v1-beta/v1-beta.d.mts.map +1 -0
- package/resources/v1-beta/v1-beta.d.ts +14 -0
- package/resources/v1-beta/v1-beta.d.ts.map +1 -0
- package/resources/v1-beta/v1-beta.js +21 -0
- package/resources/v1-beta/v1-beta.js.map +1 -0
- package/resources/v1-beta/v1-beta.mjs +16 -0
- package/resources/v1-beta/v1-beta.mjs.map +1 -0
- package/resources/v1-beta.d.mts +2 -0
- package/resources/v1-beta.d.mts.map +1 -0
- package/resources/v1-beta.d.ts +2 -0
- package/resources/v1-beta.d.ts.map +1 -0
- package/resources/v1-beta.js +6 -0
- package/resources/v1-beta.js.map +1 -0
- package/resources/v1-beta.mjs +3 -0
- package/resources/v1-beta.mjs.map +1 -0
- package/resources/v1.d.mts.map +1 -1
- package/resources/v1.d.ts.map +1 -1
- package/resources/v1.mjs.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +14 -1
- package/src/resources/index.ts +1 -0
- package/src/resources/v1/addons/addons.ts +849 -36
- package/src/resources/v1/addons/entitlements.ts +158 -10
- package/src/resources/v1/addons/index.ts +8 -0
- package/src/resources/v1/coupons.ts +154 -23
- package/src/resources/v1/credits/credits.ts +167 -23
- package/src/resources/v1/credits/custom-currencies.ts +188 -30
- package/src/resources/v1/credits/grants.ts +102 -24
- package/src/resources/v1/credits/index.ts +4 -0
- package/src/resources/v1/customers/customers.ts +333 -62
- package/src/resources/v1/customers/index.ts +8 -1
- package/src/resources/v1/customers/integrations.ts +137 -18
- package/src/resources/v1/customers/payment-method.ts +69 -10
- package/src/resources/v1/customers/promotional-entitlements.ts +82 -11
- package/src/resources/v1/events/beta/beta.ts +19 -0
- package/src/resources/v1/events/beta/customers.ts +212 -0
- package/src/resources/v1/events/beta/index.ts +8 -0
- package/src/resources/v1/events/beta.ts +3 -0
- package/src/resources/v1/events/data-export/data-export.ts +312 -0
- package/src/resources/v1/events/data-export/destinations.ts +290 -0
- package/src/resources/v1/events/data-export/index.ts +18 -0
- package/src/resources/v1/events/data-export.ts +3 -0
- package/src/resources/v1/events/events.ts +132 -0
- package/src/resources/v1/events/index.ts +13 -0
- package/src/resources/v1/events.ts +1 -75
- package/src/resources/v1/features.ts +204 -34
- package/src/resources/v1/index.ts +29 -1
- package/src/resources/v1/plans/entitlements.ts +158 -10
- package/src/resources/v1/plans/index.ts +11 -0
- package/src/resources/v1/plans/plans.ts +1440 -37
- package/src/resources/v1/products.ts +189 -27
- package/src/resources/v1/subscriptions/future-update.ts +68 -5
- package/src/resources/v1/subscriptions/index.ts +9 -2
- package/src/resources/v1/subscriptions/invoice.ts +36 -3
- package/src/resources/v1/subscriptions/subscriptions.ts +429 -86
- package/src/resources/v1/subscriptions/usage.ts +61 -5
- package/src/resources/v1/usage.ts +86 -5
- package/src/resources/v1/v1.ts +58 -2
- package/src/resources/v1-beta/customers/assignments.ts +331 -0
- package/src/resources/v1-beta/customers/customers.ts +71 -0
- package/src/resources/v1-beta/customers/entities.ts +492 -0
- package/src/resources/v1-beta/customers/entitlements.ts +366 -0
- package/src/resources/v1-beta/customers/index.ts +26 -0
- package/src/resources/v1-beta/customers.ts +3 -0
- package/src/resources/v1-beta/entity-types.ts +225 -0
- package/src/resources/v1-beta/index.ts +12 -0
- package/src/resources/v1-beta/v1-beta.ts +35 -0
- package/src/resources/v1-beta.ts +3 -0
- package/src/version.ts +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -7,12 +7,14 @@ import {
|
|
|
7
7
|
EntitlementCreateParams,
|
|
8
8
|
EntitlementCreateResponse,
|
|
9
9
|
EntitlementDeleteParams,
|
|
10
|
+
EntitlementListParams,
|
|
10
11
|
EntitlementListResponse,
|
|
11
12
|
EntitlementUpdateParams,
|
|
12
13
|
Entitlements,
|
|
13
14
|
} from './entitlements';
|
|
14
15
|
import { APIPromise } from '../../../core/api-promise';
|
|
15
16
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
|
|
17
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
16
18
|
import { RequestOptions } from '../../../internal/request-options';
|
|
17
19
|
import { path } from '../../../internal/utils/path';
|
|
18
20
|
|
|
@@ -25,70 +27,199 @@ export class Addons extends APIResource {
|
|
|
25
27
|
/**
|
|
26
28
|
* Creates a new addon in draft status, associated with a specific product.
|
|
27
29
|
*/
|
|
28
|
-
create(
|
|
29
|
-
|
|
30
|
+
create(params: AddonCreateParams, options?: RequestOptions): APIPromise<Addon> {
|
|
31
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
32
|
+
return this._client.post('/api/v1/addons', {
|
|
33
|
+
body,
|
|
34
|
+
...options,
|
|
35
|
+
headers: buildHeaders([
|
|
36
|
+
{
|
|
37
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
38
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
39
|
+
},
|
|
40
|
+
options?.headers,
|
|
41
|
+
]),
|
|
42
|
+
});
|
|
30
43
|
}
|
|
31
44
|
|
|
32
45
|
/**
|
|
33
46
|
* Retrieves an addon by its unique identifier, including entitlements and pricing
|
|
34
47
|
* details.
|
|
35
48
|
*/
|
|
36
|
-
retrieve(
|
|
37
|
-
|
|
49
|
+
retrieve(
|
|
50
|
+
id: string,
|
|
51
|
+
params: AddonRetrieveParams | null | undefined = {},
|
|
52
|
+
options?: RequestOptions,
|
|
53
|
+
): APIPromise<Addon> {
|
|
54
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
55
|
+
return this._client.get(path`/api/v1/addons/${id}`, {
|
|
56
|
+
...options,
|
|
57
|
+
headers: buildHeaders([
|
|
58
|
+
{
|
|
59
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
60
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
61
|
+
},
|
|
62
|
+
options?.headers,
|
|
63
|
+
]),
|
|
64
|
+
});
|
|
38
65
|
}
|
|
39
66
|
|
|
40
67
|
/**
|
|
41
68
|
* Updates an existing addon's properties such as display name, description, and
|
|
42
69
|
* metadata.
|
|
43
70
|
*/
|
|
44
|
-
update(id: string,
|
|
45
|
-
|
|
71
|
+
update(id: string, params: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon> {
|
|
72
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
73
|
+
return this._client.patch(path`/api/v1/addons/${id}`, {
|
|
74
|
+
body,
|
|
75
|
+
...options,
|
|
76
|
+
headers: buildHeaders([
|
|
77
|
+
{
|
|
78
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
79
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
80
|
+
},
|
|
81
|
+
options?.headers,
|
|
82
|
+
]),
|
|
83
|
+
});
|
|
46
84
|
}
|
|
47
85
|
|
|
48
86
|
/**
|
|
49
87
|
* Retrieves a paginated list of addons in the environment.
|
|
50
88
|
*/
|
|
51
89
|
list(
|
|
52
|
-
|
|
90
|
+
params: AddonListParams | null | undefined = {},
|
|
53
91
|
options?: RequestOptions,
|
|
54
92
|
): PagePromise<AddonListResponsesMyCursorIDPage, AddonListResponse> {
|
|
93
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
55
94
|
return this._client.getAPIList('/api/v1/addons', MyCursorIDPage<AddonListResponse>, {
|
|
56
95
|
query,
|
|
57
96
|
...options,
|
|
97
|
+
headers: buildHeaders([
|
|
98
|
+
{
|
|
99
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
100
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
101
|
+
},
|
|
102
|
+
options?.headers,
|
|
103
|
+
]),
|
|
58
104
|
});
|
|
59
105
|
}
|
|
60
106
|
|
|
61
107
|
/**
|
|
62
108
|
* Archives an addon, preventing it from being used in new subscriptions.
|
|
63
109
|
*/
|
|
64
|
-
archive(
|
|
65
|
-
|
|
110
|
+
archive(
|
|
111
|
+
id: string,
|
|
112
|
+
params: AddonArchiveParams | null | undefined = {},
|
|
113
|
+
options?: RequestOptions,
|
|
114
|
+
): APIPromise<Addon> {
|
|
115
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
116
|
+
return this._client.post(path`/api/v1/addons/${id}/archive`, {
|
|
117
|
+
...options,
|
|
118
|
+
headers: buildHeaders([
|
|
119
|
+
{
|
|
120
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
121
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
122
|
+
},
|
|
123
|
+
options?.headers,
|
|
124
|
+
]),
|
|
125
|
+
});
|
|
66
126
|
}
|
|
67
127
|
|
|
68
128
|
/**
|
|
69
129
|
* Creates a draft version of an existing addon for modification before publishing.
|
|
70
130
|
*/
|
|
71
|
-
createDraft(
|
|
72
|
-
|
|
131
|
+
createDraft(
|
|
132
|
+
id: string,
|
|
133
|
+
params: AddonCreateDraftParams | null | undefined = {},
|
|
134
|
+
options?: RequestOptions,
|
|
135
|
+
): APIPromise<Addon> {
|
|
136
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
137
|
+
return this._client.post(path`/api/v1/addons/${id}/draft`, {
|
|
138
|
+
...options,
|
|
139
|
+
headers: buildHeaders([
|
|
140
|
+
{
|
|
141
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
142
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
143
|
+
},
|
|
144
|
+
options?.headers,
|
|
145
|
+
]),
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/**
|
|
150
|
+
* Retrieves the list of charges configured on an addon.
|
|
151
|
+
*/
|
|
152
|
+
listCharges(
|
|
153
|
+
id: string,
|
|
154
|
+
params: AddonListChargesParams | null | undefined = {},
|
|
155
|
+
options?: RequestOptions,
|
|
156
|
+
): PagePromise<AddonListChargesResponsesMyCursorIDPage, AddonListChargesResponse> {
|
|
157
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
158
|
+
return this._client.getAPIList(
|
|
159
|
+
path`/api/v1/addons/${id}/charges`,
|
|
160
|
+
MyCursorIDPage<AddonListChargesResponse>,
|
|
161
|
+
{
|
|
162
|
+
query,
|
|
163
|
+
...options,
|
|
164
|
+
headers: buildHeaders([
|
|
165
|
+
{
|
|
166
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
167
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
168
|
+
},
|
|
169
|
+
options?.headers,
|
|
170
|
+
]),
|
|
171
|
+
},
|
|
172
|
+
);
|
|
73
173
|
}
|
|
74
174
|
|
|
75
175
|
/**
|
|
76
176
|
* Publishes a draft addon, making it available for use in subscriptions.
|
|
77
177
|
*/
|
|
78
|
-
publish(
|
|
79
|
-
|
|
178
|
+
publish(
|
|
179
|
+
id: string,
|
|
180
|
+
params: AddonPublishParams,
|
|
181
|
+
options?: RequestOptions,
|
|
182
|
+
): APIPromise<AddonPublishResponse> {
|
|
183
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
184
|
+
return this._client.post(path`/api/v1/addons/${id}/publish`, {
|
|
185
|
+
body,
|
|
186
|
+
...options,
|
|
187
|
+
headers: buildHeaders([
|
|
188
|
+
{
|
|
189
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
190
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
191
|
+
},
|
|
192
|
+
options?.headers,
|
|
193
|
+
]),
|
|
194
|
+
});
|
|
80
195
|
}
|
|
81
196
|
|
|
82
197
|
/**
|
|
83
198
|
* Removes a draft version of an addon.
|
|
84
199
|
*/
|
|
85
|
-
removeDraft(
|
|
86
|
-
|
|
200
|
+
removeDraft(
|
|
201
|
+
id: string,
|
|
202
|
+
params: AddonRemoveDraftParams | null | undefined = {},
|
|
203
|
+
options?: RequestOptions,
|
|
204
|
+
): APIPromise<AddonRemoveDraftResponse> {
|
|
205
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
206
|
+
return this._client.delete(path`/api/v1/addons/${id}/draft`, {
|
|
207
|
+
...options,
|
|
208
|
+
headers: buildHeaders([
|
|
209
|
+
{
|
|
210
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
211
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
212
|
+
},
|
|
213
|
+
options?.headers,
|
|
214
|
+
]),
|
|
215
|
+
});
|
|
87
216
|
}
|
|
88
217
|
}
|
|
89
218
|
|
|
90
219
|
export type AddonListResponsesMyCursorIDPage = MyCursorIDPage<AddonListResponse>;
|
|
91
220
|
|
|
221
|
+
export type AddonListChargesResponsesMyCursorIDPage = MyCursorIDPage<AddonListChargesResponse>;
|
|
222
|
+
|
|
92
223
|
/**
|
|
93
224
|
* Response object
|
|
94
225
|
*/
|
|
@@ -289,6 +420,550 @@ export namespace AddonListResponse {
|
|
|
289
420
|
}
|
|
290
421
|
}
|
|
291
422
|
|
|
423
|
+
/**
|
|
424
|
+
* A single pricing row on a plan or addon. Each charge encodes one (billingPeriod,
|
|
425
|
+
* billingModel, billingCadence, billingCountryCode) combination. Plans and addons
|
|
426
|
+
* own many of these — one per currency / billing period / feature.
|
|
427
|
+
*/
|
|
428
|
+
export interface AddonListChargesResponse {
|
|
429
|
+
/**
|
|
430
|
+
* Unique identifier of the charge
|
|
431
|
+
*/
|
|
432
|
+
id: string;
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
* The billing cadence (RECURRING or ONE_OFF)
|
|
436
|
+
*/
|
|
437
|
+
billingCadence: 'RECURRING' | 'ONE_OFF';
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED, MINIMUM_SPEND)
|
|
441
|
+
*/
|
|
442
|
+
billingModel: 'FLAT_FEE' | 'MINIMUM_SPEND' | 'PER_UNIT' | 'USAGE_BASED' | 'CREDIT_BASED';
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* The billing period (MONTHLY or ANNUALLY)
|
|
446
|
+
*/
|
|
447
|
+
billingPeriod: 'MONTHLY' | 'ANNUALLY';
|
|
448
|
+
|
|
449
|
+
/**
|
|
450
|
+
* Timestamp when the charge was created
|
|
451
|
+
*/
|
|
452
|
+
createdAt: string;
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* ISO country code for localized pricing, if any
|
|
456
|
+
*/
|
|
457
|
+
billingCountryCode?: string | null;
|
|
458
|
+
|
|
459
|
+
/**
|
|
460
|
+
* Identifier in the external billing integration (e.g. Stripe price id), if any
|
|
461
|
+
*/
|
|
462
|
+
billingId?: string | null;
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* Block size for usage-based pricing
|
|
466
|
+
*/
|
|
467
|
+
blockSize?: number | null;
|
|
468
|
+
|
|
469
|
+
/**
|
|
470
|
+
* When credits are granted (for credit-based pricing)
|
|
471
|
+
*/
|
|
472
|
+
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY' | null;
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Credit rate configuration for credit-based pricing
|
|
476
|
+
*/
|
|
477
|
+
creditRate?: AddonListChargesResponse.CreditRate | null;
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* Identifier in the linked CRM, if any
|
|
481
|
+
*/
|
|
482
|
+
crmId?: string | null;
|
|
483
|
+
|
|
484
|
+
/**
|
|
485
|
+
* Deep link to the charge in the linked CRM, if any
|
|
486
|
+
*/
|
|
487
|
+
crmLinkUrl?: string | null;
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* The feature this charge meters, if metered
|
|
491
|
+
*/
|
|
492
|
+
featureId?: string | null;
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* Maximum unit quantity that can be purchased
|
|
496
|
+
*/
|
|
497
|
+
maxUnitQuantity?: number | null;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Minimum unit quantity that can be purchased
|
|
501
|
+
*/
|
|
502
|
+
minUnitQuantity?: number | null;
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* The flat price amount and currency, when applicable
|
|
506
|
+
*/
|
|
507
|
+
price?: AddonListChargesResponse.Price | null;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Tiered pricing rows when the charge is tiered
|
|
511
|
+
*/
|
|
512
|
+
tiers?: Array<AddonListChargesResponse.Tier> | null;
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Tiered pricing mode (VOLUME or GRADUATED) when the charge is tiered
|
|
516
|
+
*/
|
|
517
|
+
tiersMode?: 'VOLUME' | 'GRADUATED' | null;
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* Custom currency identifier for top-up pricing, if any
|
|
521
|
+
*/
|
|
522
|
+
topUpCustomCurrencyId?: string | null;
|
|
523
|
+
|
|
524
|
+
/**
|
|
525
|
+
* True if this charge is referenced by at least one subscription
|
|
526
|
+
*/
|
|
527
|
+
usedInSubscriptions?: boolean | null;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
export namespace AddonListChargesResponse {
|
|
531
|
+
/**
|
|
532
|
+
* Credit rate configuration for credit-based pricing
|
|
533
|
+
*/
|
|
534
|
+
export interface CreditRate {
|
|
535
|
+
/**
|
|
536
|
+
* Credit rate amount
|
|
537
|
+
*/
|
|
538
|
+
amount: number;
|
|
539
|
+
|
|
540
|
+
/**
|
|
541
|
+
* Custom currency identifier
|
|
542
|
+
*/
|
|
543
|
+
currencyId: string;
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* Optional cost formula expression
|
|
547
|
+
*/
|
|
548
|
+
costFormula?: string | null;
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* The flat price amount and currency, when applicable
|
|
553
|
+
*/
|
|
554
|
+
export interface Price {
|
|
555
|
+
/**
|
|
556
|
+
* The price amount
|
|
557
|
+
*/
|
|
558
|
+
amount: number;
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* ISO 4217 currency code
|
|
562
|
+
*/
|
|
563
|
+
currency:
|
|
564
|
+
| 'usd'
|
|
565
|
+
| 'aed'
|
|
566
|
+
| 'all'
|
|
567
|
+
| 'amd'
|
|
568
|
+
| 'ang'
|
|
569
|
+
| 'aud'
|
|
570
|
+
| 'awg'
|
|
571
|
+
| 'azn'
|
|
572
|
+
| 'bam'
|
|
573
|
+
| 'bbd'
|
|
574
|
+
| 'bdt'
|
|
575
|
+
| 'bgn'
|
|
576
|
+
| 'bif'
|
|
577
|
+
| 'bmd'
|
|
578
|
+
| 'bnd'
|
|
579
|
+
| 'bsd'
|
|
580
|
+
| 'bwp'
|
|
581
|
+
| 'byn'
|
|
582
|
+
| 'bzd'
|
|
583
|
+
| 'brl'
|
|
584
|
+
| 'cad'
|
|
585
|
+
| 'cdf'
|
|
586
|
+
| 'chf'
|
|
587
|
+
| 'cny'
|
|
588
|
+
| 'czk'
|
|
589
|
+
| 'dkk'
|
|
590
|
+
| 'dop'
|
|
591
|
+
| 'dzd'
|
|
592
|
+
| 'egp'
|
|
593
|
+
| 'etb'
|
|
594
|
+
| 'eur'
|
|
595
|
+
| 'fjd'
|
|
596
|
+
| 'gbp'
|
|
597
|
+
| 'gel'
|
|
598
|
+
| 'gip'
|
|
599
|
+
| 'gmd'
|
|
600
|
+
| 'gyd'
|
|
601
|
+
| 'hkd'
|
|
602
|
+
| 'hrk'
|
|
603
|
+
| 'htg'
|
|
604
|
+
| 'idr'
|
|
605
|
+
| 'ils'
|
|
606
|
+
| 'inr'
|
|
607
|
+
| 'isk'
|
|
608
|
+
| 'jmd'
|
|
609
|
+
| 'jpy'
|
|
610
|
+
| 'kes'
|
|
611
|
+
| 'kgs'
|
|
612
|
+
| 'khr'
|
|
613
|
+
| 'kmf'
|
|
614
|
+
| 'krw'
|
|
615
|
+
| 'kyd'
|
|
616
|
+
| 'kzt'
|
|
617
|
+
| 'lbp'
|
|
618
|
+
| 'lkr'
|
|
619
|
+
| 'lrd'
|
|
620
|
+
| 'lsl'
|
|
621
|
+
| 'mad'
|
|
622
|
+
| 'mdl'
|
|
623
|
+
| 'mga'
|
|
624
|
+
| 'mkd'
|
|
625
|
+
| 'mmk'
|
|
626
|
+
| 'mnt'
|
|
627
|
+
| 'mop'
|
|
628
|
+
| 'mro'
|
|
629
|
+
| 'mvr'
|
|
630
|
+
| 'mwk'
|
|
631
|
+
| 'mxn'
|
|
632
|
+
| 'myr'
|
|
633
|
+
| 'mzn'
|
|
634
|
+
| 'nad'
|
|
635
|
+
| 'ngn'
|
|
636
|
+
| 'nok'
|
|
637
|
+
| 'npr'
|
|
638
|
+
| 'nzd'
|
|
639
|
+
| 'pgk'
|
|
640
|
+
| 'php'
|
|
641
|
+
| 'pkr'
|
|
642
|
+
| 'pln'
|
|
643
|
+
| 'qar'
|
|
644
|
+
| 'ron'
|
|
645
|
+
| 'rsd'
|
|
646
|
+
| 'rub'
|
|
647
|
+
| 'rwf'
|
|
648
|
+
| 'sar'
|
|
649
|
+
| 'sbd'
|
|
650
|
+
| 'scr'
|
|
651
|
+
| 'sek'
|
|
652
|
+
| 'sgd'
|
|
653
|
+
| 'sle'
|
|
654
|
+
| 'sll'
|
|
655
|
+
| 'sos'
|
|
656
|
+
| 'szl'
|
|
657
|
+
| 'thb'
|
|
658
|
+
| 'tjs'
|
|
659
|
+
| 'top'
|
|
660
|
+
| 'try'
|
|
661
|
+
| 'ttd'
|
|
662
|
+
| 'tzs'
|
|
663
|
+
| 'uah'
|
|
664
|
+
| 'uzs'
|
|
665
|
+
| 'vnd'
|
|
666
|
+
| 'vuv'
|
|
667
|
+
| 'wst'
|
|
668
|
+
| 'xaf'
|
|
669
|
+
| 'xcd'
|
|
670
|
+
| 'yer'
|
|
671
|
+
| 'zar'
|
|
672
|
+
| 'zmw'
|
|
673
|
+
| 'clp'
|
|
674
|
+
| 'djf'
|
|
675
|
+
| 'gnf'
|
|
676
|
+
| 'ugx'
|
|
677
|
+
| 'pyg'
|
|
678
|
+
| 'xof'
|
|
679
|
+
| 'xpf';
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* A single tier within a tiered charge
|
|
684
|
+
*/
|
|
685
|
+
export interface Tier {
|
|
686
|
+
/**
|
|
687
|
+
* Flat price for this tier
|
|
688
|
+
*/
|
|
689
|
+
flatPrice?: Tier.FlatPrice | null;
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Per-unit price in this tier
|
|
693
|
+
*/
|
|
694
|
+
unitPrice?: Tier.UnitPrice | null;
|
|
695
|
+
|
|
696
|
+
/**
|
|
697
|
+
* Upper bound of this tier (null for unlimited)
|
|
698
|
+
*/
|
|
699
|
+
upTo?: number | null;
|
|
700
|
+
}
|
|
701
|
+
|
|
702
|
+
export namespace Tier {
|
|
703
|
+
/**
|
|
704
|
+
* Flat price for this tier
|
|
705
|
+
*/
|
|
706
|
+
export interface FlatPrice {
|
|
707
|
+
/**
|
|
708
|
+
* The price amount
|
|
709
|
+
*/
|
|
710
|
+
amount: number;
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* ISO 4217 currency code
|
|
714
|
+
*/
|
|
715
|
+
currency:
|
|
716
|
+
| 'usd'
|
|
717
|
+
| 'aed'
|
|
718
|
+
| 'all'
|
|
719
|
+
| 'amd'
|
|
720
|
+
| 'ang'
|
|
721
|
+
| 'aud'
|
|
722
|
+
| 'awg'
|
|
723
|
+
| 'azn'
|
|
724
|
+
| 'bam'
|
|
725
|
+
| 'bbd'
|
|
726
|
+
| 'bdt'
|
|
727
|
+
| 'bgn'
|
|
728
|
+
| 'bif'
|
|
729
|
+
| 'bmd'
|
|
730
|
+
| 'bnd'
|
|
731
|
+
| 'bsd'
|
|
732
|
+
| 'bwp'
|
|
733
|
+
| 'byn'
|
|
734
|
+
| 'bzd'
|
|
735
|
+
| 'brl'
|
|
736
|
+
| 'cad'
|
|
737
|
+
| 'cdf'
|
|
738
|
+
| 'chf'
|
|
739
|
+
| 'cny'
|
|
740
|
+
| 'czk'
|
|
741
|
+
| 'dkk'
|
|
742
|
+
| 'dop'
|
|
743
|
+
| 'dzd'
|
|
744
|
+
| 'egp'
|
|
745
|
+
| 'etb'
|
|
746
|
+
| 'eur'
|
|
747
|
+
| 'fjd'
|
|
748
|
+
| 'gbp'
|
|
749
|
+
| 'gel'
|
|
750
|
+
| 'gip'
|
|
751
|
+
| 'gmd'
|
|
752
|
+
| 'gyd'
|
|
753
|
+
| 'hkd'
|
|
754
|
+
| 'hrk'
|
|
755
|
+
| 'htg'
|
|
756
|
+
| 'idr'
|
|
757
|
+
| 'ils'
|
|
758
|
+
| 'inr'
|
|
759
|
+
| 'isk'
|
|
760
|
+
| 'jmd'
|
|
761
|
+
| 'jpy'
|
|
762
|
+
| 'kes'
|
|
763
|
+
| 'kgs'
|
|
764
|
+
| 'khr'
|
|
765
|
+
| 'kmf'
|
|
766
|
+
| 'krw'
|
|
767
|
+
| 'kyd'
|
|
768
|
+
| 'kzt'
|
|
769
|
+
| 'lbp'
|
|
770
|
+
| 'lkr'
|
|
771
|
+
| 'lrd'
|
|
772
|
+
| 'lsl'
|
|
773
|
+
| 'mad'
|
|
774
|
+
| 'mdl'
|
|
775
|
+
| 'mga'
|
|
776
|
+
| 'mkd'
|
|
777
|
+
| 'mmk'
|
|
778
|
+
| 'mnt'
|
|
779
|
+
| 'mop'
|
|
780
|
+
| 'mro'
|
|
781
|
+
| 'mvr'
|
|
782
|
+
| 'mwk'
|
|
783
|
+
| 'mxn'
|
|
784
|
+
| 'myr'
|
|
785
|
+
| 'mzn'
|
|
786
|
+
| 'nad'
|
|
787
|
+
| 'ngn'
|
|
788
|
+
| 'nok'
|
|
789
|
+
| 'npr'
|
|
790
|
+
| 'nzd'
|
|
791
|
+
| 'pgk'
|
|
792
|
+
| 'php'
|
|
793
|
+
| 'pkr'
|
|
794
|
+
| 'pln'
|
|
795
|
+
| 'qar'
|
|
796
|
+
| 'ron'
|
|
797
|
+
| 'rsd'
|
|
798
|
+
| 'rub'
|
|
799
|
+
| 'rwf'
|
|
800
|
+
| 'sar'
|
|
801
|
+
| 'sbd'
|
|
802
|
+
| 'scr'
|
|
803
|
+
| 'sek'
|
|
804
|
+
| 'sgd'
|
|
805
|
+
| 'sle'
|
|
806
|
+
| 'sll'
|
|
807
|
+
| 'sos'
|
|
808
|
+
| 'szl'
|
|
809
|
+
| 'thb'
|
|
810
|
+
| 'tjs'
|
|
811
|
+
| 'top'
|
|
812
|
+
| 'try'
|
|
813
|
+
| 'ttd'
|
|
814
|
+
| 'tzs'
|
|
815
|
+
| 'uah'
|
|
816
|
+
| 'uzs'
|
|
817
|
+
| 'vnd'
|
|
818
|
+
| 'vuv'
|
|
819
|
+
| 'wst'
|
|
820
|
+
| 'xaf'
|
|
821
|
+
| 'xcd'
|
|
822
|
+
| 'yer'
|
|
823
|
+
| 'zar'
|
|
824
|
+
| 'zmw'
|
|
825
|
+
| 'clp'
|
|
826
|
+
| 'djf'
|
|
827
|
+
| 'gnf'
|
|
828
|
+
| 'ugx'
|
|
829
|
+
| 'pyg'
|
|
830
|
+
| 'xof'
|
|
831
|
+
| 'xpf';
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* Per-unit price in this tier
|
|
836
|
+
*/
|
|
837
|
+
export interface UnitPrice {
|
|
838
|
+
/**
|
|
839
|
+
* The price amount
|
|
840
|
+
*/
|
|
841
|
+
amount: number;
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* ISO 4217 currency code
|
|
845
|
+
*/
|
|
846
|
+
currency:
|
|
847
|
+
| 'usd'
|
|
848
|
+
| 'aed'
|
|
849
|
+
| 'all'
|
|
850
|
+
| 'amd'
|
|
851
|
+
| 'ang'
|
|
852
|
+
| 'aud'
|
|
853
|
+
| 'awg'
|
|
854
|
+
| 'azn'
|
|
855
|
+
| 'bam'
|
|
856
|
+
| 'bbd'
|
|
857
|
+
| 'bdt'
|
|
858
|
+
| 'bgn'
|
|
859
|
+
| 'bif'
|
|
860
|
+
| 'bmd'
|
|
861
|
+
| 'bnd'
|
|
862
|
+
| 'bsd'
|
|
863
|
+
| 'bwp'
|
|
864
|
+
| 'byn'
|
|
865
|
+
| 'bzd'
|
|
866
|
+
| 'brl'
|
|
867
|
+
| 'cad'
|
|
868
|
+
| 'cdf'
|
|
869
|
+
| 'chf'
|
|
870
|
+
| 'cny'
|
|
871
|
+
| 'czk'
|
|
872
|
+
| 'dkk'
|
|
873
|
+
| 'dop'
|
|
874
|
+
| 'dzd'
|
|
875
|
+
| 'egp'
|
|
876
|
+
| 'etb'
|
|
877
|
+
| 'eur'
|
|
878
|
+
| 'fjd'
|
|
879
|
+
| 'gbp'
|
|
880
|
+
| 'gel'
|
|
881
|
+
| 'gip'
|
|
882
|
+
| 'gmd'
|
|
883
|
+
| 'gyd'
|
|
884
|
+
| 'hkd'
|
|
885
|
+
| 'hrk'
|
|
886
|
+
| 'htg'
|
|
887
|
+
| 'idr'
|
|
888
|
+
| 'ils'
|
|
889
|
+
| 'inr'
|
|
890
|
+
| 'isk'
|
|
891
|
+
| 'jmd'
|
|
892
|
+
| 'jpy'
|
|
893
|
+
| 'kes'
|
|
894
|
+
| 'kgs'
|
|
895
|
+
| 'khr'
|
|
896
|
+
| 'kmf'
|
|
897
|
+
| 'krw'
|
|
898
|
+
| 'kyd'
|
|
899
|
+
| 'kzt'
|
|
900
|
+
| 'lbp'
|
|
901
|
+
| 'lkr'
|
|
902
|
+
| 'lrd'
|
|
903
|
+
| 'lsl'
|
|
904
|
+
| 'mad'
|
|
905
|
+
| 'mdl'
|
|
906
|
+
| 'mga'
|
|
907
|
+
| 'mkd'
|
|
908
|
+
| 'mmk'
|
|
909
|
+
| 'mnt'
|
|
910
|
+
| 'mop'
|
|
911
|
+
| 'mro'
|
|
912
|
+
| 'mvr'
|
|
913
|
+
| 'mwk'
|
|
914
|
+
| 'mxn'
|
|
915
|
+
| 'myr'
|
|
916
|
+
| 'mzn'
|
|
917
|
+
| 'nad'
|
|
918
|
+
| 'ngn'
|
|
919
|
+
| 'nok'
|
|
920
|
+
| 'npr'
|
|
921
|
+
| 'nzd'
|
|
922
|
+
| 'pgk'
|
|
923
|
+
| 'php'
|
|
924
|
+
| 'pkr'
|
|
925
|
+
| 'pln'
|
|
926
|
+
| 'qar'
|
|
927
|
+
| 'ron'
|
|
928
|
+
| 'rsd'
|
|
929
|
+
| 'rub'
|
|
930
|
+
| 'rwf'
|
|
931
|
+
| 'sar'
|
|
932
|
+
| 'sbd'
|
|
933
|
+
| 'scr'
|
|
934
|
+
| 'sek'
|
|
935
|
+
| 'sgd'
|
|
936
|
+
| 'sle'
|
|
937
|
+
| 'sll'
|
|
938
|
+
| 'sos'
|
|
939
|
+
| 'szl'
|
|
940
|
+
| 'thb'
|
|
941
|
+
| 'tjs'
|
|
942
|
+
| 'top'
|
|
943
|
+
| 'try'
|
|
944
|
+
| 'ttd'
|
|
945
|
+
| 'tzs'
|
|
946
|
+
| 'uah'
|
|
947
|
+
| 'uzs'
|
|
948
|
+
| 'vnd'
|
|
949
|
+
| 'vuv'
|
|
950
|
+
| 'wst'
|
|
951
|
+
| 'xaf'
|
|
952
|
+
| 'xcd'
|
|
953
|
+
| 'yer'
|
|
954
|
+
| 'zar'
|
|
955
|
+
| 'zmw'
|
|
956
|
+
| 'clp'
|
|
957
|
+
| 'djf'
|
|
958
|
+
| 'gnf'
|
|
959
|
+
| 'ugx'
|
|
960
|
+
| 'pyg'
|
|
961
|
+
| 'xof'
|
|
962
|
+
| 'xpf';
|
|
963
|
+
}
|
|
964
|
+
}
|
|
965
|
+
}
|
|
966
|
+
|
|
292
967
|
/**
|
|
293
968
|
* Response containing task ID for publish operation
|
|
294
969
|
*/
|
|
@@ -323,91 +998,134 @@ export namespace AddonRemoveDraftResponse {
|
|
|
323
998
|
|
|
324
999
|
export interface AddonCreateParams {
|
|
325
1000
|
/**
|
|
326
|
-
* The unique identifier for the entity
|
|
1001
|
+
* Body param: The unique identifier for the entity
|
|
327
1002
|
*/
|
|
328
1003
|
id: string;
|
|
329
1004
|
|
|
330
1005
|
/**
|
|
331
|
-
* The display name of the package
|
|
1006
|
+
* Body param: The display name of the package
|
|
332
1007
|
*/
|
|
333
1008
|
displayName: string;
|
|
334
1009
|
|
|
335
1010
|
/**
|
|
336
|
-
* The product id of the package
|
|
1011
|
+
* Body param: The product id of the package
|
|
337
1012
|
*/
|
|
338
1013
|
productId: string;
|
|
339
1014
|
|
|
340
1015
|
/**
|
|
341
|
-
* The unique identifier for the entity in the billing provider
|
|
1016
|
+
* Body param: The unique identifier for the entity in the billing provider
|
|
342
1017
|
*/
|
|
343
1018
|
billingId?: string | null;
|
|
344
1019
|
|
|
345
1020
|
/**
|
|
346
|
-
* The description of the package
|
|
1021
|
+
* Body param: The description of the package
|
|
347
1022
|
*/
|
|
348
1023
|
description?: string | null;
|
|
349
1024
|
|
|
350
1025
|
/**
|
|
351
|
-
* The maximum quantity of this addon that can be added to a
|
|
1026
|
+
* Body param: The maximum quantity of this addon that can be added to a
|
|
1027
|
+
* subscription
|
|
352
1028
|
*/
|
|
353
1029
|
maxQuantity?: number | null;
|
|
354
1030
|
|
|
355
1031
|
/**
|
|
356
|
-
* Metadata associated with the entity
|
|
1032
|
+
* Body param: Metadata associated with the entity
|
|
357
1033
|
*/
|
|
358
1034
|
metadata?: { [key: string]: string };
|
|
359
1035
|
|
|
360
1036
|
/**
|
|
361
|
-
* The pricing type of the package
|
|
1037
|
+
* Body param: The pricing type of the package
|
|
362
1038
|
*/
|
|
363
1039
|
pricingType?: 'FREE' | 'PAID' | 'CUSTOM' | null;
|
|
364
1040
|
|
|
365
1041
|
/**
|
|
366
|
-
* The status of the package
|
|
1042
|
+
* Body param: The status of the package
|
|
367
1043
|
*/
|
|
368
1044
|
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
1045
|
+
|
|
1046
|
+
/**
|
|
1047
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
1048
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
1049
|
+
*/
|
|
1050
|
+
'X-ACCOUNT-ID'?: string;
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
1054
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
1055
|
+
* intrinsic to the key).
|
|
1056
|
+
*/
|
|
1057
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1058
|
+
}
|
|
1059
|
+
|
|
1060
|
+
export interface AddonRetrieveParams {
|
|
1061
|
+
/**
|
|
1062
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
1063
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
1064
|
+
*/
|
|
1065
|
+
'X-ACCOUNT-ID'?: string;
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
1069
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
1070
|
+
* key).
|
|
1071
|
+
*/
|
|
1072
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
369
1073
|
}
|
|
370
1074
|
|
|
371
1075
|
export interface AddonUpdateParams {
|
|
372
1076
|
/**
|
|
373
|
-
* The unique identifier for the entity in the billing provider
|
|
1077
|
+
* Body param: The unique identifier for the entity in the billing provider
|
|
374
1078
|
*/
|
|
375
1079
|
billingId?: string | null;
|
|
376
1080
|
|
|
377
1081
|
/**
|
|
378
|
-
* Pricing configuration to set on the addon draft
|
|
1082
|
+
* Body param: Pricing configuration to set on the addon draft
|
|
379
1083
|
*/
|
|
380
1084
|
charges?: AddonUpdateParams.Charges;
|
|
381
1085
|
|
|
382
1086
|
/**
|
|
383
|
-
* List of addons the addon is dependant on
|
|
1087
|
+
* Body param: List of addons the addon is dependant on
|
|
384
1088
|
*/
|
|
385
1089
|
dependencies?: Array<string> | null;
|
|
386
1090
|
|
|
387
1091
|
/**
|
|
388
|
-
* The description of the package
|
|
1092
|
+
* Body param: The description of the package
|
|
389
1093
|
*/
|
|
390
1094
|
description?: string | null;
|
|
391
1095
|
|
|
392
1096
|
/**
|
|
393
|
-
* The display name of the package
|
|
1097
|
+
* Body param: The display name of the package
|
|
394
1098
|
*/
|
|
395
1099
|
displayName?: string;
|
|
396
1100
|
|
|
397
1101
|
/**
|
|
398
|
-
* The maximum quantity of this addon that can be added to a
|
|
1102
|
+
* Body param: The maximum quantity of this addon that can be added to a
|
|
1103
|
+
* subscription
|
|
399
1104
|
*/
|
|
400
1105
|
maxQuantity?: number | null;
|
|
401
1106
|
|
|
402
1107
|
/**
|
|
403
|
-
* Metadata associated with the entity
|
|
1108
|
+
* Body param: Metadata associated with the entity
|
|
404
1109
|
*/
|
|
405
1110
|
metadata?: { [key: string]: string };
|
|
406
1111
|
|
|
407
1112
|
/**
|
|
408
|
-
* The status of the package
|
|
1113
|
+
* Body param: The status of the package
|
|
409
1114
|
*/
|
|
410
1115
|
status?: 'DRAFT' | 'PUBLISHED' | 'ARCHIVED';
|
|
1116
|
+
|
|
1117
|
+
/**
|
|
1118
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
1119
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
1120
|
+
*/
|
|
1121
|
+
'X-ACCOUNT-ID'?: string;
|
|
1122
|
+
|
|
1123
|
+
/**
|
|
1124
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
1125
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
1126
|
+
* intrinsic to the key).
|
|
1127
|
+
*/
|
|
1128
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
411
1129
|
}
|
|
412
1130
|
|
|
413
1131
|
export namespace AddonUpdateParams {
|
|
@@ -1780,19 +2498,33 @@ export namespace AddonUpdateParams {
|
|
|
1780
2498
|
|
|
1781
2499
|
export interface AddonListParams extends MyCursorIDPageParams {
|
|
1782
2500
|
/**
|
|
1783
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
2501
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
1784
2502
|
*/
|
|
1785
2503
|
createdAt?: AddonListParams.CreatedAt;
|
|
1786
2504
|
|
|
1787
2505
|
/**
|
|
1788
|
-
* Filter by product ID
|
|
2506
|
+
* Query param: Filter by product ID
|
|
1789
2507
|
*/
|
|
1790
2508
|
productId?: string;
|
|
1791
2509
|
|
|
1792
2510
|
/**
|
|
1793
|
-
* Filter by status. Supports comma-separated values for multiple
|
|
2511
|
+
* Query param: Filter by status. Supports comma-separated values for multiple
|
|
2512
|
+
* statuses
|
|
1794
2513
|
*/
|
|
1795
2514
|
status?: Array<'DRAFT' | 'PUBLISHED' | 'ARCHIVED'>;
|
|
2515
|
+
|
|
2516
|
+
/**
|
|
2517
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2518
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2519
|
+
*/
|
|
2520
|
+
'X-ACCOUNT-ID'?: string;
|
|
2521
|
+
|
|
2522
|
+
/**
|
|
2523
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2524
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2525
|
+
* intrinsic to the key).
|
|
2526
|
+
*/
|
|
2527
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1796
2528
|
}
|
|
1797
2529
|
|
|
1798
2530
|
export namespace AddonListParams {
|
|
@@ -1822,11 +2554,84 @@ export namespace AddonListParams {
|
|
|
1822
2554
|
}
|
|
1823
2555
|
}
|
|
1824
2556
|
|
|
2557
|
+
export interface AddonArchiveParams {
|
|
2558
|
+
/**
|
|
2559
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
2560
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
2561
|
+
*/
|
|
2562
|
+
'X-ACCOUNT-ID'?: string;
|
|
2563
|
+
|
|
2564
|
+
/**
|
|
2565
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
2566
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
2567
|
+
* key).
|
|
2568
|
+
*/
|
|
2569
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2570
|
+
}
|
|
2571
|
+
|
|
2572
|
+
export interface AddonCreateDraftParams {
|
|
2573
|
+
/**
|
|
2574
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
2575
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
2576
|
+
*/
|
|
2577
|
+
'X-ACCOUNT-ID'?: string;
|
|
2578
|
+
|
|
2579
|
+
/**
|
|
2580
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
2581
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
2582
|
+
* key).
|
|
2583
|
+
*/
|
|
2584
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
export interface AddonListChargesParams extends MyCursorIDPageParams {
|
|
2588
|
+
/**
|
|
2589
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2590
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2591
|
+
*/
|
|
2592
|
+
'X-ACCOUNT-ID'?: string;
|
|
2593
|
+
|
|
2594
|
+
/**
|
|
2595
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2596
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2597
|
+
* intrinsic to the key).
|
|
2598
|
+
*/
|
|
2599
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2600
|
+
}
|
|
2601
|
+
|
|
1825
2602
|
export interface AddonPublishParams {
|
|
1826
2603
|
/**
|
|
1827
|
-
* The migration type of the package
|
|
2604
|
+
* Body param: The migration type of the package
|
|
1828
2605
|
*/
|
|
1829
2606
|
migrationType: 'NEW_CUSTOMERS' | 'ALL_CUSTOMERS';
|
|
2607
|
+
|
|
2608
|
+
/**
|
|
2609
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2610
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2611
|
+
*/
|
|
2612
|
+
'X-ACCOUNT-ID'?: string;
|
|
2613
|
+
|
|
2614
|
+
/**
|
|
2615
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2616
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2617
|
+
* intrinsic to the key).
|
|
2618
|
+
*/
|
|
2619
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2620
|
+
}
|
|
2621
|
+
|
|
2622
|
+
export interface AddonRemoveDraftParams {
|
|
2623
|
+
/**
|
|
2624
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
2625
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
2626
|
+
*/
|
|
2627
|
+
'X-ACCOUNT-ID'?: string;
|
|
2628
|
+
|
|
2629
|
+
/**
|
|
2630
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
2631
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
2632
|
+
* key).
|
|
2633
|
+
*/
|
|
2634
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1830
2635
|
}
|
|
1831
2636
|
|
|
1832
2637
|
Addons.Entitlements = Entitlements;
|
|
@@ -1835,13 +2640,20 @@ export declare namespace Addons {
|
|
|
1835
2640
|
export {
|
|
1836
2641
|
type Addon as Addon,
|
|
1837
2642
|
type AddonListResponse as AddonListResponse,
|
|
2643
|
+
type AddonListChargesResponse as AddonListChargesResponse,
|
|
1838
2644
|
type AddonPublishResponse as AddonPublishResponse,
|
|
1839
2645
|
type AddonRemoveDraftResponse as AddonRemoveDraftResponse,
|
|
1840
2646
|
type AddonListResponsesMyCursorIDPage as AddonListResponsesMyCursorIDPage,
|
|
2647
|
+
type AddonListChargesResponsesMyCursorIDPage as AddonListChargesResponsesMyCursorIDPage,
|
|
1841
2648
|
type AddonCreateParams as AddonCreateParams,
|
|
2649
|
+
type AddonRetrieveParams as AddonRetrieveParams,
|
|
1842
2650
|
type AddonUpdateParams as AddonUpdateParams,
|
|
1843
2651
|
type AddonListParams as AddonListParams,
|
|
2652
|
+
type AddonArchiveParams as AddonArchiveParams,
|
|
2653
|
+
type AddonCreateDraftParams as AddonCreateDraftParams,
|
|
2654
|
+
type AddonListChargesParams as AddonListChargesParams,
|
|
1844
2655
|
type AddonPublishParams as AddonPublishParams,
|
|
2656
|
+
type AddonRemoveDraftParams as AddonRemoveDraftParams,
|
|
1845
2657
|
};
|
|
1846
2658
|
|
|
1847
2659
|
export {
|
|
@@ -1851,6 +2663,7 @@ export declare namespace Addons {
|
|
|
1851
2663
|
type EntitlementListResponse as EntitlementListResponse,
|
|
1852
2664
|
type EntitlementCreateParams as EntitlementCreateParams,
|
|
1853
2665
|
type EntitlementUpdateParams as EntitlementUpdateParams,
|
|
2666
|
+
type EntitlementListParams as EntitlementListParams,
|
|
1854
2667
|
type EntitlementDeleteParams as EntitlementDeleteParams,
|
|
1855
2668
|
};
|
|
1856
2669
|
}
|