@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.2
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 +417 -0
- package/client.d.mts +1 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +1 -1
- package/client.d.ts.map +1 -1
- package/client.js +19 -7
- package/client.js.map +1 -1
- package/client.mjs +19 -7
- package/client.mjs.map +1 -1
- package/internal/tslib.js +17 -17
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- 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/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +3 -2
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +3 -2
- package/internal/utils/log.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/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/{events/addons → addons}/addons.js +41 -26
- package/resources/v1/addons/addons.js.map +1 -0
- package/resources/v1/{events/addons → addons}/addons.mjs +40 -25
- 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/{events/addons → addons}/index.js +3 -3
- package/resources/v1/addons/index.js.map +1 -0
- package/resources/v1/{events/addons → addons}/index.mjs +1 -1
- package/resources/v1/addons/index.mjs.map +1 -0
- package/resources/v1/addons.d.mts.map +1 -0
- package/resources/v1/addons.d.ts.map +1 -0
- package/resources/v1/{events/addons.js → addons.js} +1 -1
- package/resources/v1/addons.js.map +1 -0
- package/resources/v1/addons.mjs.map +1 -0
- package/resources/v1/coupons.d.mts +19 -4
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +19 -4
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +3 -0
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +3 -0
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/auto-recharge.d.mts +84 -0
- package/resources/v1/credits/auto-recharge.d.mts.map +1 -0
- package/resources/v1/credits/auto-recharge.d.ts +84 -0
- package/resources/v1/credits/auto-recharge.d.ts.map +1 -0
- package/resources/v1/credits/auto-recharge.js +16 -0
- package/resources/v1/credits/auto-recharge.js.map +1 -0
- package/resources/v1/credits/auto-recharge.mjs +12 -0
- package/resources/v1/credits/auto-recharge.mjs.map +1 -0
- package/resources/v1/credits/credits.d.mts +203 -0
- package/resources/v1/credits/credits.d.mts.map +1 -0
- package/resources/v1/credits/credits.d.ts +203 -0
- package/resources/v1/credits/credits.d.ts.map +1 -0
- package/resources/v1/credits/credits.js +42 -0
- package/resources/v1/credits/credits.js.map +1 -0
- package/resources/v1/credits/credits.mjs +37 -0
- package/resources/v1/credits/credits.mjs.map +1 -0
- package/resources/v1/credits/custom-currencies.d.mts +290 -0
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -0
- package/resources/v1/credits/custom-currencies.d.ts +290 -0
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -0
- package/resources/v1/credits/custom-currencies.js +56 -0
- package/resources/v1/credits/custom-currencies.js.map +1 -0
- package/resources/v1/credits/custom-currencies.mjs +52 -0
- package/resources/v1/credits/custom-currencies.mjs.map +1 -0
- package/resources/v1/credits/grants.d.mts +549 -0
- package/resources/v1/credits/grants.d.mts.map +1 -0
- package/resources/v1/credits/grants.d.ts +549 -0
- package/resources/v1/credits/grants.d.ts.map +1 -0
- package/resources/v1/credits/grants.js +37 -0
- package/resources/v1/credits/grants.js.map +1 -0
- package/resources/v1/credits/grants.mjs +33 -0
- package/resources/v1/credits/grants.mjs.map +1 -0
- package/resources/v1/credits/index.d.mts +5 -0
- package/resources/v1/credits/index.d.mts.map +1 -0
- package/resources/v1/credits/index.d.ts +5 -0
- package/resources/v1/credits/index.d.ts.map +1 -0
- package/resources/v1/credits/index.js +13 -0
- package/resources/v1/credits/index.js.map +1 -0
- package/resources/v1/credits/index.mjs +6 -0
- package/resources/v1/credits/index.mjs.map +1 -0
- package/resources/v1/credits.d.mts +2 -0
- package/resources/v1/credits.d.mts.map +1 -0
- package/resources/v1/credits.d.ts +2 -0
- package/resources/v1/credits.d.ts.map +1 -0
- package/resources/v1/credits.js +6 -0
- package/resources/v1/credits.js.map +1 -0
- package/resources/v1/credits.mjs +3 -0
- package/resources/v1/credits.mjs.map +1 -0
- package/resources/v1/customers/customers.d.mts +1204 -6
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +1204 -6
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +30 -1
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +30 -1
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -1
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -1
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +3 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -0
- 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 +3 -0
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +3 -0
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +3 -0
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +3 -0
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +4 -1
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +4 -1
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +3 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +3 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events.d.mts +65 -1
- package/resources/v1/events.d.mts.map +1 -1
- package/resources/v1/events.d.ts +65 -1
- package/resources/v1/events.d.ts.map +1 -1
- package/resources/v1/events.js +15 -2
- package/resources/v1/events.js.map +1 -1
- package/resources/v1/events.mjs +13 -1
- package/resources/v1/events.mjs.map +1 -1
- 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/{events/features.js → features.js} +6 -3
- package/resources/v1/features.js.map +1 -0
- package/resources/v1/{events/features.mjs → features.mjs} +6 -3
- package/resources/v1/features.mjs.map +1 -0
- package/resources/v1/index.d.mts +7 -3
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +7 -3
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +15 -7
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +5 -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 +22 -359
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +22 -359
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +5 -2
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +5 -2
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +3 -0
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +3 -0
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +3 -0
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +3 -0
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +3 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +3 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +3 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +3 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +1131 -166
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +1131 -166
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +2 -2
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +3 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +3 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +3 -0
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +3 -0
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +4 -1
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +4 -1
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +3 -0
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +3 -0
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +22 -6
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +22 -6
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +18 -2
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +18 -2
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +23 -10
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/env.ts +2 -2
- package/src/internal/utils/log.ts +2 -1
- package/src/internal/utils/query.ts +7 -0
- package/src/internal/utils.ts +1 -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/coupons.ts +17 -4
- package/src/resources/v1/credits/auto-recharge.ts +109 -0
- package/src/resources/v1/credits/credits.ts +313 -0
- package/src/resources/v1/credits/custom-currencies.ts +372 -0
- package/src/resources/v1/credits/grants.ts +795 -0
- package/src/resources/v1/credits/index.ts +33 -0
- package/src/resources/v1/credits.ts +3 -0
- package/src/resources/v1/customers/customers.ts +2526 -69
- package/src/resources/v1/customers/index.ts +15 -0
- package/src/resources/v1/customers/integrations.ts +252 -0
- package/src/resources/v1/customers/payment-method.ts +3 -0
- package/src/resources/v1/customers/promotional-entitlements.ts +4 -1
- package/src/resources/v1/events.ts +75 -1
- package/src/resources/v1/{events/features.ts → features.ts} +29 -512
- package/src/resources/v1/index.ts +48 -6
- 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 +24 -428
- package/src/resources/v1/subscriptions/future-update.ts +3 -0
- package/src/resources/v1/subscriptions/invoice.ts +3 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +3901 -1324
- package/src/resources/v1/subscriptions/usage.ts +3 -0
- package/src/resources/v1/usage.ts +4 -1
- package/src/resources/v1/v1.ts +112 -12
- 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/events/addons/addons.d.mts +0 -605
- package/resources/v1/events/addons/addons.d.mts.map +0 -1
- package/resources/v1/events/addons/addons.d.ts +0 -605
- package/resources/v1/events/addons/addons.d.ts.map +0 -1
- package/resources/v1/events/addons/addons.js.map +0 -1
- package/resources/v1/events/addons/addons.mjs.map +0 -1
- package/resources/v1/events/addons/draft.d.mts +0 -121
- package/resources/v1/events/addons/draft.d.mts.map +0 -1
- package/resources/v1/events/addons/draft.d.ts +0 -121
- package/resources/v1/events/addons/draft.d.ts.map +0 -1
- package/resources/v1/events/addons/draft.js +0 -22
- package/resources/v1/events/addons/draft.js.map +0 -1
- package/resources/v1/events/addons/draft.mjs +0 -18
- package/resources/v1/events/addons/draft.mjs.map +0 -1
- package/resources/v1/events/addons/index.d.mts +0 -3
- package/resources/v1/events/addons/index.d.mts.map +0 -1
- package/resources/v1/events/addons/index.d.ts +0 -3
- package/resources/v1/events/addons/index.d.ts.map +0 -1
- package/resources/v1/events/addons/index.js.map +0 -1
- package/resources/v1/events/addons/index.mjs.map +0 -1
- package/resources/v1/events/addons.d.mts.map +0 -1
- package/resources/v1/events/addons.d.ts.map +0 -1
- package/resources/v1/events/addons.js.map +0 -1
- package/resources/v1/events/addons.mjs.map +0 -1
- package/resources/v1/events/events.d.mts +0 -75
- package/resources/v1/events/events.d.mts.map +0 -1
- package/resources/v1/events/events.d.ts +0 -75
- package/resources/v1/events/events.d.ts.map +0 -1
- package/resources/v1/events/events.js +0 -32
- package/resources/v1/events/events.js.map +0 -1
- package/resources/v1/events/events.mjs +0 -27
- package/resources/v1/events/events.mjs.map +0 -1
- package/resources/v1/events/features.d.mts +0 -856
- package/resources/v1/events/features.d.mts.map +0 -1
- package/resources/v1/events/features.d.ts +0 -856
- package/resources/v1/events/features.d.ts.map +0 -1
- package/resources/v1/events/features.js.map +0 -1
- package/resources/v1/events/features.mjs.map +0 -1
- package/resources/v1/events/index.d.mts +0 -5
- package/resources/v1/events/index.d.mts.map +0 -1
- package/resources/v1/events/index.d.ts +0 -5
- package/resources/v1/events/index.d.ts.map +0 -1
- package/resources/v1/events/index.js +0 -13
- package/resources/v1/events/index.js.map +0 -1
- package/resources/v1/events/index.mjs +0 -6
- package/resources/v1/events/index.mjs.map +0 -1
- package/resources/v1/events/plans.d.mts +0 -348
- package/resources/v1/events/plans.d.mts.map +0 -1
- package/resources/v1/events/plans.d.ts +0 -348
- package/resources/v1/events/plans.d.ts.map +0 -1
- package/resources/v1/events/plans.js +0 -30
- package/resources/v1/events/plans.js.map +0 -1
- package/resources/v1/events/plans.mjs +0 -26
- package/resources/v1/events/plans.mjs.map +0 -1
- package/src/resources/v1/events/addons/addons.ts +0 -761
- package/src/resources/v1/events/addons/draft.ts +0 -151
- package/src/resources/v1/events/addons/index.ts +0 -17
- package/src/resources/v1/events/events.ts +0 -160
- package/src/resources/v1/events/index.ts +0 -39
- package/src/resources/v1/events/plans.ts +0 -429
- /package/resources/v1/{events/addons.d.mts → addons.d.mts} +0 -0
- /package/resources/v1/{events/addons.d.ts → addons.d.ts} +0 -0
- /package/resources/v1/{events/addons.mjs → addons.mjs} +0 -0
- /package/src/resources/v1/{events/addons.ts → addons.ts} +0 -0
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import * as IntegrationsAPI from "./integrations.mjs";
|
|
3
|
+
import { IntegrationLinkParams, IntegrationListParams, IntegrationListResponse, IntegrationListResponsesMyCursorIDPage, IntegrationRetrieveParams, IntegrationUnlinkParams, IntegrationUpdateParams, Integrations } from "./integrations.mjs";
|
|
2
4
|
import * as PaymentMethodAPI from "./payment-method.mjs";
|
|
3
5
|
import { PaymentMethod, PaymentMethodAttachParams } from "./payment-method.mjs";
|
|
4
6
|
import * as PromotionalEntitlementsAPI from "./promotional-entitlements.mjs";
|
|
@@ -9,6 +11,7 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
|
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
16
|
* Retrieves a customer by their unique identifier, including billing information
|
|
14
17
|
* and subscription status.
|
|
@@ -28,13 +31,24 @@ export declare class Customers extends APIResource {
|
|
|
28
31
|
* subscriptions.
|
|
29
32
|
*/
|
|
30
33
|
archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
34
|
+
/**
|
|
35
|
+
* Checks a single entitlement (feature or credit) for a customer or resource.
|
|
36
|
+
* Supports `requestedUsage` and `requestedValues` to evaluate against limits or
|
|
37
|
+
* enum values.
|
|
38
|
+
*
|
|
39
|
+
* **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
|
|
40
|
+
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
41
|
+
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
42
|
+
* with caching or the Sidecar for low-latency cached responses.
|
|
43
|
+
*/
|
|
44
|
+
checkEntitlement(id: string, query?: CustomerCheckEntitlementParams | null | undefined, options?: RequestOptions): APIPromise<CustomerCheckEntitlementResponse>;
|
|
31
45
|
/**
|
|
32
46
|
* Imports multiple customers in bulk. Used for migrating customer data from
|
|
33
47
|
* external systems.
|
|
34
48
|
*/
|
|
35
49
|
import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse>;
|
|
36
50
|
/**
|
|
37
|
-
*
|
|
51
|
+
* Retrieves a paginated list of resources within the same customer.
|
|
38
52
|
*/
|
|
39
53
|
listResources(id: string, query?: CustomerListResourcesParams | null | undefined, options?: RequestOptions): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse>;
|
|
40
54
|
/**
|
|
@@ -42,6 +56,16 @@ export declare class Customers extends APIResource {
|
|
|
42
56
|
* single operation.
|
|
43
57
|
*/
|
|
44
58
|
provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse>;
|
|
59
|
+
/**
|
|
60
|
+
* Retrieves the effective entitlements for a customer or resource, including
|
|
61
|
+
* feature and credit entitlements.
|
|
62
|
+
*
|
|
63
|
+
* **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
|
|
64
|
+
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
65
|
+
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
66
|
+
* with caching or the Sidecar for low-latency cached responses.
|
|
67
|
+
*/
|
|
68
|
+
retrieveEntitlements(id: string, query?: CustomerRetrieveEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<CustomerRetrieveEntitlementsResponse>;
|
|
45
69
|
/**
|
|
46
70
|
* Restores an archived customer, allowing them to create new subscriptions again.
|
|
47
71
|
*/
|
|
@@ -49,6 +73,81 @@ export declare class Customers extends APIResource {
|
|
|
49
73
|
}
|
|
50
74
|
export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResponse>;
|
|
51
75
|
export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Response object
|
|
78
|
+
*/
|
|
79
|
+
export interface CustomerIntegrationResponse {
|
|
80
|
+
/**
|
|
81
|
+
* External billing or CRM integration link
|
|
82
|
+
*/
|
|
83
|
+
data: CustomerIntegrationResponse.Data;
|
|
84
|
+
}
|
|
85
|
+
export declare namespace CustomerIntegrationResponse {
|
|
86
|
+
/**
|
|
87
|
+
* External billing or CRM integration link
|
|
88
|
+
*/
|
|
89
|
+
interface Data {
|
|
90
|
+
/**
|
|
91
|
+
* Integration details
|
|
92
|
+
*/
|
|
93
|
+
id: string;
|
|
94
|
+
/**
|
|
95
|
+
* Synced entity id
|
|
96
|
+
*/
|
|
97
|
+
syncedEntityId: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* The vendor identifier of integration
|
|
100
|
+
*/
|
|
101
|
+
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
102
|
+
/**
|
|
103
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
104
|
+
* group package billing ID
|
|
105
|
+
*/
|
|
106
|
+
syncData?: Data.SyncRevisionPriceBillingData | Data.SyncRevisionBillingData | Data.SyncRevisionMarketplaceData | null;
|
|
107
|
+
}
|
|
108
|
+
namespace Data {
|
|
109
|
+
/**
|
|
110
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
111
|
+
* group package billing ID
|
|
112
|
+
*/
|
|
113
|
+
interface SyncRevisionPriceBillingData {
|
|
114
|
+
/**
|
|
115
|
+
* Billing integration id
|
|
116
|
+
*/
|
|
117
|
+
billingId: string;
|
|
118
|
+
/**
|
|
119
|
+
* Billing integration url
|
|
120
|
+
*/
|
|
121
|
+
billingLinkUrl: string;
|
|
122
|
+
/**
|
|
123
|
+
* Price group package billing id
|
|
124
|
+
*/
|
|
125
|
+
priceGroupPackageBillingId: string;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Billing sync revision data containing billing ID and link URL
|
|
129
|
+
*/
|
|
130
|
+
interface SyncRevisionBillingData {
|
|
131
|
+
/**
|
|
132
|
+
* Billing integration id
|
|
133
|
+
*/
|
|
134
|
+
billingId: string;
|
|
135
|
+
/**
|
|
136
|
+
* Billing integration url
|
|
137
|
+
*/
|
|
138
|
+
billingLinkUrl: string;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Marketplace sync revision data containing dimensions
|
|
142
|
+
*/
|
|
143
|
+
interface SyncRevisionMarketplaceData {
|
|
144
|
+
/**
|
|
145
|
+
* Dimensions of the marketplace sync revision
|
|
146
|
+
*/
|
|
147
|
+
dimensions: string;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
52
151
|
/**
|
|
53
152
|
* Response object
|
|
54
153
|
*/
|
|
@@ -79,10 +178,18 @@ export declare namespace CustomerResponse {
|
|
|
79
178
|
* Timestamp of when the record was last updated
|
|
80
179
|
*/
|
|
81
180
|
updatedAt: string;
|
|
181
|
+
/**
|
|
182
|
+
* The billing currency of the customer
|
|
183
|
+
*/
|
|
184
|
+
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;
|
|
185
|
+
/**
|
|
186
|
+
* The unique identifier for the entity in the billing provider
|
|
187
|
+
*/
|
|
188
|
+
billingId?: string | null;
|
|
82
189
|
/**
|
|
83
190
|
* Customer level coupon
|
|
84
191
|
*/
|
|
85
|
-
couponId?: string | null;
|
|
192
|
+
couponId?: (string & {}) | '' | null;
|
|
86
193
|
/**
|
|
87
194
|
* The default payment method details
|
|
88
195
|
*/
|
|
@@ -95,6 +202,10 @@ export declare namespace CustomerResponse {
|
|
|
95
202
|
* List of integrations
|
|
96
203
|
*/
|
|
97
204
|
integrations?: Array<Data.Integration>;
|
|
205
|
+
/**
|
|
206
|
+
* Language to use for this customer
|
|
207
|
+
*/
|
|
208
|
+
language?: string | null;
|
|
98
209
|
/**
|
|
99
210
|
* Additional metadata
|
|
100
211
|
*/
|
|
@@ -105,6 +216,14 @@ export declare namespace CustomerResponse {
|
|
|
105
216
|
* The name of the customer
|
|
106
217
|
*/
|
|
107
218
|
name?: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* Vendor-specific billing passthrough fields.
|
|
221
|
+
*/
|
|
222
|
+
passthrough?: Data.Passthrough;
|
|
223
|
+
/**
|
|
224
|
+
* Timezone to use for this customer
|
|
225
|
+
*/
|
|
226
|
+
timezone?: string | null;
|
|
108
227
|
}
|
|
109
228
|
namespace Data {
|
|
110
229
|
/**
|
|
@@ -149,6 +268,185 @@ export declare namespace CustomerResponse {
|
|
|
149
268
|
*/
|
|
150
269
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
151
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
* Vendor-specific billing passthrough fields.
|
|
273
|
+
*/
|
|
274
|
+
interface Passthrough {
|
|
275
|
+
/**
|
|
276
|
+
* Stripe-specific billing fields for the customer.
|
|
277
|
+
*/
|
|
278
|
+
stripe?: Passthrough.Stripe;
|
|
279
|
+
/**
|
|
280
|
+
* Zuora-specific billing fields for the customer.
|
|
281
|
+
*/
|
|
282
|
+
zuora?: Passthrough.Zuora;
|
|
283
|
+
}
|
|
284
|
+
namespace Passthrough {
|
|
285
|
+
/**
|
|
286
|
+
* Stripe-specific billing fields for the customer.
|
|
287
|
+
*/
|
|
288
|
+
interface Stripe {
|
|
289
|
+
/**
|
|
290
|
+
* Physical address
|
|
291
|
+
*/
|
|
292
|
+
billingAddress?: Stripe.BillingAddress;
|
|
293
|
+
/**
|
|
294
|
+
* Customer name
|
|
295
|
+
*/
|
|
296
|
+
customerName?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Invoice custom fields
|
|
299
|
+
*/
|
|
300
|
+
invoiceCustomFields?: {
|
|
301
|
+
[key: string]: string;
|
|
302
|
+
};
|
|
303
|
+
/**
|
|
304
|
+
* Additional metadata
|
|
305
|
+
*/
|
|
306
|
+
metadata?: {
|
|
307
|
+
[key: string]: string;
|
|
308
|
+
};
|
|
309
|
+
/**
|
|
310
|
+
* Billing provider payment method id, attached to this customer
|
|
311
|
+
*/
|
|
312
|
+
paymentMethodId?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Physical address
|
|
315
|
+
*/
|
|
316
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
317
|
+
/**
|
|
318
|
+
* Tax IDs
|
|
319
|
+
*/
|
|
320
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
321
|
+
}
|
|
322
|
+
namespace Stripe {
|
|
323
|
+
/**
|
|
324
|
+
* Physical address
|
|
325
|
+
*/
|
|
326
|
+
interface BillingAddress {
|
|
327
|
+
/**
|
|
328
|
+
* City name
|
|
329
|
+
*/
|
|
330
|
+
city?: string;
|
|
331
|
+
/**
|
|
332
|
+
* Country code or name
|
|
333
|
+
*/
|
|
334
|
+
country?: string;
|
|
335
|
+
/**
|
|
336
|
+
* Street address line 1
|
|
337
|
+
*/
|
|
338
|
+
line1?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Street address line 2
|
|
341
|
+
*/
|
|
342
|
+
line2?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Postal or ZIP code
|
|
345
|
+
*/
|
|
346
|
+
postalCode?: string;
|
|
347
|
+
/**
|
|
348
|
+
* State or province
|
|
349
|
+
*/
|
|
350
|
+
state?: string;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* Physical address
|
|
354
|
+
*/
|
|
355
|
+
interface ShippingAddress {
|
|
356
|
+
/**
|
|
357
|
+
* City name
|
|
358
|
+
*/
|
|
359
|
+
city?: string;
|
|
360
|
+
/**
|
|
361
|
+
* Country code or name
|
|
362
|
+
*/
|
|
363
|
+
country?: string;
|
|
364
|
+
/**
|
|
365
|
+
* Street address line 1
|
|
366
|
+
*/
|
|
367
|
+
line1?: string;
|
|
368
|
+
/**
|
|
369
|
+
* Street address line 2
|
|
370
|
+
*/
|
|
371
|
+
line2?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Postal or ZIP code
|
|
374
|
+
*/
|
|
375
|
+
postalCode?: string;
|
|
376
|
+
/**
|
|
377
|
+
* State or province
|
|
378
|
+
*/
|
|
379
|
+
state?: string;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
383
|
+
*/
|
|
384
|
+
interface TaxID {
|
|
385
|
+
/**
|
|
386
|
+
* The type of tax exemption identifier, such as VAT.
|
|
387
|
+
*/
|
|
388
|
+
type: string;
|
|
389
|
+
/**
|
|
390
|
+
* The actual tax identifier value
|
|
391
|
+
*/
|
|
392
|
+
value: string;
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* Zuora-specific billing fields for the customer.
|
|
397
|
+
*/
|
|
398
|
+
interface Zuora {
|
|
399
|
+
/**
|
|
400
|
+
* Physical address
|
|
401
|
+
*/
|
|
402
|
+
billingAddress?: Zuora.BillingAddress;
|
|
403
|
+
/**
|
|
404
|
+
* Customers selected currency
|
|
405
|
+
*/
|
|
406
|
+
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';
|
|
407
|
+
/**
|
|
408
|
+
* Additional metadata
|
|
409
|
+
*/
|
|
410
|
+
metadata?: {
|
|
411
|
+
[key: string]: string;
|
|
412
|
+
};
|
|
413
|
+
/**
|
|
414
|
+
* Billing provider payment method id, attached to this customer
|
|
415
|
+
*/
|
|
416
|
+
paymentMethodId?: string;
|
|
417
|
+
}
|
|
418
|
+
namespace Zuora {
|
|
419
|
+
/**
|
|
420
|
+
* Physical address
|
|
421
|
+
*/
|
|
422
|
+
interface BillingAddress {
|
|
423
|
+
/**
|
|
424
|
+
* City name
|
|
425
|
+
*/
|
|
426
|
+
city?: string;
|
|
427
|
+
/**
|
|
428
|
+
* Country code or name
|
|
429
|
+
*/
|
|
430
|
+
country?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Street address line 1
|
|
433
|
+
*/
|
|
434
|
+
line1?: string;
|
|
435
|
+
/**
|
|
436
|
+
* Street address line 2
|
|
437
|
+
*/
|
|
438
|
+
line2?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Postal or ZIP code
|
|
441
|
+
*/
|
|
442
|
+
postalCode?: string;
|
|
443
|
+
/**
|
|
444
|
+
* State or province
|
|
445
|
+
*/
|
|
446
|
+
state?: string;
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
}
|
|
152
450
|
}
|
|
153
451
|
}
|
|
154
452
|
/**
|
|
@@ -171,10 +469,18 @@ export interface CustomerListResponse {
|
|
|
171
469
|
* Timestamp of when the record was last updated
|
|
172
470
|
*/
|
|
173
471
|
updatedAt: string;
|
|
472
|
+
/**
|
|
473
|
+
* The billing currency of the customer
|
|
474
|
+
*/
|
|
475
|
+
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;
|
|
476
|
+
/**
|
|
477
|
+
* The unique identifier for the entity in the billing provider
|
|
478
|
+
*/
|
|
479
|
+
billingId?: string | null;
|
|
174
480
|
/**
|
|
175
481
|
* Customer level coupon
|
|
176
482
|
*/
|
|
177
|
-
couponId?: string | null;
|
|
483
|
+
couponId?: (string & {}) | '' | null;
|
|
178
484
|
/**
|
|
179
485
|
* The default payment method details
|
|
180
486
|
*/
|
|
@@ -187,6 +493,10 @@ export interface CustomerListResponse {
|
|
|
187
493
|
* List of integrations
|
|
188
494
|
*/
|
|
189
495
|
integrations?: Array<CustomerListResponse.Integration>;
|
|
496
|
+
/**
|
|
497
|
+
* Language to use for this customer
|
|
498
|
+
*/
|
|
499
|
+
language?: string | null;
|
|
190
500
|
/**
|
|
191
501
|
* Additional metadata
|
|
192
502
|
*/
|
|
@@ -197,6 +507,14 @@ export interface CustomerListResponse {
|
|
|
197
507
|
* The name of the customer
|
|
198
508
|
*/
|
|
199
509
|
name?: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* Vendor-specific billing passthrough fields.
|
|
512
|
+
*/
|
|
513
|
+
passthrough?: CustomerListResponse.Passthrough;
|
|
514
|
+
/**
|
|
515
|
+
* Timezone to use for this customer
|
|
516
|
+
*/
|
|
517
|
+
timezone?: string | null;
|
|
200
518
|
}
|
|
201
519
|
export declare namespace CustomerListResponse {
|
|
202
520
|
/**
|
|
@@ -241,6 +559,306 @@ export declare namespace CustomerListResponse {
|
|
|
241
559
|
*/
|
|
242
560
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
243
561
|
}
|
|
562
|
+
/**
|
|
563
|
+
* Vendor-specific billing passthrough fields.
|
|
564
|
+
*/
|
|
565
|
+
interface Passthrough {
|
|
566
|
+
/**
|
|
567
|
+
* Stripe-specific billing fields for the customer.
|
|
568
|
+
*/
|
|
569
|
+
stripe?: Passthrough.Stripe;
|
|
570
|
+
/**
|
|
571
|
+
* Zuora-specific billing fields for the customer.
|
|
572
|
+
*/
|
|
573
|
+
zuora?: Passthrough.Zuora;
|
|
574
|
+
}
|
|
575
|
+
namespace Passthrough {
|
|
576
|
+
/**
|
|
577
|
+
* Stripe-specific billing fields for the customer.
|
|
578
|
+
*/
|
|
579
|
+
interface Stripe {
|
|
580
|
+
/**
|
|
581
|
+
* Physical address
|
|
582
|
+
*/
|
|
583
|
+
billingAddress?: Stripe.BillingAddress;
|
|
584
|
+
/**
|
|
585
|
+
* Customer name
|
|
586
|
+
*/
|
|
587
|
+
customerName?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Invoice custom fields
|
|
590
|
+
*/
|
|
591
|
+
invoiceCustomFields?: {
|
|
592
|
+
[key: string]: string;
|
|
593
|
+
};
|
|
594
|
+
/**
|
|
595
|
+
* Additional metadata
|
|
596
|
+
*/
|
|
597
|
+
metadata?: {
|
|
598
|
+
[key: string]: string;
|
|
599
|
+
};
|
|
600
|
+
/**
|
|
601
|
+
* Billing provider payment method id, attached to this customer
|
|
602
|
+
*/
|
|
603
|
+
paymentMethodId?: string;
|
|
604
|
+
/**
|
|
605
|
+
* Physical address
|
|
606
|
+
*/
|
|
607
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
608
|
+
/**
|
|
609
|
+
* Tax IDs
|
|
610
|
+
*/
|
|
611
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
612
|
+
}
|
|
613
|
+
namespace Stripe {
|
|
614
|
+
/**
|
|
615
|
+
* Physical address
|
|
616
|
+
*/
|
|
617
|
+
interface BillingAddress {
|
|
618
|
+
/**
|
|
619
|
+
* City name
|
|
620
|
+
*/
|
|
621
|
+
city?: string;
|
|
622
|
+
/**
|
|
623
|
+
* Country code or name
|
|
624
|
+
*/
|
|
625
|
+
country?: string;
|
|
626
|
+
/**
|
|
627
|
+
* Street address line 1
|
|
628
|
+
*/
|
|
629
|
+
line1?: string;
|
|
630
|
+
/**
|
|
631
|
+
* Street address line 2
|
|
632
|
+
*/
|
|
633
|
+
line2?: string;
|
|
634
|
+
/**
|
|
635
|
+
* Postal or ZIP code
|
|
636
|
+
*/
|
|
637
|
+
postalCode?: string;
|
|
638
|
+
/**
|
|
639
|
+
* State or province
|
|
640
|
+
*/
|
|
641
|
+
state?: string;
|
|
642
|
+
}
|
|
643
|
+
/**
|
|
644
|
+
* Physical address
|
|
645
|
+
*/
|
|
646
|
+
interface ShippingAddress {
|
|
647
|
+
/**
|
|
648
|
+
* City name
|
|
649
|
+
*/
|
|
650
|
+
city?: string;
|
|
651
|
+
/**
|
|
652
|
+
* Country code or name
|
|
653
|
+
*/
|
|
654
|
+
country?: string;
|
|
655
|
+
/**
|
|
656
|
+
* Street address line 1
|
|
657
|
+
*/
|
|
658
|
+
line1?: string;
|
|
659
|
+
/**
|
|
660
|
+
* Street address line 2
|
|
661
|
+
*/
|
|
662
|
+
line2?: string;
|
|
663
|
+
/**
|
|
664
|
+
* Postal or ZIP code
|
|
665
|
+
*/
|
|
666
|
+
postalCode?: string;
|
|
667
|
+
/**
|
|
668
|
+
* State or province
|
|
669
|
+
*/
|
|
670
|
+
state?: string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
674
|
+
*/
|
|
675
|
+
interface TaxID {
|
|
676
|
+
/**
|
|
677
|
+
* The type of tax exemption identifier, such as VAT.
|
|
678
|
+
*/
|
|
679
|
+
type: string;
|
|
680
|
+
/**
|
|
681
|
+
* The actual tax identifier value
|
|
682
|
+
*/
|
|
683
|
+
value: string;
|
|
684
|
+
}
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* Zuora-specific billing fields for the customer.
|
|
688
|
+
*/
|
|
689
|
+
interface Zuora {
|
|
690
|
+
/**
|
|
691
|
+
* Physical address
|
|
692
|
+
*/
|
|
693
|
+
billingAddress?: Zuora.BillingAddress;
|
|
694
|
+
/**
|
|
695
|
+
* Customers selected currency
|
|
696
|
+
*/
|
|
697
|
+
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';
|
|
698
|
+
/**
|
|
699
|
+
* Additional metadata
|
|
700
|
+
*/
|
|
701
|
+
metadata?: {
|
|
702
|
+
[key: string]: string;
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* Billing provider payment method id, attached to this customer
|
|
706
|
+
*/
|
|
707
|
+
paymentMethodId?: string;
|
|
708
|
+
}
|
|
709
|
+
namespace Zuora {
|
|
710
|
+
/**
|
|
711
|
+
* Physical address
|
|
712
|
+
*/
|
|
713
|
+
interface BillingAddress {
|
|
714
|
+
/**
|
|
715
|
+
* City name
|
|
716
|
+
*/
|
|
717
|
+
city?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Country code or name
|
|
720
|
+
*/
|
|
721
|
+
country?: string;
|
|
722
|
+
/**
|
|
723
|
+
* Street address line 1
|
|
724
|
+
*/
|
|
725
|
+
line1?: string;
|
|
726
|
+
/**
|
|
727
|
+
* Street address line 2
|
|
728
|
+
*/
|
|
729
|
+
line2?: string;
|
|
730
|
+
/**
|
|
731
|
+
* Postal or ZIP code
|
|
732
|
+
*/
|
|
733
|
+
postalCode?: string;
|
|
734
|
+
/**
|
|
735
|
+
* State or province
|
|
736
|
+
*/
|
|
737
|
+
state?: string;
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* Response object
|
|
744
|
+
*/
|
|
745
|
+
export interface CustomerCheckEntitlementResponse {
|
|
746
|
+
data: CustomerCheckEntitlementResponse.Feature | CustomerCheckEntitlementResponse.Credit;
|
|
747
|
+
}
|
|
748
|
+
export declare namespace CustomerCheckEntitlementResponse {
|
|
749
|
+
interface Feature {
|
|
750
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
751
|
+
isGranted: boolean;
|
|
752
|
+
type: 'FEATURE';
|
|
753
|
+
currentUsage?: number;
|
|
754
|
+
/**
|
|
755
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
756
|
+
*/
|
|
757
|
+
entitlementUpdatedAt?: string;
|
|
758
|
+
feature?: Feature.Feature;
|
|
759
|
+
hasUnlimitedUsage?: boolean;
|
|
760
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
761
|
+
usageLimit?: number | null;
|
|
762
|
+
/**
|
|
763
|
+
* The anchor for calculating the usage period for metered entitlements with a
|
|
764
|
+
* reset period configured
|
|
765
|
+
*/
|
|
766
|
+
usagePeriodAnchor?: string;
|
|
767
|
+
/**
|
|
768
|
+
* The end date of the usage period for metered entitlements with a reset period
|
|
769
|
+
* configured
|
|
770
|
+
*/
|
|
771
|
+
usagePeriodEnd?: string;
|
|
772
|
+
/**
|
|
773
|
+
* The start date of the usage period for metered entitlements with a reset period
|
|
774
|
+
* configured
|
|
775
|
+
*/
|
|
776
|
+
usagePeriodStart?: string;
|
|
777
|
+
/**
|
|
778
|
+
* The next time the entitlement should be recalculated
|
|
779
|
+
*/
|
|
780
|
+
validUntil?: string;
|
|
781
|
+
}
|
|
782
|
+
namespace Feature {
|
|
783
|
+
interface Feature {
|
|
784
|
+
/**
|
|
785
|
+
* The unique reference ID of the entitlement.
|
|
786
|
+
*/
|
|
787
|
+
id: string;
|
|
788
|
+
/**
|
|
789
|
+
* The human-readable name of the entitlement, shown in UI elements.
|
|
790
|
+
*/
|
|
791
|
+
displayName: string;
|
|
792
|
+
/**
|
|
793
|
+
* The current status of the feature.
|
|
794
|
+
*/
|
|
795
|
+
featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
|
|
796
|
+
/**
|
|
797
|
+
* The type of feature associated with the entitlement.
|
|
798
|
+
*/
|
|
799
|
+
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
interface Credit {
|
|
803
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
804
|
+
/**
|
|
805
|
+
* The currency associated with a credit entitlement.
|
|
806
|
+
*/
|
|
807
|
+
currency: Credit.Currency;
|
|
808
|
+
currentUsage: number;
|
|
809
|
+
isGranted: boolean;
|
|
810
|
+
type: 'CREDIT';
|
|
811
|
+
usageLimit: number;
|
|
812
|
+
/**
|
|
813
|
+
* Timestamp of the last update to the credit usage.
|
|
814
|
+
*/
|
|
815
|
+
usageUpdatedAt: string;
|
|
816
|
+
/**
|
|
817
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
818
|
+
*/
|
|
819
|
+
entitlementUpdatedAt?: string;
|
|
820
|
+
/**
|
|
821
|
+
* The end date of the current billing period for recurring credit grants.
|
|
822
|
+
*/
|
|
823
|
+
usagePeriodEnd?: string;
|
|
824
|
+
/**
|
|
825
|
+
* The next time the entitlement should be recalculated
|
|
826
|
+
*/
|
|
827
|
+
validUntil?: string;
|
|
828
|
+
}
|
|
829
|
+
namespace Credit {
|
|
830
|
+
/**
|
|
831
|
+
* The currency associated with a credit entitlement.
|
|
832
|
+
*/
|
|
833
|
+
interface Currency {
|
|
834
|
+
/**
|
|
835
|
+
* The unique identifier of the custom currency.
|
|
836
|
+
*/
|
|
837
|
+
currencyId: string;
|
|
838
|
+
/**
|
|
839
|
+
* The display name of the currency.
|
|
840
|
+
*/
|
|
841
|
+
displayName: string;
|
|
842
|
+
/**
|
|
843
|
+
* A description of the currency.
|
|
844
|
+
*/
|
|
845
|
+
description?: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* Additional metadata associated with the currency.
|
|
848
|
+
*/
|
|
849
|
+
metadata?: {
|
|
850
|
+
[key: string]: string;
|
|
851
|
+
} | null;
|
|
852
|
+
/**
|
|
853
|
+
* The plural form of the currency unit.
|
|
854
|
+
*/
|
|
855
|
+
unitPlural?: string | null;
|
|
856
|
+
/**
|
|
857
|
+
* The singular form of the currency unit.
|
|
858
|
+
*/
|
|
859
|
+
unitSingular?: string | null;
|
|
860
|
+
}
|
|
861
|
+
}
|
|
244
862
|
}
|
|
245
863
|
/**
|
|
246
864
|
* Response object
|
|
@@ -279,11 +897,158 @@ export interface CustomerListResourcesResponse {
|
|
|
279
897
|
*/
|
|
280
898
|
updatedAt: string;
|
|
281
899
|
}
|
|
900
|
+
/**
|
|
901
|
+
* Response object
|
|
902
|
+
*/
|
|
903
|
+
export interface CustomerRetrieveEntitlementsResponse {
|
|
904
|
+
/**
|
|
905
|
+
* The effective entitlements state for a customer or resource.
|
|
906
|
+
*/
|
|
907
|
+
data: CustomerRetrieveEntitlementsResponse.Data;
|
|
908
|
+
}
|
|
909
|
+
export declare namespace CustomerRetrieveEntitlementsResponse {
|
|
910
|
+
/**
|
|
911
|
+
* The effective entitlements state for a customer or resource.
|
|
912
|
+
*/
|
|
913
|
+
interface Data {
|
|
914
|
+
/**
|
|
915
|
+
* Reason why entitlements access was denied, if applicable
|
|
916
|
+
*/
|
|
917
|
+
accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
|
|
918
|
+
/**
|
|
919
|
+
* List of effective feature and credit entitlements
|
|
920
|
+
*/
|
|
921
|
+
entitlements: Array<Data.Feature | Data.Credit>;
|
|
922
|
+
}
|
|
923
|
+
namespace Data {
|
|
924
|
+
interface Feature {
|
|
925
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
926
|
+
isGranted: boolean;
|
|
927
|
+
type: 'FEATURE';
|
|
928
|
+
currentUsage?: number;
|
|
929
|
+
/**
|
|
930
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
931
|
+
*/
|
|
932
|
+
entitlementUpdatedAt?: string;
|
|
933
|
+
feature?: Feature.Feature;
|
|
934
|
+
hasUnlimitedUsage?: boolean;
|
|
935
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
936
|
+
usageLimit?: number | null;
|
|
937
|
+
/**
|
|
938
|
+
* The anchor for calculating the usage period for metered entitlements with a
|
|
939
|
+
* reset period configured
|
|
940
|
+
*/
|
|
941
|
+
usagePeriodAnchor?: string;
|
|
942
|
+
/**
|
|
943
|
+
* The end date of the usage period for metered entitlements with a reset period
|
|
944
|
+
* configured
|
|
945
|
+
*/
|
|
946
|
+
usagePeriodEnd?: string;
|
|
947
|
+
/**
|
|
948
|
+
* The start date of the usage period for metered entitlements with a reset period
|
|
949
|
+
* configured
|
|
950
|
+
*/
|
|
951
|
+
usagePeriodStart?: string;
|
|
952
|
+
/**
|
|
953
|
+
* The next time the entitlement should be recalculated
|
|
954
|
+
*/
|
|
955
|
+
validUntil?: string;
|
|
956
|
+
}
|
|
957
|
+
namespace Feature {
|
|
958
|
+
interface Feature {
|
|
959
|
+
/**
|
|
960
|
+
* The unique reference ID of the entitlement.
|
|
961
|
+
*/
|
|
962
|
+
id: string;
|
|
963
|
+
/**
|
|
964
|
+
* The human-readable name of the entitlement, shown in UI elements.
|
|
965
|
+
*/
|
|
966
|
+
displayName: string;
|
|
967
|
+
/**
|
|
968
|
+
* The current status of the feature.
|
|
969
|
+
*/
|
|
970
|
+
featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
|
|
971
|
+
/**
|
|
972
|
+
* The type of feature associated with the entitlement.
|
|
973
|
+
*/
|
|
974
|
+
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
975
|
+
}
|
|
976
|
+
}
|
|
977
|
+
interface Credit {
|
|
978
|
+
accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
|
|
979
|
+
/**
|
|
980
|
+
* The currency associated with a credit entitlement.
|
|
981
|
+
*/
|
|
982
|
+
currency: Credit.Currency;
|
|
983
|
+
currentUsage: number;
|
|
984
|
+
isGranted: boolean;
|
|
985
|
+
type: 'CREDIT';
|
|
986
|
+
usageLimit: number;
|
|
987
|
+
/**
|
|
988
|
+
* Timestamp of the last update to the credit usage.
|
|
989
|
+
*/
|
|
990
|
+
usageUpdatedAt: string;
|
|
991
|
+
/**
|
|
992
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
993
|
+
*/
|
|
994
|
+
entitlementUpdatedAt?: string;
|
|
995
|
+
/**
|
|
996
|
+
* The end date of the current billing period for recurring credit grants.
|
|
997
|
+
*/
|
|
998
|
+
usagePeriodEnd?: string;
|
|
999
|
+
/**
|
|
1000
|
+
* The next time the entitlement should be recalculated
|
|
1001
|
+
*/
|
|
1002
|
+
validUntil?: string;
|
|
1003
|
+
}
|
|
1004
|
+
namespace Credit {
|
|
1005
|
+
/**
|
|
1006
|
+
* The currency associated with a credit entitlement.
|
|
1007
|
+
*/
|
|
1008
|
+
interface Currency {
|
|
1009
|
+
/**
|
|
1010
|
+
* The unique identifier of the custom currency.
|
|
1011
|
+
*/
|
|
1012
|
+
currencyId: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* The display name of the currency.
|
|
1015
|
+
*/
|
|
1016
|
+
displayName: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* A description of the currency.
|
|
1019
|
+
*/
|
|
1020
|
+
description?: string | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Additional metadata associated with the currency.
|
|
1023
|
+
*/
|
|
1024
|
+
metadata?: {
|
|
1025
|
+
[key: string]: string;
|
|
1026
|
+
} | null;
|
|
1027
|
+
/**
|
|
1028
|
+
* The plural form of the currency unit.
|
|
1029
|
+
*/
|
|
1030
|
+
unitPlural?: string | null;
|
|
1031
|
+
/**
|
|
1032
|
+
* The singular form of the currency unit.
|
|
1033
|
+
*/
|
|
1034
|
+
unitSingular?: string | null;
|
|
1035
|
+
}
|
|
1036
|
+
}
|
|
1037
|
+
}
|
|
1038
|
+
}
|
|
282
1039
|
export interface CustomerUpdateParams {
|
|
1040
|
+
/**
|
|
1041
|
+
* The billing currency of the customer
|
|
1042
|
+
*/
|
|
1043
|
+
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;
|
|
1044
|
+
/**
|
|
1045
|
+
* The unique identifier for the entity in the billing provider
|
|
1046
|
+
*/
|
|
1047
|
+
billingId?: string | null;
|
|
283
1048
|
/**
|
|
284
1049
|
* Customer level coupon
|
|
285
1050
|
*/
|
|
286
|
-
couponId?: string | null;
|
|
1051
|
+
couponId?: (string & {}) | '' | null;
|
|
287
1052
|
/**
|
|
288
1053
|
* The email of the customer
|
|
289
1054
|
*/
|
|
@@ -292,6 +1057,10 @@ export interface CustomerUpdateParams {
|
|
|
292
1057
|
* List of integrations
|
|
293
1058
|
*/
|
|
294
1059
|
integrations?: Array<CustomerUpdateParams.Integration>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Language to use for this customer
|
|
1062
|
+
*/
|
|
1063
|
+
language?: string | null;
|
|
295
1064
|
/**
|
|
296
1065
|
* Additional metadata
|
|
297
1066
|
*/
|
|
@@ -302,6 +1071,14 @@ export interface CustomerUpdateParams {
|
|
|
302
1071
|
* The name of the customer
|
|
303
1072
|
*/
|
|
304
1073
|
name?: string | null;
|
|
1074
|
+
/**
|
|
1075
|
+
* Vendor-specific billing passthrough fields.
|
|
1076
|
+
*/
|
|
1077
|
+
passthrough?: CustomerUpdateParams.Passthrough;
|
|
1078
|
+
/**
|
|
1079
|
+
* Timezone to use for this customer
|
|
1080
|
+
*/
|
|
1081
|
+
timezone?: string | null;
|
|
305
1082
|
}
|
|
306
1083
|
export declare namespace CustomerUpdateParams {
|
|
307
1084
|
/**
|
|
@@ -321,6 +1098,185 @@ export declare namespace CustomerUpdateParams {
|
|
|
321
1098
|
*/
|
|
322
1099
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
323
1100
|
}
|
|
1101
|
+
/**
|
|
1102
|
+
* Vendor-specific billing passthrough fields.
|
|
1103
|
+
*/
|
|
1104
|
+
interface Passthrough {
|
|
1105
|
+
/**
|
|
1106
|
+
* Stripe-specific billing fields for the customer.
|
|
1107
|
+
*/
|
|
1108
|
+
stripe?: Passthrough.Stripe;
|
|
1109
|
+
/**
|
|
1110
|
+
* Zuora-specific billing fields for the customer.
|
|
1111
|
+
*/
|
|
1112
|
+
zuora?: Passthrough.Zuora;
|
|
1113
|
+
}
|
|
1114
|
+
namespace Passthrough {
|
|
1115
|
+
/**
|
|
1116
|
+
* Stripe-specific billing fields for the customer.
|
|
1117
|
+
*/
|
|
1118
|
+
interface Stripe {
|
|
1119
|
+
/**
|
|
1120
|
+
* Physical address
|
|
1121
|
+
*/
|
|
1122
|
+
billingAddress?: Stripe.BillingAddress;
|
|
1123
|
+
/**
|
|
1124
|
+
* Customer name
|
|
1125
|
+
*/
|
|
1126
|
+
customerName?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Invoice custom fields
|
|
1129
|
+
*/
|
|
1130
|
+
invoiceCustomFields?: {
|
|
1131
|
+
[key: string]: string;
|
|
1132
|
+
};
|
|
1133
|
+
/**
|
|
1134
|
+
* Additional metadata
|
|
1135
|
+
*/
|
|
1136
|
+
metadata?: {
|
|
1137
|
+
[key: string]: string;
|
|
1138
|
+
};
|
|
1139
|
+
/**
|
|
1140
|
+
* Billing provider payment method id, attached to this customer
|
|
1141
|
+
*/
|
|
1142
|
+
paymentMethodId?: string;
|
|
1143
|
+
/**
|
|
1144
|
+
* Physical address
|
|
1145
|
+
*/
|
|
1146
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
1147
|
+
/**
|
|
1148
|
+
* Tax IDs
|
|
1149
|
+
*/
|
|
1150
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
1151
|
+
}
|
|
1152
|
+
namespace Stripe {
|
|
1153
|
+
/**
|
|
1154
|
+
* Physical address
|
|
1155
|
+
*/
|
|
1156
|
+
interface BillingAddress {
|
|
1157
|
+
/**
|
|
1158
|
+
* City name
|
|
1159
|
+
*/
|
|
1160
|
+
city?: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Country code or name
|
|
1163
|
+
*/
|
|
1164
|
+
country?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* Street address line 1
|
|
1167
|
+
*/
|
|
1168
|
+
line1?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* Street address line 2
|
|
1171
|
+
*/
|
|
1172
|
+
line2?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* Postal or ZIP code
|
|
1175
|
+
*/
|
|
1176
|
+
postalCode?: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* State or province
|
|
1179
|
+
*/
|
|
1180
|
+
state?: string;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* Physical address
|
|
1184
|
+
*/
|
|
1185
|
+
interface ShippingAddress {
|
|
1186
|
+
/**
|
|
1187
|
+
* City name
|
|
1188
|
+
*/
|
|
1189
|
+
city?: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Country code or name
|
|
1192
|
+
*/
|
|
1193
|
+
country?: string;
|
|
1194
|
+
/**
|
|
1195
|
+
* Street address line 1
|
|
1196
|
+
*/
|
|
1197
|
+
line1?: string;
|
|
1198
|
+
/**
|
|
1199
|
+
* Street address line 2
|
|
1200
|
+
*/
|
|
1201
|
+
line2?: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* Postal or ZIP code
|
|
1204
|
+
*/
|
|
1205
|
+
postalCode?: string;
|
|
1206
|
+
/**
|
|
1207
|
+
* State or province
|
|
1208
|
+
*/
|
|
1209
|
+
state?: string;
|
|
1210
|
+
}
|
|
1211
|
+
/**
|
|
1212
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
1213
|
+
*/
|
|
1214
|
+
interface TaxID {
|
|
1215
|
+
/**
|
|
1216
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1217
|
+
*/
|
|
1218
|
+
type: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* The actual tax identifier value
|
|
1221
|
+
*/
|
|
1222
|
+
value: string;
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
/**
|
|
1226
|
+
* Zuora-specific billing fields for the customer.
|
|
1227
|
+
*/
|
|
1228
|
+
interface Zuora {
|
|
1229
|
+
/**
|
|
1230
|
+
* Physical address
|
|
1231
|
+
*/
|
|
1232
|
+
billingAddress?: Zuora.BillingAddress;
|
|
1233
|
+
/**
|
|
1234
|
+
* Customers selected currency
|
|
1235
|
+
*/
|
|
1236
|
+
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';
|
|
1237
|
+
/**
|
|
1238
|
+
* Additional metadata
|
|
1239
|
+
*/
|
|
1240
|
+
metadata?: {
|
|
1241
|
+
[key: string]: string;
|
|
1242
|
+
};
|
|
1243
|
+
/**
|
|
1244
|
+
* Billing provider payment method id, attached to this customer
|
|
1245
|
+
*/
|
|
1246
|
+
paymentMethodId?: string;
|
|
1247
|
+
}
|
|
1248
|
+
namespace Zuora {
|
|
1249
|
+
/**
|
|
1250
|
+
* Physical address
|
|
1251
|
+
*/
|
|
1252
|
+
interface BillingAddress {
|
|
1253
|
+
/**
|
|
1254
|
+
* City name
|
|
1255
|
+
*/
|
|
1256
|
+
city?: string;
|
|
1257
|
+
/**
|
|
1258
|
+
* Country code or name
|
|
1259
|
+
*/
|
|
1260
|
+
country?: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* Street address line 1
|
|
1263
|
+
*/
|
|
1264
|
+
line1?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* Street address line 2
|
|
1267
|
+
*/
|
|
1268
|
+
line2?: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* Postal or ZIP code
|
|
1271
|
+
*/
|
|
1272
|
+
postalCode?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* State or province
|
|
1275
|
+
*/
|
|
1276
|
+
state?: string;
|
|
1277
|
+
}
|
|
1278
|
+
}
|
|
1279
|
+
}
|
|
324
1280
|
}
|
|
325
1281
|
export interface CustomerListParams extends MyCursorIDPageParams {
|
|
326
1282
|
/**
|
|
@@ -359,11 +1315,39 @@ export declare namespace CustomerListParams {
|
|
|
359
1315
|
lte?: string;
|
|
360
1316
|
}
|
|
361
1317
|
}
|
|
1318
|
+
export interface CustomerCheckEntitlementParams {
|
|
1319
|
+
/**
|
|
1320
|
+
* Currency ID (refId) to check for credit entitlements. Mutually exclusive with
|
|
1321
|
+
* `featureId`.
|
|
1322
|
+
*/
|
|
1323
|
+
currencyId?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Feature ID (refId) to check. Mutually exclusive with `currencyId`.
|
|
1326
|
+
*/
|
|
1327
|
+
featureId?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* Requested usage amount to evaluate against the entitlement limit (numeric
|
|
1330
|
+
* features only)
|
|
1331
|
+
*/
|
|
1332
|
+
requestedUsage?: number;
|
|
1333
|
+
/**
|
|
1334
|
+
* Requested values to evaluate against allowed values (enum features only)
|
|
1335
|
+
*/
|
|
1336
|
+
requestedValues?: Array<string>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Resource ID to scope the entitlement check to a specific resource
|
|
1339
|
+
*/
|
|
1340
|
+
resourceId?: string;
|
|
1341
|
+
}
|
|
362
1342
|
export interface CustomerImportParams {
|
|
363
1343
|
/**
|
|
364
1344
|
* List of customer objects to import
|
|
365
1345
|
*/
|
|
366
1346
|
customers: Array<CustomerImportParams.Customer>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Integration details
|
|
1349
|
+
*/
|
|
1350
|
+
integrationId?: string;
|
|
367
1351
|
}
|
|
368
1352
|
export declare namespace CustomerImportParams {
|
|
369
1353
|
interface Customer {
|
|
@@ -379,6 +1363,10 @@ export declare namespace CustomerImportParams {
|
|
|
379
1363
|
* The name of the customer
|
|
380
1364
|
*/
|
|
381
1365
|
name: string | null;
|
|
1366
|
+
/**
|
|
1367
|
+
* Id in the billing provider
|
|
1368
|
+
*/
|
|
1369
|
+
billingId?: string;
|
|
382
1370
|
/**
|
|
383
1371
|
* Additional metadata
|
|
384
1372
|
*/
|
|
@@ -389,6 +1377,10 @@ export declare namespace CustomerImportParams {
|
|
|
389
1377
|
* Billing provider payment method id
|
|
390
1378
|
*/
|
|
391
1379
|
paymentMethodId?: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* The unique identifier for the customer in Salesforce integration
|
|
1382
|
+
*/
|
|
1383
|
+
salesforceId?: string;
|
|
392
1384
|
/**
|
|
393
1385
|
* Timestamp of when the record was last updated
|
|
394
1386
|
*/
|
|
@@ -402,10 +1394,18 @@ export interface CustomerProvisionParams {
|
|
|
402
1394
|
* Customer slug
|
|
403
1395
|
*/
|
|
404
1396
|
id: string;
|
|
1397
|
+
/**
|
|
1398
|
+
* The billing currency of the customer
|
|
1399
|
+
*/
|
|
1400
|
+
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;
|
|
1401
|
+
/**
|
|
1402
|
+
* The unique identifier for the entity in the billing provider
|
|
1403
|
+
*/
|
|
1404
|
+
billingId?: string | null;
|
|
405
1405
|
/**
|
|
406
1406
|
* Customer level coupon
|
|
407
1407
|
*/
|
|
408
|
-
couponId?: string | null;
|
|
1408
|
+
couponId?: (string & {}) | '' | null;
|
|
409
1409
|
/**
|
|
410
1410
|
* The default payment method details
|
|
411
1411
|
*/
|
|
@@ -418,6 +1418,10 @@ export interface CustomerProvisionParams {
|
|
|
418
1418
|
* List of integrations
|
|
419
1419
|
*/
|
|
420
1420
|
integrations?: Array<CustomerProvisionParams.Integration>;
|
|
1421
|
+
/**
|
|
1422
|
+
* Language to use for this customer
|
|
1423
|
+
*/
|
|
1424
|
+
language?: string | null;
|
|
421
1425
|
/**
|
|
422
1426
|
* Additional metadata
|
|
423
1427
|
*/
|
|
@@ -428,6 +1432,14 @@ export interface CustomerProvisionParams {
|
|
|
428
1432
|
* The name of the customer
|
|
429
1433
|
*/
|
|
430
1434
|
name?: string | null;
|
|
1435
|
+
/**
|
|
1436
|
+
* Vendor-specific billing passthrough fields.
|
|
1437
|
+
*/
|
|
1438
|
+
passthrough?: CustomerProvisionParams.Passthrough;
|
|
1439
|
+
/**
|
|
1440
|
+
* Timezone to use for this customer
|
|
1441
|
+
*/
|
|
1442
|
+
timezone?: string | null;
|
|
431
1443
|
}
|
|
432
1444
|
export declare namespace CustomerProvisionParams {
|
|
433
1445
|
/**
|
|
@@ -472,10 +1484,196 @@ export declare namespace CustomerProvisionParams {
|
|
|
472
1484
|
*/
|
|
473
1485
|
vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
|
|
474
1486
|
}
|
|
1487
|
+
/**
|
|
1488
|
+
* Vendor-specific billing passthrough fields.
|
|
1489
|
+
*/
|
|
1490
|
+
interface Passthrough {
|
|
1491
|
+
/**
|
|
1492
|
+
* Stripe-specific billing fields for the customer.
|
|
1493
|
+
*/
|
|
1494
|
+
stripe?: Passthrough.Stripe;
|
|
1495
|
+
/**
|
|
1496
|
+
* Zuora-specific billing fields for the customer.
|
|
1497
|
+
*/
|
|
1498
|
+
zuora?: Passthrough.Zuora;
|
|
1499
|
+
}
|
|
1500
|
+
namespace Passthrough {
|
|
1501
|
+
/**
|
|
1502
|
+
* Stripe-specific billing fields for the customer.
|
|
1503
|
+
*/
|
|
1504
|
+
interface Stripe {
|
|
1505
|
+
/**
|
|
1506
|
+
* Physical address
|
|
1507
|
+
*/
|
|
1508
|
+
billingAddress?: Stripe.BillingAddress;
|
|
1509
|
+
/**
|
|
1510
|
+
* Customer name
|
|
1511
|
+
*/
|
|
1512
|
+
customerName?: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Invoice custom fields
|
|
1515
|
+
*/
|
|
1516
|
+
invoiceCustomFields?: {
|
|
1517
|
+
[key: string]: string;
|
|
1518
|
+
};
|
|
1519
|
+
/**
|
|
1520
|
+
* Additional metadata
|
|
1521
|
+
*/
|
|
1522
|
+
metadata?: {
|
|
1523
|
+
[key: string]: string;
|
|
1524
|
+
};
|
|
1525
|
+
/**
|
|
1526
|
+
* Billing provider payment method id, attached to this customer
|
|
1527
|
+
*/
|
|
1528
|
+
paymentMethodId?: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* Physical address
|
|
1531
|
+
*/
|
|
1532
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
1533
|
+
/**
|
|
1534
|
+
* Tax IDs
|
|
1535
|
+
*/
|
|
1536
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
1537
|
+
}
|
|
1538
|
+
namespace Stripe {
|
|
1539
|
+
/**
|
|
1540
|
+
* Physical address
|
|
1541
|
+
*/
|
|
1542
|
+
interface BillingAddress {
|
|
1543
|
+
/**
|
|
1544
|
+
* City name
|
|
1545
|
+
*/
|
|
1546
|
+
city?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* Country code or name
|
|
1549
|
+
*/
|
|
1550
|
+
country?: string;
|
|
1551
|
+
/**
|
|
1552
|
+
* Street address line 1
|
|
1553
|
+
*/
|
|
1554
|
+
line1?: string;
|
|
1555
|
+
/**
|
|
1556
|
+
* Street address line 2
|
|
1557
|
+
*/
|
|
1558
|
+
line2?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* Postal or ZIP code
|
|
1561
|
+
*/
|
|
1562
|
+
postalCode?: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* State or province
|
|
1565
|
+
*/
|
|
1566
|
+
state?: string;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* Physical address
|
|
1570
|
+
*/
|
|
1571
|
+
interface ShippingAddress {
|
|
1572
|
+
/**
|
|
1573
|
+
* City name
|
|
1574
|
+
*/
|
|
1575
|
+
city?: string;
|
|
1576
|
+
/**
|
|
1577
|
+
* Country code or name
|
|
1578
|
+
*/
|
|
1579
|
+
country?: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* Street address line 1
|
|
1582
|
+
*/
|
|
1583
|
+
line1?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Street address line 2
|
|
1586
|
+
*/
|
|
1587
|
+
line2?: string;
|
|
1588
|
+
/**
|
|
1589
|
+
* Postal or ZIP code
|
|
1590
|
+
*/
|
|
1591
|
+
postalCode?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* State or province
|
|
1594
|
+
*/
|
|
1595
|
+
state?: string;
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
1599
|
+
*/
|
|
1600
|
+
interface TaxID {
|
|
1601
|
+
/**
|
|
1602
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1603
|
+
*/
|
|
1604
|
+
type: string;
|
|
1605
|
+
/**
|
|
1606
|
+
* The actual tax identifier value
|
|
1607
|
+
*/
|
|
1608
|
+
value: string;
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* Zuora-specific billing fields for the customer.
|
|
1613
|
+
*/
|
|
1614
|
+
interface Zuora {
|
|
1615
|
+
/**
|
|
1616
|
+
* Physical address
|
|
1617
|
+
*/
|
|
1618
|
+
billingAddress?: Zuora.BillingAddress;
|
|
1619
|
+
/**
|
|
1620
|
+
* Customers selected currency
|
|
1621
|
+
*/
|
|
1622
|
+
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';
|
|
1623
|
+
/**
|
|
1624
|
+
* Additional metadata
|
|
1625
|
+
*/
|
|
1626
|
+
metadata?: {
|
|
1627
|
+
[key: string]: string;
|
|
1628
|
+
};
|
|
1629
|
+
/**
|
|
1630
|
+
* Billing provider payment method id, attached to this customer
|
|
1631
|
+
*/
|
|
1632
|
+
paymentMethodId?: string;
|
|
1633
|
+
}
|
|
1634
|
+
namespace Zuora {
|
|
1635
|
+
/**
|
|
1636
|
+
* Physical address
|
|
1637
|
+
*/
|
|
1638
|
+
interface BillingAddress {
|
|
1639
|
+
/**
|
|
1640
|
+
* City name
|
|
1641
|
+
*/
|
|
1642
|
+
city?: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* Country code or name
|
|
1645
|
+
*/
|
|
1646
|
+
country?: string;
|
|
1647
|
+
/**
|
|
1648
|
+
* Street address line 1
|
|
1649
|
+
*/
|
|
1650
|
+
line1?: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* Street address line 2
|
|
1653
|
+
*/
|
|
1654
|
+
line2?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* Postal or ZIP code
|
|
1657
|
+
*/
|
|
1658
|
+
postalCode?: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* State or province
|
|
1661
|
+
*/
|
|
1662
|
+
state?: string;
|
|
1663
|
+
}
|
|
1664
|
+
}
|
|
1665
|
+
}
|
|
1666
|
+
}
|
|
1667
|
+
export interface CustomerRetrieveEntitlementsParams {
|
|
1668
|
+
/**
|
|
1669
|
+
* Resource ID to scope entitlements to a specific resource
|
|
1670
|
+
*/
|
|
1671
|
+
resourceId?: string;
|
|
475
1672
|
}
|
|
476
1673
|
export declare namespace Customers {
|
|
477
|
-
export { type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, 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, };
|
|
1674
|
+
export { type CustomerIntegrationResponse as CustomerIntegrationResponse, type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerCheckEntitlementResponse as CustomerCheckEntitlementResponse, 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 CustomerCheckEntitlementParams as CustomerCheckEntitlementParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams, };
|
|
478
1675
|
export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
|
|
479
1676
|
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, };
|
|
1677
|
+
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, };
|
|
480
1678
|
}
|
|
481
1679
|
//# sourceMappingURL=customers.d.mts.map
|