@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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
2
|
import * as FutureUpdateAPI from "./future-update.js";
|
|
3
|
-
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate } from "./future-update.js";
|
|
3
|
+
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate, FutureUpdateCancelPendingPaymentParams, FutureUpdateCancelScheduleParams } from "./future-update.js";
|
|
4
4
|
import * as InvoiceAPI from "./invoice.js";
|
|
5
|
-
import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.js";
|
|
5
|
+
import { Invoice, InvoiceMarkAsPaidParams, InvoiceMarkAsPaidResponse } from "./invoice.js";
|
|
6
6
|
import * as UsageAPI from "./usage.js";
|
|
7
|
-
import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncResponse } from "./usage.js";
|
|
7
|
+
import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncParams, UsageSyncResponse } from "./usage.js";
|
|
8
8
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
9
9
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
|
|
10
10
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
@@ -16,52 +16,52 @@ export declare class Subscriptions extends APIResource {
|
|
|
16
16
|
* Retrieves a subscription by its unique identifier, including plan details,
|
|
17
17
|
* billing period, status, and add-ons.
|
|
18
18
|
*/
|
|
19
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
|
|
19
|
+
retrieve(id: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Subscription>;
|
|
20
20
|
/**
|
|
21
21
|
* Updates an active subscription's properties including billing period, add-ons,
|
|
22
22
|
* unit quantities, and discounts.
|
|
23
23
|
*/
|
|
24
|
-
update(id: string,
|
|
24
|
+
update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
25
25
|
/**
|
|
26
26
|
* Retrieves a paginated list of subscriptions, with optional filters for customer,
|
|
27
27
|
* status, and plan.
|
|
28
28
|
*/
|
|
29
|
-
list(
|
|
29
|
+
list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
|
|
30
30
|
/**
|
|
31
31
|
* Cancels an active subscription, either immediately or at a specified time such
|
|
32
32
|
* as end of billing period.
|
|
33
33
|
*/
|
|
34
|
-
cancel(id: string,
|
|
34
|
+
cancel(id: string, params: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
35
35
|
/**
|
|
36
36
|
* Delegates the payment responsibility of a subscription to a different customer.
|
|
37
37
|
* The delegated customer will be billed for this subscription.
|
|
38
38
|
*/
|
|
39
|
-
delegate(id: string,
|
|
39
|
+
delegate(id: string, params: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
40
40
|
/**
|
|
41
41
|
* Imports multiple subscriptions in bulk. Used for migrating subscription data
|
|
42
42
|
* from external systems.
|
|
43
43
|
*/
|
|
44
|
-
import(
|
|
44
|
+
import(params: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* Migrates a subscription to the latest published version of its plan or add-ons.
|
|
47
47
|
* Handles prorated charges or credits automatically.
|
|
48
48
|
*/
|
|
49
|
-
migrate(id: string,
|
|
49
|
+
migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
50
50
|
/**
|
|
51
51
|
* Previews the pricing impact of creating or updating a subscription without
|
|
52
52
|
* making changes. Returns estimated costs, taxes, and proration details.
|
|
53
53
|
*/
|
|
54
|
-
preview(
|
|
54
|
+
preview(params: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
|
|
55
55
|
/**
|
|
56
56
|
* Creates a new subscription for an existing customer. When payment is required
|
|
57
57
|
* and no payment method exists, returns a checkout URL.
|
|
58
58
|
*/
|
|
59
|
-
provision(
|
|
59
|
+
provision(params: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
|
|
60
60
|
/**
|
|
61
61
|
* Transfers a subscription to a different resource ID. Used for multi-resource
|
|
62
62
|
* products where subscriptions apply to specific entities like websites or apps.
|
|
63
63
|
*/
|
|
64
|
-
transfer(id: string,
|
|
64
|
+
transfer(id: string, params: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
65
65
|
}
|
|
66
66
|
export type SubscriptionListResponsesMyCursorIDPage = MyCursorIDPage<SubscriptionListResponse>;
|
|
67
67
|
/**
|
|
@@ -1659,39 +1659,101 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
1659
1659
|
}
|
|
1660
1660
|
}
|
|
1661
1661
|
}
|
|
1662
|
+
export interface SubscriptionRetrieveParams {
|
|
1663
|
+
/**
|
|
1664
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
1665
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
1666
|
+
*/
|
|
1667
|
+
'X-ACCOUNT-ID'?: string;
|
|
1668
|
+
/**
|
|
1669
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
1670
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
1671
|
+
* key).
|
|
1672
|
+
*/
|
|
1673
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1674
|
+
}
|
|
1662
1675
|
export interface SubscriptionUpdateParams {
|
|
1676
|
+
/**
|
|
1677
|
+
* Body param
|
|
1678
|
+
*/
|
|
1663
1679
|
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
1680
|
+
/**
|
|
1681
|
+
* Body param
|
|
1682
|
+
*/
|
|
1664
1683
|
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
1665
1684
|
/**
|
|
1666
|
-
* Await payment confirmation
|
|
1685
|
+
* Body param: Await payment confirmation
|
|
1667
1686
|
*/
|
|
1668
1687
|
awaitPaymentConfirmation?: boolean;
|
|
1688
|
+
/**
|
|
1689
|
+
* Body param
|
|
1690
|
+
*/
|
|
1669
1691
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
1692
|
+
/**
|
|
1693
|
+
* Body param
|
|
1694
|
+
*/
|
|
1670
1695
|
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
1696
|
+
/**
|
|
1697
|
+
* Body param
|
|
1698
|
+
*/
|
|
1671
1699
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
1700
|
+
/**
|
|
1701
|
+
* Body param
|
|
1702
|
+
*/
|
|
1672
1703
|
budget?: SubscriptionUpdateParams.Budget | null;
|
|
1704
|
+
/**
|
|
1705
|
+
* Body param: Subscription cancellation date
|
|
1706
|
+
*/
|
|
1707
|
+
cancellationDate?: string | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Body param
|
|
1710
|
+
*/
|
|
1673
1711
|
charges?: Array<SubscriptionUpdateParams.Charge>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Body param
|
|
1714
|
+
*/
|
|
1674
1715
|
entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
|
|
1675
1716
|
/**
|
|
1676
|
-
* Additional metadata for the subscription
|
|
1717
|
+
* Body param: Additional metadata for the subscription
|
|
1677
1718
|
*/
|
|
1678
1719
|
metadata?: {
|
|
1679
1720
|
[key: string]: string;
|
|
1680
1721
|
};
|
|
1681
1722
|
/**
|
|
1682
|
-
* Minimum spend amount
|
|
1723
|
+
* Body param: Minimum spend amount
|
|
1683
1724
|
*/
|
|
1684
1725
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
1726
|
+
/**
|
|
1727
|
+
* Body param
|
|
1728
|
+
*/
|
|
1685
1729
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
1686
1730
|
/**
|
|
1687
|
-
* Promotion code
|
|
1731
|
+
* Body param: Promotion code
|
|
1688
1732
|
*/
|
|
1689
1733
|
promotionCode?: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* Body param: Salesforce ID
|
|
1736
|
+
*/
|
|
1737
|
+
salesforceId?: string | null;
|
|
1738
|
+
/**
|
|
1739
|
+
* Body param
|
|
1740
|
+
*/
|
|
1690
1741
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
1691
1742
|
/**
|
|
1692
|
-
* Subscription trial end date
|
|
1743
|
+
* Body param: Subscription trial end date
|
|
1693
1744
|
*/
|
|
1694
1745
|
trialEndDate?: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
1748
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
1749
|
+
*/
|
|
1750
|
+
'X-ACCOUNT-ID'?: string;
|
|
1751
|
+
/**
|
|
1752
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
1753
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
1754
|
+
* intrinsic to the key).
|
|
1755
|
+
*/
|
|
1756
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1695
1757
|
}
|
|
1696
1758
|
export declare namespace SubscriptionUpdateParams {
|
|
1697
1759
|
/**
|
|
@@ -1955,30 +2017,42 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1955
2017
|
}
|
|
1956
2018
|
export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
1957
2019
|
/**
|
|
1958
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
2020
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
1959
2021
|
*/
|
|
1960
2022
|
createdAt?: SubscriptionListParams.CreatedAt;
|
|
1961
2023
|
/**
|
|
1962
|
-
* Filter by customer ID
|
|
2024
|
+
* Query param: Filter by customer ID
|
|
1963
2025
|
*/
|
|
1964
2026
|
customerId?: string;
|
|
1965
2027
|
/**
|
|
1966
|
-
* Filter by plan ID
|
|
2028
|
+
* Query param: Filter by plan ID
|
|
1967
2029
|
*/
|
|
1968
2030
|
planId?: string;
|
|
1969
2031
|
/**
|
|
1970
|
-
* Filter by pricing type. Supports comma-separated values for
|
|
2032
|
+
* Query param: Filter by pricing type. Supports comma-separated values for
|
|
2033
|
+
* multiple types
|
|
1971
2034
|
*/
|
|
1972
2035
|
pricingType?: Array<'FREE' | 'PAID' | 'CUSTOM'>;
|
|
1973
2036
|
/**
|
|
1974
|
-
* Filter by resource ID
|
|
2037
|
+
* Query param: Filter by resource ID
|
|
1975
2038
|
*/
|
|
1976
2039
|
resourceId?: string;
|
|
1977
2040
|
/**
|
|
1978
|
-
* Filter by subscription status. Supports comma-separated values for
|
|
1979
|
-
* statuses
|
|
2041
|
+
* Query param: Filter by subscription status. Supports comma-separated values for
|
|
2042
|
+
* multiple statuses
|
|
1980
2043
|
*/
|
|
1981
2044
|
status?: Array<'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED'>;
|
|
2045
|
+
/**
|
|
2046
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2047
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2048
|
+
*/
|
|
2049
|
+
'X-ACCOUNT-ID'?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2052
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2053
|
+
* intrinsic to the key).
|
|
2054
|
+
*/
|
|
2055
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1982
2056
|
}
|
|
1983
2057
|
export declare namespace SubscriptionListParams {
|
|
1984
2058
|
/**
|
|
@@ -2005,39 +2079,74 @@ export declare namespace SubscriptionListParams {
|
|
|
2005
2079
|
}
|
|
2006
2080
|
export interface SubscriptionCancelParams {
|
|
2007
2081
|
/**
|
|
2008
|
-
* Action on cancellation (downgrade or revoke)
|
|
2082
|
+
* Body param: Action on cancellation (downgrade or revoke)
|
|
2009
2083
|
*/
|
|
2010
2084
|
cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
|
|
2011
2085
|
/**
|
|
2012
|
-
* When to cancel (immediate, period end, or date)
|
|
2086
|
+
* Body param: When to cancel (immediate, period end, or date)
|
|
2013
2087
|
*/
|
|
2014
2088
|
cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
|
|
2015
2089
|
/**
|
|
2016
|
-
* Subscription end date
|
|
2090
|
+
* Body param: Subscription end date
|
|
2017
2091
|
*/
|
|
2018
2092
|
endDate?: string;
|
|
2019
2093
|
/**
|
|
2020
|
-
* If set, enables or disables prorating of credits on subscription
|
|
2094
|
+
* Body param: If set, enables or disables prorating of credits on subscription
|
|
2095
|
+
* cancellation.
|
|
2021
2096
|
*/
|
|
2022
2097
|
prorate?: boolean;
|
|
2098
|
+
/**
|
|
2099
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2100
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2101
|
+
*/
|
|
2102
|
+
'X-ACCOUNT-ID'?: string;
|
|
2103
|
+
/**
|
|
2104
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2105
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2106
|
+
* intrinsic to the key).
|
|
2107
|
+
*/
|
|
2108
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2023
2109
|
}
|
|
2024
2110
|
export interface SubscriptionDelegateParams {
|
|
2025
2111
|
/**
|
|
2026
|
-
* The unique identifier of the customer who will assume payment
|
|
2027
|
-
* this subscription. This customer must already exist in your
|
|
2028
|
-
* have a valid payment method if the subscription requires
|
|
2112
|
+
* Body param: The unique identifier of the customer who will assume payment
|
|
2113
|
+
* responsibility for this subscription. This customer must already exist in your
|
|
2114
|
+
* Stigg account and have a valid payment method if the subscription requires
|
|
2115
|
+
* payment.
|
|
2029
2116
|
*/
|
|
2030
2117
|
targetCustomerId: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2120
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2121
|
+
*/
|
|
2122
|
+
'X-ACCOUNT-ID'?: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2125
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2126
|
+
* intrinsic to the key).
|
|
2127
|
+
*/
|
|
2128
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2031
2129
|
}
|
|
2032
2130
|
export interface SubscriptionImportParams {
|
|
2033
2131
|
/**
|
|
2034
|
-
* List of subscription objects to import
|
|
2132
|
+
* Body param: List of subscription objects to import
|
|
2035
2133
|
*/
|
|
2036
2134
|
subscriptions: Array<SubscriptionImportParams.Subscription>;
|
|
2037
2135
|
/**
|
|
2038
|
-
* Integration ID to use for importing subscriptions
|
|
2136
|
+
* Body param: Integration ID to use for importing subscriptions
|
|
2039
2137
|
*/
|
|
2040
2138
|
integrationId?: string | null;
|
|
2139
|
+
/**
|
|
2140
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2141
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2142
|
+
*/
|
|
2143
|
+
'X-ACCOUNT-ID'?: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2146
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2147
|
+
* intrinsic to the key).
|
|
2148
|
+
*/
|
|
2149
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2041
2150
|
}
|
|
2042
2151
|
export declare namespace SubscriptionImportParams {
|
|
2043
2152
|
interface Subscription {
|
|
@@ -2097,7 +2206,8 @@ export declare namespace SubscriptionImportParams {
|
|
|
2097
2206
|
quantity: number;
|
|
2098
2207
|
}
|
|
2099
2208
|
/**
|
|
2100
|
-
*
|
|
2209
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
2210
|
+
* quantity).
|
|
2101
2211
|
*/
|
|
2102
2212
|
interface Charge {
|
|
2103
2213
|
/**
|
|
@@ -2117,75 +2227,97 @@ export declare namespace SubscriptionImportParams {
|
|
|
2117
2227
|
}
|
|
2118
2228
|
export interface SubscriptionMigrateParams {
|
|
2119
2229
|
/**
|
|
2120
|
-
* When to migrate (immediate or period end)
|
|
2230
|
+
* Body param: When to migrate (immediate or period end)
|
|
2121
2231
|
*/
|
|
2122
2232
|
subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
|
|
2233
|
+
/**
|
|
2234
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2235
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2236
|
+
*/
|
|
2237
|
+
'X-ACCOUNT-ID'?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2240
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2241
|
+
* intrinsic to the key).
|
|
2242
|
+
*/
|
|
2243
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2123
2244
|
}
|
|
2124
2245
|
export interface SubscriptionPreviewParams {
|
|
2125
2246
|
/**
|
|
2126
|
-
* Customer ID
|
|
2247
|
+
* Body param: Customer ID
|
|
2127
2248
|
*/
|
|
2128
2249
|
customerId: string;
|
|
2129
2250
|
/**
|
|
2130
|
-
* Plan ID
|
|
2251
|
+
* Body param: Plan ID
|
|
2131
2252
|
*/
|
|
2132
2253
|
planId: string;
|
|
2133
2254
|
/**
|
|
2134
|
-
* Addons to include
|
|
2255
|
+
* Body param: Addons to include
|
|
2135
2256
|
*/
|
|
2136
2257
|
addons?: Array<SubscriptionPreviewParams.Addon>;
|
|
2137
2258
|
/**
|
|
2138
|
-
* Coupon or discount to apply
|
|
2259
|
+
* Body param: Coupon or discount to apply
|
|
2139
2260
|
*/
|
|
2140
2261
|
appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
|
|
2141
2262
|
/**
|
|
2142
|
-
* Billable features with quantities
|
|
2263
|
+
* Body param: Billable features with quantities
|
|
2143
2264
|
*/
|
|
2144
2265
|
billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
|
|
2145
2266
|
/**
|
|
2146
|
-
* ISO 3166-1 country code for localization
|
|
2267
|
+
* Body param: ISO 3166-1 country code for localization
|
|
2147
2268
|
*/
|
|
2148
2269
|
billingCountryCode?: string;
|
|
2149
2270
|
/**
|
|
2150
|
-
* Billing cycle anchor behavior for the subscription
|
|
2271
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
2151
2272
|
*/
|
|
2152
2273
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
2153
2274
|
/**
|
|
2154
|
-
* Billing and tax configuration
|
|
2275
|
+
* Body param: Billing and tax configuration
|
|
2155
2276
|
*/
|
|
2156
2277
|
billingInformation?: SubscriptionPreviewParams.BillingInformation;
|
|
2157
2278
|
/**
|
|
2158
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
2279
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
2159
2280
|
*/
|
|
2160
2281
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
2161
2282
|
/**
|
|
2162
|
-
* One-time or recurring charges
|
|
2283
|
+
* Body param: One-time or recurring charges
|
|
2163
2284
|
*/
|
|
2164
2285
|
charges?: Array<SubscriptionPreviewParams.Charge>;
|
|
2165
2286
|
/**
|
|
2166
|
-
* Paying customer ID for delegated billing
|
|
2287
|
+
* Body param: Paying customer ID for delegated billing
|
|
2167
2288
|
*/
|
|
2168
2289
|
payingCustomerId?: string;
|
|
2169
2290
|
/**
|
|
2170
|
-
* Resource ID for multi-instance subscriptions
|
|
2291
|
+
* Body param: Resource ID for multi-instance subscriptions
|
|
2171
2292
|
*/
|
|
2172
2293
|
resourceId?: string;
|
|
2173
2294
|
/**
|
|
2174
|
-
* When to apply subscription changes
|
|
2295
|
+
* Body param: When to apply subscription changes
|
|
2175
2296
|
*/
|
|
2176
2297
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
2177
2298
|
/**
|
|
2178
|
-
* Subscription start date
|
|
2299
|
+
* Body param: Subscription start date
|
|
2179
2300
|
*/
|
|
2180
2301
|
startDate?: string;
|
|
2181
2302
|
/**
|
|
2182
|
-
* Trial period override settings
|
|
2303
|
+
* Body param: Trial period override settings
|
|
2183
2304
|
*/
|
|
2184
2305
|
trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
|
|
2185
2306
|
/**
|
|
2186
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2307
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2187
2308
|
*/
|
|
2188
2309
|
unitQuantity?: number;
|
|
2310
|
+
/**
|
|
2311
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2312
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2313
|
+
*/
|
|
2314
|
+
'X-ACCOUNT-ID'?: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2317
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2318
|
+
* intrinsic to the key).
|
|
2319
|
+
*/
|
|
2320
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2189
2321
|
}
|
|
2190
2322
|
export declare namespace SubscriptionPreviewParams {
|
|
2191
2323
|
/**
|
|
@@ -2365,7 +2497,8 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
2365
2497
|
}
|
|
2366
2498
|
}
|
|
2367
2499
|
/**
|
|
2368
|
-
*
|
|
2500
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
2501
|
+
* quantity).
|
|
2369
2502
|
*/
|
|
2370
2503
|
interface Charge {
|
|
2371
2504
|
/**
|
|
@@ -2401,93 +2534,127 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
2401
2534
|
}
|
|
2402
2535
|
export interface SubscriptionProvisionParams {
|
|
2403
2536
|
/**
|
|
2404
|
-
* Customer ID to provision the subscription for
|
|
2537
|
+
* Body param: Customer ID to provision the subscription for
|
|
2405
2538
|
*/
|
|
2406
2539
|
customerId: string;
|
|
2407
2540
|
/**
|
|
2408
|
-
* Plan ID to provision
|
|
2541
|
+
* Body param: Plan ID to provision
|
|
2409
2542
|
*/
|
|
2410
2543
|
planId: string;
|
|
2411
2544
|
/**
|
|
2412
|
-
* Unique identifier for the subscription
|
|
2545
|
+
* Body param: Unique identifier for the subscription
|
|
2413
2546
|
*/
|
|
2414
2547
|
id?: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Body param
|
|
2550
|
+
*/
|
|
2415
2551
|
addons?: Array<SubscriptionProvisionParams.Addon>;
|
|
2416
2552
|
/**
|
|
2417
|
-
* Coupon configuration
|
|
2553
|
+
* Body param: Coupon configuration
|
|
2418
2554
|
*/
|
|
2419
2555
|
appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
|
|
2420
2556
|
/**
|
|
2421
|
-
* Whether to wait for payment confirmation before returning the
|
|
2557
|
+
* Body param: Whether to wait for payment confirmation before returning the
|
|
2558
|
+
* subscription
|
|
2422
2559
|
*/
|
|
2423
2560
|
awaitPaymentConfirmation?: boolean;
|
|
2424
2561
|
/**
|
|
2425
|
-
* The ISO 3166-1 alpha-2 country code for billing
|
|
2562
|
+
* Body param: The ISO 3166-1 alpha-2 country code for billing
|
|
2426
2563
|
*/
|
|
2427
2564
|
billingCountryCode?: string | null;
|
|
2428
2565
|
/**
|
|
2429
|
-
* Billing cycle anchor behavior for the subscription
|
|
2566
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
2430
2567
|
*/
|
|
2431
2568
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
2432
2569
|
/**
|
|
2433
|
-
* External billing system identifier
|
|
2570
|
+
* Body param: External billing system identifier
|
|
2434
2571
|
*/
|
|
2435
2572
|
billingId?: string | null;
|
|
2573
|
+
/**
|
|
2574
|
+
* Body param
|
|
2575
|
+
*/
|
|
2436
2576
|
billingInformation?: SubscriptionProvisionParams.BillingInformation;
|
|
2437
2577
|
/**
|
|
2438
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
2578
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
2439
2579
|
*/
|
|
2440
2580
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
2581
|
+
/**
|
|
2582
|
+
* Body param
|
|
2583
|
+
*/
|
|
2441
2584
|
budget?: SubscriptionProvisionParams.Budget | null;
|
|
2585
|
+
/**
|
|
2586
|
+
* Body param: Subscription cancellation date
|
|
2587
|
+
*/
|
|
2588
|
+
cancellationDate?: string;
|
|
2589
|
+
/**
|
|
2590
|
+
* Body param
|
|
2591
|
+
*/
|
|
2442
2592
|
charges?: Array<SubscriptionProvisionParams.Charge>;
|
|
2443
2593
|
/**
|
|
2444
|
-
* Checkout page configuration for payment collection
|
|
2594
|
+
* Body param: Checkout page configuration for payment collection
|
|
2445
2595
|
*/
|
|
2446
2596
|
checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
|
|
2597
|
+
/**
|
|
2598
|
+
* Body param
|
|
2599
|
+
*/
|
|
2447
2600
|
entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
|
|
2448
2601
|
/**
|
|
2449
|
-
* Additional metadata for the subscription
|
|
2602
|
+
* Body param: Additional metadata for the subscription
|
|
2450
2603
|
*/
|
|
2451
2604
|
metadata?: {
|
|
2452
2605
|
[key: string]: string;
|
|
2453
2606
|
};
|
|
2454
2607
|
/**
|
|
2455
|
-
* Minimum spend amount
|
|
2608
|
+
* Body param: Minimum spend amount
|
|
2456
2609
|
*/
|
|
2457
2610
|
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
2458
2611
|
/**
|
|
2459
|
-
* Optional paying customer ID for split billing scenarios
|
|
2612
|
+
* Body param: Optional paying customer ID for split billing scenarios
|
|
2460
2613
|
*/
|
|
2461
2614
|
payingCustomerId?: string | null;
|
|
2462
2615
|
/**
|
|
2463
|
-
* How payments should be collected for this subscription
|
|
2616
|
+
* Body param: How payments should be collected for this subscription
|
|
2464
2617
|
*/
|
|
2465
2618
|
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
|
|
2619
|
+
/**
|
|
2620
|
+
* Body param
|
|
2621
|
+
*/
|
|
2466
2622
|
priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
|
|
2467
2623
|
/**
|
|
2468
|
-
* Optional resource ID for multi-instance subscriptions
|
|
2624
|
+
* Body param: Optional resource ID for multi-instance subscriptions
|
|
2469
2625
|
*/
|
|
2470
2626
|
resourceId?: string | null;
|
|
2471
2627
|
/**
|
|
2472
|
-
* Salesforce ID
|
|
2628
|
+
* Body param: Salesforce ID
|
|
2473
2629
|
*/
|
|
2474
2630
|
salesforceId?: string | null;
|
|
2475
2631
|
/**
|
|
2476
|
-
* Strategy for scheduling subscription changes
|
|
2632
|
+
* Body param: Strategy for scheduling subscription changes
|
|
2477
2633
|
*/
|
|
2478
2634
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
2479
2635
|
/**
|
|
2480
|
-
* Subscription start date
|
|
2636
|
+
* Body param: Subscription start date
|
|
2481
2637
|
*/
|
|
2482
2638
|
startDate?: string;
|
|
2483
2639
|
/**
|
|
2484
|
-
* Trial period override settings
|
|
2640
|
+
* Body param: Trial period override settings
|
|
2485
2641
|
*/
|
|
2486
2642
|
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
2487
2643
|
/**
|
|
2488
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2644
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2489
2645
|
*/
|
|
2490
2646
|
unitQuantity?: number;
|
|
2647
|
+
/**
|
|
2648
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2649
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2650
|
+
*/
|
|
2651
|
+
'X-ACCOUNT-ID'?: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2654
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2655
|
+
* intrinsic to the key).
|
|
2656
|
+
*/
|
|
2657
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2491
2658
|
}
|
|
2492
2659
|
export declare namespace SubscriptionProvisionParams {
|
|
2493
2660
|
/**
|
|
@@ -2661,7 +2828,8 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
2661
2828
|
limit: number;
|
|
2662
2829
|
}
|
|
2663
2830
|
/**
|
|
2664
|
-
*
|
|
2831
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
2832
|
+
* quantity).
|
|
2665
2833
|
*/
|
|
2666
2834
|
interface Charge {
|
|
2667
2835
|
/**
|
|
@@ -2928,14 +3096,25 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
2928
3096
|
}
|
|
2929
3097
|
export interface SubscriptionTransferParams {
|
|
2930
3098
|
/**
|
|
2931
|
-
* Resource ID to transfer the subscription to
|
|
3099
|
+
* Body param: Resource ID to transfer the subscription to
|
|
2932
3100
|
*/
|
|
2933
3101
|
destinationResourceId: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
3104
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
3105
|
+
*/
|
|
3106
|
+
'X-ACCOUNT-ID'?: string;
|
|
3107
|
+
/**
|
|
3108
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
3109
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
3110
|
+
* intrinsic to the key).
|
|
3111
|
+
*/
|
|
3112
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2934
3113
|
}
|
|
2935
3114
|
export declare namespace Subscriptions {
|
|
2936
|
-
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
2937
|
-
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
|
|
2938
|
-
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
|
|
2939
|
-
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
|
|
3115
|
+
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
3116
|
+
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription, type FutureUpdateCancelPendingPaymentParams as FutureUpdateCancelPendingPaymentParams, type FutureUpdateCancelScheduleParams as FutureUpdateCancelScheduleParams, };
|
|
3117
|
+
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, type UsageSyncParams as UsageSyncParams, };
|
|
3118
|
+
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse, type InvoiceMarkAsPaidParams as InvoiceMarkAsPaidParams, };
|
|
2940
3119
|
}
|
|
2941
3120
|
//# sourceMappingURL=subscriptions.d.ts.map
|