@stigg/typescript 0.1.0-beta.14 → 0.1.0-beta.15
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 +8 -0
- package/client.d.mts +0 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +0 -3
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +0 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +0 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -1
- package/resources/index.mjs.map +1 -1
- package/resources/v1/addons/addons.d.mts +59 -0
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +59 -0
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +59 -0
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +59 -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/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/credits/credits.d.mts +59 -0
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +59 -0
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +25 -0
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +25 -0
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +49 -0
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +49 -0
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +49 -0
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +49 -0
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +28 -0
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +28 -0
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +28 -0
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +28 -0
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +77 -0
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +77 -0
- 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/integrations.d.mts +47 -0
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +47 -0
- 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 +16 -0
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +16 -0
- 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-beta/v1-beta.d.mts → v1/events/beta/beta.d.mts} +4 -4
- package/resources/v1/events/beta/beta.d.mts.map +1 -0
- package/resources/{v1-beta/v1-beta.d.ts → v1/events/beta/beta.d.ts} +4 -4
- package/resources/v1/events/beta/beta.d.ts.map +1 -0
- package/resources/{v1-beta/v1-beta.js → v1/events/beta/beta.js} +8 -8
- package/resources/v1/events/beta/beta.js.map +1 -0
- package/resources/{v1-beta/v1-beta.mjs → v1/events/beta/beta.mjs} +5 -5
- package/resources/v1/events/beta/beta.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/assignments.d.mts +24 -21
- package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/assignments.d.ts +24 -21
- package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/assignments.js +23 -20
- package/resources/v1/events/beta/customers/assignments.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/assignments.mjs +23 -20
- package/resources/v1/events/beta/customers/assignments.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/customers.d.mts +1 -1
- package/resources/v1/events/beta/customers/customers.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/customers.d.ts +1 -1
- package/resources/v1/events/beta/customers/customers.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/customers.js +2 -2
- package/resources/v1/events/beta/customers/customers.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/customers.mjs +1 -1
- package/resources/v1/events/beta/customers/customers.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entities.d.mts +37 -28
- package/resources/v1/events/beta/customers/entities.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entities.d.ts +37 -28
- package/resources/v1/events/beta/customers/entities.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entities.js +36 -27
- package/resources/v1/events/beta/customers/entities.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entities.mjs +36 -27
- package/resources/v1/events/beta/customers/entities.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entitlements.d.mts +6 -4
- package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entitlements.d.ts +6 -4
- package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entitlements.js +5 -3
- package/resources/v1/events/beta/customers/entitlements.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers/entitlements.mjs +5 -3
- package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -0
- package/resources/v1/events/beta/customers/index.d.mts.map +1 -0
- package/resources/v1/events/beta/customers/index.d.ts.map +1 -0
- package/resources/v1/events/beta/customers/index.js.map +1 -0
- package/resources/v1/events/beta/customers/index.mjs.map +1 -0
- package/resources/v1/events/beta/customers.d.mts.map +1 -0
- package/resources/v1/events/beta/customers.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/customers.js +1 -1
- package/resources/v1/events/beta/customers.js.map +1 -0
- package/resources/v1/events/beta/customers.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/entity-types.d.mts +20 -19
- package/resources/v1/events/beta/entity-types.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/entity-types.d.ts +20 -19
- package/resources/v1/events/beta/entity-types.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/entity-types.js +18 -17
- package/resources/v1/events/beta/entity-types.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/entity-types.mjs +18 -17
- package/resources/v1/events/beta/entity-types.mjs.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/index.d.mts +1 -1
- package/resources/v1/events/beta/index.d.mts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/index.d.ts +1 -1
- package/resources/v1/events/beta/index.d.ts.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/index.js +3 -3
- package/resources/v1/events/beta/index.js.map +1 -0
- package/resources/{v1-beta → v1/events/beta}/index.mjs +1 -1
- 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-beta.js → v1/events/beta.js} +3 -3
- package/resources/v1/events/beta.js.map +1 -0
- package/resources/{v1-beta.mjs → v1/events/beta.mjs} +2 -2
- package/resources/v1/events/beta.mjs.map +1 -0
- package/resources/v1/events/events.d.mts +83 -0
- package/resources/v1/events/events.d.mts.map +1 -0
- package/resources/v1/events/events.d.ts +83 -0
- package/resources/v1/events/events.d.ts.map +1 -0
- package/resources/v1/events/events.js +40 -0
- package/resources/v1/events/events.js.map +1 -0
- package/resources/v1/events/events.mjs +35 -0
- package/resources/v1/events/events.mjs.map +1 -0
- package/resources/v1/events/index.d.mts +3 -0
- package/resources/v1/events/index.d.mts.map +1 -0
- package/resources/v1/events/index.d.ts +3 -0
- package/resources/v1/events/index.d.ts.map +1 -0
- package/resources/v1/events/index.js +9 -0
- package/resources/v1/events/index.js.map +1 -0
- package/resources/v1/events/index.mjs +4 -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 +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 +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- 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 +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/plans.d.mts +69 -0
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +69 -0
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +69 -0
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +69 -0
- package/resources/v1/plans/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/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 +81 -0
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +81 -0
- 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/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 +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- 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/src/client.ts +0 -5
- package/src/resources/index.ts +0 -1
- package/src/resources/v1/addons/addons.ts +59 -0
- package/src/resources/v1/addons/entitlements.ts +31 -0
- package/src/resources/v1/coupons.ts +36 -0
- package/src/resources/v1/credits/credits.ts +65 -0
- package/src/resources/v1/credits/custom-currencies.ts +49 -0
- package/src/resources/v1/credits/grants.ts +28 -0
- package/src/resources/v1/customers/customers.ts +77 -0
- package/src/resources/v1/customers/integrations.ts +47 -0
- package/src/resources/v1/customers/payment-method.ts +16 -0
- package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
- package/src/resources/{v1-beta/v1-beta.ts → v1/events/beta/beta.ts} +5 -5
- package/src/resources/{v1-beta → v1/events/beta}/customers/assignments.ts +25 -22
- package/src/resources/{v1-beta → v1/events/beta}/customers/customers.ts +1 -1
- package/src/resources/{v1-beta → v1/events/beta}/customers/entities.ts +38 -29
- package/src/resources/{v1-beta → v1/events/beta}/customers/entitlements.ts +7 -5
- package/src/resources/{v1-beta → v1/events/beta}/entity-types.ts +20 -19
- package/src/resources/{v1-beta → v1/events/beta}/index.ts +1 -1
- package/src/resources/{v1-beta.ts → v1/events/beta.ts} +1 -1
- package/src/resources/v1/events/events.ts +98 -0
- package/src/resources/v1/events/index.ts +4 -0
- package/src/resources/v1/events.ts +1 -75
- package/src/resources/v1/features.ts +43 -0
- package/src/resources/v1/index.ts +1 -1
- package/src/resources/v1/plans/entitlements.ts +31 -0
- package/src/resources/v1/plans/plans.ts +69 -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 +81 -0
- package/src/resources/v1/subscriptions/usage.ts +13 -0
- package/src/resources/v1/usage.ts +24 -0
- package/src/resources/v1/v1.ts +2 -2
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/v1-beta/customers/assignments.d.mts.map +0 -1
- package/resources/v1-beta/customers/assignments.d.ts.map +0 -1
- package/resources/v1-beta/customers/assignments.js.map +0 -1
- package/resources/v1-beta/customers/assignments.mjs.map +0 -1
- package/resources/v1-beta/customers/customers.d.mts.map +0 -1
- package/resources/v1-beta/customers/customers.d.ts.map +0 -1
- package/resources/v1-beta/customers/customers.js.map +0 -1
- package/resources/v1-beta/customers/customers.mjs.map +0 -1
- package/resources/v1-beta/customers/entities.d.mts.map +0 -1
- package/resources/v1-beta/customers/entities.d.ts.map +0 -1
- package/resources/v1-beta/customers/entities.js.map +0 -1
- package/resources/v1-beta/customers/entities.mjs.map +0 -1
- package/resources/v1-beta/customers/entitlements.d.mts.map +0 -1
- package/resources/v1-beta/customers/entitlements.d.ts.map +0 -1
- package/resources/v1-beta/customers/entitlements.js.map +0 -1
- package/resources/v1-beta/customers/entitlements.mjs.map +0 -1
- package/resources/v1-beta/customers/index.d.mts.map +0 -1
- package/resources/v1-beta/customers/index.d.ts.map +0 -1
- package/resources/v1-beta/customers/index.js.map +0 -1
- package/resources/v1-beta/customers/index.mjs.map +0 -1
- package/resources/v1-beta/customers.d.mts.map +0 -1
- package/resources/v1-beta/customers.d.ts.map +0 -1
- package/resources/v1-beta/customers.js.map +0 -1
- package/resources/v1-beta/customers.mjs.map +0 -1
- package/resources/v1-beta/entity-types.d.mts.map +0 -1
- package/resources/v1-beta/entity-types.d.ts.map +0 -1
- package/resources/v1-beta/entity-types.js.map +0 -1
- package/resources/v1-beta/entity-types.mjs.map +0 -1
- package/resources/v1-beta/index.d.mts.map +0 -1
- package/resources/v1-beta/index.d.ts.map +0 -1
- package/resources/v1-beta/index.js.map +0 -1
- package/resources/v1-beta/index.mjs.map +0 -1
- package/resources/v1-beta/v1-beta.d.mts.map +0 -1
- package/resources/v1-beta/v1-beta.d.ts.map +0 -1
- package/resources/v1-beta/v1-beta.js.map +0 -1
- package/resources/v1-beta/v1-beta.mjs.map +0 -1
- package/resources/v1-beta.d.mts +0 -2
- package/resources/v1-beta.d.mts.map +0 -1
- package/resources/v1-beta.d.ts +0 -2
- package/resources/v1-beta.d.ts.map +0 -1
- package/resources/v1-beta.js.map +0 -1
- package/resources/v1-beta.mjs.map +0 -1
- /package/resources/{v1-beta → v1/events/beta}/customers/index.d.mts +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers/index.d.ts +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers/index.js +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers/index.mjs +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers.d.mts +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers.d.ts +0 -0
- /package/resources/{v1-beta → v1/events/beta}/customers.mjs +0 -0
- /package/src/resources/{v1-beta → v1/events/beta}/customers/index.ts +0 -0
- /package/src/resources/{v1-beta → v1/events/beta}/customers.ts +0 -0
|
@@ -12,6 +12,13 @@ import { path } from '../../internal/utils/path';
|
|
|
12
12
|
export class Features extends APIResource {
|
|
13
13
|
/**
|
|
14
14
|
* Archives a feature, preventing it from being used in new entitlements.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const feature = await client.v1.features.archiveFeature(
|
|
19
|
+
* 'x',
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
15
22
|
*/
|
|
16
23
|
archiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
|
|
17
24
|
return this._client.post(path`/api/v1/features/${id}/archive`, options);
|
|
@@ -19,6 +26,15 @@ export class Features extends APIResource {
|
|
|
19
26
|
|
|
20
27
|
/**
|
|
21
28
|
* Creates a new feature with the specified type, metering, and configuration.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const feature = await client.v1.features.createFeature({
|
|
33
|
+
* id: 'id',
|
|
34
|
+
* displayName: 'displayName',
|
|
35
|
+
* featureType: 'BOOLEAN',
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
22
38
|
*/
|
|
23
39
|
createFeature(body: FeatureCreateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
|
|
24
40
|
return this._client.post('/api/v1/features', { body, ...options });
|
|
@@ -26,6 +42,14 @@ export class Features extends APIResource {
|
|
|
26
42
|
|
|
27
43
|
/**
|
|
28
44
|
* Retrieves a paginated list of features in the environment.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* // Automatically fetches more pages as needed.
|
|
49
|
+
* for await (const featureListFeaturesResponse of client.v1.features.listFeatures()) {
|
|
50
|
+
* // ...
|
|
51
|
+
* }
|
|
52
|
+
* ```
|
|
29
53
|
*/
|
|
30
54
|
listFeatures(
|
|
31
55
|
query: FeatureListFeaturesParams | null | undefined = {},
|
|
@@ -39,6 +63,13 @@ export class Features extends APIResource {
|
|
|
39
63
|
|
|
40
64
|
/**
|
|
41
65
|
* Retrieves a feature by its unique identifier.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* const feature = await client.v1.features.retrieveFeature(
|
|
70
|
+
* 'x',
|
|
71
|
+
* );
|
|
72
|
+
* ```
|
|
42
73
|
*/
|
|
43
74
|
retrieveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
|
|
44
75
|
return this._client.get(path`/api/v1/features/${id}`, options);
|
|
@@ -46,6 +77,13 @@ export class Features extends APIResource {
|
|
|
46
77
|
|
|
47
78
|
/**
|
|
48
79
|
* Restores an archived feature, allowing it to be used in entitlements again.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* const feature = await client.v1.features.unarchiveFeature(
|
|
84
|
+
* 'x',
|
|
85
|
+
* );
|
|
86
|
+
* ```
|
|
49
87
|
*/
|
|
50
88
|
unarchiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
|
|
51
89
|
return this._client.post(path`/api/v1/features/${id}/unarchive`, options);
|
|
@@ -54,6 +92,11 @@ export class Features extends APIResource {
|
|
|
54
92
|
/**
|
|
55
93
|
* Updates an existing feature's properties such as display name, description, and
|
|
56
94
|
* configuration.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```ts
|
|
98
|
+
* const feature = await client.v1.features.updateFeature('x');
|
|
99
|
+
* ```
|
|
57
100
|
*/
|
|
58
101
|
updateFeature(id: string, body: FeatureUpdateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
|
|
59
102
|
return this._client.patch(path`/api/v1/features/${id}`, { body, ...options });
|
|
@@ -53,7 +53,7 @@ export {
|
|
|
53
53
|
type CustomerListResponsesMyCursorIDPage,
|
|
54
54
|
type CustomerListResourcesResponsesMyCursorIDPage,
|
|
55
55
|
} from './customers/index';
|
|
56
|
-
export { Events, type EventReportResponse, type EventReportParams } from './events';
|
|
56
|
+
export { Events, type EventReportResponse, type EventReportParams } from './events/index';
|
|
57
57
|
export {
|
|
58
58
|
Features,
|
|
59
59
|
type Feature,
|
|
@@ -8,6 +8,14 @@ import { path } from '../../../internal/utils/path';
|
|
|
8
8
|
export class Entitlements extends APIResource {
|
|
9
9
|
/**
|
|
10
10
|
* Creates one or more entitlements (feature or credit) on a draft plan.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const entitlement =
|
|
15
|
+
* await client.v1.plans.entitlements.create('planId', {
|
|
16
|
+
* entitlements: [{ id: 'id', type: 'FEATURE' }],
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
11
19
|
*/
|
|
12
20
|
create(
|
|
13
21
|
planID: string,
|
|
@@ -19,6 +27,15 @@ export class Entitlements extends APIResource {
|
|
|
19
27
|
|
|
20
28
|
/**
|
|
21
29
|
* Updates an existing entitlement on a draft plan.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const planEntitlement =
|
|
34
|
+
* await client.v1.plans.entitlements.update('id', {
|
|
35
|
+
* planId: 'planId',
|
|
36
|
+
* type: 'FEATURE',
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
22
39
|
*/
|
|
23
40
|
update(id: string, params: EntitlementUpdateParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
|
|
24
41
|
const { planId, ...body } = params;
|
|
@@ -27,6 +44,12 @@ export class Entitlements extends APIResource {
|
|
|
27
44
|
|
|
28
45
|
/**
|
|
29
46
|
* Retrieves a list of entitlements for a plan.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const entitlements =
|
|
51
|
+
* await client.v1.plans.entitlements.list('planId');
|
|
52
|
+
* ```
|
|
30
53
|
*/
|
|
31
54
|
list(planID: string, options?: RequestOptions): APIPromise<EntitlementListResponse> {
|
|
32
55
|
return this._client.get(path`/api/v1/plans/${planID}/entitlements`, options);
|
|
@@ -34,6 +57,14 @@ export class Entitlements extends APIResource {
|
|
|
34
57
|
|
|
35
58
|
/**
|
|
36
59
|
* Deletes an entitlement from a draft plan.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const planEntitlement =
|
|
64
|
+
* await client.v1.plans.entitlements.delete('id', {
|
|
65
|
+
* planId: 'planId',
|
|
66
|
+
* });
|
|
67
|
+
* ```
|
|
37
68
|
*/
|
|
38
69
|
delete(id: string, params: EntitlementDeleteParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
|
|
39
70
|
const { planId } = params;
|
|
@@ -24,6 +24,15 @@ export class Plans extends APIResource {
|
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* Creates a new plan in draft status.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const plan = await client.v1.plans.create({
|
|
31
|
+
* id: 'id',
|
|
32
|
+
* displayName: 'displayName',
|
|
33
|
+
* productId: 'productId',
|
|
34
|
+
* });
|
|
35
|
+
* ```
|
|
27
36
|
*/
|
|
28
37
|
create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
|
|
29
38
|
return this._client.post('/api/v1/plans', { body, ...options });
|
|
@@ -32,6 +41,11 @@ export class Plans extends APIResource {
|
|
|
32
41
|
/**
|
|
33
42
|
* Retrieves a plan by its unique identifier, including entitlements and pricing
|
|
34
43
|
* details.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const plan = await client.v1.plans.retrieve('x');
|
|
48
|
+
* ```
|
|
35
49
|
*/
|
|
36
50
|
retrieve(id: string, options?: RequestOptions): APIPromise<Plan> {
|
|
37
51
|
return this._client.get(path`/api/v1/plans/${id}`, options);
|
|
@@ -40,6 +54,11 @@ export class Plans extends APIResource {
|
|
|
40
54
|
/**
|
|
41
55
|
* Updates an existing plan's properties such as display name, description, and
|
|
42
56
|
* metadata.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const plan = await client.v1.plans.update('x');
|
|
61
|
+
* ```
|
|
43
62
|
*/
|
|
44
63
|
update(id: string, body: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan> {
|
|
45
64
|
return this._client.patch(path`/api/v1/plans/${id}`, { body, ...options });
|
|
@@ -47,6 +66,14 @@ export class Plans extends APIResource {
|
|
|
47
66
|
|
|
48
67
|
/**
|
|
49
68
|
* Retrieves a paginated list of plans in the environment.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* // Automatically fetches more pages as needed.
|
|
73
|
+
* for await (const planListResponse of client.v1.plans.list()) {
|
|
74
|
+
* // ...
|
|
75
|
+
* }
|
|
76
|
+
* ```
|
|
50
77
|
*/
|
|
51
78
|
list(
|
|
52
79
|
query: PlanListParams | null | undefined = {},
|
|
@@ -57,6 +84,11 @@ export class Plans extends APIResource {
|
|
|
57
84
|
|
|
58
85
|
/**
|
|
59
86
|
* Archives a plan, preventing it from being used in new subscriptions.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const plan = await client.v1.plans.archive('x');
|
|
91
|
+
* ```
|
|
60
92
|
*/
|
|
61
93
|
archive(id: string, options?: RequestOptions): APIPromise<Plan> {
|
|
62
94
|
return this._client.post(path`/api/v1/plans/${id}/archive`, options);
|
|
@@ -64,6 +96,11 @@ export class Plans extends APIResource {
|
|
|
64
96
|
|
|
65
97
|
/**
|
|
66
98
|
* Creates a draft version of an existing plan for modification before publishing.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```ts
|
|
102
|
+
* const plan = await client.v1.plans.createDraft('x');
|
|
103
|
+
* ```
|
|
67
104
|
*/
|
|
68
105
|
createDraft(id: string, options?: RequestOptions): APIPromise<Plan> {
|
|
69
106
|
return this._client.post(path`/api/v1/plans/${id}/draft`, options);
|
|
@@ -71,6 +108,16 @@ export class Plans extends APIResource {
|
|
|
71
108
|
|
|
72
109
|
/**
|
|
73
110
|
* Retrieves the list of charges configured on a plan.
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* // Automatically fetches more pages as needed.
|
|
115
|
+
* for await (const planListChargesResponse of client.v1.plans.listCharges(
|
|
116
|
+
* 'x',
|
|
117
|
+
* )) {
|
|
118
|
+
* // ...
|
|
119
|
+
* }
|
|
120
|
+
* ```
|
|
74
121
|
*/
|
|
75
122
|
listCharges(
|
|
76
123
|
id: string,
|
|
@@ -86,6 +133,16 @@ export class Plans extends APIResource {
|
|
|
86
133
|
|
|
87
134
|
/**
|
|
88
135
|
* Retrieves the list of overage charges configured on a plan.
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```ts
|
|
139
|
+
* // Automatically fetches more pages as needed.
|
|
140
|
+
* for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges(
|
|
141
|
+
* 'x',
|
|
142
|
+
* )) {
|
|
143
|
+
* // ...
|
|
144
|
+
* }
|
|
145
|
+
* ```
|
|
89
146
|
*/
|
|
90
147
|
listOverageCharges(
|
|
91
148
|
id: string,
|
|
@@ -101,6 +158,13 @@ export class Plans extends APIResource {
|
|
|
101
158
|
|
|
102
159
|
/**
|
|
103
160
|
* Publishes a draft plan, making it available for use in subscriptions.
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```ts
|
|
164
|
+
* const response = await client.v1.plans.publish('x', {
|
|
165
|
+
* migrationType: 'NEW_CUSTOMERS',
|
|
166
|
+
* });
|
|
167
|
+
* ```
|
|
104
168
|
*/
|
|
105
169
|
publish(id: string, body: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse> {
|
|
106
170
|
return this._client.post(path`/api/v1/plans/${id}/publish`, { body, ...options });
|
|
@@ -108,6 +172,11 @@ export class Plans extends APIResource {
|
|
|
108
172
|
|
|
109
173
|
/**
|
|
110
174
|
* Removes a draft version of a plan.
|
|
175
|
+
*
|
|
176
|
+
* @example
|
|
177
|
+
* ```ts
|
|
178
|
+
* const response = await client.v1.plans.removeDraft('x');
|
|
179
|
+
* ```
|
|
111
180
|
*/
|
|
112
181
|
removeDraft(id: string, options?: RequestOptions): APIPromise<PlanRemoveDraftResponse> {
|
|
113
182
|
return this._client.delete(path`/api/v1/plans/${id}/draft`, options);
|
|
@@ -13,6 +13,13 @@ export class Products extends APIResource {
|
|
|
13
13
|
/**
|
|
14
14
|
* Archives a product, preventing new subscriptions. All plans and addons are
|
|
15
15
|
* archived.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const product = await client.v1.products.archiveProduct(
|
|
20
|
+
* 'x',
|
|
21
|
+
* );
|
|
22
|
+
* ```
|
|
16
23
|
*/
|
|
17
24
|
archiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
|
|
18
25
|
return this._client.post(path`/api/v1/products/${id}/archive`, options);
|
|
@@ -20,6 +27,14 @@ export class Products extends APIResource {
|
|
|
20
27
|
|
|
21
28
|
/**
|
|
22
29
|
* Creates a new product.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const product = await client.v1.products.createProduct({
|
|
34
|
+
* id: 'id',
|
|
35
|
+
* displayName: 'displayName',
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
23
38
|
*/
|
|
24
39
|
createProduct(body: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
|
|
25
40
|
return this._client.post('/api/v1/products', { body, ...options });
|
|
@@ -27,6 +42,14 @@ export class Products extends APIResource {
|
|
|
27
42
|
|
|
28
43
|
/**
|
|
29
44
|
* Duplicates an existing product, including its plans, addons, and configuration.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const product = await client.v1.products.duplicateProduct(
|
|
49
|
+
* 'x',
|
|
50
|
+
* { targetId: 'targetId' },
|
|
51
|
+
* );
|
|
52
|
+
* ```
|
|
30
53
|
*/
|
|
31
54
|
duplicateProduct(
|
|
32
55
|
id: string,
|
|
@@ -38,6 +61,14 @@ export class Products extends APIResource {
|
|
|
38
61
|
|
|
39
62
|
/**
|
|
40
63
|
* Retrieves a paginated list of products in the environment.
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* // Automatically fetches more pages as needed.
|
|
68
|
+
* for await (const productListProductsResponse of client.v1.products.listProducts()) {
|
|
69
|
+
* // ...
|
|
70
|
+
* }
|
|
71
|
+
* ```
|
|
41
72
|
*/
|
|
42
73
|
listProducts(
|
|
43
74
|
query: ProductListProductsParams | null | undefined = {},
|
|
@@ -51,6 +82,13 @@ export class Products extends APIResource {
|
|
|
51
82
|
|
|
52
83
|
/**
|
|
53
84
|
* Restores an archived product, allowing new subscriptions to be created.
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* const product = await client.v1.products.unarchiveProduct(
|
|
89
|
+
* 'x',
|
|
90
|
+
* );
|
|
91
|
+
* ```
|
|
54
92
|
*/
|
|
55
93
|
unarchiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
|
|
56
94
|
return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
|
|
@@ -59,6 +97,11 @@ export class Products extends APIResource {
|
|
|
59
97
|
/**
|
|
60
98
|
* Updates an existing product's properties such as display name, description, and
|
|
61
99
|
* metadata.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* const product = await client.v1.products.updateProduct('x');
|
|
104
|
+
* ```
|
|
62
105
|
*/
|
|
63
106
|
updateProduct(id: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
|
|
64
107
|
return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });
|
|
@@ -11,6 +11,14 @@ import { path } from '../../../internal/utils/path';
|
|
|
11
11
|
export class FutureUpdate extends APIResource {
|
|
12
12
|
/**
|
|
13
13
|
* Cancels a subscription update that is pending payment completion.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const cancelSubscription =
|
|
18
|
+
* await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
|
|
19
|
+
* 'x',
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
14
22
|
*/
|
|
15
23
|
cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
|
|
16
24
|
return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
|
|
@@ -19,6 +27,14 @@ export class FutureUpdate extends APIResource {
|
|
|
19
27
|
/**
|
|
20
28
|
* Cancels a scheduled subscription update, such as a future downgrade or plan
|
|
21
29
|
* change.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const cancelSubscription =
|
|
34
|
+
* await client.v1.subscriptions.futureUpdate.cancelSchedule(
|
|
35
|
+
* 'x',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
22
38
|
*/
|
|
23
39
|
cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
|
|
24
40
|
return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);
|
|
@@ -12,6 +12,12 @@ export class Invoice extends APIResource {
|
|
|
12
12
|
/**
|
|
13
13
|
* Marks the latest invoice of a subscription as paid in the billing provider. The
|
|
14
14
|
* invoice must exist and have an OPEN status.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.v1.subscriptions.invoice.markAsPaid('x');
|
|
20
|
+
* ```
|
|
15
21
|
*/
|
|
16
22
|
markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse> {
|
|
17
23
|
return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, options);
|
|
@@ -20,6 +20,13 @@ export class Subscriptions extends APIResource {
|
|
|
20
20
|
/**
|
|
21
21
|
* Retrieves a subscription by its unique identifier, including plan details,
|
|
22
22
|
* billing period, status, and add-ons.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const subscription = await client.v1.subscriptions.retrieve(
|
|
27
|
+
* 'x',
|
|
28
|
+
* );
|
|
29
|
+
* ```
|
|
23
30
|
*/
|
|
24
31
|
retrieve(id: string, options?: RequestOptions): APIPromise<Subscription> {
|
|
25
32
|
return this._client.get(path`/api/v1/subscriptions/${id}`, options);
|
|
@@ -28,6 +35,13 @@ export class Subscriptions extends APIResource {
|
|
|
28
35
|
/**
|
|
29
36
|
* Updates an active subscription's properties including billing period, add-ons,
|
|
30
37
|
* unit quantities, and discounts.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const subscription = await client.v1.subscriptions.update(
|
|
42
|
+
* 'x',
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
31
45
|
*/
|
|
32
46
|
update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
33
47
|
return this._client.patch(path`/api/v1/subscriptions/${id}`, { body, ...options });
|
|
@@ -36,6 +50,14 @@ export class Subscriptions extends APIResource {
|
|
|
36
50
|
/**
|
|
37
51
|
* Retrieves a paginated list of subscriptions, with optional filters for customer,
|
|
38
52
|
* status, and plan.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* // Automatically fetches more pages as needed.
|
|
57
|
+
* for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
|
|
58
|
+
* // ...
|
|
59
|
+
* }
|
|
60
|
+
* ```
|
|
39
61
|
*/
|
|
40
62
|
list(
|
|
41
63
|
query: SubscriptionListParams | null | undefined = {},
|
|
@@ -50,6 +72,13 @@ export class Subscriptions extends APIResource {
|
|
|
50
72
|
/**
|
|
51
73
|
* Cancels an active subscription, either immediately or at a specified time such
|
|
52
74
|
* as end of billing period.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const subscription = await client.v1.subscriptions.cancel(
|
|
79
|
+
* 'x',
|
|
80
|
+
* );
|
|
81
|
+
* ```
|
|
53
82
|
*/
|
|
54
83
|
cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
55
84
|
return this._client.post(path`/api/v1/subscriptions/${id}/cancel`, { body, ...options });
|
|
@@ -58,6 +87,14 @@ export class Subscriptions extends APIResource {
|
|
|
58
87
|
/**
|
|
59
88
|
* Delegates the payment responsibility of a subscription to a different customer.
|
|
60
89
|
* The delegated customer will be billed for this subscription.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* const subscription = await client.v1.subscriptions.delegate(
|
|
94
|
+
* 'x',
|
|
95
|
+
* { targetCustomerId: 'targetCustomerId' },
|
|
96
|
+
* );
|
|
97
|
+
* ```
|
|
61
98
|
*/
|
|
62
99
|
delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
63
100
|
return this._client.post(path`/api/v1/subscriptions/${id}/delegate`, { body, ...options });
|
|
@@ -66,6 +103,19 @@ export class Subscriptions extends APIResource {
|
|
|
66
103
|
/**
|
|
67
104
|
* Imports multiple subscriptions in bulk. Used for migrating subscription data
|
|
68
105
|
* from external systems.
|
|
106
|
+
*
|
|
107
|
+
* @example
|
|
108
|
+
* ```ts
|
|
109
|
+
* const response = await client.v1.subscriptions.import({
|
|
110
|
+
* subscriptions: [
|
|
111
|
+
* {
|
|
112
|
+
* id: 'id',
|
|
113
|
+
* customerId: 'customerId',
|
|
114
|
+
* planId: 'planId',
|
|
115
|
+
* },
|
|
116
|
+
* ],
|
|
117
|
+
* });
|
|
118
|
+
* ```
|
|
69
119
|
*/
|
|
70
120
|
import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse> {
|
|
71
121
|
return this._client.post('/api/v1/subscriptions/import', { body, ...options });
|
|
@@ -74,6 +124,13 @@ export class Subscriptions extends APIResource {
|
|
|
74
124
|
/**
|
|
75
125
|
* Migrates a subscription to the latest published version of its plan or add-ons.
|
|
76
126
|
* Handles prorated charges or credits automatically.
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* const subscription = await client.v1.subscriptions.migrate(
|
|
131
|
+
* 'x',
|
|
132
|
+
* );
|
|
133
|
+
* ```
|
|
77
134
|
*/
|
|
78
135
|
migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
79
136
|
return this._client.post(path`/api/v1/subscriptions/${id}/migrate`, { body, ...options });
|
|
@@ -82,6 +139,14 @@ export class Subscriptions extends APIResource {
|
|
|
82
139
|
/**
|
|
83
140
|
* Previews the pricing impact of creating or updating a subscription without
|
|
84
141
|
* making changes. Returns estimated costs, taxes, and proration details.
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* const response = await client.v1.subscriptions.preview({
|
|
146
|
+
* customerId: 'customerId',
|
|
147
|
+
* planId: 'planId',
|
|
148
|
+
* });
|
|
149
|
+
* ```
|
|
85
150
|
*/
|
|
86
151
|
preview(
|
|
87
152
|
body: SubscriptionPreviewParams,
|
|
@@ -93,6 +158,14 @@ export class Subscriptions extends APIResource {
|
|
|
93
158
|
/**
|
|
94
159
|
* Creates a new subscription for an existing customer. When payment is required
|
|
95
160
|
* and no payment method exists, returns a checkout URL.
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```ts
|
|
164
|
+
* const response = await client.v1.subscriptions.provision({
|
|
165
|
+
* customerId: 'customerId',
|
|
166
|
+
* planId: 'planId',
|
|
167
|
+
* });
|
|
168
|
+
* ```
|
|
96
169
|
*/
|
|
97
170
|
provision(
|
|
98
171
|
body: SubscriptionProvisionParams,
|
|
@@ -104,6 +177,14 @@ export class Subscriptions extends APIResource {
|
|
|
104
177
|
/**
|
|
105
178
|
* Transfers a subscription to a different resource ID. Used for multi-resource
|
|
106
179
|
* products where subscriptions apply to specific entities like websites or apps.
|
|
180
|
+
*
|
|
181
|
+
* @example
|
|
182
|
+
* ```ts
|
|
183
|
+
* const subscription = await client.v1.subscriptions.transfer(
|
|
184
|
+
* 'x',
|
|
185
|
+
* { destinationResourceId: 'destinationResourceId' },
|
|
186
|
+
* );
|
|
187
|
+
* ```
|
|
107
188
|
*/
|
|
108
189
|
transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
109
190
|
return this._client.post(path`/api/v1/subscriptions/${id}/transfer`, { body, ...options });
|
|
@@ -12,6 +12,12 @@ export class Usage extends APIResource {
|
|
|
12
12
|
/**
|
|
13
13
|
* Immediately charges usage for a subscription via the billing integration.
|
|
14
14
|
* Calculates usage since the last charge and creates an invoice.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const response =
|
|
19
|
+
* await client.v1.subscriptions.usage.chargeUsage('x');
|
|
20
|
+
* ```
|
|
15
21
|
*/
|
|
16
22
|
chargeUsage(
|
|
17
23
|
id: string,
|
|
@@ -24,6 +30,13 @@ export class Usage extends APIResource {
|
|
|
24
30
|
/**
|
|
25
31
|
* Triggers a usage sync for a subscription, reporting current usage to the billing
|
|
26
32
|
* provider.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const response = await client.v1.subscriptions.usage.sync(
|
|
37
|
+
* 'x',
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
27
40
|
*/
|
|
28
41
|
sync(id: string, options?: RequestOptions): APIPromise<UsageSyncResponse> {
|
|
29
42
|
return this._client.post(path`/api/v1/subscriptions/${id}/usage/sync`, options);
|
|
@@ -11,6 +11,17 @@ import { path } from '../../internal/utils/path';
|
|
|
11
11
|
export class Usage extends APIResource {
|
|
12
12
|
/**
|
|
13
13
|
* Retrieves historical usage data for a customer's metered feature over time.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const response = await client.v1.usage.history(
|
|
18
|
+
* 'featureId',
|
|
19
|
+
* {
|
|
20
|
+
* customerId: 'customerId',
|
|
21
|
+
* startDate: '2019-12-27T18:11:19.117Z',
|
|
22
|
+
* },
|
|
23
|
+
* );
|
|
24
|
+
* ```
|
|
14
25
|
*/
|
|
15
26
|
history(
|
|
16
27
|
featureID: string,
|
|
@@ -24,6 +35,19 @@ export class Usage extends APIResource {
|
|
|
24
35
|
/**
|
|
25
36
|
* Reports usage measurements for metered features. The reported usage is used to
|
|
26
37
|
* track, limit, and bill customer consumption.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const response = await client.v1.usage.report({
|
|
42
|
+
* usages: [
|
|
43
|
+
* {
|
|
44
|
+
* customerId: 'customerId',
|
|
45
|
+
* featureId: 'featureId',
|
|
46
|
+
* value: -9007199254740991,
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* });
|
|
50
|
+
* ```
|
|
27
51
|
*/
|
|
28
52
|
report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
|
|
29
53
|
return this._client.post('/api/v1/usage', { body, ...options });
|
package/src/resources/v1/v1.ts
CHANGED
|
@@ -11,8 +11,6 @@ import {
|
|
|
11
11
|
CouponUpdateCouponParams,
|
|
12
12
|
Coupons,
|
|
13
13
|
} from './coupons';
|
|
14
|
-
import * as EventsAPI from './events';
|
|
15
|
-
import { EventReportParams, EventReportResponse, Events } from './events';
|
|
16
14
|
import * as FeaturesAPI from './features';
|
|
17
15
|
import {
|
|
18
16
|
Feature,
|
|
@@ -89,6 +87,8 @@ import {
|
|
|
89
87
|
CustomerUpdateParams,
|
|
90
88
|
Customers,
|
|
91
89
|
} from './customers/customers';
|
|
90
|
+
import * as EventsAPI from './events/events';
|
|
91
|
+
import { EventReportParams, EventReportResponse, Events } from './events/events';
|
|
92
92
|
import * as PlansAPI from './plans/plans';
|
|
93
93
|
import {
|
|
94
94
|
Plan,
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.1.0-beta.
|
|
1
|
+
export const VERSION = '0.1.0-beta.15'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.1.0-beta.
|
|
1
|
+
export declare const VERSION = "0.1.0-beta.15";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.1.0-beta.
|
|
1
|
+
export declare const VERSION = "0.1.0-beta.15";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.VERSION = void 0;
|
|
4
|
-
exports.VERSION = '0.1.0-beta.
|
|
4
|
+
exports.VERSION = '0.1.0-beta.15'; // x-release-please-version
|
|
5
5
|
//# sourceMappingURL=version.js.map
|
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.1.0-beta.
|
|
1
|
+
export const VERSION = '0.1.0-beta.15'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"assignments.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/assignments.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,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAQ7E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED,MAAM,MAAM,qCAAqC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;CACvD;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;OAKG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/assignments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAClG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAQ7E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED,MAAM,MAAM,qCAAqC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;CACvD;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;OAKG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|