@stigg/typescript 0.1.0-beta.1 → 0.1.0-beta.13
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 +114 -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.map +1 -1
- package/client.d.ts.map +1 -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.map +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/v1/addons/addons.d.mts +231 -1
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +231 -1
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +65 -0
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +65 -0
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +31 -0
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +31 -0
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +31 -0
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +31 -0
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +1 -1
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +1 -1
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/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 +36 -0
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +36 -0
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +36 -0
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +36 -0
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/{events/credits → credits}/credits.d.mts +57 -10
- package/resources/v1/credits/credits.d.mts.map +1 -0
- package/resources/v1/{events/credits → credits}/credits.d.ts +57 -10
- package/resources/v1/credits/credits.d.ts.map +1 -0
- package/resources/v1/{events/credits → credits}/credits.js +28 -3
- package/resources/v1/credits/credits.js.map +1 -0
- package/resources/v1/{events/credits → credits}/credits.mjs +27 -2
- package/resources/v1/credits/credits.mjs.map +1 -0
- package/resources/v1/{events/credits → credits}/custom-currencies.d.mts +63 -221
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -0
- package/resources/v1/{events/credits → credits}/custom-currencies.d.ts +63 -221
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -0
- package/resources/v1/{events/credits → credits}/custom-currencies.js +52 -3
- package/resources/v1/credits/custom-currencies.js.map +1 -0
- package/resources/v1/{events/credits → credits}/custom-currencies.mjs +52 -3
- package/resources/v1/credits/custom-currencies.mjs.map +1 -0
- package/resources/v1/{events/credits → credits}/grants.d.mts +32 -4
- package/resources/v1/credits/grants.d.mts.map +1 -0
- package/resources/v1/{events/credits → credits}/grants.d.ts +32 -4
- package/resources/v1/credits/grants.d.ts.map +1 -0
- package/resources/v1/{events/credits → credits}/grants.js +31 -3
- package/resources/v1/credits/grants.js.map +1 -0
- package/resources/v1/{events/credits → credits}/grants.mjs +31 -3
- package/resources/v1/credits/grants.mjs.map +1 -0
- package/resources/v1/credits/index.d.mts +4 -0
- package/resources/v1/credits/index.d.mts.map +1 -0
- package/resources/v1/credits/index.d.ts +4 -0
- package/resources/v1/credits/index.d.ts.map +1 -0
- package/resources/v1/credits/index.js.map +1 -0
- package/resources/v1/credits/index.mjs.map +1 -0
- package/resources/v1/credits.d.mts.map +1 -0
- package/resources/v1/credits.d.ts.map +1 -0
- package/resources/v1/{events/credits.js → credits.js} +1 -1
- package/resources/v1/credits.js.map +1 -0
- package/resources/v1/credits.mjs.map +1 -0
- package/resources/v1/customers/customers.d.mts +82 -5
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +82 -5
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +77 -0
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +77 -0
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +50 -3
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +50 -3
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +47 -0
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +47 -0
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +17 -1
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +17 -1
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +16 -0
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +16 -0
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +51 -0
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +51 -0
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +51 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +51 -0
- 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 +14 -0
- package/resources/v1/events/beta/beta.d.mts.map +1 -0
- package/resources/v1/events/beta/beta.d.ts +14 -0
- package/resources/v1/events/beta/beta.d.ts.map +1 -0
- package/resources/v1/events/beta/beta.js +21 -0
- package/resources/v1/events/beta/beta.js.map +1 -0
- package/resources/v1/events/beta/beta.mjs +16 -0
- package/resources/v1/events/beta/beta.mjs.map +1 -0
- package/resources/v1/events/beta/customers/assignments.d.mts +178 -0
- package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/assignments.d.ts +178 -0
- package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/assignments.js +62 -0
- package/resources/v1/events/beta/customers/assignments.js.map +1 -0
- package/resources/v1/events/beta/customers/assignments.mjs +58 -0
- package/resources/v1/events/beta/customers/assignments.mjs.map +1 -0
- package/resources/v1/events/beta/customers/customers.d.mts +18 -0
- package/resources/v1/events/beta/customers/customers.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/customers.d.ts +18 -0
- package/resources/v1/events/beta/customers/customers.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/customers.js +25 -0
- package/resources/v1/events/beta/customers/customers.js.map +1 -0
- package/resources/v1/events/beta/customers/customers.mjs +20 -0
- package/resources/v1/events/beta/customers/customers.mjs.map +1 -0
- package/resources/v1/events/beta/customers/entities.d.mts +304 -0
- package/resources/v1/events/beta/customers/entities.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/entities.d.ts +304 -0
- package/resources/v1/events/beta/customers/entities.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/entities.js +105 -0
- package/resources/v1/events/beta/customers/entities.js.map +1 -0
- package/resources/v1/events/beta/customers/entities.mjs +101 -0
- package/resources/v1/events/beta/customers/entities.mjs.map +1 -0
- package/resources/v1/events/beta/customers/entitlements.d.mts +238 -0
- package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/entitlements.d.ts +238 -0
- package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/entitlements.js +26 -0
- package/resources/v1/events/beta/customers/entitlements.js.map +1 -0
- package/resources/v1/events/beta/customers/entitlements.mjs +22 -0
- package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -0
- package/resources/v1/events/beta/customers/index.d.mts +5 -0
- package/resources/v1/events/beta/customers/index.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/index.d.ts +5 -0
- package/resources/v1/events/beta/customers/index.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/index.js +13 -0
- package/resources/v1/events/beta/customers/index.js.map +1 -0
- package/resources/v1/events/beta/customers/index.mjs +6 -0
- package/resources/v1/events/beta/customers/index.mjs.map +1 -0
- package/resources/v1/events/beta/customers.d.mts +2 -0
- package/resources/v1/events/beta/customers.d.mts.map +1 -0
- package/resources/v1/events/beta/customers.d.ts +2 -0
- package/resources/v1/events/beta/customers.d.ts.map +1 -0
- package/resources/v1/events/beta/customers.js +6 -0
- package/resources/v1/events/beta/customers.js.map +1 -0
- package/resources/v1/events/beta/customers.mjs +3 -0
- package/resources/v1/events/beta/customers.mjs.map +1 -0
- package/resources/v1/events/beta/entity-types.d.mts +144 -0
- package/resources/v1/events/beta/entity-types.d.mts.map +1 -0
- package/resources/v1/events/beta/entity-types.d.ts +144 -0
- package/resources/v1/events/beta/entity-types.d.ts.map +1 -0
- package/resources/v1/events/beta/entity-types.js +56 -0
- package/resources/v1/events/beta/entity-types.js.map +1 -0
- package/resources/v1/events/beta/entity-types.mjs +52 -0
- package/resources/v1/events/beta/entity-types.mjs.map +1 -0
- package/resources/v1/events/beta/index.d.mts +4 -0
- package/resources/v1/events/beta/index.d.mts.map +1 -0
- package/resources/v1/events/beta/index.d.ts +4 -0
- package/resources/v1/events/beta/index.d.ts.map +1 -0
- package/resources/v1/events/beta/index.js +11 -0
- package/resources/v1/events/beta/index.js.map +1 -0
- package/resources/v1/events/beta/index.mjs +5 -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/events.d.mts +17 -4
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +17 -4
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +17 -4
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +17 -4
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/events/index.d.mts +1 -1
- package/resources/v1/events/index.d.mts.map +1 -1
- package/resources/v1/events/index.d.ts +1 -1
- package/resources/v1/events/index.d.ts.map +1 -1
- package/resources/v1/events/index.js +3 -3
- package/resources/v1/events/index.js.map +1 -1
- package/resources/v1/events/index.mjs +1 -1
- package/resources/v1/events/index.mjs.map +1 -1
- package/resources/v1/events.d.mts.map +1 -1
- package/resources/v1/events.d.ts.map +1 -1
- package/resources/v1/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +43 -0
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +43 -0
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +43 -0
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +43 -0
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +3 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +3 -2
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +11 -9
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -0
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +31 -0
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +31 -0
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +31 -0
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +31 -0
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +1 -1
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +1 -1
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +412 -1
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +412 -1
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +81 -0
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +81 -0
- 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 +43 -0
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +43 -0
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +43 -0
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +43 -0
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +16 -0
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +16 -0
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +16 -0
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +16 -0
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +6 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +6 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +6 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +6 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +93 -9
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +93 -9
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +81 -0
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +81 -0
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +13 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +13 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +13 -0
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +13 -0
- 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 +24 -0
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +24 -0
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +24 -0
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +24 -0
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +8 -4
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +8 -4
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -0
- package/resources/v1/v1.mjs.map +1 -1
- 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/resources/v1/addons/addons.ts +625 -0
- package/src/resources/v1/addons/entitlements.ts +31 -0
- package/src/resources/v1/addons/index.ts +3 -0
- package/src/resources/v1/coupons.ts +36 -0
- package/src/resources/v1/{events/credits → credits}/credits.ts +61 -16
- package/src/resources/v1/{events/credits → credits}/custom-currencies.ts +65 -259
- package/src/resources/v1/{events/credits → credits}/grants.ts +33 -5
- package/src/resources/v1/{events/credits → credits}/index.ts +1 -4
- package/src/resources/v1/customers/customers.ts +92 -5
- package/src/resources/v1/customers/integrations.ts +55 -2
- package/src/resources/v1/customers/payment-method.ts +19 -1
- package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
- package/src/resources/v1/events/beta/beta.ts +35 -0
- package/src/resources/v1/events/beta/customers/assignments.ts +228 -0
- package/src/resources/v1/events/beta/customers/customers.ts +71 -0
- package/src/resources/v1/events/beta/customers/entities.ts +381 -0
- package/src/resources/v1/events/beta/customers/entitlements.ts +327 -0
- package/src/resources/v1/events/beta/customers/index.ts +26 -0
- package/src/resources/v1/events/beta/customers.ts +3 -0
- package/src/resources/v1/events/beta/entity-types.ts +180 -0
- package/src/resources/v1/events/beta/index.ts +12 -0
- package/src/resources/v1/events/beta.ts +3 -0
- package/src/resources/v1/events/events.ts +18 -23
- package/src/resources/v1/events/index.ts +1 -10
- package/src/resources/v1/features.ts +43 -0
- package/src/resources/v1/index.ts +19 -0
- package/src/resources/v1/plans/entitlements.ts +31 -0
- package/src/resources/v1/plans/index.ts +6 -0
- package/src/resources/v1/plans/plans.ts +1201 -0
- package/src/resources/v1/products.ts +43 -0
- package/src/resources/v1/subscriptions/future-update.ts +16 -0
- package/src/resources/v1/subscriptions/invoice.ts +6 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +93 -9
- package/src/resources/v1/subscriptions/usage.ts +13 -0
- package/src/resources/v1/usage.ts +24 -0
- package/src/resources/v1/v1.ts +42 -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
- package/resources/v1/events/credits/credits.d.mts.map +0 -1
- package/resources/v1/events/credits/credits.d.ts.map +0 -1
- package/resources/v1/events/credits/credits.js.map +0 -1
- package/resources/v1/events/credits/credits.mjs.map +0 -1
- package/resources/v1/events/credits/custom-currencies.d.mts.map +0 -1
- package/resources/v1/events/credits/custom-currencies.d.ts.map +0 -1
- package/resources/v1/events/credits/custom-currencies.js.map +0 -1
- package/resources/v1/events/credits/custom-currencies.mjs.map +0 -1
- package/resources/v1/events/credits/grants.d.mts.map +0 -1
- package/resources/v1/events/credits/grants.d.ts.map +0 -1
- package/resources/v1/events/credits/grants.js.map +0 -1
- package/resources/v1/events/credits/grants.mjs.map +0 -1
- package/resources/v1/events/credits/index.d.mts +0 -4
- package/resources/v1/events/credits/index.d.mts.map +0 -1
- package/resources/v1/events/credits/index.d.ts +0 -4
- package/resources/v1/events/credits/index.d.ts.map +0 -1
- package/resources/v1/events/credits/index.js.map +0 -1
- package/resources/v1/events/credits/index.mjs.map +0 -1
- package/resources/v1/events/credits.d.mts.map +0 -1
- package/resources/v1/events/credits.d.ts.map +0 -1
- package/resources/v1/events/credits.js.map +0 -1
- package/resources/v1/events/credits.mjs.map +0 -1
- /package/resources/v1/{events/credits → credits}/index.js +0 -0
- /package/resources/v1/{events/credits → credits}/index.mjs +0 -0
- /package/resources/v1/{events/credits.d.mts → credits.d.mts} +0 -0
- /package/resources/v1/{events/credits.d.ts → credits.d.ts} +0 -0
- /package/resources/v1/{events/credits.mjs → credits.mjs} +0 -0
- /package/src/resources/v1/{events/credits.ts → credits.ts} +0 -0
|
@@ -6,25 +6,72 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
6
6
|
export declare class Integrations extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves a specific integration for a customer by integration ID.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const customerIntegrationResponse =
|
|
13
|
+
* await client.v1.customers.integrations.retrieve(
|
|
14
|
+
* 'integrationId',
|
|
15
|
+
* { id: 'id' },
|
|
16
|
+
* );
|
|
17
|
+
* ```
|
|
9
18
|
*/
|
|
10
19
|
retrieve(integrationID: string, params: IntegrationRetrieveParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerIntegrationResponse>;
|
|
11
20
|
/**
|
|
12
21
|
* Updates a customer's integration link, such as changing the synced external
|
|
13
22
|
* entity ID.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const customerIntegrationResponse =
|
|
27
|
+
* await client.v1.customers.integrations.update(
|
|
28
|
+
* 'integrationId',
|
|
29
|
+
* { id: 'id', syncedEntityId: 'syncedEntityId' },
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
14
32
|
*/
|
|
15
33
|
update(integrationID: string, params: IntegrationUpdateParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerIntegrationResponse>;
|
|
16
34
|
/**
|
|
17
35
|
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
18
36
|
* etc.).
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* // Automatically fetches more pages as needed.
|
|
41
|
+
* for await (const integrationListResponse of client.v1.customers.integrations.list(
|
|
42
|
+
* 'x',
|
|
43
|
+
* )) {
|
|
44
|
+
* // ...
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
19
47
|
*/
|
|
20
48
|
list(id: string, query?: IntegrationListParams | null | undefined, options?: RequestOptions): PagePromise<IntegrationListResponsesMyCursorIDPage, IntegrationListResponse>;
|
|
21
49
|
/**
|
|
22
50
|
* Links a customer to an external integration by specifying the vendor and
|
|
23
51
|
* external entity ID.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const customerIntegrationResponse =
|
|
56
|
+
* await client.v1.customers.integrations.link('x', {
|
|
57
|
+
* id: 'id',
|
|
58
|
+
* syncedEntityId: 'syncedEntityId',
|
|
59
|
+
* vendorIdentifier: 'AUTH0',
|
|
60
|
+
* });
|
|
61
|
+
* ```
|
|
24
62
|
*/
|
|
25
63
|
link(id: string, body: IntegrationLinkParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerIntegrationResponse>;
|
|
26
64
|
/**
|
|
27
65
|
* Removes the link between a customer and an external integration.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const customerIntegrationResponse =
|
|
70
|
+
* await client.v1.customers.integrations.unlink(
|
|
71
|
+
* 'integrationId',
|
|
72
|
+
* { id: 'id' },
|
|
73
|
+
* );
|
|
74
|
+
* ```
|
|
28
75
|
*/
|
|
29
76
|
unlink(integrationID: string, params: IntegrationUnlinkParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerIntegrationResponse>;
|
|
30
77
|
}
|
|
@@ -44,7 +91,7 @@ export interface IntegrationListResponse {
|
|
|
44
91
|
/**
|
|
45
92
|
* The vendor identifier of integration
|
|
46
93
|
*/
|
|
47
|
-
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
94
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
|
|
48
95
|
/**
|
|
49
96
|
* Price billing sync revision data containing billing ID, link URL, and price
|
|
50
97
|
* group package billing ID
|
|
@@ -114,7 +161,7 @@ export interface IntegrationListParams extends MyCursorIDPageParams {
|
|
|
114
161
|
* Filter by vendor identifier. Supports comma-separated values for multiple
|
|
115
162
|
* vendors (e.g., STRIPE,HUBSPOT)
|
|
116
163
|
*/
|
|
117
|
-
vendorIdentifier?: Array<'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE'>;
|
|
164
|
+
vendorIdentifier?: Array<'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL'>;
|
|
118
165
|
}
|
|
119
166
|
export interface IntegrationLinkParams {
|
|
120
167
|
/**
|
|
@@ -128,7 +175,7 @@ export interface IntegrationLinkParams {
|
|
|
128
175
|
/**
|
|
129
176
|
* The vendor identifier of integration
|
|
130
177
|
*/
|
|
131
|
-
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
178
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
|
|
132
179
|
}
|
|
133
180
|
export interface IntegrationUnlinkParams {
|
|
134
181
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integrations.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"integrations.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,2BAA2B,CAAC;IAKvD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,2BAA2B,CAAC;IAQvD;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,uBAAuB,CAAC;IAQ/E;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,2BAA2B,CAAC;IAIvD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,2BAA2B,CAAC;CAIxD;AAED,MAAM,MAAM,sCAAsC,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE7F;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,CAAC;IAEd;;;OAGG;IACH,QAAQ,CAAC,EACL,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,uBAAuB,GAC/C,uBAAuB,CAAC,2BAA2B,GACnD,IAAI,CAAC;CACV;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,0BAA0B,EAAE,MAAM,CAAC;KACpC;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CACpB,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,CACZ,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|
|
@@ -8,6 +8,15 @@ const path_1 = require("../../../internal/utils/path.js");
|
|
|
8
8
|
class Integrations extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
10
|
* Retrieves a specific integration for a customer by integration ID.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const customerIntegrationResponse =
|
|
15
|
+
* await client.v1.customers.integrations.retrieve(
|
|
16
|
+
* 'integrationId',
|
|
17
|
+
* { id: 'id' },
|
|
18
|
+
* );
|
|
19
|
+
* ```
|
|
11
20
|
*/
|
|
12
21
|
retrieve(integrationID, params, options) {
|
|
13
22
|
const { id } = params;
|
|
@@ -16,6 +25,15 @@ class Integrations extends resource_1.APIResource {
|
|
|
16
25
|
/**
|
|
17
26
|
* Updates a customer's integration link, such as changing the synced external
|
|
18
27
|
* entity ID.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const customerIntegrationResponse =
|
|
32
|
+
* await client.v1.customers.integrations.update(
|
|
33
|
+
* 'integrationId',
|
|
34
|
+
* { id: 'id', syncedEntityId: 'syncedEntityId' },
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
19
37
|
*/
|
|
20
38
|
update(integrationID, params, options) {
|
|
21
39
|
const { id, ...body } = params;
|
|
@@ -27,6 +45,16 @@ class Integrations extends resource_1.APIResource {
|
|
|
27
45
|
/**
|
|
28
46
|
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
29
47
|
* etc.).
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const integrationListResponse of client.v1.customers.integrations.list(
|
|
53
|
+
* 'x',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
30
58
|
*/
|
|
31
59
|
list(id, query = {}, options) {
|
|
32
60
|
return this._client.getAPIList((0, path_1.path) `/api/v1/customers/${id}/integrations`, (pagination_1.MyCursorIDPage), { query, ...options });
|
|
@@ -34,12 +62,31 @@ class Integrations extends resource_1.APIResource {
|
|
|
34
62
|
/**
|
|
35
63
|
* Links a customer to an external integration by specifying the vendor and
|
|
36
64
|
* external entity ID.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const customerIntegrationResponse =
|
|
69
|
+
* await client.v1.customers.integrations.link('x', {
|
|
70
|
+
* id: 'id',
|
|
71
|
+
* syncedEntityId: 'syncedEntityId',
|
|
72
|
+
* vendorIdentifier: 'AUTH0',
|
|
73
|
+
* });
|
|
74
|
+
* ```
|
|
37
75
|
*/
|
|
38
76
|
link(id, body, options) {
|
|
39
77
|
return this._client.post((0, path_1.path) `/api/v1/customers/${id}/integrations`, { body, ...options });
|
|
40
78
|
}
|
|
41
79
|
/**
|
|
42
80
|
* Removes the link between a customer and an external integration.
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const customerIntegrationResponse =
|
|
85
|
+
* await client.v1.customers.integrations.unlink(
|
|
86
|
+
* 'integrationId',
|
|
87
|
+
* { id: 'id' },
|
|
88
|
+
* );
|
|
89
|
+
* ```
|
|
43
90
|
*/
|
|
44
91
|
unlink(integrationID, params, options) {
|
|
45
92
|
const { id } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integrations.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAAkG;AAElG,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"integrations.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,4DAAkG;AAElG,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,aAAqB,EACrB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,qBAAqB,EAAE,eAAe,EAC1C,CAAA,2BAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF;AAnHD,oCAmHC"}
|
|
@@ -5,6 +5,15 @@ import { path } from "../../../internal/utils/path.mjs";
|
|
|
5
5
|
export class Integrations extends APIResource {
|
|
6
6
|
/**
|
|
7
7
|
* Retrieves a specific integration for a customer by integration ID.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const customerIntegrationResponse =
|
|
12
|
+
* await client.v1.customers.integrations.retrieve(
|
|
13
|
+
* 'integrationId',
|
|
14
|
+
* { id: 'id' },
|
|
15
|
+
* );
|
|
16
|
+
* ```
|
|
8
17
|
*/
|
|
9
18
|
retrieve(integrationID, params, options) {
|
|
10
19
|
const { id } = params;
|
|
@@ -13,6 +22,15 @@ export class Integrations extends APIResource {
|
|
|
13
22
|
/**
|
|
14
23
|
* Updates a customer's integration link, such as changing the synced external
|
|
15
24
|
* entity ID.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const customerIntegrationResponse =
|
|
29
|
+
* await client.v1.customers.integrations.update(
|
|
30
|
+
* 'integrationId',
|
|
31
|
+
* { id: 'id', syncedEntityId: 'syncedEntityId' },
|
|
32
|
+
* );
|
|
33
|
+
* ```
|
|
16
34
|
*/
|
|
17
35
|
update(integrationID, params, options) {
|
|
18
36
|
const { id, ...body } = params;
|
|
@@ -24,6 +42,16 @@ export class Integrations extends APIResource {
|
|
|
24
42
|
/**
|
|
25
43
|
* Retrieves a paginated list of a customer's external integrations (billing, CRM,
|
|
26
44
|
* etc.).
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* // Automatically fetches more pages as needed.
|
|
49
|
+
* for await (const integrationListResponse of client.v1.customers.integrations.list(
|
|
50
|
+
* 'x',
|
|
51
|
+
* )) {
|
|
52
|
+
* // ...
|
|
53
|
+
* }
|
|
54
|
+
* ```
|
|
27
55
|
*/
|
|
28
56
|
list(id, query = {}, options) {
|
|
29
57
|
return this._client.getAPIList(path `/api/v1/customers/${id}/integrations`, (MyCursorIDPage), { query, ...options });
|
|
@@ -31,12 +59,31 @@ export class Integrations extends APIResource {
|
|
|
31
59
|
/**
|
|
32
60
|
* Links a customer to an external integration by specifying the vendor and
|
|
33
61
|
* external entity ID.
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```ts
|
|
65
|
+
* const customerIntegrationResponse =
|
|
66
|
+
* await client.v1.customers.integrations.link('x', {
|
|
67
|
+
* id: 'id',
|
|
68
|
+
* syncedEntityId: 'syncedEntityId',
|
|
69
|
+
* vendorIdentifier: 'AUTH0',
|
|
70
|
+
* });
|
|
71
|
+
* ```
|
|
34
72
|
*/
|
|
35
73
|
link(id, body, options) {
|
|
36
74
|
return this._client.post(path `/api/v1/customers/${id}/integrations`, { body, ...options });
|
|
37
75
|
}
|
|
38
76
|
/**
|
|
39
77
|
* Removes the link between a customer and an external integration.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const customerIntegrationResponse =
|
|
82
|
+
* await client.v1.customers.integrations.unlink(
|
|
83
|
+
* 'integrationId',
|
|
84
|
+
* { id: 'id' },
|
|
85
|
+
* );
|
|
86
|
+
* ```
|
|
40
87
|
*/
|
|
41
88
|
unlink(integrationID, params, options) {
|
|
42
89
|
const { id } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integrations.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"integrations.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/integrations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAElG,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,aAAqB,EACrB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,qBAAqB,EAAE,eAAe,EAC1C,CAAA,cAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,aAAqB,EACrB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF"}
|
|
@@ -9,11 +9,27 @@ export declare class PaymentMethod extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Attaches a payment method to a customer for billing. Required for paid
|
|
11
11
|
* subscriptions when integrated with a billing provider.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const customerResponse =
|
|
16
|
+
* await client.v1.customers.paymentMethod.attach('x', {
|
|
17
|
+
* integrationId: 'integrationId',
|
|
18
|
+
* paymentMethodId: 'paymentMethodId',
|
|
19
|
+
* vendorIdentifier: 'AUTH0',
|
|
20
|
+
* });
|
|
21
|
+
* ```
|
|
12
22
|
*/
|
|
13
23
|
attach(id: string, body: PaymentMethodAttachParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse>;
|
|
14
24
|
/**
|
|
15
25
|
* Removes the payment method from a customer. Ensure active paid subscriptions
|
|
16
26
|
* have an alternative payment method.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const customerResponse =
|
|
31
|
+
* await client.v1.customers.paymentMethod.detach('x');
|
|
32
|
+
* ```
|
|
17
33
|
*/
|
|
18
34
|
detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse>;
|
|
19
35
|
}
|
|
@@ -29,7 +45,7 @@ export interface PaymentMethodAttachParams {
|
|
|
29
45
|
/**
|
|
30
46
|
* The vendor identifier of integration
|
|
31
47
|
*/
|
|
32
|
-
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
48
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
|
|
33
49
|
/**
|
|
34
50
|
* Customers selected currency
|
|
35
51
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-method.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"payment-method.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAI5C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC;CAGxF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EACZ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,CAAC;CACV;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
|
|
@@ -9,11 +9,27 @@ export declare class PaymentMethod extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Attaches a payment method to a customer for billing. Required for paid
|
|
11
11
|
* subscriptions when integrated with a billing provider.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const customerResponse =
|
|
16
|
+
* await client.v1.customers.paymentMethod.attach('x', {
|
|
17
|
+
* integrationId: 'integrationId',
|
|
18
|
+
* paymentMethodId: 'paymentMethodId',
|
|
19
|
+
* vendorIdentifier: 'AUTH0',
|
|
20
|
+
* });
|
|
21
|
+
* ```
|
|
12
22
|
*/
|
|
13
23
|
attach(id: string, body: PaymentMethodAttachParams, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse>;
|
|
14
24
|
/**
|
|
15
25
|
* Removes the payment method from a customer. Ensure active paid subscriptions
|
|
16
26
|
* have an alternative payment method.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const customerResponse =
|
|
31
|
+
* await client.v1.customers.paymentMethod.detach('x');
|
|
32
|
+
* ```
|
|
17
33
|
*/
|
|
18
34
|
detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse>;
|
|
19
35
|
}
|
|
@@ -29,7 +45,7 @@ export interface PaymentMethodAttachParams {
|
|
|
29
45
|
/**
|
|
30
46
|
* The vendor identifier of integration
|
|
31
47
|
*/
|
|
32
|
-
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
48
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL';
|
|
33
49
|
/**
|
|
34
50
|
* Customers selected currency
|
|
35
51
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-method.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"payment-method.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAI5C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC;CAGxF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,SAAS,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EACZ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,CAAC;CACV;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}
|
|
@@ -11,6 +11,16 @@ class PaymentMethod extends resource_1.APIResource {
|
|
|
11
11
|
/**
|
|
12
12
|
* Attaches a payment method to a customer for billing. Required for paid
|
|
13
13
|
* subscriptions when integrated with a billing provider.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const customerResponse =
|
|
18
|
+
* await client.v1.customers.paymentMethod.attach('x', {
|
|
19
|
+
* integrationId: 'integrationId',
|
|
20
|
+
* paymentMethodId: 'paymentMethodId',
|
|
21
|
+
* vendorIdentifier: 'AUTH0',
|
|
22
|
+
* });
|
|
23
|
+
* ```
|
|
14
24
|
*/
|
|
15
25
|
attach(id, body, options) {
|
|
16
26
|
return this._client.post((0, path_1.path) `/api/v1/customers/${id}/payment-method`, { body, ...options });
|
|
@@ -18,6 +28,12 @@ class PaymentMethod extends resource_1.APIResource {
|
|
|
18
28
|
/**
|
|
19
29
|
* Removes the payment method from a customer. Ensure active paid subscriptions
|
|
20
30
|
* have an alternative payment method.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const customerResponse =
|
|
35
|
+
* await client.v1.customers.paymentMethod.detach('x');
|
|
36
|
+
* ```
|
|
21
37
|
*/
|
|
22
38
|
detach(id, options) {
|
|
23
39
|
return this._client.delete((0, path_1.path) `/api/v1/customers/${id}/payment-method`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-method.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C
|
|
1
|
+
{"version":3,"file":"payment-method.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF;AApCD,sCAoCC"}
|
|
@@ -8,6 +8,16 @@ export class PaymentMethod extends APIResource {
|
|
|
8
8
|
/**
|
|
9
9
|
* Attaches a payment method to a customer for billing. Required for paid
|
|
10
10
|
* subscriptions when integrated with a billing provider.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const customerResponse =
|
|
15
|
+
* await client.v1.customers.paymentMethod.attach('x', {
|
|
16
|
+
* integrationId: 'integrationId',
|
|
17
|
+
* paymentMethodId: 'paymentMethodId',
|
|
18
|
+
* vendorIdentifier: 'AUTH0',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
11
21
|
*/
|
|
12
22
|
attach(id, body, options) {
|
|
13
23
|
return this._client.post(path `/api/v1/customers/${id}/payment-method`, { body, ...options });
|
|
@@ -15,6 +25,12 @@ export class PaymentMethod extends APIResource {
|
|
|
15
25
|
/**
|
|
16
26
|
* Removes the payment method from a customer. Ensure active paid subscriptions
|
|
17
27
|
* have an alternative payment method.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const customerResponse =
|
|
32
|
+
* await client.v1.customers.paymentMethod.detach('x');
|
|
33
|
+
* ```
|
|
18
34
|
*/
|
|
19
35
|
detach(id, options) {
|
|
20
36
|
return this._client.delete(path `/api/v1/customers/${id}/payment-method`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-method.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"AAAA,sFAAsF;
|
|
1
|
+
{"version":3,"file":"payment-method.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/payment-method.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;CACF"}
|
|
@@ -9,15 +9,66 @@ export declare class PromotionalEntitlements extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Grants promotional entitlements to a customer, providing feature access outside
|
|
11
11
|
* their subscription. Entitlements can be time-limited or permanent.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const promotionalEntitlement =
|
|
16
|
+
* await client.v1.customers.promotionalEntitlements.create(
|
|
17
|
+
* 'x',
|
|
18
|
+
* {
|
|
19
|
+
* promotionalEntitlements: [
|
|
20
|
+
* {
|
|
21
|
+
* customEndDate: '2019-12-27T18:11:19.117Z',
|
|
22
|
+
* enumValues: ['string'],
|
|
23
|
+
* featureId: 'featureId',
|
|
24
|
+
* hasSoftLimit: true,
|
|
25
|
+
* hasUnlimitedUsage: true,
|
|
26
|
+
* isVisible: true,
|
|
27
|
+
* monthlyResetPeriodConfiguration: {
|
|
28
|
+
* accordingTo: 'SubscriptionStart',
|
|
29
|
+
* },
|
|
30
|
+
* period: '1 week',
|
|
31
|
+
* resetPeriod: 'YEAR',
|
|
32
|
+
* usageLimit: -9007199254740991,
|
|
33
|
+
* weeklyResetPeriodConfiguration: {
|
|
34
|
+
* accordingTo: 'SubscriptionStart',
|
|
35
|
+
* },
|
|
36
|
+
* yearlyResetPeriodConfiguration: {
|
|
37
|
+
* accordingTo: 'SubscriptionStart',
|
|
38
|
+
* },
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* },
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
12
44
|
*/
|
|
13
45
|
create(id: string, body: PromotionalEntitlementCreateParams, options?: RequestOptions): APIPromise<PromotionalEntitlementCreateResponse>;
|
|
14
46
|
/**
|
|
15
47
|
* Retrieves a paginated list of a customer's promotional entitlements.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
|
|
53
|
+
* 'x',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
16
58
|
*/
|
|
17
59
|
list(id: string, query?: PromotionalEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse>;
|
|
18
60
|
/**
|
|
19
61
|
* Revokes a previously granted promotional entitlement from a customer for a
|
|
20
62
|
* specific feature.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response =
|
|
67
|
+
* await client.v1.customers.promotionalEntitlements.revoke(
|
|
68
|
+
* 'featureId',
|
|
69
|
+
* { id: 'id' },
|
|
70
|
+
* );
|
|
71
|
+
* ```
|
|
21
72
|
*/
|
|
22
73
|
revoke(featureID: string, params: PromotionalEntitlementRevokeParams, options?: RequestOptions): APIPromise<PromotionalEntitlementRevokeResponse>;
|
|
23
74
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promotional-entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"promotional-entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iDAAiD,EAAE,kCAAkC,CAAC;IAQrG;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAIpD;AAED,MAAM,MAAM,iDAAiD,GAC3D,cAAc,CAAC,kCAAkC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,KAAK,CAAC,oCAAoC,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IAE5E;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,wBAAwB,EACpB,kCAAkC,CAAC,uBAAuB,GAC1D,kCAAkC,CAAC,wBAAwB,GAC3D,kCAAkC,CAAC,uBAAuB,GAC1D,IAAI,CAAC;IAET;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;KACtD;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,EAAE,oCAAoC,CAAC,IAAI,CAAC;CACjD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,uBAAuB,EAAE,KAAK,CAAC,kCAAkC,CAAC,sBAAsB,CAAC,CAAC;CAC3F;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,+BAA+B,EAAE,sBAAsB,CAAC,+BAA+B,GAAG,IAAI,CAAC;QAE/F;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;QAE7F;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;KAC9F;IAED,UAAiB,sBAAsB,CAAC;QACtC;;;WAGG;QACH,UAAiB,+BAA+B;YAC9C;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;KACF;CACF;AAED,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E;;OAEG;IACH,SAAS,CAAC,EAAE,gCAAgC,CAAC,SAAS,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC,CAAC;CACjD;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
|
|
@@ -9,15 +9,66 @@ export declare class PromotionalEntitlements extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Grants promotional entitlements to a customer, providing feature access outside
|
|
11
11
|
* their subscription. Entitlements can be time-limited or permanent.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const promotionalEntitlement =
|
|
16
|
+
* await client.v1.customers.promotionalEntitlements.create(
|
|
17
|
+
* 'x',
|
|
18
|
+
* {
|
|
19
|
+
* promotionalEntitlements: [
|
|
20
|
+
* {
|
|
21
|
+
* customEndDate: '2019-12-27T18:11:19.117Z',
|
|
22
|
+
* enumValues: ['string'],
|
|
23
|
+
* featureId: 'featureId',
|
|
24
|
+
* hasSoftLimit: true,
|
|
25
|
+
* hasUnlimitedUsage: true,
|
|
26
|
+
* isVisible: true,
|
|
27
|
+
* monthlyResetPeriodConfiguration: {
|
|
28
|
+
* accordingTo: 'SubscriptionStart',
|
|
29
|
+
* },
|
|
30
|
+
* period: '1 week',
|
|
31
|
+
* resetPeriod: 'YEAR',
|
|
32
|
+
* usageLimit: -9007199254740991,
|
|
33
|
+
* weeklyResetPeriodConfiguration: {
|
|
34
|
+
* accordingTo: 'SubscriptionStart',
|
|
35
|
+
* },
|
|
36
|
+
* yearlyResetPeriodConfiguration: {
|
|
37
|
+
* accordingTo: 'SubscriptionStart',
|
|
38
|
+
* },
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* },
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
12
44
|
*/
|
|
13
45
|
create(id: string, body: PromotionalEntitlementCreateParams, options?: RequestOptions): APIPromise<PromotionalEntitlementCreateResponse>;
|
|
14
46
|
/**
|
|
15
47
|
* Retrieves a paginated list of a customer's promotional entitlements.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
|
|
53
|
+
* 'x',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
16
58
|
*/
|
|
17
59
|
list(id: string, query?: PromotionalEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse>;
|
|
18
60
|
/**
|
|
19
61
|
* Revokes a previously granted promotional entitlement from a customer for a
|
|
20
62
|
* specific feature.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response =
|
|
67
|
+
* await client.v1.customers.promotionalEntitlements.revoke(
|
|
68
|
+
* 'featureId',
|
|
69
|
+
* { id: 'id' },
|
|
70
|
+
* );
|
|
71
|
+
* ```
|
|
21
72
|
*/
|
|
22
73
|
revoke(featureID: string, params: PromotionalEntitlementRevokeParams, options?: RequestOptions): APIPromise<PromotionalEntitlementRevokeResponse>;
|
|
23
74
|
}
|