@stigg/typescript 0.1.0-beta.20 → 0.1.0-beta.22
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 +16 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/v1/addons/addons.d.mts +145 -94
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +145 -94
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +110 -76
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +110 -76
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +62 -36
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +62 -36
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +49 -39
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +49 -39
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +2 -2
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +2 -2
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/addons/index.js.map +1 -1
- package/resources/v1/addons/index.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +81 -57
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +81 -57
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +60 -45
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +60 -45
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +60 -52
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +60 -52
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +36 -30
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +36 -30
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +98 -74
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +98 -74
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +76 -61
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +76 -61
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +63 -54
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +63 -54
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +35 -33
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +35 -33
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/index.d.mts +2 -2
- package/resources/v1/credits/index.d.mts.map +1 -1
- package/resources/v1/credits/index.d.ts +2 -2
- package/resources/v1/credits/index.d.ts.map +1 -1
- package/resources/v1/credits/index.js.map +1 -1
- package/resources/v1/credits/index.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +167 -127
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +167 -127
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +124 -96
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +124 -96
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +66 -58
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +66 -58
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +57 -56
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +57 -56
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +33 -25
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +33 -25
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +26 -20
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +26 -20
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +42 -60
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +42 -60
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +38 -57
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +38 -57
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events/data-export/data-export.d.mts +29 -21
- package/resources/v1/events/data-export/data-export.d.mts.map +1 -1
- package/resources/v1/events/data-export/data-export.d.ts +29 -21
- package/resources/v1/events/data-export/data-export.d.ts.map +1 -1
- package/resources/v1/events/data-export/data-export.js +27 -18
- package/resources/v1/events/data-export/data-export.js.map +1 -1
- package/resources/v1/events/data-export/data-export.mjs +27 -18
- package/resources/v1/events/data-export/data-export.mjs.map +1 -1
- package/resources/v1/events/data-export/destinations.d.mts +29 -22
- package/resources/v1/events/data-export/destinations.d.mts.map +1 -1
- package/resources/v1/events/data-export/destinations.d.ts +29 -22
- package/resources/v1/events/data-export/destinations.d.ts.map +1 -1
- package/resources/v1/events/data-export/destinations.js +26 -21
- package/resources/v1/events/data-export/destinations.js.map +1 -1
- package/resources/v1/events/data-export/destinations.mjs +26 -21
- package/resources/v1/events/data-export/destinations.mjs.map +1 -1
- package/resources/v1/events/data-export/index.d.mts +1 -1
- package/resources/v1/events/data-export/index.d.mts.map +1 -1
- package/resources/v1/events/data-export/index.d.ts +1 -1
- package/resources/v1/events/data-export/index.d.ts.map +1 -1
- package/resources/v1/events/data-export/index.js.map +1 -1
- package/resources/v1/events/data-export/index.mjs.map +1 -1
- package/resources/v1/events/events.d.mts +13 -19
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +13 -19
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +14 -19
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +14 -19
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/events/index.d.mts +0 -1
- package/resources/v1/events/index.d.mts.map +1 -1
- package/resources/v1/events/index.d.ts +0 -1
- package/resources/v1/events/index.d.ts.map +1 -1
- package/resources/v1/events/index.js +3 -5
- package/resources/v1/events/index.js.map +1 -1
- package/resources/v1/events/index.mjs +0 -1
- package/resources/v1/events/index.mjs.map +1 -1
- package/resources/v1/features.d.mts +109 -74
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +109 -74
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +72 -54
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +72 -54
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +7 -7
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +7 -7
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +62 -36
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +62 -36
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +49 -39
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +49 -39
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +2 -2
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +2 -2
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +159 -106
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +159 -106
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +127 -89
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +127 -89
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +97 -66
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +97 -66
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +73 -54
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +73 -54
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +29 -19
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +29 -19
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +25 -20
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +25 -20
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -4
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -4
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +15 -8
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +15 -8
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +13 -8
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +13 -8
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +244 -161
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +244 -161
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +126 -100
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +128 -102
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +29 -17
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +29 -17
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +26 -17
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +26 -17
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +24 -26
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +24 -26
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +26 -28
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +26 -28
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +14 -14
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +14 -14
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1-beta/customers/assignments.d.mts +242 -0
- package/resources/v1-beta/customers/assignments.d.mts.map +1 -0
- package/resources/v1-beta/customers/assignments.d.ts +242 -0
- package/resources/v1-beta/customers/assignments.d.ts.map +1 -0
- package/resources/v1-beta/customers/assignments.js +84 -0
- package/resources/v1-beta/customers/assignments.js.map +1 -0
- package/resources/v1-beta/customers/assignments.mjs +80 -0
- package/resources/v1-beta/customers/assignments.mjs.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/customers.d.mts +1 -1
- package/resources/v1-beta/customers/customers.d.mts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/customers.d.ts +1 -1
- package/resources/v1-beta/customers/customers.d.ts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/customers.js +2 -2
- package/resources/v1-beta/customers/customers.js.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/customers.mjs +1 -1
- package/resources/v1-beta/customers/customers.mjs.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/entities.d.mts +94 -47
- package/resources/v1-beta/customers/entities.d.mts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/entities.d.ts +94 -47
- package/resources/v1-beta/customers/entities.d.ts.map +1 -0
- package/resources/v1-beta/customers/entities.js +150 -0
- package/resources/v1-beta/customers/entities.js.map +1 -0
- package/resources/v1-beta/customers/entities.mjs +146 -0
- package/resources/v1-beta/customers/entities.mjs.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/entitlements.d.mts +27 -16
- package/resources/v1-beta/customers/entitlements.d.mts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers/entitlements.d.ts +27 -16
- package/resources/v1-beta/customers/entitlements.d.ts.map +1 -0
- package/resources/v1-beta/customers/entitlements.js +36 -0
- package/resources/v1-beta/customers/entitlements.js.map +1 -0
- package/resources/v1-beta/customers/entitlements.mjs +32 -0
- package/resources/v1-beta/customers/entitlements.mjs.map +1 -0
- package/resources/v1-beta/customers/index.d.mts.map +1 -0
- package/resources/v1-beta/customers/index.d.ts.map +1 -0
- package/resources/v1-beta/customers/index.js.map +1 -0
- package/resources/v1-beta/customers/index.mjs.map +1 -0
- package/resources/v1-beta/customers.d.mts.map +1 -0
- package/resources/v1-beta/customers.d.ts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/customers.js +1 -1
- package/resources/v1-beta/customers.js.map +1 -0
- package/resources/v1-beta/customers.mjs.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/entity-types.d.mts +44 -23
- package/resources/v1-beta/entity-types.d.mts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/entity-types.d.ts +44 -23
- package/resources/v1-beta/entity-types.d.ts.map +1 -0
- package/resources/v1-beta/entity-types.js +75 -0
- package/resources/v1-beta/entity-types.js.map +1 -0
- package/resources/v1-beta/entity-types.mjs +71 -0
- package/resources/v1-beta/entity-types.mjs.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/index.d.mts +1 -1
- package/resources/v1-beta/index.d.mts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/index.d.ts +1 -1
- package/resources/v1-beta/index.d.ts.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/index.js +3 -3
- package/resources/v1-beta/index.js.map +1 -0
- package/resources/{v1/events/beta → v1-beta}/index.mjs +1 -1
- package/resources/v1-beta/index.mjs.map +1 -0
- package/resources/{v1/events/beta/beta.d.mts → v1-beta/v1-beta.d.mts} +4 -4
- package/resources/v1-beta/v1-beta.d.mts.map +1 -0
- package/resources/{v1/events/beta/beta.d.ts → v1-beta/v1-beta.d.ts} +4 -4
- package/resources/v1-beta/v1-beta.d.ts.map +1 -0
- package/resources/{v1/events/beta/beta.js → v1-beta/v1-beta.js} +8 -8
- package/resources/v1-beta/v1-beta.js.map +1 -0
- package/resources/{v1/events/beta/beta.mjs → v1-beta/v1-beta.mjs} +5 -5
- package/resources/v1-beta/v1-beta.mjs.map +1 -0
- package/resources/v1-beta.d.mts +2 -0
- package/resources/v1-beta.d.mts.map +1 -0
- package/resources/v1-beta.d.ts +2 -0
- package/resources/v1-beta.d.ts.map +1 -0
- package/resources/{v1/events/beta.js → v1-beta.js} +3 -3
- package/resources/v1-beta.js.map +1 -0
- package/resources/{v1/events/beta.mjs → v1-beta.mjs} +2 -2
- package/resources/v1-beta.mjs.map +1 -0
- package/src/client.ts +5 -0
- package/src/resources/index.ts +1 -0
- package/src/resources/v1/addons/addons.ts +293 -105
- package/src/resources/v1/addons/entitlements.ts +123 -41
- package/src/resources/v1/addons/index.ts +5 -0
- package/src/resources/v1/coupons.ts +158 -63
- package/src/resources/v1/credits/credits.ts +103 -50
- package/src/resources/v1/credits/custom-currencies.ts +191 -82
- package/src/resources/v1/credits/grants.ts +104 -54
- package/src/resources/v1/credits/index.ts +4 -0
- package/src/resources/v1/customers/customers.ts +324 -140
- package/src/resources/v1/customers/index.ts +8 -1
- package/src/resources/v1/customers/integrations.ts +129 -63
- package/src/resources/v1/customers/payment-method.ts +66 -25
- package/src/resources/v1/customers/promotional-entitlements.ts +82 -62
- package/src/resources/v1/events/data-export/data-export.ts +58 -21
- package/src/resources/v1/events/data-export/destinations.ts +61 -23
- package/src/resources/v1/events/data-export/index.ts +1 -0
- package/src/resources/v1/events/events.ts +28 -22
- package/src/resources/v1/events/index.ts +0 -1
- package/src/resources/v1/features.ts +209 -82
- package/src/resources/v1/index.ts +19 -0
- package/src/resources/v1/plans/entitlements.ts +123 -41
- package/src/resources/v1/plans/index.ts +5 -0
- package/src/resources/v1/plans/plans.ts +321 -119
- package/src/resources/v1/products.ts +193 -74
- package/src/resources/v1/subscriptions/future-update.ts +68 -21
- package/src/resources/v1/subscriptions/index.ts +9 -2
- package/src/resources/v1/subscriptions/invoice.ts +36 -9
- package/src/resources/v1/subscriptions/subscriptions.ts +417 -173
- package/src/resources/v1/subscriptions/usage.ts +61 -18
- package/src/resources/v1/usage.ts +53 -29
- package/src/resources/v1/v1.ts +38 -0
- package/src/resources/v1-beta/customers/assignments.ts +328 -0
- package/src/resources/{v1/events/beta → v1-beta}/customers/customers.ts +1 -1
- package/src/resources/{v1/events/beta → v1-beta}/customers/entities.ts +165 -54
- package/src/resources/{v1/events/beta → v1-beta}/customers/entitlements.ts +43 -18
- package/src/resources/{v1/events/beta → v1-beta}/entity-types.ts +70 -25
- package/src/resources/{v1/events/beta → v1-beta}/index.ts +1 -1
- package/src/resources/{v1/events/beta/beta.ts → v1-beta/v1-beta.ts} +5 -5
- package/src/resources/{v1/events/beta.ts → v1-beta.ts} +1 -1
- 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/events/beta/beta.d.mts.map +0 -1
- package/resources/v1/events/beta/beta.d.ts.map +0 -1
- package/resources/v1/events/beta/beta.js.map +0 -1
- package/resources/v1/events/beta/beta.mjs.map +0 -1
- package/resources/v1/events/beta/customers/assignments.d.mts +0 -178
- package/resources/v1/events/beta/customers/assignments.d.mts.map +0 -1
- package/resources/v1/events/beta/customers/assignments.d.ts +0 -178
- package/resources/v1/events/beta/customers/assignments.d.ts.map +0 -1
- package/resources/v1/events/beta/customers/assignments.js +0 -62
- package/resources/v1/events/beta/customers/assignments.js.map +0 -1
- package/resources/v1/events/beta/customers/assignments.mjs +0 -58
- package/resources/v1/events/beta/customers/assignments.mjs.map +0 -1
- package/resources/v1/events/beta/customers/customers.d.mts.map +0 -1
- package/resources/v1/events/beta/customers/customers.d.ts.map +0 -1
- package/resources/v1/events/beta/customers/customers.js.map +0 -1
- package/resources/v1/events/beta/customers/customers.mjs.map +0 -1
- package/resources/v1/events/beta/customers/entities.d.mts.map +0 -1
- package/resources/v1/events/beta/customers/entities.d.ts.map +0 -1
- package/resources/v1/events/beta/customers/entities.js +0 -105
- package/resources/v1/events/beta/customers/entities.js.map +0 -1
- package/resources/v1/events/beta/customers/entities.mjs +0 -101
- package/resources/v1/events/beta/customers/entities.mjs.map +0 -1
- package/resources/v1/events/beta/customers/entitlements.d.mts.map +0 -1
- package/resources/v1/events/beta/customers/entitlements.d.ts.map +0 -1
- package/resources/v1/events/beta/customers/entitlements.js +0 -26
- package/resources/v1/events/beta/customers/entitlements.js.map +0 -1
- package/resources/v1/events/beta/customers/entitlements.mjs +0 -22
- package/resources/v1/events/beta/customers/entitlements.mjs.map +0 -1
- package/resources/v1/events/beta/customers/index.d.mts.map +0 -1
- package/resources/v1/events/beta/customers/index.d.ts.map +0 -1
- package/resources/v1/events/beta/customers/index.js.map +0 -1
- package/resources/v1/events/beta/customers/index.mjs.map +0 -1
- package/resources/v1/events/beta/customers.d.mts.map +0 -1
- package/resources/v1/events/beta/customers.d.ts.map +0 -1
- package/resources/v1/events/beta/customers.js.map +0 -1
- package/resources/v1/events/beta/customers.mjs.map +0 -1
- package/resources/v1/events/beta/entity-types.d.mts.map +0 -1
- package/resources/v1/events/beta/entity-types.d.ts.map +0 -1
- package/resources/v1/events/beta/entity-types.js +0 -56
- package/resources/v1/events/beta/entity-types.js.map +0 -1
- package/resources/v1/events/beta/entity-types.mjs +0 -52
- package/resources/v1/events/beta/entity-types.mjs.map +0 -1
- package/resources/v1/events/beta/index.d.mts.map +0 -1
- package/resources/v1/events/beta/index.d.ts.map +0 -1
- package/resources/v1/events/beta/index.js.map +0 -1
- package/resources/v1/events/beta/index.mjs.map +0 -1
- package/resources/v1/events/beta.d.mts +0 -2
- package/resources/v1/events/beta.d.mts.map +0 -1
- package/resources/v1/events/beta.d.ts +0 -2
- package/resources/v1/events/beta.d.ts.map +0 -1
- package/resources/v1/events/beta.js.map +0 -1
- package/resources/v1/events/beta.mjs.map +0 -1
- package/src/resources/v1/events/beta/customers/assignments.ts +0 -228
- /package/resources/{v1/events/beta → v1-beta}/customers/index.d.mts +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers/index.d.ts +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers/index.js +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers/index.mjs +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers.d.mts +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers.d.ts +0 -0
- /package/resources/{v1/events/beta → v1-beta}/customers.mjs +0 -0
- /package/src/resources/{v1/events/beta → v1-beta}/customers/index.ts +0 -0
- /package/src/resources/{v1/events/beta → v1-beta}/customers.ts +0 -0
|
@@ -13,7 +13,7 @@ import {
|
|
|
13
13
|
Integrations,
|
|
14
14
|
} from './integrations';
|
|
15
15
|
import * as PaymentMethodAPI from './payment-method';
|
|
16
|
-
import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
|
|
16
|
+
import { PaymentMethod, PaymentMethodAttachParams, PaymentMethodDetachParams } from './payment-method';
|
|
17
17
|
import * as PromotionalEntitlementsAPI from './promotional-entitlements';
|
|
18
18
|
import {
|
|
19
19
|
PromotionalEntitlementCreateParams,
|
|
@@ -27,6 +27,7 @@ import {
|
|
|
27
27
|
} from './promotional-entitlements';
|
|
28
28
|
import { APIPromise } from '../../../core/api-promise';
|
|
29
29
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
|
|
30
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
30
31
|
import { RequestOptions } from '../../../internal/request-options';
|
|
31
32
|
import { path } from '../../../internal/utils/path';
|
|
32
33
|
|
|
@@ -39,67 +40,85 @@ export class Customers extends APIResource {
|
|
|
39
40
|
/**
|
|
40
41
|
* Retrieves a customer by their unique identifier, including billing information
|
|
41
42
|
* and subscription status.
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
43
|
+
*/
|
|
44
|
+
retrieve(
|
|
45
|
+
id: string,
|
|
46
|
+
params: CustomerRetrieveParams | null | undefined = {},
|
|
47
|
+
options?: RequestOptions,
|
|
48
|
+
): APIPromise<CustomerResponse> {
|
|
49
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
50
|
+
return this._client.get(path`/api/v1/customers/${id}`, {
|
|
51
|
+
...options,
|
|
52
|
+
headers: buildHeaders([
|
|
53
|
+
{
|
|
54
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
55
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
56
|
+
},
|
|
57
|
+
options?.headers,
|
|
58
|
+
]),
|
|
59
|
+
});
|
|
52
60
|
}
|
|
53
61
|
|
|
54
62
|
/**
|
|
55
63
|
* Updates an existing customer's properties such as name, email, and billing
|
|
56
64
|
* information.
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
65
|
+
*/
|
|
66
|
+
update(id: string, params: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
|
|
67
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
68
|
+
return this._client.patch(path`/api/v1/customers/${id}`, {
|
|
69
|
+
body,
|
|
70
|
+
...options,
|
|
71
|
+
headers: buildHeaders([
|
|
72
|
+
{
|
|
73
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
74
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
75
|
+
},
|
|
76
|
+
options?.headers,
|
|
77
|
+
]),
|
|
78
|
+
});
|
|
67
79
|
}
|
|
68
80
|
|
|
69
81
|
/**
|
|
70
82
|
* Retrieves a paginated list of customers in the environment.
|
|
71
|
-
*
|
|
72
|
-
* @example
|
|
73
|
-
* ```ts
|
|
74
|
-
* // Automatically fetches more pages as needed.
|
|
75
|
-
* for await (const customerListResponse of client.v1.customers.list()) {
|
|
76
|
-
* // ...
|
|
77
|
-
* }
|
|
78
|
-
* ```
|
|
79
83
|
*/
|
|
80
84
|
list(
|
|
81
|
-
|
|
85
|
+
params: CustomerListParams | null | undefined = {},
|
|
82
86
|
options?: RequestOptions,
|
|
83
87
|
): PagePromise<CustomerListResponsesMyCursorIDPage, CustomerListResponse> {
|
|
88
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
84
89
|
return this._client.getAPIList('/api/v1/customers', MyCursorIDPage<CustomerListResponse>, {
|
|
85
90
|
query,
|
|
86
91
|
...options,
|
|
92
|
+
headers: buildHeaders([
|
|
93
|
+
{
|
|
94
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
95
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
96
|
+
},
|
|
97
|
+
options?.headers,
|
|
98
|
+
]),
|
|
87
99
|
});
|
|
88
100
|
}
|
|
89
101
|
|
|
90
102
|
/**
|
|
91
103
|
* Archives a customer, preventing new subscriptions. Optionally cancels existing
|
|
92
104
|
* subscriptions.
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
105
|
+
*/
|
|
106
|
+
archive(
|
|
107
|
+
id: string,
|
|
108
|
+
params: CustomerArchiveParams | null | undefined = {},
|
|
109
|
+
options?: RequestOptions,
|
|
110
|
+
): APIPromise<CustomerResponse> {
|
|
111
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
112
|
+
return this._client.post(path`/api/v1/customers/${id}/archive`, {
|
|
113
|
+
...options,
|
|
114
|
+
headers: buildHeaders([
|
|
115
|
+
{
|
|
116
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
117
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
118
|
+
},
|
|
119
|
+
options?.headers,
|
|
120
|
+
]),
|
|
121
|
+
});
|
|
103
122
|
}
|
|
104
123
|
|
|
105
124
|
/**
|
|
@@ -111,80 +130,88 @@ export class Customers extends APIResource {
|
|
|
111
130
|
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
112
131
|
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
113
132
|
* with caching or the Sidecar for low-latency cached responses.
|
|
114
|
-
*
|
|
115
|
-
* @example
|
|
116
|
-
* ```ts
|
|
117
|
-
* const response = await client.v1.customers.checkEntitlement(
|
|
118
|
-
* 'x',
|
|
119
|
-
* );
|
|
120
|
-
* ```
|
|
121
133
|
*/
|
|
122
134
|
checkEntitlement(
|
|
123
135
|
id: string,
|
|
124
|
-
|
|
136
|
+
params: CustomerCheckEntitlementParams | null | undefined = {},
|
|
125
137
|
options?: RequestOptions,
|
|
126
138
|
): APIPromise<CustomerCheckEntitlementResponse> {
|
|
127
|
-
|
|
139
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
140
|
+
return this._client.get(path`/api/v1/customers/${id}/entitlements/check`, {
|
|
141
|
+
query,
|
|
142
|
+
...options,
|
|
143
|
+
headers: buildHeaders([
|
|
144
|
+
{
|
|
145
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
146
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
147
|
+
},
|
|
148
|
+
options?.headers,
|
|
149
|
+
]),
|
|
150
|
+
});
|
|
128
151
|
}
|
|
129
152
|
|
|
130
153
|
/**
|
|
131
154
|
* Imports multiple customers in bulk. Used for migrating customer data from
|
|
132
155
|
* external systems.
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
|
|
148
|
-
return this._client.post('/api/v1/customers/import', { body, ...options });
|
|
156
|
+
*/
|
|
157
|
+
import(params: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
|
|
158
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
159
|
+
return this._client.post('/api/v1/customers/import', {
|
|
160
|
+
body,
|
|
161
|
+
...options,
|
|
162
|
+
headers: buildHeaders([
|
|
163
|
+
{
|
|
164
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
165
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
166
|
+
},
|
|
167
|
+
options?.headers,
|
|
168
|
+
]),
|
|
169
|
+
});
|
|
149
170
|
}
|
|
150
171
|
|
|
151
172
|
/**
|
|
152
173
|
* Retrieves a paginated list of resources within the same customer.
|
|
153
|
-
*
|
|
154
|
-
* @example
|
|
155
|
-
* ```ts
|
|
156
|
-
* // Automatically fetches more pages as needed.
|
|
157
|
-
* for await (const customerListResourcesResponse of client.v1.customers.listResources(
|
|
158
|
-
* 'x',
|
|
159
|
-
* )) {
|
|
160
|
-
* // ...
|
|
161
|
-
* }
|
|
162
|
-
* ```
|
|
163
174
|
*/
|
|
164
175
|
listResources(
|
|
165
176
|
id: string,
|
|
166
|
-
|
|
177
|
+
params: CustomerListResourcesParams | null | undefined = {},
|
|
167
178
|
options?: RequestOptions,
|
|
168
179
|
): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse> {
|
|
180
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
169
181
|
return this._client.getAPIList(
|
|
170
182
|
path`/api/v1/customers/${id}/resources`,
|
|
171
183
|
MyCursorIDPage<CustomerListResourcesResponse>,
|
|
172
|
-
{
|
|
184
|
+
{
|
|
185
|
+
query,
|
|
186
|
+
...options,
|
|
187
|
+
headers: buildHeaders([
|
|
188
|
+
{
|
|
189
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
190
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
191
|
+
},
|
|
192
|
+
options?.headers,
|
|
193
|
+
]),
|
|
194
|
+
},
|
|
173
195
|
);
|
|
174
196
|
}
|
|
175
197
|
|
|
176
198
|
/**
|
|
177
199
|
* Creates a new customer and optionally provisions an initial subscription in a
|
|
178
200
|
* single operation.
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
201
|
+
*/
|
|
202
|
+
provision(params: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
|
|
203
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
204
|
+
return this._client.post('/api/v1/customers', {
|
|
205
|
+
body,
|
|
206
|
+
...options,
|
|
207
|
+
headers: buildHeaders([
|
|
208
|
+
{
|
|
209
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
210
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
211
|
+
},
|
|
212
|
+
options?.headers,
|
|
213
|
+
]),
|
|
214
|
+
});
|
|
188
215
|
}
|
|
189
216
|
|
|
190
217
|
/**
|
|
@@ -195,32 +222,45 @@ export class Customers extends APIResource {
|
|
|
195
222
|
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
196
223
|
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
197
224
|
* with caching or the Sidecar for low-latency cached responses.
|
|
198
|
-
*
|
|
199
|
-
* @example
|
|
200
|
-
* ```ts
|
|
201
|
-
* const response =
|
|
202
|
-
* await client.v1.customers.retrieveEntitlements('x');
|
|
203
|
-
* ```
|
|
204
225
|
*/
|
|
205
226
|
retrieveEntitlements(
|
|
206
227
|
id: string,
|
|
207
|
-
|
|
228
|
+
params: CustomerRetrieveEntitlementsParams | null | undefined = {},
|
|
208
229
|
options?: RequestOptions,
|
|
209
230
|
): APIPromise<CustomerRetrieveEntitlementsResponse> {
|
|
210
|
-
|
|
231
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
232
|
+
return this._client.get(path`/api/v1/customers/${id}/entitlements`, {
|
|
233
|
+
query,
|
|
234
|
+
...options,
|
|
235
|
+
headers: buildHeaders([
|
|
236
|
+
{
|
|
237
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
238
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
239
|
+
},
|
|
240
|
+
options?.headers,
|
|
241
|
+
]),
|
|
242
|
+
});
|
|
211
243
|
}
|
|
212
244
|
|
|
213
245
|
/**
|
|
214
246
|
* Restores an archived customer, allowing them to create new subscriptions again.
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
247
|
+
*/
|
|
248
|
+
unarchive(
|
|
249
|
+
id: string,
|
|
250
|
+
params: CustomerUnarchiveParams | null | undefined = {},
|
|
251
|
+
options?: RequestOptions,
|
|
252
|
+
): APIPromise<CustomerResponse> {
|
|
253
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
254
|
+
return this._client.post(path`/api/v1/customers/${id}/unarchive`, {
|
|
255
|
+
...options,
|
|
256
|
+
headers: buildHeaders([
|
|
257
|
+
{
|
|
258
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
259
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
260
|
+
},
|
|
261
|
+
options?.headers,
|
|
262
|
+
]),
|
|
263
|
+
});
|
|
224
264
|
}
|
|
225
265
|
}
|
|
226
266
|
|
|
@@ -1936,9 +1976,24 @@ export namespace CustomerRetrieveEntitlementsResponse {
|
|
|
1936
1976
|
}
|
|
1937
1977
|
}
|
|
1938
1978
|
|
|
1979
|
+
export interface CustomerRetrieveParams {
|
|
1980
|
+
/**
|
|
1981
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
1982
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
1983
|
+
*/
|
|
1984
|
+
'X-ACCOUNT-ID'?: string;
|
|
1985
|
+
|
|
1986
|
+
/**
|
|
1987
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
1988
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
1989
|
+
* key).
|
|
1990
|
+
*/
|
|
1991
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1939
1994
|
export interface CustomerUpdateParams {
|
|
1940
1995
|
/**
|
|
1941
|
-
* The billing currency of the customer
|
|
1996
|
+
* Body param: The billing currency of the customer
|
|
1942
1997
|
*/
|
|
1943
1998
|
billingCurrency?:
|
|
1944
1999
|
| 'usd'
|
|
@@ -2060,49 +2115,62 @@ export interface CustomerUpdateParams {
|
|
|
2060
2115
|
| null;
|
|
2061
2116
|
|
|
2062
2117
|
/**
|
|
2063
|
-
* The unique identifier for the entity in the billing provider
|
|
2118
|
+
* Body param: The unique identifier for the entity in the billing provider
|
|
2064
2119
|
*/
|
|
2065
2120
|
billingId?: string | null;
|
|
2066
2121
|
|
|
2067
2122
|
/**
|
|
2068
|
-
* Customer level coupon
|
|
2123
|
+
* Body param: Customer level coupon
|
|
2069
2124
|
*/
|
|
2070
2125
|
couponId?: (string & {}) | '' | null;
|
|
2071
2126
|
|
|
2072
2127
|
/**
|
|
2073
|
-
* The email of the customer
|
|
2128
|
+
* Body param: The email of the customer
|
|
2074
2129
|
*/
|
|
2075
2130
|
email?: string | null;
|
|
2076
2131
|
|
|
2077
2132
|
/**
|
|
2078
|
-
* List of integrations
|
|
2133
|
+
* Body param: List of integrations
|
|
2079
2134
|
*/
|
|
2080
2135
|
integrations?: Array<CustomerUpdateParams.Integration>;
|
|
2081
2136
|
|
|
2082
2137
|
/**
|
|
2083
|
-
* Language to use for this customer
|
|
2138
|
+
* Body param: Language to use for this customer
|
|
2084
2139
|
*/
|
|
2085
2140
|
language?: string | null;
|
|
2086
2141
|
|
|
2087
2142
|
/**
|
|
2088
|
-
* Additional metadata
|
|
2143
|
+
* Body param: Additional metadata
|
|
2089
2144
|
*/
|
|
2090
2145
|
metadata?: { [key: string]: string };
|
|
2091
2146
|
|
|
2092
2147
|
/**
|
|
2093
|
-
* The name of the customer
|
|
2148
|
+
* Body param: The name of the customer
|
|
2094
2149
|
*/
|
|
2095
2150
|
name?: string | null;
|
|
2096
2151
|
|
|
2097
2152
|
/**
|
|
2098
|
-
* Vendor-specific billing passthrough fields.
|
|
2153
|
+
* Body param: Vendor-specific billing passthrough fields.
|
|
2099
2154
|
*/
|
|
2100
2155
|
passthrough?: CustomerUpdateParams.Passthrough;
|
|
2101
2156
|
|
|
2102
2157
|
/**
|
|
2103
|
-
* Timezone to use for this customer
|
|
2158
|
+
* Body param: Timezone to use for this customer
|
|
2104
2159
|
*/
|
|
2105
2160
|
timezone?: string | null;
|
|
2161
|
+
|
|
2162
|
+
/**
|
|
2163
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2164
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2165
|
+
*/
|
|
2166
|
+
'X-ACCOUNT-ID'?: string;
|
|
2167
|
+
|
|
2168
|
+
/**
|
|
2169
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2170
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2171
|
+
* intrinsic to the key).
|
|
2172
|
+
*/
|
|
2173
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2106
2174
|
}
|
|
2107
2175
|
|
|
2108
2176
|
export namespace CustomerUpdateParams {
|
|
@@ -2463,19 +2531,32 @@ export namespace CustomerUpdateParams {
|
|
|
2463
2531
|
|
|
2464
2532
|
export interface CustomerListParams extends MyCursorIDPageParams {
|
|
2465
2533
|
/**
|
|
2466
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
2534
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
2467
2535
|
*/
|
|
2468
2536
|
createdAt?: CustomerListParams.CreatedAt;
|
|
2469
2537
|
|
|
2470
2538
|
/**
|
|
2471
|
-
* Filter by exact customer email address
|
|
2539
|
+
* Query param: Filter by exact customer email address
|
|
2472
2540
|
*/
|
|
2473
2541
|
email?: string;
|
|
2474
2542
|
|
|
2475
2543
|
/**
|
|
2476
|
-
* Filter by exact customer name
|
|
2544
|
+
* Query param: Filter by exact customer name
|
|
2477
2545
|
*/
|
|
2478
2546
|
name?: string;
|
|
2547
|
+
|
|
2548
|
+
/**
|
|
2549
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2550
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2551
|
+
*/
|
|
2552
|
+
'X-ACCOUNT-ID'?: string;
|
|
2553
|
+
|
|
2554
|
+
/**
|
|
2555
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2556
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2557
|
+
* intrinsic to the key).
|
|
2558
|
+
*/
|
|
2559
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2479
2560
|
}
|
|
2480
2561
|
|
|
2481
2562
|
export namespace CustomerListParams {
|
|
@@ -2505,45 +2586,87 @@ export namespace CustomerListParams {
|
|
|
2505
2586
|
}
|
|
2506
2587
|
}
|
|
2507
2588
|
|
|
2589
|
+
export interface CustomerArchiveParams {
|
|
2590
|
+
/**
|
|
2591
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
2592
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
2593
|
+
*/
|
|
2594
|
+
'X-ACCOUNT-ID'?: string;
|
|
2595
|
+
|
|
2596
|
+
/**
|
|
2597
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
2598
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
2599
|
+
* key).
|
|
2600
|
+
*/
|
|
2601
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2602
|
+
}
|
|
2603
|
+
|
|
2508
2604
|
export interface CustomerCheckEntitlementParams {
|
|
2509
2605
|
/**
|
|
2510
|
-
* Currency ID (refId) to check for credit entitlements. Mutually
|
|
2511
|
-
* `featureId`.
|
|
2606
|
+
* Query param: Currency ID (refId) to check for credit entitlements. Mutually
|
|
2607
|
+
* exclusive with `featureId`.
|
|
2512
2608
|
*/
|
|
2513
2609
|
currencyId?: string;
|
|
2514
2610
|
|
|
2515
2611
|
/**
|
|
2516
|
-
* Feature ID (refId) to check. Mutually exclusive with `currencyId`.
|
|
2612
|
+
* Query param: Feature ID (refId) to check. Mutually exclusive with `currencyId`.
|
|
2517
2613
|
*/
|
|
2518
2614
|
featureId?: string;
|
|
2519
2615
|
|
|
2520
2616
|
/**
|
|
2521
|
-
* Requested usage amount to evaluate against the entitlement limit
|
|
2522
|
-
* features only)
|
|
2617
|
+
* Query param: Requested usage amount to evaluate against the entitlement limit
|
|
2618
|
+
* (numeric features only)
|
|
2523
2619
|
*/
|
|
2524
2620
|
requestedUsage?: number;
|
|
2525
2621
|
|
|
2526
2622
|
/**
|
|
2527
|
-
* Requested values to evaluate against allowed values (enum features
|
|
2623
|
+
* Query param: Requested values to evaluate against allowed values (enum features
|
|
2624
|
+
* only)
|
|
2528
2625
|
*/
|
|
2529
2626
|
requestedValues?: Array<string>;
|
|
2530
2627
|
|
|
2531
2628
|
/**
|
|
2532
|
-
* Resource ID to scope the entitlement check to a specific resource
|
|
2629
|
+
* Query param: Resource ID to scope the entitlement check to a specific resource
|
|
2533
2630
|
*/
|
|
2534
2631
|
resourceId?: string;
|
|
2632
|
+
|
|
2633
|
+
/**
|
|
2634
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2635
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2636
|
+
*/
|
|
2637
|
+
'X-ACCOUNT-ID'?: string;
|
|
2638
|
+
|
|
2639
|
+
/**
|
|
2640
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2641
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2642
|
+
* intrinsic to the key).
|
|
2643
|
+
*/
|
|
2644
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2535
2645
|
}
|
|
2536
2646
|
|
|
2537
2647
|
export interface CustomerImportParams {
|
|
2538
2648
|
/**
|
|
2539
|
-
* List of customer objects to import
|
|
2649
|
+
* Body param: List of customer objects to import
|
|
2540
2650
|
*/
|
|
2541
2651
|
customers: Array<CustomerImportParams.Customer>;
|
|
2542
2652
|
|
|
2543
2653
|
/**
|
|
2544
|
-
* Integration details
|
|
2654
|
+
* Body param: Integration details
|
|
2545
2655
|
*/
|
|
2546
2656
|
integrationId?: string;
|
|
2657
|
+
|
|
2658
|
+
/**
|
|
2659
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2660
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2661
|
+
*/
|
|
2662
|
+
'X-ACCOUNT-ID'?: string;
|
|
2663
|
+
|
|
2664
|
+
/**
|
|
2665
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2666
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2667
|
+
* intrinsic to the key).
|
|
2668
|
+
*/
|
|
2669
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2547
2670
|
}
|
|
2548
2671
|
|
|
2549
2672
|
export namespace CustomerImportParams {
|
|
@@ -2590,16 +2713,29 @@ export namespace CustomerImportParams {
|
|
|
2590
2713
|
}
|
|
2591
2714
|
}
|
|
2592
2715
|
|
|
2593
|
-
export interface CustomerListResourcesParams extends MyCursorIDPageParams {
|
|
2716
|
+
export interface CustomerListResourcesParams extends MyCursorIDPageParams {
|
|
2717
|
+
/**
|
|
2718
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2719
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2720
|
+
*/
|
|
2721
|
+
'X-ACCOUNT-ID'?: string;
|
|
2722
|
+
|
|
2723
|
+
/**
|
|
2724
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2725
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2726
|
+
* intrinsic to the key).
|
|
2727
|
+
*/
|
|
2728
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2729
|
+
}
|
|
2594
2730
|
|
|
2595
2731
|
export interface CustomerProvisionParams {
|
|
2596
2732
|
/**
|
|
2597
|
-
* Customer slug
|
|
2733
|
+
* Body param: Customer slug
|
|
2598
2734
|
*/
|
|
2599
2735
|
id: string;
|
|
2600
2736
|
|
|
2601
2737
|
/**
|
|
2602
|
-
* The billing currency of the customer
|
|
2738
|
+
* Body param: The billing currency of the customer
|
|
2603
2739
|
*/
|
|
2604
2740
|
billingCurrency?:
|
|
2605
2741
|
| 'usd'
|
|
@@ -2721,54 +2857,67 @@ export interface CustomerProvisionParams {
|
|
|
2721
2857
|
| null;
|
|
2722
2858
|
|
|
2723
2859
|
/**
|
|
2724
|
-
* The unique identifier for the entity in the billing provider
|
|
2860
|
+
* Body param: The unique identifier for the entity in the billing provider
|
|
2725
2861
|
*/
|
|
2726
2862
|
billingId?: string | null;
|
|
2727
2863
|
|
|
2728
2864
|
/**
|
|
2729
|
-
* Customer level coupon
|
|
2865
|
+
* Body param: Customer level coupon
|
|
2730
2866
|
*/
|
|
2731
2867
|
couponId?: (string & {}) | '' | null;
|
|
2732
2868
|
|
|
2733
2869
|
/**
|
|
2734
|
-
* The default payment method details
|
|
2870
|
+
* Body param: The default payment method details
|
|
2735
2871
|
*/
|
|
2736
2872
|
defaultPaymentMethod?: CustomerProvisionParams.DefaultPaymentMethod | null;
|
|
2737
2873
|
|
|
2738
2874
|
/**
|
|
2739
|
-
* The email of the customer
|
|
2875
|
+
* Body param: The email of the customer
|
|
2740
2876
|
*/
|
|
2741
2877
|
email?: string | null;
|
|
2742
2878
|
|
|
2743
2879
|
/**
|
|
2744
|
-
* List of integrations
|
|
2880
|
+
* Body param: List of integrations
|
|
2745
2881
|
*/
|
|
2746
2882
|
integrations?: Array<CustomerProvisionParams.Integration>;
|
|
2747
2883
|
|
|
2748
2884
|
/**
|
|
2749
|
-
* Language to use for this customer
|
|
2885
|
+
* Body param: Language to use for this customer
|
|
2750
2886
|
*/
|
|
2751
2887
|
language?: string | null;
|
|
2752
2888
|
|
|
2753
2889
|
/**
|
|
2754
|
-
* Additional metadata
|
|
2890
|
+
* Body param: Additional metadata
|
|
2755
2891
|
*/
|
|
2756
2892
|
metadata?: { [key: string]: string };
|
|
2757
2893
|
|
|
2758
2894
|
/**
|
|
2759
|
-
* The name of the customer
|
|
2895
|
+
* Body param: The name of the customer
|
|
2760
2896
|
*/
|
|
2761
2897
|
name?: string | null;
|
|
2762
2898
|
|
|
2763
2899
|
/**
|
|
2764
|
-
* Vendor-specific billing passthrough fields.
|
|
2900
|
+
* Body param: Vendor-specific billing passthrough fields.
|
|
2765
2901
|
*/
|
|
2766
2902
|
passthrough?: CustomerProvisionParams.Passthrough;
|
|
2767
2903
|
|
|
2768
2904
|
/**
|
|
2769
|
-
* Timezone to use for this customer
|
|
2905
|
+
* Body param: Timezone to use for this customer
|
|
2770
2906
|
*/
|
|
2771
2907
|
timezone?: string | null;
|
|
2908
|
+
|
|
2909
|
+
/**
|
|
2910
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2911
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2912
|
+
*/
|
|
2913
|
+
'X-ACCOUNT-ID'?: string;
|
|
2914
|
+
|
|
2915
|
+
/**
|
|
2916
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2917
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2918
|
+
* intrinsic to the key).
|
|
2919
|
+
*/
|
|
2920
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2772
2921
|
}
|
|
2773
2922
|
|
|
2774
2923
|
export namespace CustomerProvisionParams {
|
|
@@ -3159,9 +3308,37 @@ export namespace CustomerProvisionParams {
|
|
|
3159
3308
|
|
|
3160
3309
|
export interface CustomerRetrieveEntitlementsParams {
|
|
3161
3310
|
/**
|
|
3162
|
-
* Resource ID to scope entitlements to a specific resource
|
|
3311
|
+
* Query param: Resource ID to scope entitlements to a specific resource
|
|
3163
3312
|
*/
|
|
3164
3313
|
resourceId?: string;
|
|
3314
|
+
|
|
3315
|
+
/**
|
|
3316
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
3317
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
3318
|
+
*/
|
|
3319
|
+
'X-ACCOUNT-ID'?: string;
|
|
3320
|
+
|
|
3321
|
+
/**
|
|
3322
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
3323
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
3324
|
+
* intrinsic to the key).
|
|
3325
|
+
*/
|
|
3326
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
3327
|
+
}
|
|
3328
|
+
|
|
3329
|
+
export interface CustomerUnarchiveParams {
|
|
3330
|
+
/**
|
|
3331
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
3332
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
3333
|
+
*/
|
|
3334
|
+
'X-ACCOUNT-ID'?: string;
|
|
3335
|
+
|
|
3336
|
+
/**
|
|
3337
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
3338
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
3339
|
+
* key).
|
|
3340
|
+
*/
|
|
3341
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
3165
3342
|
}
|
|
3166
3343
|
|
|
3167
3344
|
Customers.PaymentMethod = PaymentMethod;
|
|
@@ -3179,16 +3356,23 @@ export declare namespace Customers {
|
|
|
3179
3356
|
type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
|
|
3180
3357
|
type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
|
|
3181
3358
|
type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
|
|
3359
|
+
type CustomerRetrieveParams as CustomerRetrieveParams,
|
|
3182
3360
|
type CustomerUpdateParams as CustomerUpdateParams,
|
|
3183
3361
|
type CustomerListParams as CustomerListParams,
|
|
3362
|
+
type CustomerArchiveParams as CustomerArchiveParams,
|
|
3184
3363
|
type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams,
|
|
3185
3364
|
type CustomerImportParams as CustomerImportParams,
|
|
3186
3365
|
type CustomerListResourcesParams as CustomerListResourcesParams,
|
|
3187
3366
|
type CustomerProvisionParams as CustomerProvisionParams,
|
|
3188
3367
|
type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
|
|
3368
|
+
type CustomerUnarchiveParams as CustomerUnarchiveParams,
|
|
3189
3369
|
};
|
|
3190
3370
|
|
|
3191
|
-
export {
|
|
3371
|
+
export {
|
|
3372
|
+
PaymentMethod as PaymentMethod,
|
|
3373
|
+
type PaymentMethodAttachParams as PaymentMethodAttachParams,
|
|
3374
|
+
type PaymentMethodDetachParams as PaymentMethodDetachParams,
|
|
3375
|
+
};
|
|
3192
3376
|
|
|
3193
3377
|
export {
|
|
3194
3378
|
PromotionalEntitlements as PromotionalEntitlements,
|