@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +406 -0
- package/README.md +9 -0
- package/client.d.mts +10 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -9
- package/client.d.ts.map +1 -1
- package/client.js +32 -26
- package/client.js.map +1 -1
- package/client.mjs +33 -27
- package/client.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/tslib.js +17 -17
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/internal/utils/query.d.mts +2 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +10 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils.d.mts +1 -0
- package/internal/utils.d.ts +1 -0
- package/internal/utils.js +1 -0
- package/internal/utils.js.map +1 -1
- package/internal/utils.mjs +1 -0
- package/package.json +12 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- 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 +2 -1
- package/resources/index.mjs.map +1 -1
- package/resources/internal/beta/beta.d.mts +10 -0
- package/resources/internal/beta/beta.d.mts.map +1 -0
- package/resources/internal/beta/beta.d.ts +10 -0
- package/resources/internal/beta/beta.d.ts.map +1 -0
- package/resources/internal/beta/beta.js +17 -0
- package/resources/internal/beta/beta.js.map +1 -0
- package/resources/internal/beta/beta.mjs +12 -0
- package/resources/internal/beta/beta.mjs.map +1 -0
- package/resources/internal/beta/event-queues.d.mts +171 -0
- package/resources/internal/beta/event-queues.d.mts.map +1 -0
- package/resources/internal/beta/event-queues.d.ts +171 -0
- package/resources/internal/beta/event-queues.d.ts.map +1 -0
- package/resources/internal/beta/event-queues.js +40 -0
- package/resources/internal/beta/event-queues.js.map +1 -0
- package/resources/internal/beta/event-queues.mjs +36 -0
- package/resources/internal/beta/event-queues.mjs.map +1 -0
- package/resources/internal/beta/index.d.mts +3 -0
- package/resources/internal/beta/index.d.mts.map +1 -0
- package/resources/internal/beta/index.d.ts +3 -0
- package/resources/internal/beta/index.d.ts.map +1 -0
- package/resources/internal/beta/index.js +9 -0
- package/resources/internal/beta/index.js.map +1 -0
- package/resources/internal/beta/index.mjs +4 -0
- package/resources/internal/beta/index.mjs.map +1 -0
- package/resources/internal/beta.d.mts +2 -0
- package/resources/internal/beta.d.mts.map +1 -0
- package/resources/internal/beta.d.ts +2 -0
- package/resources/internal/beta.d.ts.map +1 -0
- package/resources/internal/beta.js +6 -0
- package/resources/internal/beta.js.map +1 -0
- package/resources/internal/beta.mjs +3 -0
- package/resources/internal/beta.mjs.map +1 -0
- package/resources/internal/index.d.mts +3 -0
- package/resources/internal/index.d.mts.map +1 -0
- package/resources/internal/index.d.ts +3 -0
- package/resources/internal/index.d.ts.map +1 -0
- package/resources/internal/index.js +9 -0
- package/resources/internal/index.js.map +1 -0
- package/resources/internal/index.mjs +4 -0
- package/resources/internal/index.mjs.map +1 -0
- package/resources/internal/internal.d.mts +10 -0
- package/resources/internal/internal.d.mts.map +1 -0
- package/resources/internal/internal.d.ts +10 -0
- package/resources/internal/internal.d.ts.map +1 -0
- package/resources/internal/internal.js +17 -0
- package/resources/internal/internal.js.map +1 -0
- package/resources/internal/internal.mjs +12 -0
- package/resources/internal/internal.mjs.map +1 -0
- package/resources/internal.d.mts +2 -0
- package/resources/internal.d.mts.map +1 -0
- package/resources/internal.d.ts +2 -0
- package/resources/internal.d.ts.map +1 -0
- package/resources/internal.js +6 -0
- package/resources/internal.js.map +1 -0
- package/resources/internal.mjs +3 -0
- package/resources/internal.mjs.map +1 -0
- package/resources/v1/addons/addons.d.mts +828 -0
- package/resources/v1/addons/addons.d.mts.map +1 -0
- package/resources/v1/addons/addons.d.ts +828 -0
- package/resources/v1/addons/addons.d.ts.map +1 -0
- package/resources/v1/addons/addons.js +75 -0
- package/resources/v1/addons/addons.js.map +1 -0
- package/resources/v1/addons/addons.mjs +70 -0
- package/resources/v1/addons/addons.mjs.map +1 -0
- package/resources/v1/addons/entitlements.d.mts +888 -0
- package/resources/v1/addons/entitlements.d.mts.map +1 -0
- package/resources/v1/addons/entitlements.d.ts +888 -0
- package/resources/v1/addons/entitlements.d.ts.map +1 -0
- package/resources/v1/addons/entitlements.js +36 -0
- package/resources/v1/addons/entitlements.js.map +1 -0
- package/resources/v1/addons/entitlements.mjs +32 -0
- package/resources/v1/addons/entitlements.mjs.map +1 -0
- package/resources/v1/addons/index.d.mts +3 -0
- package/resources/v1/addons/index.d.mts.map +1 -0
- package/resources/v1/addons/index.d.ts +3 -0
- package/resources/v1/addons/index.d.ts.map +1 -0
- package/resources/v1/addons/index.js +9 -0
- package/resources/v1/addons/index.js.map +1 -0
- package/resources/v1/addons/index.mjs +4 -0
- package/resources/v1/addons/index.mjs.map +1 -0
- package/resources/v1/addons.d.mts +2 -0
- package/resources/v1/addons.d.mts.map +1 -0
- package/resources/v1/addons.d.ts +2 -0
- package/resources/v1/addons.d.ts.map +1 -0
- package/resources/v1/addons.js +6 -0
- package/resources/v1/addons.js.map +1 -0
- package/resources/v1/addons.mjs +3 -0
- package/resources/v1/addons.mjs.map +1 -0
- package/resources/v1/coupons.d.mts +94 -96
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +94 -96
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +19 -3
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +19 -3
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +1214 -48
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +1214 -48
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +48 -15
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +48 -15
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +3 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +3 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +5 -3
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +2 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +142 -0
- package/resources/v1/customers/integrations.d.mts.map +1 -0
- package/resources/v1/customers/integrations.d.ts +142 -0
- package/resources/v1/customers/integrations.d.ts.map +1 -0
- package/resources/v1/customers/integrations.js +50 -0
- package/resources/v1/customers/integrations.js.map +1 -0
- package/resources/v1/customers/integrations.mjs +46 -0
- package/resources/v1/customers/integrations.mjs.map +1 -0
- package/resources/v1/customers/payment-method.d.mts +7 -2
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +7 -2
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +7 -2
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +7 -2
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +501 -0
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
- package/resources/v1/customers/promotional-entitlements.d.ts +501 -0
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
- package/resources/v1/customers/promotional-entitlements.js +35 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -0
- package/resources/v1/customers/promotional-entitlements.mjs +31 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
- package/resources/v1/events/credits/credits.d.mts +270 -0
- package/resources/v1/events/credits/credits.d.mts.map +1 -0
- package/resources/v1/events/credits/credits.d.ts +270 -0
- package/resources/v1/events/credits/credits.d.ts.map +1 -0
- package/resources/v1/events/credits/credits.js +41 -0
- package/resources/v1/events/credits/credits.js.map +1 -0
- package/resources/v1/events/credits/credits.mjs +36 -0
- package/resources/v1/events/credits/credits.mjs.map +1 -0
- package/resources/v1/events/credits/grants.d.mts +549 -0
- package/resources/v1/events/credits/grants.d.mts.map +1 -0
- package/resources/v1/events/credits/grants.d.ts +549 -0
- package/resources/v1/events/credits/grants.d.ts.map +1 -0
- package/resources/v1/events/credits/grants.js +37 -0
- package/resources/v1/events/credits/grants.js.map +1 -0
- package/resources/v1/events/credits/grants.mjs +33 -0
- package/resources/v1/events/credits/grants.mjs.map +1 -0
- package/resources/v1/events/credits/index.d.mts +3 -0
- package/resources/v1/events/credits/index.d.mts.map +1 -0
- package/resources/v1/events/credits/index.d.ts +3 -0
- package/resources/v1/events/credits/index.d.ts.map +1 -0
- package/resources/v1/events/credits/index.js +9 -0
- package/resources/v1/events/credits/index.js.map +1 -0
- package/resources/v1/events/credits/index.mjs +4 -0
- package/resources/v1/events/credits/index.mjs.map +1 -0
- package/resources/v1/events/credits.d.mts +2 -0
- package/resources/v1/events/credits.d.mts.map +1 -0
- package/resources/v1/events/credits.d.ts +2 -0
- package/resources/v1/events/credits.d.ts.map +1 -0
- package/resources/v1/events/credits.js +6 -0
- package/resources/v1/events/credits.js.map +1 -0
- package/resources/v1/events/credits.mjs +3 -0
- package/resources/v1/events/credits.mjs.map +1 -0
- package/resources/v1/events/events.d.mts +70 -0
- package/resources/v1/events/events.d.mts.map +1 -0
- package/resources/v1/events/events.d.ts +70 -0
- package/resources/v1/events/events.d.ts.map +1 -0
- package/resources/v1/events/events.js +27 -0
- package/resources/v1/events/events.js.map +1 -0
- package/resources/v1/events/events.mjs +22 -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 +2 -0
- package/resources/v1/events.d.mts.map +1 -0
- package/resources/v1/events.d.ts +2 -0
- package/resources/v1/events.d.ts.map +1 -0
- package/resources/v1/events.js +6 -0
- package/resources/v1/events.js.map +1 -0
- package/resources/v1/events.mjs +3 -0
- package/resources/v1/events.mjs.map +1 -0
- package/resources/v1/features.d.mts +456 -0
- package/resources/v1/features.d.mts.map +1 -0
- package/resources/v1/features.d.ts +456 -0
- package/resources/v1/features.d.ts.map +1 -0
- package/resources/v1/features.js +54 -0
- package/resources/v1/features.js.map +1 -0
- package/resources/v1/features.mjs +50 -0
- package/resources/v1/features.mjs.map +1 -0
- package/resources/v1/index.d.mts +10 -4
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +10 -4
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +17 -5
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +7 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +888 -0
- package/resources/v1/plans/entitlements.d.mts.map +1 -0
- package/resources/v1/plans/entitlements.d.ts +888 -0
- package/resources/v1/plans/entitlements.d.ts.map +1 -0
- package/resources/v1/plans/entitlements.js +36 -0
- package/resources/v1/plans/entitlements.js.map +1 -0
- package/resources/v1/plans/entitlements.mjs +32 -0
- package/resources/v1/plans/entitlements.mjs.map +1 -0
- package/resources/v1/plans/index.d.mts +3 -0
- package/resources/v1/plans/index.d.mts.map +1 -0
- package/resources/v1/plans/index.d.ts +3 -0
- package/resources/v1/plans/index.d.ts.map +1 -0
- package/resources/v1/plans/index.js +9 -0
- package/resources/v1/plans/index.js.map +1 -0
- package/resources/v1/plans/index.mjs +4 -0
- package/resources/v1/plans/index.mjs.map +1 -0
- package/resources/v1/plans/plans.d.mts +977 -0
- package/resources/v1/plans/plans.d.mts.map +1 -0
- package/resources/v1/plans/plans.d.ts +977 -0
- package/resources/v1/plans/plans.d.ts.map +1 -0
- package/resources/v1/plans/plans.js +72 -0
- package/resources/v1/plans/plans.js.map +1 -0
- package/resources/v1/plans/plans.mjs +67 -0
- package/resources/v1/plans/plans.mjs.map +1 -0
- package/resources/v1/plans.d.mts +2 -0
- package/resources/v1/plans.d.mts.map +1 -0
- package/resources/v1/plans.d.ts +2 -0
- package/resources/v1/plans.d.ts.map +1 -0
- package/resources/v1/plans.js +6 -0
- package/resources/v1/plans.js.map +1 -0
- package/resources/v1/plans.mjs +3 -0
- package/resources/v1/plans.mjs.map +1 -0
- package/resources/v1/products.d.mts +339 -0
- package/resources/v1/products.d.mts.map +1 -0
- package/resources/v1/products.d.ts +339 -0
- package/resources/v1/products.d.ts.map +1 -0
- package/resources/v1/products.js +55 -0
- package/resources/v1/products.js.map +1 -0
- package/resources/v1/products.mjs +51 -0
- package/resources/v1/products.mjs.map +1 -0
- package/resources/v1/subscriptions/future-update.d.mts +12 -22
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +12 -22
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +6 -2
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +6 -2
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -2
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -2
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js +5 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +3 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +37 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -0
- package/resources/v1/subscriptions/invoice.d.ts +37 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -0
- package/resources/v1/subscriptions/invoice.js +20 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -0
- package/resources/v1/subscriptions/invoice.mjs +16 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -0
- package/resources/v1/subscriptions/subscriptions.d.mts +1926 -915
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +1926 -915
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +47 -11
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +49 -13
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +101 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -0
- package/resources/v1/subscriptions/usage.d.ts +101 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -0
- package/resources/v1/subscriptions/usage.js +27 -0
- package/resources/v1/subscriptions/usage.js.map +1 -0
- package/resources/v1/subscriptions/usage.mjs +23 -0
- package/resources/v1/subscriptions/usage.mjs.map +1 -0
- package/resources/v1/usage.d.mts +233 -0
- package/resources/v1/usage.d.mts.map +1 -0
- package/resources/v1/usage.d.ts +233 -0
- package/resources/v1/usage.d.ts.map +1 -0
- package/resources/v1/usage.js +27 -0
- package/resources/v1/usage.js.map +1 -0
- package/resources/v1/usage.mjs +23 -0
- package/resources/v1/usage.mjs.map +1 -0
- package/resources/v1/v1.d.mts +30 -172
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +30 -172
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +24 -12
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +24 -12
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +46 -47
- package/src/internal/parse.ts +6 -0
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/utils/env.ts +2 -2
- package/src/internal/utils/query.ts +7 -0
- package/src/internal/utils.ts +1 -0
- package/src/resources/index.ts +2 -7
- package/src/resources/internal/beta/beta.ts +27 -0
- package/src/resources/internal/beta/event-queues.ts +554 -0
- package/src/resources/internal/beta/index.ts +10 -0
- package/src/resources/internal/beta.ts +3 -0
- package/src/resources/internal/index.ts +4 -0
- package/src/resources/internal/internal.ts +15 -0
- package/src/resources/internal.ts +3 -0
- package/src/resources/v1/addons/addons.ts +1856 -0
- package/src/resources/v1/addons/entitlements.ts +1153 -0
- package/src/resources/v1/addons/index.ts +23 -0
- package/src/resources/v1/addons.ts +3 -0
- package/src/resources/v1/coupons.ts +106 -229
- package/src/resources/v1/customers/customers.ts +2465 -60
- package/src/resources/v1/customers/index.ts +29 -2
- package/src/resources/v1/customers/integrations.ts +241 -0
- package/src/resources/v1/customers/payment-method.ts +7 -2
- package/src/resources/v1/customers/promotional-entitlements.ts +672 -0
- package/src/resources/v1/events/credits/credits.ts +370 -0
- package/src/resources/v1/events/credits/grants.ts +795 -0
- package/src/resources/v1/events/credits/index.ts +20 -0
- package/src/resources/v1/events/credits.ts +3 -0
- package/src/resources/v1/events/events.ts +103 -0
- package/src/resources/v1/events/index.ts +13 -0
- package/src/resources/v1/events.ts +3 -0
- package/src/resources/v1/features.ts +583 -0
- package/src/resources/v1/index.ts +69 -15
- package/src/resources/v1/plans/entitlements.ts +1145 -0
- package/src/resources/v1/plans/index.ts +23 -0
- package/src/resources/v1/plans/plans.ts +2029 -0
- package/src/resources/v1/plans.ts +3 -0
- package/src/resources/v1/products.ts +430 -0
- package/src/resources/v1/subscriptions/future-update.ts +12 -30
- package/src/resources/v1/subscriptions/index.ts +15 -11
- package/src/resources/v1/subscriptions/invoice.ts +45 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +5302 -2289
- package/src/resources/v1/subscriptions/usage.ts +129 -0
- package/src/resources/v1/usage.ts +287 -0
- package/src/resources/v1/v1.ts +166 -220
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/v1/customers/usage.d.mts +0 -4
- package/resources/v1/customers/usage.d.mts.map +0 -1
- package/resources/v1/customers/usage.d.ts +0 -4
- package/resources/v1/customers/usage.d.ts.map +0 -1
- package/resources/v1/customers/usage.js +0 -9
- package/resources/v1/customers/usage.js.map +0 -1
- package/resources/v1/customers/usage.mjs +0 -5
- package/resources/v1/customers/usage.mjs.map +0 -1
- package/src/resources/v1/customers/usage.ts +0 -5
|
@@ -1,40 +1,142 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import * as IntegrationsAPI from "./integrations.js";
|
|
3
|
+
import { IntegrationLinkParams, IntegrationListParams, IntegrationListResponse, IntegrationListResponsesMyCursorIDPage, IntegrationRetrieveParams, IntegrationUnlinkParams, IntegrationUpdateParams, Integrations } from "./integrations.js";
|
|
2
4
|
import * as PaymentMethodAPI from "./payment-method.js";
|
|
3
5
|
import { PaymentMethod, PaymentMethodAttachParams } from "./payment-method.js";
|
|
4
|
-
import * as
|
|
5
|
-
import {
|
|
6
|
+
import * as PromotionalEntitlementsAPI from "./promotional-entitlements.js";
|
|
7
|
+
import { PromotionalEntitlementCreateParams, PromotionalEntitlementCreateResponse, PromotionalEntitlementListParams, PromotionalEntitlementListResponse, PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementRevokeParams, PromotionalEntitlementRevokeResponse, PromotionalEntitlements } from "./promotional-entitlements.js";
|
|
6
8
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
7
9
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
|
|
8
10
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
9
11
|
export declare class Customers extends APIResource {
|
|
10
12
|
paymentMethod: PaymentMethodAPI.PaymentMethod;
|
|
11
|
-
|
|
13
|
+
promotionalEntitlements: PromotionalEntitlementsAPI.PromotionalEntitlements;
|
|
14
|
+
integrations: IntegrationsAPI.Integrations;
|
|
12
15
|
/**
|
|
13
|
-
*
|
|
14
|
-
|
|
15
|
-
create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
16
|
-
/**
|
|
17
|
-
* Get a single customer by ID
|
|
16
|
+
* Retrieves a customer by their unique identifier, including billing information
|
|
17
|
+
* and subscription status.
|
|
18
18
|
*/
|
|
19
19
|
retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Updates an existing customer's properties such as name, email, and billing
|
|
22
|
+
* information.
|
|
22
23
|
*/
|
|
23
24
|
update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
24
25
|
/**
|
|
25
|
-
*
|
|
26
|
+
* Retrieves a paginated list of customers in the environment.
|
|
26
27
|
*/
|
|
27
28
|
list(query?: CustomerListParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResponsesMyCursorIDPage, CustomerListResponse>;
|
|
28
29
|
/**
|
|
29
|
-
*
|
|
30
|
+
* Archives a customer, preventing new subscriptions. Optionally cancels existing
|
|
31
|
+
* subscriptions.
|
|
30
32
|
*/
|
|
31
33
|
archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
32
34
|
/**
|
|
33
|
-
*
|
|
35
|
+
* Imports multiple customers in bulk. Used for migrating customer data from
|
|
36
|
+
* external systems.
|
|
37
|
+
*/
|
|
38
|
+
import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves a paginated list of resources within the same customer.
|
|
41
|
+
*/
|
|
42
|
+
listResources(id: string, query?: CustomerListResourcesParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse>;
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new customer and optionally provisions an initial subscription in a
|
|
45
|
+
* single operation.
|
|
46
|
+
*/
|
|
47
|
+
provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Retrieves the effective entitlements for a customer or resource, including
|
|
50
|
+
* feature and credit entitlements.
|
|
51
|
+
*
|
|
52
|
+
* **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
|
|
53
|
+
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
54
|
+
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
55
|
+
* with caching or the Sidecar for low-latency cached responses.
|
|
56
|
+
*/
|
|
57
|
+
retrieveEntitlements(id: string, query?: CustomerRetrieveEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<CustomerRetrieveEntitlementsResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Restores an archived customer, allowing them to create new subscriptions again.
|
|
34
60
|
*/
|
|
35
61
|
unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
36
62
|
}
|
|
37
63
|
export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResponse>;
|
|
64
|
+
export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
|
|
65
|
+
/**
|
|
66
|
+
* Response object
|
|
67
|
+
*/
|
|
68
|
+
export interface CustomerIntegrationResponse {
|
|
69
|
+
/**
|
|
70
|
+
* External billing or CRM integration link
|
|
71
|
+
*/
|
|
72
|
+
data: CustomerIntegrationResponse.Data;
|
|
73
|
+
}
|
|
74
|
+
export declare namespace CustomerIntegrationResponse {
|
|
75
|
+
/**
|
|
76
|
+
* External billing or CRM integration link
|
|
77
|
+
*/
|
|
78
|
+
interface Data {
|
|
79
|
+
/**
|
|
80
|
+
* Integration details
|
|
81
|
+
*/
|
|
82
|
+
id: string;
|
|
83
|
+
/**
|
|
84
|
+
* Synced entity id
|
|
85
|
+
*/
|
|
86
|
+
syncedEntityId: string | null;
|
|
87
|
+
/**
|
|
88
|
+
* The vendor identifier of integration
|
|
89
|
+
*/
|
|
90
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
91
|
+
/**
|
|
92
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
93
|
+
* group package billing ID
|
|
94
|
+
*/
|
|
95
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
96
|
+
}
|
|
97
|
+
namespace Data {
|
|
98
|
+
/**
|
|
99
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
100
|
+
* group package billing ID
|
|
101
|
+
*/
|
|
102
|
+
interface SyncRevisionPriceBillingData {
|
|
103
|
+
/**
|
|
104
|
+
* Billing integration id
|
|
105
|
+
*/
|
|
106
|
+
billingId: string;
|
|
107
|
+
/**
|
|
108
|
+
* Billing integration url
|
|
109
|
+
*/
|
|
110
|
+
billingLinkUrl: string;
|
|
111
|
+
/**
|
|
112
|
+
* Price group package billing id
|
|
113
|
+
*/
|
|
114
|
+
priceGroupPackageBillingId: string;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Billing sync revision data containing billing ID and link URL
|
|
118
|
+
*/
|
|
119
|
+
interface SyncRevisionBillingData {
|
|
120
|
+
/**
|
|
121
|
+
* Billing integration id
|
|
122
|
+
*/
|
|
123
|
+
billingId: string;
|
|
124
|
+
/**
|
|
125
|
+
* Billing integration url
|
|
126
|
+
*/
|
|
127
|
+
billingLinkUrl: string;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Marketplace sync revision data containing dimensions
|
|
131
|
+
*/
|
|
132
|
+
interface SyncRevisionMarketplaceData {
|
|
133
|
+
/**
|
|
134
|
+
* Dimensions of the marketplace sync revision
|
|
135
|
+
*/
|
|
136
|
+
dimensions: string;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
38
140
|
/**
|
|
39
141
|
* Response object
|
|
40
142
|
*/
|
|
@@ -65,10 +167,18 @@ export declare namespace CustomerResponse {
|
|
|
65
167
|
* Timestamp of when the record was last updated
|
|
66
168
|
*/
|
|
67
169
|
updatedAt: string;
|
|
170
|
+
/**
|
|
171
|
+
* The billing currency of the customer
|
|
172
|
+
*/
|
|
173
|
+
billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
|
|
174
|
+
/**
|
|
175
|
+
* The unique identifier for the entity in the billing provider
|
|
176
|
+
*/
|
|
177
|
+
billingId?: string | null;
|
|
68
178
|
/**
|
|
69
179
|
* Customer level coupon
|
|
70
180
|
*/
|
|
71
|
-
couponId?: string | null;
|
|
181
|
+
couponId?: (string & {}) | '' | null;
|
|
72
182
|
/**
|
|
73
183
|
* The default payment method details
|
|
74
184
|
*/
|
|
@@ -81,6 +191,10 @@ export declare namespace CustomerResponse {
|
|
|
81
191
|
* List of integrations
|
|
82
192
|
*/
|
|
83
193
|
integrations?: Array<Data.Integration>;
|
|
194
|
+
/**
|
|
195
|
+
* Language to use for this customer
|
|
196
|
+
*/
|
|
197
|
+
language?: string | null;
|
|
84
198
|
/**
|
|
85
199
|
* Additional metadata
|
|
86
200
|
*/
|
|
@@ -91,6 +205,14 @@ export declare namespace CustomerResponse {
|
|
|
91
205
|
* The name of the customer
|
|
92
206
|
*/
|
|
93
207
|
name?: string | null;
|
|
208
|
+
/**
|
|
209
|
+
* Vendor-specific billing passthrough fields.
|
|
210
|
+
*/
|
|
211
|
+
passthrough?: Data.Passthrough;
|
|
212
|
+
/**
|
|
213
|
+
* Timezone to use for this customer
|
|
214
|
+
*/
|
|
215
|
+
timezone?: string | null;
|
|
94
216
|
}
|
|
95
217
|
namespace Data {
|
|
96
218
|
/**
|
|
@@ -135,6 +257,185 @@ export declare namespace CustomerResponse {
|
|
|
135
257
|
*/
|
|
136
258
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
137
259
|
}
|
|
260
|
+
/**
|
|
261
|
+
* Vendor-specific billing passthrough fields.
|
|
262
|
+
*/
|
|
263
|
+
interface Passthrough {
|
|
264
|
+
/**
|
|
265
|
+
* Stripe-specific billing fields for the customer.
|
|
266
|
+
*/
|
|
267
|
+
stripe?: Passthrough.Stripe;
|
|
268
|
+
/**
|
|
269
|
+
* Zuora-specific billing fields for the customer.
|
|
270
|
+
*/
|
|
271
|
+
zuora?: Passthrough.Zuora;
|
|
272
|
+
}
|
|
273
|
+
namespace Passthrough {
|
|
274
|
+
/**
|
|
275
|
+
* Stripe-specific billing fields for the customer.
|
|
276
|
+
*/
|
|
277
|
+
interface Stripe {
|
|
278
|
+
/**
|
|
279
|
+
* Physical address
|
|
280
|
+
*/
|
|
281
|
+
billingAddress?: Stripe.BillingAddress;
|
|
282
|
+
/**
|
|
283
|
+
* Customer name
|
|
284
|
+
*/
|
|
285
|
+
customerName?: string;
|
|
286
|
+
/**
|
|
287
|
+
* Invoice custom fields
|
|
288
|
+
*/
|
|
289
|
+
invoiceCustomFields?: {
|
|
290
|
+
[key: string]: string;
|
|
291
|
+
};
|
|
292
|
+
/**
|
|
293
|
+
* Additional metadata
|
|
294
|
+
*/
|
|
295
|
+
metadata?: {
|
|
296
|
+
[key: string]: string;
|
|
297
|
+
};
|
|
298
|
+
/**
|
|
299
|
+
* Billing provider payment method id, attached to this customer
|
|
300
|
+
*/
|
|
301
|
+
paymentMethodId?: string;
|
|
302
|
+
/**
|
|
303
|
+
* Physical address
|
|
304
|
+
*/
|
|
305
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
306
|
+
/**
|
|
307
|
+
* Tax IDs
|
|
308
|
+
*/
|
|
309
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
310
|
+
}
|
|
311
|
+
namespace Stripe {
|
|
312
|
+
/**
|
|
313
|
+
* Physical address
|
|
314
|
+
*/
|
|
315
|
+
interface BillingAddress {
|
|
316
|
+
/**
|
|
317
|
+
* City name
|
|
318
|
+
*/
|
|
319
|
+
city?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Country code or name
|
|
322
|
+
*/
|
|
323
|
+
country?: string;
|
|
324
|
+
/**
|
|
325
|
+
* Street address line 1
|
|
326
|
+
*/
|
|
327
|
+
line1?: string;
|
|
328
|
+
/**
|
|
329
|
+
* Street address line 2
|
|
330
|
+
*/
|
|
331
|
+
line2?: string;
|
|
332
|
+
/**
|
|
333
|
+
* Postal or ZIP code
|
|
334
|
+
*/
|
|
335
|
+
postalCode?: string;
|
|
336
|
+
/**
|
|
337
|
+
* State or province
|
|
338
|
+
*/
|
|
339
|
+
state?: string;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Physical address
|
|
343
|
+
*/
|
|
344
|
+
interface ShippingAddress {
|
|
345
|
+
/**
|
|
346
|
+
* City name
|
|
347
|
+
*/
|
|
348
|
+
city?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Country code or name
|
|
351
|
+
*/
|
|
352
|
+
country?: string;
|
|
353
|
+
/**
|
|
354
|
+
* Street address line 1
|
|
355
|
+
*/
|
|
356
|
+
line1?: string;
|
|
357
|
+
/**
|
|
358
|
+
* Street address line 2
|
|
359
|
+
*/
|
|
360
|
+
line2?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Postal or ZIP code
|
|
363
|
+
*/
|
|
364
|
+
postalCode?: string;
|
|
365
|
+
/**
|
|
366
|
+
* State or province
|
|
367
|
+
*/
|
|
368
|
+
state?: string;
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
372
|
+
*/
|
|
373
|
+
interface TaxID {
|
|
374
|
+
/**
|
|
375
|
+
* The type of tax exemption identifier, such as VAT.
|
|
376
|
+
*/
|
|
377
|
+
type: string;
|
|
378
|
+
/**
|
|
379
|
+
* The actual tax identifier value
|
|
380
|
+
*/
|
|
381
|
+
value: string;
|
|
382
|
+
}
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Zuora-specific billing fields for the customer.
|
|
386
|
+
*/
|
|
387
|
+
interface Zuora {
|
|
388
|
+
/**
|
|
389
|
+
* Physical address
|
|
390
|
+
*/
|
|
391
|
+
billingAddress?: Zuora.BillingAddress;
|
|
392
|
+
/**
|
|
393
|
+
* Customers selected currency
|
|
394
|
+
*/
|
|
395
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
396
|
+
/**
|
|
397
|
+
* Additional metadata
|
|
398
|
+
*/
|
|
399
|
+
metadata?: {
|
|
400
|
+
[key: string]: string;
|
|
401
|
+
};
|
|
402
|
+
/**
|
|
403
|
+
* Billing provider payment method id, attached to this customer
|
|
404
|
+
*/
|
|
405
|
+
paymentMethodId?: string;
|
|
406
|
+
}
|
|
407
|
+
namespace Zuora {
|
|
408
|
+
/**
|
|
409
|
+
* Physical address
|
|
410
|
+
*/
|
|
411
|
+
interface BillingAddress {
|
|
412
|
+
/**
|
|
413
|
+
* City name
|
|
414
|
+
*/
|
|
415
|
+
city?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Country code or name
|
|
418
|
+
*/
|
|
419
|
+
country?: string;
|
|
420
|
+
/**
|
|
421
|
+
* Street address line 1
|
|
422
|
+
*/
|
|
423
|
+
line1?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Street address line 2
|
|
426
|
+
*/
|
|
427
|
+
line2?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Postal or ZIP code
|
|
430
|
+
*/
|
|
431
|
+
postalCode?: string;
|
|
432
|
+
/**
|
|
433
|
+
* State or province
|
|
434
|
+
*/
|
|
435
|
+
state?: string;
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
}
|
|
138
439
|
}
|
|
139
440
|
}
|
|
140
441
|
/**
|
|
@@ -157,10 +458,18 @@ export interface CustomerListResponse {
|
|
|
157
458
|
* Timestamp of when the record was last updated
|
|
158
459
|
*/
|
|
159
460
|
updatedAt: string;
|
|
461
|
+
/**
|
|
462
|
+
* The billing currency of the customer
|
|
463
|
+
*/
|
|
464
|
+
billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
|
|
465
|
+
/**
|
|
466
|
+
* The unique identifier for the entity in the billing provider
|
|
467
|
+
*/
|
|
468
|
+
billingId?: string | null;
|
|
160
469
|
/**
|
|
161
470
|
* Customer level coupon
|
|
162
471
|
*/
|
|
163
|
-
couponId?: string | null;
|
|
472
|
+
couponId?: (string & {}) | '' | null;
|
|
164
473
|
/**
|
|
165
474
|
* The default payment method details
|
|
166
475
|
*/
|
|
@@ -173,6 +482,10 @@ export interface CustomerListResponse {
|
|
|
173
482
|
* List of integrations
|
|
174
483
|
*/
|
|
175
484
|
integrations?: Array<CustomerListResponse.Integration>;
|
|
485
|
+
/**
|
|
486
|
+
* Language to use for this customer
|
|
487
|
+
*/
|
|
488
|
+
language?: string | null;
|
|
176
489
|
/**
|
|
177
490
|
* Additional metadata
|
|
178
491
|
*/
|
|
@@ -183,6 +496,14 @@ export interface CustomerListResponse {
|
|
|
183
496
|
* The name of the customer
|
|
184
497
|
*/
|
|
185
498
|
name?: string | null;
|
|
499
|
+
/**
|
|
500
|
+
* Vendor-specific billing passthrough fields.
|
|
501
|
+
*/
|
|
502
|
+
passthrough?: CustomerListResponse.Passthrough;
|
|
503
|
+
/**
|
|
504
|
+
* Timezone to use for this customer
|
|
505
|
+
*/
|
|
506
|
+
timezone?: string | null;
|
|
186
507
|
}
|
|
187
508
|
export declare namespace CustomerListResponse {
|
|
188
509
|
/**
|
|
@@ -227,20 +548,375 @@ export declare namespace CustomerListResponse {
|
|
|
227
548
|
*/
|
|
228
549
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
229
550
|
}
|
|
551
|
+
/**
|
|
552
|
+
* Vendor-specific billing passthrough fields.
|
|
553
|
+
*/
|
|
554
|
+
interface Passthrough {
|
|
555
|
+
/**
|
|
556
|
+
* Stripe-specific billing fields for the customer.
|
|
557
|
+
*/
|
|
558
|
+
stripe?: Passthrough.Stripe;
|
|
559
|
+
/**
|
|
560
|
+
* Zuora-specific billing fields for the customer.
|
|
561
|
+
*/
|
|
562
|
+
zuora?: Passthrough.Zuora;
|
|
563
|
+
}
|
|
564
|
+
namespace Passthrough {
|
|
565
|
+
/**
|
|
566
|
+
* Stripe-specific billing fields for the customer.
|
|
567
|
+
*/
|
|
568
|
+
interface Stripe {
|
|
569
|
+
/**
|
|
570
|
+
* Physical address
|
|
571
|
+
*/
|
|
572
|
+
billingAddress?: Stripe.BillingAddress;
|
|
573
|
+
/**
|
|
574
|
+
* Customer name
|
|
575
|
+
*/
|
|
576
|
+
customerName?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Invoice custom fields
|
|
579
|
+
*/
|
|
580
|
+
invoiceCustomFields?: {
|
|
581
|
+
[key: string]: string;
|
|
582
|
+
};
|
|
583
|
+
/**
|
|
584
|
+
* Additional metadata
|
|
585
|
+
*/
|
|
586
|
+
metadata?: {
|
|
587
|
+
[key: string]: string;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* Billing provider payment method id, attached to this customer
|
|
591
|
+
*/
|
|
592
|
+
paymentMethodId?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Physical address
|
|
595
|
+
*/
|
|
596
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
597
|
+
/**
|
|
598
|
+
* Tax IDs
|
|
599
|
+
*/
|
|
600
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
601
|
+
}
|
|
602
|
+
namespace Stripe {
|
|
603
|
+
/**
|
|
604
|
+
* Physical address
|
|
605
|
+
*/
|
|
606
|
+
interface BillingAddress {
|
|
607
|
+
/**
|
|
608
|
+
* City name
|
|
609
|
+
*/
|
|
610
|
+
city?: string;
|
|
611
|
+
/**
|
|
612
|
+
* Country code or name
|
|
613
|
+
*/
|
|
614
|
+
country?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Street address line 1
|
|
617
|
+
*/
|
|
618
|
+
line1?: string;
|
|
619
|
+
/**
|
|
620
|
+
* Street address line 2
|
|
621
|
+
*/
|
|
622
|
+
line2?: string;
|
|
623
|
+
/**
|
|
624
|
+
* Postal or ZIP code
|
|
625
|
+
*/
|
|
626
|
+
postalCode?: string;
|
|
627
|
+
/**
|
|
628
|
+
* State or province
|
|
629
|
+
*/
|
|
630
|
+
state?: string;
|
|
631
|
+
}
|
|
632
|
+
/**
|
|
633
|
+
* Physical address
|
|
634
|
+
*/
|
|
635
|
+
interface ShippingAddress {
|
|
636
|
+
/**
|
|
637
|
+
* City name
|
|
638
|
+
*/
|
|
639
|
+
city?: string;
|
|
640
|
+
/**
|
|
641
|
+
* Country code or name
|
|
642
|
+
*/
|
|
643
|
+
country?: string;
|
|
644
|
+
/**
|
|
645
|
+
* Street address line 1
|
|
646
|
+
*/
|
|
647
|
+
line1?: string;
|
|
648
|
+
/**
|
|
649
|
+
* Street address line 2
|
|
650
|
+
*/
|
|
651
|
+
line2?: string;
|
|
652
|
+
/**
|
|
653
|
+
* Postal or ZIP code
|
|
654
|
+
*/
|
|
655
|
+
postalCode?: string;
|
|
656
|
+
/**
|
|
657
|
+
* State or province
|
|
658
|
+
*/
|
|
659
|
+
state?: string;
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
663
|
+
*/
|
|
664
|
+
interface TaxID {
|
|
665
|
+
/**
|
|
666
|
+
* The type of tax exemption identifier, such as VAT.
|
|
667
|
+
*/
|
|
668
|
+
type: string;
|
|
669
|
+
/**
|
|
670
|
+
* The actual tax identifier value
|
|
671
|
+
*/
|
|
672
|
+
value: string;
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* Zuora-specific billing fields for the customer.
|
|
677
|
+
*/
|
|
678
|
+
interface Zuora {
|
|
679
|
+
/**
|
|
680
|
+
* Physical address
|
|
681
|
+
*/
|
|
682
|
+
billingAddress?: Zuora.BillingAddress;
|
|
683
|
+
/**
|
|
684
|
+
* Customers selected currency
|
|
685
|
+
*/
|
|
686
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
687
|
+
/**
|
|
688
|
+
* Additional metadata
|
|
689
|
+
*/
|
|
690
|
+
metadata?: {
|
|
691
|
+
[key: string]: string;
|
|
692
|
+
};
|
|
693
|
+
/**
|
|
694
|
+
* Billing provider payment method id, attached to this customer
|
|
695
|
+
*/
|
|
696
|
+
paymentMethodId?: string;
|
|
697
|
+
}
|
|
698
|
+
namespace Zuora {
|
|
699
|
+
/**
|
|
700
|
+
* Physical address
|
|
701
|
+
*/
|
|
702
|
+
interface BillingAddress {
|
|
703
|
+
/**
|
|
704
|
+
* City name
|
|
705
|
+
*/
|
|
706
|
+
city?: string;
|
|
707
|
+
/**
|
|
708
|
+
* Country code or name
|
|
709
|
+
*/
|
|
710
|
+
country?: string;
|
|
711
|
+
/**
|
|
712
|
+
* Street address line 1
|
|
713
|
+
*/
|
|
714
|
+
line1?: string;
|
|
715
|
+
/**
|
|
716
|
+
* Street address line 2
|
|
717
|
+
*/
|
|
718
|
+
line2?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Postal or ZIP code
|
|
721
|
+
*/
|
|
722
|
+
postalCode?: string;
|
|
723
|
+
/**
|
|
724
|
+
* State or province
|
|
725
|
+
*/
|
|
726
|
+
state?: string;
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
}
|
|
230
730
|
}
|
|
231
|
-
|
|
731
|
+
/**
|
|
732
|
+
* Response object
|
|
733
|
+
*/
|
|
734
|
+
export interface CustomerImportResponse {
|
|
232
735
|
/**
|
|
233
|
-
*
|
|
736
|
+
* List of newly created customer IDs from the import operation.
|
|
737
|
+
*/
|
|
738
|
+
data: CustomerImportResponse.Data;
|
|
739
|
+
}
|
|
740
|
+
export declare namespace CustomerImportResponse {
|
|
741
|
+
/**
|
|
742
|
+
* List of newly created customer IDs from the import operation.
|
|
743
|
+
*/
|
|
744
|
+
interface Data {
|
|
745
|
+
/**
|
|
746
|
+
* Customer IDs created during import
|
|
747
|
+
*/
|
|
748
|
+
newCustomers: Array<string>;
|
|
749
|
+
}
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* Resource object that belongs to a customer
|
|
753
|
+
*/
|
|
754
|
+
export interface CustomerListResourcesResponse {
|
|
755
|
+
/**
|
|
756
|
+
* Resource slug
|
|
234
757
|
*/
|
|
235
758
|
id: string;
|
|
236
759
|
/**
|
|
237
|
-
*
|
|
760
|
+
* Timestamp of when the record was created
|
|
238
761
|
*/
|
|
239
|
-
|
|
762
|
+
createdAt: string;
|
|
240
763
|
/**
|
|
241
|
-
*
|
|
764
|
+
* Timestamp of when the record was last updated
|
|
765
|
+
*/
|
|
766
|
+
updatedAt: string;
|
|
767
|
+
}
|
|
768
|
+
/**
|
|
769
|
+
* Response object
|
|
770
|
+
*/
|
|
771
|
+
export interface CustomerRetrieveEntitlementsResponse {
|
|
772
|
+
/**
|
|
773
|
+
* The effective entitlements state for a customer or resource.
|
|
242
774
|
*/
|
|
243
|
-
|
|
775
|
+
data: CustomerRetrieveEntitlementsResponse.Data;
|
|
776
|
+
}
|
|
777
|
+
export declare namespace CustomerRetrieveEntitlementsResponse {
|
|
778
|
+
/**
|
|
779
|
+
* The effective entitlements state for a customer or resource.
|
|
780
|
+
*/
|
|
781
|
+
interface Data {
|
|
782
|
+
/**
|
|
783
|
+
* Reason why entitlements access was denied, if applicable
|
|
784
|
+
*/
|
|
785
|
+
accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
|
|
786
|
+
/**
|
|
787
|
+
* List of effective feature and credit entitlements
|
|
788
|
+
*/
|
|
789
|
+
entitlements: Array<Data.Feature | Data.Credit>;
|
|
790
|
+
}
|
|
791
|
+
namespace Data {
|
|
792
|
+
interface Feature {
|
|
793
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
794
|
+
isGranted: boolean;
|
|
795
|
+
type: 'FEATURE';
|
|
796
|
+
currentUsage?: number;
|
|
797
|
+
/**
|
|
798
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
799
|
+
*/
|
|
800
|
+
entitlementUpdatedAt?: string;
|
|
801
|
+
feature?: Feature.Feature;
|
|
802
|
+
hasUnlimitedUsage?: boolean;
|
|
803
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
804
|
+
usageLimit?: number | null;
|
|
805
|
+
/**
|
|
806
|
+
* The anchor for calculating the usage period for metered entitlements with a
|
|
807
|
+
* reset period configured
|
|
808
|
+
*/
|
|
809
|
+
usagePeriodAnchor?: string;
|
|
810
|
+
/**
|
|
811
|
+
* The end date of the usage period for metered entitlements with a reset period
|
|
812
|
+
* configured
|
|
813
|
+
*/
|
|
814
|
+
usagePeriodEnd?: string;
|
|
815
|
+
/**
|
|
816
|
+
* The start date of the usage period for metered entitlements with a reset period
|
|
817
|
+
* configured
|
|
818
|
+
*/
|
|
819
|
+
usagePeriodStart?: string;
|
|
820
|
+
/**
|
|
821
|
+
* The next time the entitlement should be recalculated
|
|
822
|
+
*/
|
|
823
|
+
validUntil?: string;
|
|
824
|
+
}
|
|
825
|
+
namespace Feature {
|
|
826
|
+
interface Feature {
|
|
827
|
+
/**
|
|
828
|
+
* The unique reference ID of the entitlement.
|
|
829
|
+
*/
|
|
830
|
+
id: string;
|
|
831
|
+
/**
|
|
832
|
+
* The human-readable name of the entitlement, shown in UI elements.
|
|
833
|
+
*/
|
|
834
|
+
displayName: string;
|
|
835
|
+
/**
|
|
836
|
+
* The current status of the feature.
|
|
837
|
+
*/
|
|
838
|
+
featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
|
|
839
|
+
/**
|
|
840
|
+
* The type of feature associated with the entitlement.
|
|
841
|
+
*/
|
|
842
|
+
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
interface Credit {
|
|
846
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
847
|
+
/**
|
|
848
|
+
* The currency associated with a credit entitlement.
|
|
849
|
+
*/
|
|
850
|
+
currency: Credit.Currency;
|
|
851
|
+
currentUsage: number;
|
|
852
|
+
isGranted: boolean;
|
|
853
|
+
type: 'CREDIT';
|
|
854
|
+
usageLimit: number;
|
|
855
|
+
/**
|
|
856
|
+
* Timestamp of the last update to the credit usage.
|
|
857
|
+
*/
|
|
858
|
+
usageUpdatedAt: string;
|
|
859
|
+
/**
|
|
860
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
861
|
+
*/
|
|
862
|
+
entitlementUpdatedAt?: string;
|
|
863
|
+
/**
|
|
864
|
+
* The end date of the current billing period for recurring credit grants.
|
|
865
|
+
*/
|
|
866
|
+
usagePeriodEnd?: string;
|
|
867
|
+
/**
|
|
868
|
+
* The next time the entitlement should be recalculated
|
|
869
|
+
*/
|
|
870
|
+
validUntil?: string;
|
|
871
|
+
}
|
|
872
|
+
namespace Credit {
|
|
873
|
+
/**
|
|
874
|
+
* The currency associated with a credit entitlement.
|
|
875
|
+
*/
|
|
876
|
+
interface Currency {
|
|
877
|
+
/**
|
|
878
|
+
* The unique identifier of the custom currency.
|
|
879
|
+
*/
|
|
880
|
+
currencyId: string;
|
|
881
|
+
/**
|
|
882
|
+
* The display name of the currency.
|
|
883
|
+
*/
|
|
884
|
+
displayName: string;
|
|
885
|
+
/**
|
|
886
|
+
* A description of the currency.
|
|
887
|
+
*/
|
|
888
|
+
description?: string | null;
|
|
889
|
+
/**
|
|
890
|
+
* Additional metadata associated with the currency.
|
|
891
|
+
*/
|
|
892
|
+
metadata?: {
|
|
893
|
+
[key: string]: string;
|
|
894
|
+
} | null;
|
|
895
|
+
/**
|
|
896
|
+
* The plural form of the currency unit.
|
|
897
|
+
*/
|
|
898
|
+
unitPlural?: string | null;
|
|
899
|
+
/**
|
|
900
|
+
* The singular form of the currency unit.
|
|
901
|
+
*/
|
|
902
|
+
unitSingular?: string | null;
|
|
903
|
+
}
|
|
904
|
+
}
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
export interface CustomerUpdateParams {
|
|
908
|
+
/**
|
|
909
|
+
* The billing currency of the customer
|
|
910
|
+
*/
|
|
911
|
+
billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
|
|
912
|
+
/**
|
|
913
|
+
* The unique identifier for the entity in the billing provider
|
|
914
|
+
*/
|
|
915
|
+
billingId?: string | null;
|
|
916
|
+
/**
|
|
917
|
+
* Customer level coupon
|
|
918
|
+
*/
|
|
919
|
+
couponId?: (string & {}) | '' | null;
|
|
244
920
|
/**
|
|
245
921
|
* The email of the customer
|
|
246
922
|
*/
|
|
@@ -248,7 +924,11 @@ export interface CustomerCreateParams {
|
|
|
248
924
|
/**
|
|
249
925
|
* List of integrations
|
|
250
926
|
*/
|
|
251
|
-
integrations?: Array<
|
|
927
|
+
integrations?: Array<CustomerUpdateParams.Integration>;
|
|
928
|
+
/**
|
|
929
|
+
* Language to use for this customer
|
|
930
|
+
*/
|
|
931
|
+
language?: string | null;
|
|
252
932
|
/**
|
|
253
933
|
* Additional metadata
|
|
254
934
|
*/
|
|
@@ -259,56 +939,321 @@ export interface CustomerCreateParams {
|
|
|
259
939
|
* The name of the customer
|
|
260
940
|
*/
|
|
261
941
|
name?: string | null;
|
|
942
|
+
/**
|
|
943
|
+
* Vendor-specific billing passthrough fields.
|
|
944
|
+
*/
|
|
945
|
+
passthrough?: CustomerUpdateParams.Passthrough;
|
|
946
|
+
/**
|
|
947
|
+
* Timezone to use for this customer
|
|
948
|
+
*/
|
|
949
|
+
timezone?: string | null;
|
|
262
950
|
}
|
|
263
|
-
export declare namespace
|
|
951
|
+
export declare namespace CustomerUpdateParams {
|
|
264
952
|
/**
|
|
265
|
-
*
|
|
953
|
+
* External billing or CRM integration link
|
|
266
954
|
*/
|
|
267
|
-
interface
|
|
955
|
+
interface Integration {
|
|
268
956
|
/**
|
|
269
|
-
*
|
|
957
|
+
* Integration details
|
|
270
958
|
*/
|
|
271
|
-
|
|
959
|
+
id: string;
|
|
272
960
|
/**
|
|
273
|
-
*
|
|
961
|
+
* Synced entity id
|
|
274
962
|
*/
|
|
275
|
-
|
|
963
|
+
syncedEntityId: string | null;
|
|
276
964
|
/**
|
|
277
|
-
* The
|
|
965
|
+
* The vendor identifier of integration
|
|
278
966
|
*/
|
|
279
|
-
|
|
967
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
968
|
+
}
|
|
969
|
+
/**
|
|
970
|
+
* Vendor-specific billing passthrough fields.
|
|
971
|
+
*/
|
|
972
|
+
interface Passthrough {
|
|
280
973
|
/**
|
|
281
|
-
*
|
|
974
|
+
* Stripe-specific billing fields for the customer.
|
|
282
975
|
*/
|
|
283
|
-
|
|
976
|
+
stripe?: Passthrough.Stripe;
|
|
284
977
|
/**
|
|
285
|
-
*
|
|
978
|
+
* Zuora-specific billing fields for the customer.
|
|
286
979
|
*/
|
|
287
|
-
|
|
980
|
+
zuora?: Passthrough.Zuora;
|
|
288
981
|
}
|
|
982
|
+
namespace Passthrough {
|
|
983
|
+
/**
|
|
984
|
+
* Stripe-specific billing fields for the customer.
|
|
985
|
+
*/
|
|
986
|
+
interface Stripe {
|
|
987
|
+
/**
|
|
988
|
+
* Physical address
|
|
989
|
+
*/
|
|
990
|
+
billingAddress?: Stripe.BillingAddress;
|
|
991
|
+
/**
|
|
992
|
+
* Customer name
|
|
993
|
+
*/
|
|
994
|
+
customerName?: string;
|
|
995
|
+
/**
|
|
996
|
+
* Invoice custom fields
|
|
997
|
+
*/
|
|
998
|
+
invoiceCustomFields?: {
|
|
999
|
+
[key: string]: string;
|
|
1000
|
+
};
|
|
1001
|
+
/**
|
|
1002
|
+
* Additional metadata
|
|
1003
|
+
*/
|
|
1004
|
+
metadata?: {
|
|
1005
|
+
[key: string]: string;
|
|
1006
|
+
};
|
|
1007
|
+
/**
|
|
1008
|
+
* Billing provider payment method id, attached to this customer
|
|
1009
|
+
*/
|
|
1010
|
+
paymentMethodId?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Physical address
|
|
1013
|
+
*/
|
|
1014
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
1015
|
+
/**
|
|
1016
|
+
* Tax IDs
|
|
1017
|
+
*/
|
|
1018
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
1019
|
+
}
|
|
1020
|
+
namespace Stripe {
|
|
1021
|
+
/**
|
|
1022
|
+
* Physical address
|
|
1023
|
+
*/
|
|
1024
|
+
interface BillingAddress {
|
|
1025
|
+
/**
|
|
1026
|
+
* City name
|
|
1027
|
+
*/
|
|
1028
|
+
city?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Country code or name
|
|
1031
|
+
*/
|
|
1032
|
+
country?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Street address line 1
|
|
1035
|
+
*/
|
|
1036
|
+
line1?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Street address line 2
|
|
1039
|
+
*/
|
|
1040
|
+
line2?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Postal or ZIP code
|
|
1043
|
+
*/
|
|
1044
|
+
postalCode?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* State or province
|
|
1047
|
+
*/
|
|
1048
|
+
state?: string;
|
|
1049
|
+
}
|
|
1050
|
+
/**
|
|
1051
|
+
* Physical address
|
|
1052
|
+
*/
|
|
1053
|
+
interface ShippingAddress {
|
|
1054
|
+
/**
|
|
1055
|
+
* City name
|
|
1056
|
+
*/
|
|
1057
|
+
city?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Country code or name
|
|
1060
|
+
*/
|
|
1061
|
+
country?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Street address line 1
|
|
1064
|
+
*/
|
|
1065
|
+
line1?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Street address line 2
|
|
1068
|
+
*/
|
|
1069
|
+
line2?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* Postal or ZIP code
|
|
1072
|
+
*/
|
|
1073
|
+
postalCode?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* State or province
|
|
1076
|
+
*/
|
|
1077
|
+
state?: string;
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
1081
|
+
*/
|
|
1082
|
+
interface TaxID {
|
|
1083
|
+
/**
|
|
1084
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1085
|
+
*/
|
|
1086
|
+
type: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* The actual tax identifier value
|
|
1089
|
+
*/
|
|
1090
|
+
value: string;
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Zuora-specific billing fields for the customer.
|
|
1095
|
+
*/
|
|
1096
|
+
interface Zuora {
|
|
1097
|
+
/**
|
|
1098
|
+
* Physical address
|
|
1099
|
+
*/
|
|
1100
|
+
billingAddress?: Zuora.BillingAddress;
|
|
1101
|
+
/**
|
|
1102
|
+
* Customers selected currency
|
|
1103
|
+
*/
|
|
1104
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1105
|
+
/**
|
|
1106
|
+
* Additional metadata
|
|
1107
|
+
*/
|
|
1108
|
+
metadata?: {
|
|
1109
|
+
[key: string]: string;
|
|
1110
|
+
};
|
|
1111
|
+
/**
|
|
1112
|
+
* Billing provider payment method id, attached to this customer
|
|
1113
|
+
*/
|
|
1114
|
+
paymentMethodId?: string;
|
|
1115
|
+
}
|
|
1116
|
+
namespace Zuora {
|
|
1117
|
+
/**
|
|
1118
|
+
* Physical address
|
|
1119
|
+
*/
|
|
1120
|
+
interface BillingAddress {
|
|
1121
|
+
/**
|
|
1122
|
+
* City name
|
|
1123
|
+
*/
|
|
1124
|
+
city?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Country code or name
|
|
1127
|
+
*/
|
|
1128
|
+
country?: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Street address line 1
|
|
1131
|
+
*/
|
|
1132
|
+
line1?: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* Street address line 2
|
|
1135
|
+
*/
|
|
1136
|
+
line2?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Postal or ZIP code
|
|
1139
|
+
*/
|
|
1140
|
+
postalCode?: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* State or province
|
|
1143
|
+
*/
|
|
1144
|
+
state?: string;
|
|
1145
|
+
}
|
|
1146
|
+
}
|
|
1147
|
+
}
|
|
1148
|
+
}
|
|
1149
|
+
export interface CustomerListParams extends MyCursorIDPageParams {
|
|
289
1150
|
/**
|
|
290
|
-
*
|
|
1151
|
+
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
291
1152
|
*/
|
|
292
|
-
|
|
1153
|
+
createdAt?: CustomerListParams.CreatedAt;
|
|
1154
|
+
/**
|
|
1155
|
+
* Filter by exact customer email address
|
|
1156
|
+
*/
|
|
1157
|
+
email?: string;
|
|
1158
|
+
/**
|
|
1159
|
+
* Filter by exact customer name
|
|
1160
|
+
*/
|
|
1161
|
+
name?: string;
|
|
1162
|
+
}
|
|
1163
|
+
export declare namespace CustomerListParams {
|
|
1164
|
+
/**
|
|
1165
|
+
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
1166
|
+
*/
|
|
1167
|
+
interface CreatedAt {
|
|
293
1168
|
/**
|
|
294
|
-
*
|
|
1169
|
+
* Greater than the specified createdAt value
|
|
1170
|
+
*/
|
|
1171
|
+
gt?: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Greater than or equal to the specified createdAt value
|
|
1174
|
+
*/
|
|
1175
|
+
gte?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Less than the specified createdAt value
|
|
1178
|
+
*/
|
|
1179
|
+
lt?: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* Less than or equal to the specified createdAt value
|
|
1182
|
+
*/
|
|
1183
|
+
lte?: string;
|
|
1184
|
+
}
|
|
1185
|
+
}
|
|
1186
|
+
export interface CustomerImportParams {
|
|
1187
|
+
/**
|
|
1188
|
+
* List of customer objects to import
|
|
1189
|
+
*/
|
|
1190
|
+
customers: Array<CustomerImportParams.Customer>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Integration details
|
|
1193
|
+
*/
|
|
1194
|
+
integrationId?: string;
|
|
1195
|
+
}
|
|
1196
|
+
export declare namespace CustomerImportParams {
|
|
1197
|
+
interface Customer {
|
|
1198
|
+
/**
|
|
1199
|
+
* Customer slug
|
|
295
1200
|
*/
|
|
296
1201
|
id: string;
|
|
297
1202
|
/**
|
|
298
|
-
*
|
|
1203
|
+
* The email of the customer
|
|
299
1204
|
*/
|
|
300
|
-
|
|
1205
|
+
email: string | null;
|
|
301
1206
|
/**
|
|
302
|
-
* The
|
|
1207
|
+
* The name of the customer
|
|
303
1208
|
*/
|
|
304
|
-
|
|
1209
|
+
name: string | null;
|
|
1210
|
+
/**
|
|
1211
|
+
* Id in the billing provider
|
|
1212
|
+
*/
|
|
1213
|
+
billingId?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* Additional metadata
|
|
1216
|
+
*/
|
|
1217
|
+
metadata?: {
|
|
1218
|
+
[key: string]: string;
|
|
1219
|
+
};
|
|
1220
|
+
/**
|
|
1221
|
+
* Billing provider payment method id
|
|
1222
|
+
*/
|
|
1223
|
+
paymentMethodId?: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* The unique identifier for the customer in Salesforce integration
|
|
1226
|
+
*/
|
|
1227
|
+
salesforceId?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* Timestamp of when the record was last updated
|
|
1230
|
+
*/
|
|
1231
|
+
updatedAt?: string;
|
|
305
1232
|
}
|
|
306
1233
|
}
|
|
307
|
-
export interface
|
|
1234
|
+
export interface CustomerListResourcesParams extends MyCursorIDPageParams {
|
|
1235
|
+
}
|
|
1236
|
+
export interface CustomerProvisionParams {
|
|
1237
|
+
/**
|
|
1238
|
+
* Customer slug
|
|
1239
|
+
*/
|
|
1240
|
+
id: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* The billing currency of the customer
|
|
1243
|
+
*/
|
|
1244
|
+
billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* The unique identifier for the entity in the billing provider
|
|
1247
|
+
*/
|
|
1248
|
+
billingId?: string | null;
|
|
308
1249
|
/**
|
|
309
1250
|
* Customer level coupon
|
|
310
1251
|
*/
|
|
311
|
-
couponId?: string | null;
|
|
1252
|
+
couponId?: (string & {}) | '' | null;
|
|
1253
|
+
/**
|
|
1254
|
+
* The default payment method details
|
|
1255
|
+
*/
|
|
1256
|
+
defaultPaymentMethod?: CustomerProvisionParams.DefaultPaymentMethod | null;
|
|
312
1257
|
/**
|
|
313
1258
|
* The email of the customer
|
|
314
1259
|
*/
|
|
@@ -316,7 +1261,11 @@ export interface CustomerUpdateParams {
|
|
|
316
1261
|
/**
|
|
317
1262
|
* List of integrations
|
|
318
1263
|
*/
|
|
319
|
-
integrations?: Array<
|
|
1264
|
+
integrations?: Array<CustomerProvisionParams.Integration>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Language to use for this customer
|
|
1267
|
+
*/
|
|
1268
|
+
language?: string | null;
|
|
320
1269
|
/**
|
|
321
1270
|
* Additional metadata
|
|
322
1271
|
*/
|
|
@@ -327,8 +1276,41 @@ export interface CustomerUpdateParams {
|
|
|
327
1276
|
* The name of the customer
|
|
328
1277
|
*/
|
|
329
1278
|
name?: string | null;
|
|
1279
|
+
/**
|
|
1280
|
+
* Vendor-specific billing passthrough fields.
|
|
1281
|
+
*/
|
|
1282
|
+
passthrough?: CustomerProvisionParams.Passthrough;
|
|
1283
|
+
/**
|
|
1284
|
+
* Timezone to use for this customer
|
|
1285
|
+
*/
|
|
1286
|
+
timezone?: string | null;
|
|
330
1287
|
}
|
|
331
|
-
export declare namespace
|
|
1288
|
+
export declare namespace CustomerProvisionParams {
|
|
1289
|
+
/**
|
|
1290
|
+
* The default payment method details
|
|
1291
|
+
*/
|
|
1292
|
+
interface DefaultPaymentMethod {
|
|
1293
|
+
/**
|
|
1294
|
+
* The default payment method id
|
|
1295
|
+
*/
|
|
1296
|
+
billingId: string | null;
|
|
1297
|
+
/**
|
|
1298
|
+
* The expiration month of the default payment method
|
|
1299
|
+
*/
|
|
1300
|
+
cardExpiryMonth: number | null;
|
|
1301
|
+
/**
|
|
1302
|
+
* The expiration year of the default payment method
|
|
1303
|
+
*/
|
|
1304
|
+
cardExpiryYear: number | null;
|
|
1305
|
+
/**
|
|
1306
|
+
* The last 4 digits of the default payment method
|
|
1307
|
+
*/
|
|
1308
|
+
cardLast4Digits: string | null;
|
|
1309
|
+
/**
|
|
1310
|
+
* The default payment method type
|
|
1311
|
+
*/
|
|
1312
|
+
type: 'CARD' | 'BANK' | 'CASH_APP';
|
|
1313
|
+
}
|
|
332
1314
|
/**
|
|
333
1315
|
* External billing or CRM integration link
|
|
334
1316
|
*/
|
|
@@ -346,12 +1328,196 @@ export declare namespace CustomerUpdateParams {
|
|
|
346
1328
|
*/
|
|
347
1329
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
348
1330
|
}
|
|
1331
|
+
/**
|
|
1332
|
+
* Vendor-specific billing passthrough fields.
|
|
1333
|
+
*/
|
|
1334
|
+
interface Passthrough {
|
|
1335
|
+
/**
|
|
1336
|
+
* Stripe-specific billing fields for the customer.
|
|
1337
|
+
*/
|
|
1338
|
+
stripe?: Passthrough.Stripe;
|
|
1339
|
+
/**
|
|
1340
|
+
* Zuora-specific billing fields for the customer.
|
|
1341
|
+
*/
|
|
1342
|
+
zuora?: Passthrough.Zuora;
|
|
1343
|
+
}
|
|
1344
|
+
namespace Passthrough {
|
|
1345
|
+
/**
|
|
1346
|
+
* Stripe-specific billing fields for the customer.
|
|
1347
|
+
*/
|
|
1348
|
+
interface Stripe {
|
|
1349
|
+
/**
|
|
1350
|
+
* Physical address
|
|
1351
|
+
*/
|
|
1352
|
+
billingAddress?: Stripe.BillingAddress;
|
|
1353
|
+
/**
|
|
1354
|
+
* Customer name
|
|
1355
|
+
*/
|
|
1356
|
+
customerName?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* Invoice custom fields
|
|
1359
|
+
*/
|
|
1360
|
+
invoiceCustomFields?: {
|
|
1361
|
+
[key: string]: string;
|
|
1362
|
+
};
|
|
1363
|
+
/**
|
|
1364
|
+
* Additional metadata
|
|
1365
|
+
*/
|
|
1366
|
+
metadata?: {
|
|
1367
|
+
[key: string]: string;
|
|
1368
|
+
};
|
|
1369
|
+
/**
|
|
1370
|
+
* Billing provider payment method id, attached to this customer
|
|
1371
|
+
*/
|
|
1372
|
+
paymentMethodId?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* Physical address
|
|
1375
|
+
*/
|
|
1376
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
1377
|
+
/**
|
|
1378
|
+
* Tax IDs
|
|
1379
|
+
*/
|
|
1380
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
1381
|
+
}
|
|
1382
|
+
namespace Stripe {
|
|
1383
|
+
/**
|
|
1384
|
+
* Physical address
|
|
1385
|
+
*/
|
|
1386
|
+
interface BillingAddress {
|
|
1387
|
+
/**
|
|
1388
|
+
* City name
|
|
1389
|
+
*/
|
|
1390
|
+
city?: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* Country code or name
|
|
1393
|
+
*/
|
|
1394
|
+
country?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* Street address line 1
|
|
1397
|
+
*/
|
|
1398
|
+
line1?: string;
|
|
1399
|
+
/**
|
|
1400
|
+
* Street address line 2
|
|
1401
|
+
*/
|
|
1402
|
+
line2?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* Postal or ZIP code
|
|
1405
|
+
*/
|
|
1406
|
+
postalCode?: string;
|
|
1407
|
+
/**
|
|
1408
|
+
* State or province
|
|
1409
|
+
*/
|
|
1410
|
+
state?: string;
|
|
1411
|
+
}
|
|
1412
|
+
/**
|
|
1413
|
+
* Physical address
|
|
1414
|
+
*/
|
|
1415
|
+
interface ShippingAddress {
|
|
1416
|
+
/**
|
|
1417
|
+
* City name
|
|
1418
|
+
*/
|
|
1419
|
+
city?: string;
|
|
1420
|
+
/**
|
|
1421
|
+
* Country code or name
|
|
1422
|
+
*/
|
|
1423
|
+
country?: string;
|
|
1424
|
+
/**
|
|
1425
|
+
* Street address line 1
|
|
1426
|
+
*/
|
|
1427
|
+
line1?: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* Street address line 2
|
|
1430
|
+
*/
|
|
1431
|
+
line2?: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* Postal or ZIP code
|
|
1434
|
+
*/
|
|
1435
|
+
postalCode?: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* State or province
|
|
1438
|
+
*/
|
|
1439
|
+
state?: string;
|
|
1440
|
+
}
|
|
1441
|
+
/**
|
|
1442
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
1443
|
+
*/
|
|
1444
|
+
interface TaxID {
|
|
1445
|
+
/**
|
|
1446
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1447
|
+
*/
|
|
1448
|
+
type: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* The actual tax identifier value
|
|
1451
|
+
*/
|
|
1452
|
+
value: string;
|
|
1453
|
+
}
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* Zuora-specific billing fields for the customer.
|
|
1457
|
+
*/
|
|
1458
|
+
interface Zuora {
|
|
1459
|
+
/**
|
|
1460
|
+
* Physical address
|
|
1461
|
+
*/
|
|
1462
|
+
billingAddress?: Zuora.BillingAddress;
|
|
1463
|
+
/**
|
|
1464
|
+
* Customers selected currency
|
|
1465
|
+
*/
|
|
1466
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1467
|
+
/**
|
|
1468
|
+
* Additional metadata
|
|
1469
|
+
*/
|
|
1470
|
+
metadata?: {
|
|
1471
|
+
[key: string]: string;
|
|
1472
|
+
};
|
|
1473
|
+
/**
|
|
1474
|
+
* Billing provider payment method id, attached to this customer
|
|
1475
|
+
*/
|
|
1476
|
+
paymentMethodId?: string;
|
|
1477
|
+
}
|
|
1478
|
+
namespace Zuora {
|
|
1479
|
+
/**
|
|
1480
|
+
* Physical address
|
|
1481
|
+
*/
|
|
1482
|
+
interface BillingAddress {
|
|
1483
|
+
/**
|
|
1484
|
+
* City name
|
|
1485
|
+
*/
|
|
1486
|
+
city?: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* Country code or name
|
|
1489
|
+
*/
|
|
1490
|
+
country?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* Street address line 1
|
|
1493
|
+
*/
|
|
1494
|
+
line1?: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* Street address line 2
|
|
1497
|
+
*/
|
|
1498
|
+
line2?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* Postal or ZIP code
|
|
1501
|
+
*/
|
|
1502
|
+
postalCode?: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* State or province
|
|
1505
|
+
*/
|
|
1506
|
+
state?: string;
|
|
1507
|
+
}
|
|
1508
|
+
}
|
|
1509
|
+
}
|
|
349
1510
|
}
|
|
350
|
-
export interface
|
|
1511
|
+
export interface CustomerRetrieveEntitlementsParams {
|
|
1512
|
+
/**
|
|
1513
|
+
* Resource ID to scope entitlements to a specific resource
|
|
1514
|
+
*/
|
|
1515
|
+
resourceId?: string;
|
|
351
1516
|
}
|
|
352
1517
|
export declare namespace Customers {
|
|
353
|
-
export { type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type
|
|
1518
|
+
export { type CustomerIntegrationResponse as CustomerIntegrationResponse, type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams, };
|
|
354
1519
|
export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
|
|
355
|
-
export {
|
|
1520
|
+
export { PromotionalEntitlements as PromotionalEntitlements, type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse, type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse, type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse, type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage, type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams, type PromotionalEntitlementListParams as PromotionalEntitlementListParams, type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams, };
|
|
1521
|
+
export { Integrations as Integrations, type IntegrationListResponse as IntegrationListResponse, type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage, type IntegrationRetrieveParams as IntegrationRetrieveParams, type IntegrationUpdateParams as IntegrationUpdateParams, type IntegrationListParams as IntegrationListParams, type IntegrationLinkParams as IntegrationLinkParams, type IntegrationUnlinkParams as IntegrationUnlinkParams, };
|
|
356
1522
|
}
|
|
357
1523
|
//# sourceMappingURL=customers.d.ts.map
|