@stigg/typescript 0.1.0-alpha.9 → 0.1.0-beta.1
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 +409 -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/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/credits/credits.d.mts +274 -0
- package/resources/v1/events/credits/credits.d.mts.map +1 -0
- package/resources/v1/events/credits/credits.d.ts +274 -0
- package/resources/v1/events/credits/credits.d.ts.map +1 -0
- package/resources/v1/events/credits/credits.js +45 -0
- package/resources/v1/events/credits/credits.js.map +1 -0
- package/resources/v1/events/credits/credits.mjs +40 -0
- package/resources/v1/events/credits/credits.mjs.map +1 -0
- package/resources/v1/events/credits/custom-currencies.d.mts +497 -0
- package/resources/v1/events/credits/custom-currencies.d.mts.map +1 -0
- package/resources/v1/events/credits/custom-currencies.d.ts +497 -0
- package/resources/v1/events/credits/custom-currencies.d.ts.map +1 -0
- package/resources/v1/events/credits/custom-currencies.js +56 -0
- package/resources/v1/events/credits/custom-currencies.js.map +1 -0
- package/resources/v1/events/credits/custom-currencies.mjs +52 -0
- package/resources/v1/events/credits/custom-currencies.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 +4 -0
- package/resources/v1/events/credits/index.d.mts.map +1 -0
- package/resources/v1/events/credits/index.d.ts +4 -0
- package/resources/v1/events/credits/index.d.ts.map +1 -0
- package/resources/v1/events/credits/index.js +11 -0
- package/resources/v1/events/credits/index.js.map +1 -0
- package/resources/v1/events/credits/index.mjs +5 -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 +7 -12
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +7 -12
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +7 -12
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +7 -12
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/events/index.d.mts +1 -3
- package/resources/v1/events/index.d.mts.map +1 -1
- package/resources/v1/events/index.d.ts +1 -3
- package/resources/v1/events/index.d.ts.map +1 -1
- package/resources/v1/events/index.js +3 -7
- package/resources/v1/events/index.js.map +1 -1
- package/resources/v1/events/index.mjs +1 -3
- package/resources/v1/events/index.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 +5 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +5 -2
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +13 -7
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +3 -0
- 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 +16 -4
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +16 -4
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +12 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +12 -0
- 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/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/credits/credits.ts +402 -0
- package/src/resources/v1/events/credits/custom-currencies.ts +615 -0
- package/src/resources/v1/events/credits/grants.ts +795 -0
- package/src/resources/v1/events/credits/index.ts +33 -0
- package/src/resources/v1/events/credits.ts +3 -0
- package/src/resources/v1/events/events.ts +23 -80
- package/src/resources/v1/events/index.ts +9 -35
- package/src/resources/v1/{events/features.ts → features.ts} +29 -512
- package/src/resources/v1/index.ts +39 -5
- 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 +90 -10
- 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/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/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/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,6 +1,17 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../../core/resource';
|
|
4
|
+
import * as IntegrationsAPI from './integrations';
|
|
5
|
+
import {
|
|
6
|
+
IntegrationLinkParams,
|
|
7
|
+
IntegrationListParams,
|
|
8
|
+
IntegrationListResponse,
|
|
9
|
+
IntegrationListResponsesMyCursorIDPage,
|
|
10
|
+
IntegrationRetrieveParams,
|
|
11
|
+
IntegrationUnlinkParams,
|
|
12
|
+
IntegrationUpdateParams,
|
|
13
|
+
Integrations,
|
|
14
|
+
} from './integrations';
|
|
4
15
|
import * as PaymentMethodAPI from './payment-method';
|
|
5
16
|
import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
|
|
6
17
|
import * as PromotionalEntitlementsAPI from './promotional-entitlements';
|
|
@@ -23,6 +34,7 @@ export class Customers extends APIResource {
|
|
|
23
34
|
paymentMethod: PaymentMethodAPI.PaymentMethod = new PaymentMethodAPI.PaymentMethod(this._client);
|
|
24
35
|
promotionalEntitlements: PromotionalEntitlementsAPI.PromotionalEntitlements =
|
|
25
36
|
new PromotionalEntitlementsAPI.PromotionalEntitlements(this._client);
|
|
37
|
+
integrations: IntegrationsAPI.Integrations = new IntegrationsAPI.Integrations(this._client);
|
|
26
38
|
|
|
27
39
|
/**
|
|
28
40
|
* Retrieves a customer by their unique identifier, including billing information
|
|
@@ -61,6 +73,24 @@ export class Customers extends APIResource {
|
|
|
61
73
|
return this._client.post(path`/api/v1/customers/${id}/archive`, options);
|
|
62
74
|
}
|
|
63
75
|
|
|
76
|
+
/**
|
|
77
|
+
* Checks a single entitlement (feature or credit) for a customer or resource.
|
|
78
|
+
* Supports `requestedUsage` and `requestedValues` to evaluate against limits or
|
|
79
|
+
* enum values.
|
|
80
|
+
*
|
|
81
|
+
* **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
|
|
82
|
+
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
83
|
+
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
84
|
+
* with caching or the Sidecar for low-latency cached responses.
|
|
85
|
+
*/
|
|
86
|
+
checkEntitlement(
|
|
87
|
+
id: string,
|
|
88
|
+
query: CustomerCheckEntitlementParams | null | undefined = {},
|
|
89
|
+
options?: RequestOptions,
|
|
90
|
+
): APIPromise<CustomerCheckEntitlementResponse> {
|
|
91
|
+
return this._client.get(path`/api/v1/customers/${id}/entitlements/check`, { query, ...options });
|
|
92
|
+
}
|
|
93
|
+
|
|
64
94
|
/**
|
|
65
95
|
* Imports multiple customers in bulk. Used for migrating customer data from
|
|
66
96
|
* external systems.
|
|
@@ -70,7 +100,7 @@ export class Customers extends APIResource {
|
|
|
70
100
|
}
|
|
71
101
|
|
|
72
102
|
/**
|
|
73
|
-
*
|
|
103
|
+
* Retrieves a paginated list of resources within the same customer.
|
|
74
104
|
*/
|
|
75
105
|
listResources(
|
|
76
106
|
id: string,
|
|
@@ -92,6 +122,23 @@ export class Customers extends APIResource {
|
|
|
92
122
|
return this._client.post('/api/v1/customers', { body, ...options });
|
|
93
123
|
}
|
|
94
124
|
|
|
125
|
+
/**
|
|
126
|
+
* Retrieves the effective entitlements for a customer or resource, including
|
|
127
|
+
* feature and credit entitlements.
|
|
128
|
+
*
|
|
129
|
+
* **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
|
|
130
|
+
* mechanisms, and low-latency guarantees. It is not recommended for hot-path
|
|
131
|
+
* entitlement checks. For production use, consider using the Stigg Node Server SDK
|
|
132
|
+
* with caching or the Sidecar for low-latency cached responses.
|
|
133
|
+
*/
|
|
134
|
+
retrieveEntitlements(
|
|
135
|
+
id: string,
|
|
136
|
+
query: CustomerRetrieveEntitlementsParams | null | undefined = {},
|
|
137
|
+
options?: RequestOptions,
|
|
138
|
+
): APIPromise<CustomerRetrieveEntitlementsResponse> {
|
|
139
|
+
return this._client.get(path`/api/v1/customers/${id}/entitlements`, { query, ...options });
|
|
140
|
+
}
|
|
141
|
+
|
|
95
142
|
/**
|
|
96
143
|
* Restores an archived customer, allowing them to create new subscriptions again.
|
|
97
144
|
*/
|
|
@@ -104,6 +151,106 @@ export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListRes
|
|
|
104
151
|
|
|
105
152
|
export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
|
|
106
153
|
|
|
154
|
+
/**
|
|
155
|
+
* Response object
|
|
156
|
+
*/
|
|
157
|
+
export interface CustomerIntegrationResponse {
|
|
158
|
+
/**
|
|
159
|
+
* External billing or CRM integration link
|
|
160
|
+
*/
|
|
161
|
+
data: CustomerIntegrationResponse.Data;
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
export namespace CustomerIntegrationResponse {
|
|
165
|
+
/**
|
|
166
|
+
* External billing or CRM integration link
|
|
167
|
+
*/
|
|
168
|
+
export interface Data {
|
|
169
|
+
/**
|
|
170
|
+
* Integration details
|
|
171
|
+
*/
|
|
172
|
+
id: string;
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Synced entity id
|
|
176
|
+
*/
|
|
177
|
+
syncedEntityId: string | null;
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* The vendor identifier of integration
|
|
181
|
+
*/
|
|
182
|
+
vendorIdentifier:
|
|
183
|
+
| 'AUTH0'
|
|
184
|
+
| 'ZUORA'
|
|
185
|
+
| 'STRIPE'
|
|
186
|
+
| 'HUBSPOT'
|
|
187
|
+
| 'AWS_MARKETPLACE'
|
|
188
|
+
| 'SNOWFLAKE'
|
|
189
|
+
| 'SALESFORCE'
|
|
190
|
+
| 'BIG_QUERY'
|
|
191
|
+
| 'OPEN_FGA'
|
|
192
|
+
| 'APP_STORE';
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
196
|
+
* group package billing ID
|
|
197
|
+
*/
|
|
198
|
+
syncData?:
|
|
199
|
+
| Data.SyncRevisionPriceBillingData
|
|
200
|
+
| Data.SyncRevisionBillingData
|
|
201
|
+
| Data.SyncRevisionMarketplaceData
|
|
202
|
+
| null;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
export namespace Data {
|
|
206
|
+
/**
|
|
207
|
+
* Price billing sync revision data containing billing ID, link URL, and price
|
|
208
|
+
* group package billing ID
|
|
209
|
+
*/
|
|
210
|
+
export interface SyncRevisionPriceBillingData {
|
|
211
|
+
/**
|
|
212
|
+
* Billing integration id
|
|
213
|
+
*/
|
|
214
|
+
billingId: string;
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* Billing integration url
|
|
218
|
+
*/
|
|
219
|
+
billingLinkUrl: string;
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Price group package billing id
|
|
223
|
+
*/
|
|
224
|
+
priceGroupPackageBillingId: string;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* Billing sync revision data containing billing ID and link URL
|
|
229
|
+
*/
|
|
230
|
+
export interface SyncRevisionBillingData {
|
|
231
|
+
/**
|
|
232
|
+
* Billing integration id
|
|
233
|
+
*/
|
|
234
|
+
billingId: string;
|
|
235
|
+
|
|
236
|
+
/**
|
|
237
|
+
* Billing integration url
|
|
238
|
+
*/
|
|
239
|
+
billingLinkUrl: string;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Marketplace sync revision data containing dimensions
|
|
244
|
+
*/
|
|
245
|
+
export interface SyncRevisionMarketplaceData {
|
|
246
|
+
/**
|
|
247
|
+
* Dimensions of the marketplace sync revision
|
|
248
|
+
*/
|
|
249
|
+
dimensions: string;
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
|
|
107
254
|
/**
|
|
108
255
|
* Response object
|
|
109
256
|
*/
|
|
@@ -139,10 +286,137 @@ export namespace CustomerResponse {
|
|
|
139
286
|
*/
|
|
140
287
|
updatedAt: string;
|
|
141
288
|
|
|
289
|
+
/**
|
|
290
|
+
* The billing currency of the customer
|
|
291
|
+
*/
|
|
292
|
+
billingCurrency?:
|
|
293
|
+
| 'usd'
|
|
294
|
+
| 'aed'
|
|
295
|
+
| 'all'
|
|
296
|
+
| 'amd'
|
|
297
|
+
| 'ang'
|
|
298
|
+
| 'aud'
|
|
299
|
+
| 'awg'
|
|
300
|
+
| 'azn'
|
|
301
|
+
| 'bam'
|
|
302
|
+
| 'bbd'
|
|
303
|
+
| 'bdt'
|
|
304
|
+
| 'bgn'
|
|
305
|
+
| 'bif'
|
|
306
|
+
| 'bmd'
|
|
307
|
+
| 'bnd'
|
|
308
|
+
| 'bsd'
|
|
309
|
+
| 'bwp'
|
|
310
|
+
| 'byn'
|
|
311
|
+
| 'bzd'
|
|
312
|
+
| 'brl'
|
|
313
|
+
| 'cad'
|
|
314
|
+
| 'cdf'
|
|
315
|
+
| 'chf'
|
|
316
|
+
| 'cny'
|
|
317
|
+
| 'czk'
|
|
318
|
+
| 'dkk'
|
|
319
|
+
| 'dop'
|
|
320
|
+
| 'dzd'
|
|
321
|
+
| 'egp'
|
|
322
|
+
| 'etb'
|
|
323
|
+
| 'eur'
|
|
324
|
+
| 'fjd'
|
|
325
|
+
| 'gbp'
|
|
326
|
+
| 'gel'
|
|
327
|
+
| 'gip'
|
|
328
|
+
| 'gmd'
|
|
329
|
+
| 'gyd'
|
|
330
|
+
| 'hkd'
|
|
331
|
+
| 'hrk'
|
|
332
|
+
| 'htg'
|
|
333
|
+
| 'idr'
|
|
334
|
+
| 'ils'
|
|
335
|
+
| 'inr'
|
|
336
|
+
| 'isk'
|
|
337
|
+
| 'jmd'
|
|
338
|
+
| 'jpy'
|
|
339
|
+
| 'kes'
|
|
340
|
+
| 'kgs'
|
|
341
|
+
| 'khr'
|
|
342
|
+
| 'kmf'
|
|
343
|
+
| 'krw'
|
|
344
|
+
| 'kyd'
|
|
345
|
+
| 'kzt'
|
|
346
|
+
| 'lbp'
|
|
347
|
+
| 'lkr'
|
|
348
|
+
| 'lrd'
|
|
349
|
+
| 'lsl'
|
|
350
|
+
| 'mad'
|
|
351
|
+
| 'mdl'
|
|
352
|
+
| 'mga'
|
|
353
|
+
| 'mkd'
|
|
354
|
+
| 'mmk'
|
|
355
|
+
| 'mnt'
|
|
356
|
+
| 'mop'
|
|
357
|
+
| 'mro'
|
|
358
|
+
| 'mvr'
|
|
359
|
+
| 'mwk'
|
|
360
|
+
| 'mxn'
|
|
361
|
+
| 'myr'
|
|
362
|
+
| 'mzn'
|
|
363
|
+
| 'nad'
|
|
364
|
+
| 'ngn'
|
|
365
|
+
| 'nok'
|
|
366
|
+
| 'npr'
|
|
367
|
+
| 'nzd'
|
|
368
|
+
| 'pgk'
|
|
369
|
+
| 'php'
|
|
370
|
+
| 'pkr'
|
|
371
|
+
| 'pln'
|
|
372
|
+
| 'qar'
|
|
373
|
+
| 'ron'
|
|
374
|
+
| 'rsd'
|
|
375
|
+
| 'rub'
|
|
376
|
+
| 'rwf'
|
|
377
|
+
| 'sar'
|
|
378
|
+
| 'sbd'
|
|
379
|
+
| 'scr'
|
|
380
|
+
| 'sek'
|
|
381
|
+
| 'sgd'
|
|
382
|
+
| 'sle'
|
|
383
|
+
| 'sll'
|
|
384
|
+
| 'sos'
|
|
385
|
+
| 'szl'
|
|
386
|
+
| 'thb'
|
|
387
|
+
| 'tjs'
|
|
388
|
+
| 'top'
|
|
389
|
+
| 'try'
|
|
390
|
+
| 'ttd'
|
|
391
|
+
| 'tzs'
|
|
392
|
+
| 'uah'
|
|
393
|
+
| 'uzs'
|
|
394
|
+
| 'vnd'
|
|
395
|
+
| 'vuv'
|
|
396
|
+
| 'wst'
|
|
397
|
+
| 'xaf'
|
|
398
|
+
| 'xcd'
|
|
399
|
+
| 'yer'
|
|
400
|
+
| 'zar'
|
|
401
|
+
| 'zmw'
|
|
402
|
+
| 'clp'
|
|
403
|
+
| 'djf'
|
|
404
|
+
| 'gnf'
|
|
405
|
+
| 'ugx'
|
|
406
|
+
| 'pyg'
|
|
407
|
+
| 'xof'
|
|
408
|
+
| 'xpf'
|
|
409
|
+
| null;
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* The unique identifier for the entity in the billing provider
|
|
413
|
+
*/
|
|
414
|
+
billingId?: string | null;
|
|
415
|
+
|
|
142
416
|
/**
|
|
143
417
|
* Customer level coupon
|
|
144
418
|
*/
|
|
145
|
-
couponId?: string | null;
|
|
419
|
+
couponId?: (string & {}) | '' | null;
|
|
146
420
|
|
|
147
421
|
/**
|
|
148
422
|
* The default payment method details
|
|
@@ -159,6 +433,11 @@ export namespace CustomerResponse {
|
|
|
159
433
|
*/
|
|
160
434
|
integrations?: Array<Data.Integration>;
|
|
161
435
|
|
|
436
|
+
/**
|
|
437
|
+
* Language to use for this customer
|
|
438
|
+
*/
|
|
439
|
+
language?: string | null;
|
|
440
|
+
|
|
162
441
|
/**
|
|
163
442
|
* Additional metadata
|
|
164
443
|
*/
|
|
@@ -168,6 +447,16 @@ export namespace CustomerResponse {
|
|
|
168
447
|
* The name of the customer
|
|
169
448
|
*/
|
|
170
449
|
name?: string | null;
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* Vendor-specific billing passthrough fields.
|
|
453
|
+
*/
|
|
454
|
+
passthrough?: Data.Passthrough;
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* Timezone to use for this customer
|
|
458
|
+
*/
|
|
459
|
+
timezone?: string | null;
|
|
171
460
|
}
|
|
172
461
|
|
|
173
462
|
export namespace Data {
|
|
@@ -230,6 +519,328 @@ export namespace CustomerResponse {
|
|
|
230
519
|
| 'OPEN_FGA'
|
|
231
520
|
| 'APP_STORE';
|
|
232
521
|
}
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* Vendor-specific billing passthrough fields.
|
|
525
|
+
*/
|
|
526
|
+
export interface Passthrough {
|
|
527
|
+
/**
|
|
528
|
+
* Stripe-specific billing fields for the customer.
|
|
529
|
+
*/
|
|
530
|
+
stripe?: Passthrough.Stripe;
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* Zuora-specific billing fields for the customer.
|
|
534
|
+
*/
|
|
535
|
+
zuora?: Passthrough.Zuora;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
export namespace Passthrough {
|
|
539
|
+
/**
|
|
540
|
+
* Stripe-specific billing fields for the customer.
|
|
541
|
+
*/
|
|
542
|
+
export interface Stripe {
|
|
543
|
+
/**
|
|
544
|
+
* Physical address
|
|
545
|
+
*/
|
|
546
|
+
billingAddress?: Stripe.BillingAddress;
|
|
547
|
+
|
|
548
|
+
/**
|
|
549
|
+
* Customer name
|
|
550
|
+
*/
|
|
551
|
+
customerName?: string;
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* Invoice custom fields
|
|
555
|
+
*/
|
|
556
|
+
invoiceCustomFields?: { [key: string]: string };
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Additional metadata
|
|
560
|
+
*/
|
|
561
|
+
metadata?: { [key: string]: string };
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* Billing provider payment method id, attached to this customer
|
|
565
|
+
*/
|
|
566
|
+
paymentMethodId?: string;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Physical address
|
|
570
|
+
*/
|
|
571
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* Tax IDs
|
|
575
|
+
*/
|
|
576
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
export namespace Stripe {
|
|
580
|
+
/**
|
|
581
|
+
* Physical address
|
|
582
|
+
*/
|
|
583
|
+
export interface BillingAddress {
|
|
584
|
+
/**
|
|
585
|
+
* City name
|
|
586
|
+
*/
|
|
587
|
+
city?: string;
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* Country code or name
|
|
591
|
+
*/
|
|
592
|
+
country?: string;
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Street address line 1
|
|
596
|
+
*/
|
|
597
|
+
line1?: string;
|
|
598
|
+
|
|
599
|
+
/**
|
|
600
|
+
* Street address line 2
|
|
601
|
+
*/
|
|
602
|
+
line2?: string;
|
|
603
|
+
|
|
604
|
+
/**
|
|
605
|
+
* Postal or ZIP code
|
|
606
|
+
*/
|
|
607
|
+
postalCode?: string;
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* State or province
|
|
611
|
+
*/
|
|
612
|
+
state?: string;
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
* Physical address
|
|
617
|
+
*/
|
|
618
|
+
export interface ShippingAddress {
|
|
619
|
+
/**
|
|
620
|
+
* City name
|
|
621
|
+
*/
|
|
622
|
+
city?: string;
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* Country code or name
|
|
626
|
+
*/
|
|
627
|
+
country?: string;
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* Street address line 1
|
|
631
|
+
*/
|
|
632
|
+
line1?: string;
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* Street address line 2
|
|
636
|
+
*/
|
|
637
|
+
line2?: string;
|
|
638
|
+
|
|
639
|
+
/**
|
|
640
|
+
* Postal or ZIP code
|
|
641
|
+
*/
|
|
642
|
+
postalCode?: string;
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* State or province
|
|
646
|
+
*/
|
|
647
|
+
state?: string;
|
|
648
|
+
}
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
652
|
+
*/
|
|
653
|
+
export interface TaxID {
|
|
654
|
+
/**
|
|
655
|
+
* The type of tax exemption identifier, such as VAT.
|
|
656
|
+
*/
|
|
657
|
+
type: string;
|
|
658
|
+
|
|
659
|
+
/**
|
|
660
|
+
* The actual tax identifier value
|
|
661
|
+
*/
|
|
662
|
+
value: string;
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
/**
|
|
667
|
+
* Zuora-specific billing fields for the customer.
|
|
668
|
+
*/
|
|
669
|
+
export interface Zuora {
|
|
670
|
+
/**
|
|
671
|
+
* Physical address
|
|
672
|
+
*/
|
|
673
|
+
billingAddress?: Zuora.BillingAddress;
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* Customers selected currency
|
|
677
|
+
*/
|
|
678
|
+
currency?:
|
|
679
|
+
| 'usd'
|
|
680
|
+
| 'aed'
|
|
681
|
+
| 'all'
|
|
682
|
+
| 'amd'
|
|
683
|
+
| 'ang'
|
|
684
|
+
| 'aud'
|
|
685
|
+
| 'awg'
|
|
686
|
+
| 'azn'
|
|
687
|
+
| 'bam'
|
|
688
|
+
| 'bbd'
|
|
689
|
+
| 'bdt'
|
|
690
|
+
| 'bgn'
|
|
691
|
+
| 'bif'
|
|
692
|
+
| 'bmd'
|
|
693
|
+
| 'bnd'
|
|
694
|
+
| 'bsd'
|
|
695
|
+
| 'bwp'
|
|
696
|
+
| 'byn'
|
|
697
|
+
| 'bzd'
|
|
698
|
+
| 'brl'
|
|
699
|
+
| 'cad'
|
|
700
|
+
| 'cdf'
|
|
701
|
+
| 'chf'
|
|
702
|
+
| 'cny'
|
|
703
|
+
| 'czk'
|
|
704
|
+
| 'dkk'
|
|
705
|
+
| 'dop'
|
|
706
|
+
| 'dzd'
|
|
707
|
+
| 'egp'
|
|
708
|
+
| 'etb'
|
|
709
|
+
| 'eur'
|
|
710
|
+
| 'fjd'
|
|
711
|
+
| 'gbp'
|
|
712
|
+
| 'gel'
|
|
713
|
+
| 'gip'
|
|
714
|
+
| 'gmd'
|
|
715
|
+
| 'gyd'
|
|
716
|
+
| 'hkd'
|
|
717
|
+
| 'hrk'
|
|
718
|
+
| 'htg'
|
|
719
|
+
| 'idr'
|
|
720
|
+
| 'ils'
|
|
721
|
+
| 'inr'
|
|
722
|
+
| 'isk'
|
|
723
|
+
| 'jmd'
|
|
724
|
+
| 'jpy'
|
|
725
|
+
| 'kes'
|
|
726
|
+
| 'kgs'
|
|
727
|
+
| 'khr'
|
|
728
|
+
| 'kmf'
|
|
729
|
+
| 'krw'
|
|
730
|
+
| 'kyd'
|
|
731
|
+
| 'kzt'
|
|
732
|
+
| 'lbp'
|
|
733
|
+
| 'lkr'
|
|
734
|
+
| 'lrd'
|
|
735
|
+
| 'lsl'
|
|
736
|
+
| 'mad'
|
|
737
|
+
| 'mdl'
|
|
738
|
+
| 'mga'
|
|
739
|
+
| 'mkd'
|
|
740
|
+
| 'mmk'
|
|
741
|
+
| 'mnt'
|
|
742
|
+
| 'mop'
|
|
743
|
+
| 'mro'
|
|
744
|
+
| 'mvr'
|
|
745
|
+
| 'mwk'
|
|
746
|
+
| 'mxn'
|
|
747
|
+
| 'myr'
|
|
748
|
+
| 'mzn'
|
|
749
|
+
| 'nad'
|
|
750
|
+
| 'ngn'
|
|
751
|
+
| 'nok'
|
|
752
|
+
| 'npr'
|
|
753
|
+
| 'nzd'
|
|
754
|
+
| 'pgk'
|
|
755
|
+
| 'php'
|
|
756
|
+
| 'pkr'
|
|
757
|
+
| 'pln'
|
|
758
|
+
| 'qar'
|
|
759
|
+
| 'ron'
|
|
760
|
+
| 'rsd'
|
|
761
|
+
| 'rub'
|
|
762
|
+
| 'rwf'
|
|
763
|
+
| 'sar'
|
|
764
|
+
| 'sbd'
|
|
765
|
+
| 'scr'
|
|
766
|
+
| 'sek'
|
|
767
|
+
| 'sgd'
|
|
768
|
+
| 'sle'
|
|
769
|
+
| 'sll'
|
|
770
|
+
| 'sos'
|
|
771
|
+
| 'szl'
|
|
772
|
+
| 'thb'
|
|
773
|
+
| 'tjs'
|
|
774
|
+
| 'top'
|
|
775
|
+
| 'try'
|
|
776
|
+
| 'ttd'
|
|
777
|
+
| 'tzs'
|
|
778
|
+
| 'uah'
|
|
779
|
+
| 'uzs'
|
|
780
|
+
| 'vnd'
|
|
781
|
+
| 'vuv'
|
|
782
|
+
| 'wst'
|
|
783
|
+
| 'xaf'
|
|
784
|
+
| 'xcd'
|
|
785
|
+
| 'yer'
|
|
786
|
+
| 'zar'
|
|
787
|
+
| 'zmw'
|
|
788
|
+
| 'clp'
|
|
789
|
+
| 'djf'
|
|
790
|
+
| 'gnf'
|
|
791
|
+
| 'ugx'
|
|
792
|
+
| 'pyg'
|
|
793
|
+
| 'xof'
|
|
794
|
+
| 'xpf';
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
* Additional metadata
|
|
798
|
+
*/
|
|
799
|
+
metadata?: { [key: string]: string };
|
|
800
|
+
|
|
801
|
+
/**
|
|
802
|
+
* Billing provider payment method id, attached to this customer
|
|
803
|
+
*/
|
|
804
|
+
paymentMethodId?: string;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
export namespace Zuora {
|
|
808
|
+
/**
|
|
809
|
+
* Physical address
|
|
810
|
+
*/
|
|
811
|
+
export interface BillingAddress {
|
|
812
|
+
/**
|
|
813
|
+
* City name
|
|
814
|
+
*/
|
|
815
|
+
city?: string;
|
|
816
|
+
|
|
817
|
+
/**
|
|
818
|
+
* Country code or name
|
|
819
|
+
*/
|
|
820
|
+
country?: string;
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* Street address line 1
|
|
824
|
+
*/
|
|
825
|
+
line1?: string;
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* Street address line 2
|
|
829
|
+
*/
|
|
830
|
+
line2?: string;
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* Postal or ZIP code
|
|
834
|
+
*/
|
|
835
|
+
postalCode?: string;
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* State or province
|
|
839
|
+
*/
|
|
840
|
+
state?: string;
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
}
|
|
233
844
|
}
|
|
234
845
|
}
|
|
235
846
|
|
|
@@ -257,10 +868,137 @@ export interface CustomerListResponse {
|
|
|
257
868
|
*/
|
|
258
869
|
updatedAt: string;
|
|
259
870
|
|
|
871
|
+
/**
|
|
872
|
+
* The billing currency of the customer
|
|
873
|
+
*/
|
|
874
|
+
billingCurrency?:
|
|
875
|
+
| 'usd'
|
|
876
|
+
| 'aed'
|
|
877
|
+
| 'all'
|
|
878
|
+
| 'amd'
|
|
879
|
+
| 'ang'
|
|
880
|
+
| 'aud'
|
|
881
|
+
| 'awg'
|
|
882
|
+
| 'azn'
|
|
883
|
+
| 'bam'
|
|
884
|
+
| 'bbd'
|
|
885
|
+
| 'bdt'
|
|
886
|
+
| 'bgn'
|
|
887
|
+
| 'bif'
|
|
888
|
+
| 'bmd'
|
|
889
|
+
| 'bnd'
|
|
890
|
+
| 'bsd'
|
|
891
|
+
| 'bwp'
|
|
892
|
+
| 'byn'
|
|
893
|
+
| 'bzd'
|
|
894
|
+
| 'brl'
|
|
895
|
+
| 'cad'
|
|
896
|
+
| 'cdf'
|
|
897
|
+
| 'chf'
|
|
898
|
+
| 'cny'
|
|
899
|
+
| 'czk'
|
|
900
|
+
| 'dkk'
|
|
901
|
+
| 'dop'
|
|
902
|
+
| 'dzd'
|
|
903
|
+
| 'egp'
|
|
904
|
+
| 'etb'
|
|
905
|
+
| 'eur'
|
|
906
|
+
| 'fjd'
|
|
907
|
+
| 'gbp'
|
|
908
|
+
| 'gel'
|
|
909
|
+
| 'gip'
|
|
910
|
+
| 'gmd'
|
|
911
|
+
| 'gyd'
|
|
912
|
+
| 'hkd'
|
|
913
|
+
| 'hrk'
|
|
914
|
+
| 'htg'
|
|
915
|
+
| 'idr'
|
|
916
|
+
| 'ils'
|
|
917
|
+
| 'inr'
|
|
918
|
+
| 'isk'
|
|
919
|
+
| 'jmd'
|
|
920
|
+
| 'jpy'
|
|
921
|
+
| 'kes'
|
|
922
|
+
| 'kgs'
|
|
923
|
+
| 'khr'
|
|
924
|
+
| 'kmf'
|
|
925
|
+
| 'krw'
|
|
926
|
+
| 'kyd'
|
|
927
|
+
| 'kzt'
|
|
928
|
+
| 'lbp'
|
|
929
|
+
| 'lkr'
|
|
930
|
+
| 'lrd'
|
|
931
|
+
| 'lsl'
|
|
932
|
+
| 'mad'
|
|
933
|
+
| 'mdl'
|
|
934
|
+
| 'mga'
|
|
935
|
+
| 'mkd'
|
|
936
|
+
| 'mmk'
|
|
937
|
+
| 'mnt'
|
|
938
|
+
| 'mop'
|
|
939
|
+
| 'mro'
|
|
940
|
+
| 'mvr'
|
|
941
|
+
| 'mwk'
|
|
942
|
+
| 'mxn'
|
|
943
|
+
| 'myr'
|
|
944
|
+
| 'mzn'
|
|
945
|
+
| 'nad'
|
|
946
|
+
| 'ngn'
|
|
947
|
+
| 'nok'
|
|
948
|
+
| 'npr'
|
|
949
|
+
| 'nzd'
|
|
950
|
+
| 'pgk'
|
|
951
|
+
| 'php'
|
|
952
|
+
| 'pkr'
|
|
953
|
+
| 'pln'
|
|
954
|
+
| 'qar'
|
|
955
|
+
| 'ron'
|
|
956
|
+
| 'rsd'
|
|
957
|
+
| 'rub'
|
|
958
|
+
| 'rwf'
|
|
959
|
+
| 'sar'
|
|
960
|
+
| 'sbd'
|
|
961
|
+
| 'scr'
|
|
962
|
+
| 'sek'
|
|
963
|
+
| 'sgd'
|
|
964
|
+
| 'sle'
|
|
965
|
+
| 'sll'
|
|
966
|
+
| 'sos'
|
|
967
|
+
| 'szl'
|
|
968
|
+
| 'thb'
|
|
969
|
+
| 'tjs'
|
|
970
|
+
| 'top'
|
|
971
|
+
| 'try'
|
|
972
|
+
| 'ttd'
|
|
973
|
+
| 'tzs'
|
|
974
|
+
| 'uah'
|
|
975
|
+
| 'uzs'
|
|
976
|
+
| 'vnd'
|
|
977
|
+
| 'vuv'
|
|
978
|
+
| 'wst'
|
|
979
|
+
| 'xaf'
|
|
980
|
+
| 'xcd'
|
|
981
|
+
| 'yer'
|
|
982
|
+
| 'zar'
|
|
983
|
+
| 'zmw'
|
|
984
|
+
| 'clp'
|
|
985
|
+
| 'djf'
|
|
986
|
+
| 'gnf'
|
|
987
|
+
| 'ugx'
|
|
988
|
+
| 'pyg'
|
|
989
|
+
| 'xof'
|
|
990
|
+
| 'xpf'
|
|
991
|
+
| null;
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* The unique identifier for the entity in the billing provider
|
|
995
|
+
*/
|
|
996
|
+
billingId?: string | null;
|
|
997
|
+
|
|
260
998
|
/**
|
|
261
999
|
* Customer level coupon
|
|
262
1000
|
*/
|
|
263
|
-
couponId?: string | null;
|
|
1001
|
+
couponId?: (string & {}) | '' | null;
|
|
264
1002
|
|
|
265
1003
|
/**
|
|
266
1004
|
* The default payment method details
|
|
@@ -277,6 +1015,11 @@ export interface CustomerListResponse {
|
|
|
277
1015
|
*/
|
|
278
1016
|
integrations?: Array<CustomerListResponse.Integration>;
|
|
279
1017
|
|
|
1018
|
+
/**
|
|
1019
|
+
* Language to use for this customer
|
|
1020
|
+
*/
|
|
1021
|
+
language?: string | null;
|
|
1022
|
+
|
|
280
1023
|
/**
|
|
281
1024
|
* Additional metadata
|
|
282
1025
|
*/
|
|
@@ -286,6 +1029,16 @@ export interface CustomerListResponse {
|
|
|
286
1029
|
* The name of the customer
|
|
287
1030
|
*/
|
|
288
1031
|
name?: string | null;
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* Vendor-specific billing passthrough fields.
|
|
1035
|
+
*/
|
|
1036
|
+
passthrough?: CustomerListResponse.Passthrough;
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* Timezone to use for this customer
|
|
1040
|
+
*/
|
|
1041
|
+
timezone?: string | null;
|
|
289
1042
|
}
|
|
290
1043
|
|
|
291
1044
|
export namespace CustomerListResponse {
|
|
@@ -348,98 +1101,948 @@ export namespace CustomerListResponse {
|
|
|
348
1101
|
| 'OPEN_FGA'
|
|
349
1102
|
| 'APP_STORE';
|
|
350
1103
|
}
|
|
351
|
-
}
|
|
352
1104
|
|
|
353
|
-
/**
|
|
354
|
-
* Response object
|
|
355
|
-
*/
|
|
356
|
-
export interface CustomerImportResponse {
|
|
357
1105
|
/**
|
|
358
|
-
*
|
|
1106
|
+
* Vendor-specific billing passthrough fields.
|
|
359
1107
|
*/
|
|
360
|
-
|
|
361
|
-
|
|
1108
|
+
export interface Passthrough {
|
|
1109
|
+
/**
|
|
1110
|
+
* Stripe-specific billing fields for the customer.
|
|
1111
|
+
*/
|
|
1112
|
+
stripe?: Passthrough.Stripe;
|
|
362
1113
|
|
|
363
|
-
export namespace CustomerImportResponse {
|
|
364
|
-
/**
|
|
365
|
-
* List of newly created customer IDs from the import operation.
|
|
366
|
-
*/
|
|
367
|
-
export interface Data {
|
|
368
1114
|
/**
|
|
369
|
-
*
|
|
1115
|
+
* Zuora-specific billing fields for the customer.
|
|
370
1116
|
*/
|
|
371
|
-
|
|
1117
|
+
zuora?: Passthrough.Zuora;
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
export namespace Passthrough {
|
|
1121
|
+
/**
|
|
1122
|
+
* Stripe-specific billing fields for the customer.
|
|
1123
|
+
*/
|
|
1124
|
+
export interface Stripe {
|
|
1125
|
+
/**
|
|
1126
|
+
* Physical address
|
|
1127
|
+
*/
|
|
1128
|
+
billingAddress?: Stripe.BillingAddress;
|
|
1129
|
+
|
|
1130
|
+
/**
|
|
1131
|
+
* Customer name
|
|
1132
|
+
*/
|
|
1133
|
+
customerName?: string;
|
|
1134
|
+
|
|
1135
|
+
/**
|
|
1136
|
+
* Invoice custom fields
|
|
1137
|
+
*/
|
|
1138
|
+
invoiceCustomFields?: { [key: string]: string };
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* Additional metadata
|
|
1142
|
+
*/
|
|
1143
|
+
metadata?: { [key: string]: string };
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
* Billing provider payment method id, attached to this customer
|
|
1147
|
+
*/
|
|
1148
|
+
paymentMethodId?: string;
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
* Physical address
|
|
1152
|
+
*/
|
|
1153
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
1154
|
+
|
|
1155
|
+
/**
|
|
1156
|
+
* Tax IDs
|
|
1157
|
+
*/
|
|
1158
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
1159
|
+
}
|
|
1160
|
+
|
|
1161
|
+
export namespace Stripe {
|
|
1162
|
+
/**
|
|
1163
|
+
* Physical address
|
|
1164
|
+
*/
|
|
1165
|
+
export interface BillingAddress {
|
|
1166
|
+
/**
|
|
1167
|
+
* City name
|
|
1168
|
+
*/
|
|
1169
|
+
city?: string;
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* Country code or name
|
|
1173
|
+
*/
|
|
1174
|
+
country?: string;
|
|
1175
|
+
|
|
1176
|
+
/**
|
|
1177
|
+
* Street address line 1
|
|
1178
|
+
*/
|
|
1179
|
+
line1?: string;
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* Street address line 2
|
|
1183
|
+
*/
|
|
1184
|
+
line2?: string;
|
|
1185
|
+
|
|
1186
|
+
/**
|
|
1187
|
+
* Postal or ZIP code
|
|
1188
|
+
*/
|
|
1189
|
+
postalCode?: string;
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
* State or province
|
|
1193
|
+
*/
|
|
1194
|
+
state?: string;
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
/**
|
|
1198
|
+
* Physical address
|
|
1199
|
+
*/
|
|
1200
|
+
export interface ShippingAddress {
|
|
1201
|
+
/**
|
|
1202
|
+
* City name
|
|
1203
|
+
*/
|
|
1204
|
+
city?: string;
|
|
1205
|
+
|
|
1206
|
+
/**
|
|
1207
|
+
* Country code or name
|
|
1208
|
+
*/
|
|
1209
|
+
country?: string;
|
|
1210
|
+
|
|
1211
|
+
/**
|
|
1212
|
+
* Street address line 1
|
|
1213
|
+
*/
|
|
1214
|
+
line1?: string;
|
|
1215
|
+
|
|
1216
|
+
/**
|
|
1217
|
+
* Street address line 2
|
|
1218
|
+
*/
|
|
1219
|
+
line2?: string;
|
|
1220
|
+
|
|
1221
|
+
/**
|
|
1222
|
+
* Postal or ZIP code
|
|
1223
|
+
*/
|
|
1224
|
+
postalCode?: string;
|
|
1225
|
+
|
|
1226
|
+
/**
|
|
1227
|
+
* State or province
|
|
1228
|
+
*/
|
|
1229
|
+
state?: string;
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
/**
|
|
1233
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
1234
|
+
*/
|
|
1235
|
+
export interface TaxID {
|
|
1236
|
+
/**
|
|
1237
|
+
* The type of tax exemption identifier, such as VAT.
|
|
1238
|
+
*/
|
|
1239
|
+
type: string;
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
* The actual tax identifier value
|
|
1243
|
+
*/
|
|
1244
|
+
value: string;
|
|
1245
|
+
}
|
|
1246
|
+
}
|
|
1247
|
+
|
|
1248
|
+
/**
|
|
1249
|
+
* Zuora-specific billing fields for the customer.
|
|
1250
|
+
*/
|
|
1251
|
+
export interface Zuora {
|
|
1252
|
+
/**
|
|
1253
|
+
* Physical address
|
|
1254
|
+
*/
|
|
1255
|
+
billingAddress?: Zuora.BillingAddress;
|
|
1256
|
+
|
|
1257
|
+
/**
|
|
1258
|
+
* Customers selected currency
|
|
1259
|
+
*/
|
|
1260
|
+
currency?:
|
|
1261
|
+
| 'usd'
|
|
1262
|
+
| 'aed'
|
|
1263
|
+
| 'all'
|
|
1264
|
+
| 'amd'
|
|
1265
|
+
| 'ang'
|
|
1266
|
+
| 'aud'
|
|
1267
|
+
| 'awg'
|
|
1268
|
+
| 'azn'
|
|
1269
|
+
| 'bam'
|
|
1270
|
+
| 'bbd'
|
|
1271
|
+
| 'bdt'
|
|
1272
|
+
| 'bgn'
|
|
1273
|
+
| 'bif'
|
|
1274
|
+
| 'bmd'
|
|
1275
|
+
| 'bnd'
|
|
1276
|
+
| 'bsd'
|
|
1277
|
+
| 'bwp'
|
|
1278
|
+
| 'byn'
|
|
1279
|
+
| 'bzd'
|
|
1280
|
+
| 'brl'
|
|
1281
|
+
| 'cad'
|
|
1282
|
+
| 'cdf'
|
|
1283
|
+
| 'chf'
|
|
1284
|
+
| 'cny'
|
|
1285
|
+
| 'czk'
|
|
1286
|
+
| 'dkk'
|
|
1287
|
+
| 'dop'
|
|
1288
|
+
| 'dzd'
|
|
1289
|
+
| 'egp'
|
|
1290
|
+
| 'etb'
|
|
1291
|
+
| 'eur'
|
|
1292
|
+
| 'fjd'
|
|
1293
|
+
| 'gbp'
|
|
1294
|
+
| 'gel'
|
|
1295
|
+
| 'gip'
|
|
1296
|
+
| 'gmd'
|
|
1297
|
+
| 'gyd'
|
|
1298
|
+
| 'hkd'
|
|
1299
|
+
| 'hrk'
|
|
1300
|
+
| 'htg'
|
|
1301
|
+
| 'idr'
|
|
1302
|
+
| 'ils'
|
|
1303
|
+
| 'inr'
|
|
1304
|
+
| 'isk'
|
|
1305
|
+
| 'jmd'
|
|
1306
|
+
| 'jpy'
|
|
1307
|
+
| 'kes'
|
|
1308
|
+
| 'kgs'
|
|
1309
|
+
| 'khr'
|
|
1310
|
+
| 'kmf'
|
|
1311
|
+
| 'krw'
|
|
1312
|
+
| 'kyd'
|
|
1313
|
+
| 'kzt'
|
|
1314
|
+
| 'lbp'
|
|
1315
|
+
| 'lkr'
|
|
1316
|
+
| 'lrd'
|
|
1317
|
+
| 'lsl'
|
|
1318
|
+
| 'mad'
|
|
1319
|
+
| 'mdl'
|
|
1320
|
+
| 'mga'
|
|
1321
|
+
| 'mkd'
|
|
1322
|
+
| 'mmk'
|
|
1323
|
+
| 'mnt'
|
|
1324
|
+
| 'mop'
|
|
1325
|
+
| 'mro'
|
|
1326
|
+
| 'mvr'
|
|
1327
|
+
| 'mwk'
|
|
1328
|
+
| 'mxn'
|
|
1329
|
+
| 'myr'
|
|
1330
|
+
| 'mzn'
|
|
1331
|
+
| 'nad'
|
|
1332
|
+
| 'ngn'
|
|
1333
|
+
| 'nok'
|
|
1334
|
+
| 'npr'
|
|
1335
|
+
| 'nzd'
|
|
1336
|
+
| 'pgk'
|
|
1337
|
+
| 'php'
|
|
1338
|
+
| 'pkr'
|
|
1339
|
+
| 'pln'
|
|
1340
|
+
| 'qar'
|
|
1341
|
+
| 'ron'
|
|
1342
|
+
| 'rsd'
|
|
1343
|
+
| 'rub'
|
|
1344
|
+
| 'rwf'
|
|
1345
|
+
| 'sar'
|
|
1346
|
+
| 'sbd'
|
|
1347
|
+
| 'scr'
|
|
1348
|
+
| 'sek'
|
|
1349
|
+
| 'sgd'
|
|
1350
|
+
| 'sle'
|
|
1351
|
+
| 'sll'
|
|
1352
|
+
| 'sos'
|
|
1353
|
+
| 'szl'
|
|
1354
|
+
| 'thb'
|
|
1355
|
+
| 'tjs'
|
|
1356
|
+
| 'top'
|
|
1357
|
+
| 'try'
|
|
1358
|
+
| 'ttd'
|
|
1359
|
+
| 'tzs'
|
|
1360
|
+
| 'uah'
|
|
1361
|
+
| 'uzs'
|
|
1362
|
+
| 'vnd'
|
|
1363
|
+
| 'vuv'
|
|
1364
|
+
| 'wst'
|
|
1365
|
+
| 'xaf'
|
|
1366
|
+
| 'xcd'
|
|
1367
|
+
| 'yer'
|
|
1368
|
+
| 'zar'
|
|
1369
|
+
| 'zmw'
|
|
1370
|
+
| 'clp'
|
|
1371
|
+
| 'djf'
|
|
1372
|
+
| 'gnf'
|
|
1373
|
+
| 'ugx'
|
|
1374
|
+
| 'pyg'
|
|
1375
|
+
| 'xof'
|
|
1376
|
+
| 'xpf';
|
|
1377
|
+
|
|
1378
|
+
/**
|
|
1379
|
+
* Additional metadata
|
|
1380
|
+
*/
|
|
1381
|
+
metadata?: { [key: string]: string };
|
|
1382
|
+
|
|
1383
|
+
/**
|
|
1384
|
+
* Billing provider payment method id, attached to this customer
|
|
1385
|
+
*/
|
|
1386
|
+
paymentMethodId?: string;
|
|
1387
|
+
}
|
|
1388
|
+
|
|
1389
|
+
export namespace Zuora {
|
|
1390
|
+
/**
|
|
1391
|
+
* Physical address
|
|
1392
|
+
*/
|
|
1393
|
+
export interface BillingAddress {
|
|
1394
|
+
/**
|
|
1395
|
+
* City name
|
|
1396
|
+
*/
|
|
1397
|
+
city?: string;
|
|
1398
|
+
|
|
1399
|
+
/**
|
|
1400
|
+
* Country code or name
|
|
1401
|
+
*/
|
|
1402
|
+
country?: string;
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Street address line 1
|
|
1406
|
+
*/
|
|
1407
|
+
line1?: string;
|
|
1408
|
+
|
|
1409
|
+
/**
|
|
1410
|
+
* Street address line 2
|
|
1411
|
+
*/
|
|
1412
|
+
line2?: string;
|
|
1413
|
+
|
|
1414
|
+
/**
|
|
1415
|
+
* Postal or ZIP code
|
|
1416
|
+
*/
|
|
1417
|
+
postalCode?: string;
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* State or province
|
|
1421
|
+
*/
|
|
1422
|
+
state?: string;
|
|
1423
|
+
}
|
|
1424
|
+
}
|
|
372
1425
|
}
|
|
373
1426
|
}
|
|
374
1427
|
|
|
375
1428
|
/**
|
|
376
|
-
*
|
|
1429
|
+
* Response object
|
|
377
1430
|
*/
|
|
378
|
-
export interface
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
*/
|
|
382
|
-
id: string;
|
|
1431
|
+
export interface CustomerCheckEntitlementResponse {
|
|
1432
|
+
data: CustomerCheckEntitlementResponse.Feature | CustomerCheckEntitlementResponse.Credit;
|
|
1433
|
+
}
|
|
383
1434
|
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
1435
|
+
export namespace CustomerCheckEntitlementResponse {
|
|
1436
|
+
export interface Feature {
|
|
1437
|
+
accessDeniedReason:
|
|
1438
|
+
| 'FeatureNotFound'
|
|
1439
|
+
| 'CustomerNotFound'
|
|
1440
|
+
| 'CustomerIsArchived'
|
|
1441
|
+
| 'CustomerResourceNotFound'
|
|
1442
|
+
| 'NoActiveSubscription'
|
|
1443
|
+
| 'NoFeatureEntitlementInSubscription'
|
|
1444
|
+
| 'RequestedUsageExceedingLimit'
|
|
1445
|
+
| 'RequestedValuesMismatch'
|
|
1446
|
+
| 'BudgetExceeded'
|
|
1447
|
+
| 'Unknown'
|
|
1448
|
+
| 'FeatureTypeMismatch'
|
|
1449
|
+
| 'Revoked'
|
|
1450
|
+
| 'InsufficientCredits'
|
|
1451
|
+
| 'EntitlementNotFound'
|
|
1452
|
+
| null;
|
|
1453
|
+
|
|
1454
|
+
isGranted: boolean;
|
|
1455
|
+
|
|
1456
|
+
type: 'FEATURE';
|
|
1457
|
+
|
|
1458
|
+
currentUsage?: number;
|
|
388
1459
|
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
}
|
|
1460
|
+
/**
|
|
1461
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
1462
|
+
*/
|
|
1463
|
+
entitlementUpdatedAt?: string;
|
|
394
1464
|
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
* Customer level coupon
|
|
398
|
-
*/
|
|
399
|
-
couponId?: string | null;
|
|
1465
|
+
feature?: Feature.Feature;
|
|
400
1466
|
|
|
401
|
-
|
|
402
|
-
* The email of the customer
|
|
403
|
-
*/
|
|
404
|
-
email?: string | null;
|
|
1467
|
+
hasUnlimitedUsage?: boolean;
|
|
405
1468
|
|
|
406
|
-
|
|
407
|
-
* List of integrations
|
|
408
|
-
*/
|
|
409
|
-
integrations?: Array<CustomerUpdateParams.Integration>;
|
|
1469
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
410
1470
|
|
|
411
|
-
|
|
412
|
-
* Additional metadata
|
|
413
|
-
*/
|
|
414
|
-
metadata?: { [key: string]: string };
|
|
1471
|
+
usageLimit?: number | null;
|
|
415
1472
|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
1473
|
+
/**
|
|
1474
|
+
* The anchor for calculating the usage period for metered entitlements with a
|
|
1475
|
+
* reset period configured
|
|
1476
|
+
*/
|
|
1477
|
+
usagePeriodAnchor?: string;
|
|
421
1478
|
|
|
422
|
-
export namespace CustomerUpdateParams {
|
|
423
|
-
/**
|
|
424
|
-
* External billing or CRM integration link
|
|
425
|
-
*/
|
|
426
|
-
export interface Integration {
|
|
427
1479
|
/**
|
|
428
|
-
*
|
|
1480
|
+
* The end date of the usage period for metered entitlements with a reset period
|
|
1481
|
+
* configured
|
|
429
1482
|
*/
|
|
430
|
-
|
|
1483
|
+
usagePeriodEnd?: string;
|
|
431
1484
|
|
|
432
1485
|
/**
|
|
433
|
-
*
|
|
1486
|
+
* The start date of the usage period for metered entitlements with a reset period
|
|
1487
|
+
* configured
|
|
434
1488
|
*/
|
|
435
|
-
|
|
1489
|
+
usagePeriodStart?: string;
|
|
436
1490
|
|
|
437
1491
|
/**
|
|
438
|
-
* The
|
|
1492
|
+
* The next time the entitlement should be recalculated
|
|
439
1493
|
*/
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
1494
|
+
validUntil?: string;
|
|
1495
|
+
}
|
|
1496
|
+
|
|
1497
|
+
export namespace Feature {
|
|
1498
|
+
export interface Feature {
|
|
1499
|
+
/**
|
|
1500
|
+
* The unique reference ID of the entitlement.
|
|
1501
|
+
*/
|
|
1502
|
+
id: string;
|
|
1503
|
+
|
|
1504
|
+
/**
|
|
1505
|
+
* The human-readable name of the entitlement, shown in UI elements.
|
|
1506
|
+
*/
|
|
1507
|
+
displayName: string;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* The current status of the feature.
|
|
1511
|
+
*/
|
|
1512
|
+
featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* The type of feature associated with the entitlement.
|
|
1516
|
+
*/
|
|
1517
|
+
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
1518
|
+
}
|
|
1519
|
+
}
|
|
1520
|
+
|
|
1521
|
+
export interface Credit {
|
|
1522
|
+
accessDeniedReason:
|
|
1523
|
+
| 'FeatureNotFound'
|
|
1524
|
+
| 'CustomerNotFound'
|
|
1525
|
+
| 'CustomerIsArchived'
|
|
1526
|
+
| 'CustomerResourceNotFound'
|
|
1527
|
+
| 'NoActiveSubscription'
|
|
1528
|
+
| 'NoFeatureEntitlementInSubscription'
|
|
1529
|
+
| 'RequestedUsageExceedingLimit'
|
|
1530
|
+
| 'RequestedValuesMismatch'
|
|
1531
|
+
| 'BudgetExceeded'
|
|
1532
|
+
| 'Unknown'
|
|
1533
|
+
| 'FeatureTypeMismatch'
|
|
1534
|
+
| 'Revoked'
|
|
1535
|
+
| 'InsufficientCredits'
|
|
1536
|
+
| 'EntitlementNotFound'
|
|
1537
|
+
| null;
|
|
1538
|
+
|
|
1539
|
+
/**
|
|
1540
|
+
* The currency associated with a credit entitlement.
|
|
1541
|
+
*/
|
|
1542
|
+
currency: Credit.Currency;
|
|
1543
|
+
|
|
1544
|
+
currentUsage: number;
|
|
1545
|
+
|
|
1546
|
+
isGranted: boolean;
|
|
1547
|
+
|
|
1548
|
+
type: 'CREDIT';
|
|
1549
|
+
|
|
1550
|
+
usageLimit: number;
|
|
1551
|
+
|
|
1552
|
+
/**
|
|
1553
|
+
* Timestamp of the last update to the credit usage.
|
|
1554
|
+
*/
|
|
1555
|
+
usageUpdatedAt: string;
|
|
1556
|
+
|
|
1557
|
+
/**
|
|
1558
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
1559
|
+
*/
|
|
1560
|
+
entitlementUpdatedAt?: string;
|
|
1561
|
+
|
|
1562
|
+
/**
|
|
1563
|
+
* The end date of the current billing period for recurring credit grants.
|
|
1564
|
+
*/
|
|
1565
|
+
usagePeriodEnd?: string;
|
|
1566
|
+
|
|
1567
|
+
/**
|
|
1568
|
+
* The next time the entitlement should be recalculated
|
|
1569
|
+
*/
|
|
1570
|
+
validUntil?: string;
|
|
1571
|
+
}
|
|
1572
|
+
|
|
1573
|
+
export namespace Credit {
|
|
1574
|
+
/**
|
|
1575
|
+
* The currency associated with a credit entitlement.
|
|
1576
|
+
*/
|
|
1577
|
+
export interface Currency {
|
|
1578
|
+
/**
|
|
1579
|
+
* The unique identifier of the custom currency.
|
|
1580
|
+
*/
|
|
1581
|
+
currencyId: string;
|
|
1582
|
+
|
|
1583
|
+
/**
|
|
1584
|
+
* The display name of the currency.
|
|
1585
|
+
*/
|
|
1586
|
+
displayName: string;
|
|
1587
|
+
|
|
1588
|
+
/**
|
|
1589
|
+
* A description of the currency.
|
|
1590
|
+
*/
|
|
1591
|
+
description?: string | null;
|
|
1592
|
+
|
|
1593
|
+
/**
|
|
1594
|
+
* Additional metadata associated with the currency.
|
|
1595
|
+
*/
|
|
1596
|
+
metadata?: { [key: string]: string } | null;
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* The plural form of the currency unit.
|
|
1600
|
+
*/
|
|
1601
|
+
unitPlural?: string | null;
|
|
1602
|
+
|
|
1603
|
+
/**
|
|
1604
|
+
* The singular form of the currency unit.
|
|
1605
|
+
*/
|
|
1606
|
+
unitSingular?: string | null;
|
|
1607
|
+
}
|
|
1608
|
+
}
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1611
|
+
/**
|
|
1612
|
+
* Response object
|
|
1613
|
+
*/
|
|
1614
|
+
export interface CustomerImportResponse {
|
|
1615
|
+
/**
|
|
1616
|
+
* List of newly created customer IDs from the import operation.
|
|
1617
|
+
*/
|
|
1618
|
+
data: CustomerImportResponse.Data;
|
|
1619
|
+
}
|
|
1620
|
+
|
|
1621
|
+
export namespace CustomerImportResponse {
|
|
1622
|
+
/**
|
|
1623
|
+
* List of newly created customer IDs from the import operation.
|
|
1624
|
+
*/
|
|
1625
|
+
export interface Data {
|
|
1626
|
+
/**
|
|
1627
|
+
* Customer IDs created during import
|
|
1628
|
+
*/
|
|
1629
|
+
newCustomers: Array<string>;
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
|
|
1633
|
+
/**
|
|
1634
|
+
* Resource object that belongs to a customer
|
|
1635
|
+
*/
|
|
1636
|
+
export interface CustomerListResourcesResponse {
|
|
1637
|
+
/**
|
|
1638
|
+
* Resource slug
|
|
1639
|
+
*/
|
|
1640
|
+
id: string;
|
|
1641
|
+
|
|
1642
|
+
/**
|
|
1643
|
+
* Timestamp of when the record was created
|
|
1644
|
+
*/
|
|
1645
|
+
createdAt: string;
|
|
1646
|
+
|
|
1647
|
+
/**
|
|
1648
|
+
* Timestamp of when the record was last updated
|
|
1649
|
+
*/
|
|
1650
|
+
updatedAt: string;
|
|
1651
|
+
}
|
|
1652
|
+
|
|
1653
|
+
/**
|
|
1654
|
+
* Response object
|
|
1655
|
+
*/
|
|
1656
|
+
export interface CustomerRetrieveEntitlementsResponse {
|
|
1657
|
+
/**
|
|
1658
|
+
* The effective entitlements state for a customer or resource.
|
|
1659
|
+
*/
|
|
1660
|
+
data: CustomerRetrieveEntitlementsResponse.Data;
|
|
1661
|
+
}
|
|
1662
|
+
|
|
1663
|
+
export namespace CustomerRetrieveEntitlementsResponse {
|
|
1664
|
+
/**
|
|
1665
|
+
* The effective entitlements state for a customer or resource.
|
|
1666
|
+
*/
|
|
1667
|
+
export interface Data {
|
|
1668
|
+
/**
|
|
1669
|
+
* Reason why entitlements access was denied, if applicable
|
|
1670
|
+
*/
|
|
1671
|
+
accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
|
|
1672
|
+
|
|
1673
|
+
/**
|
|
1674
|
+
* List of effective feature and credit entitlements
|
|
1675
|
+
*/
|
|
1676
|
+
entitlements: Array<Data.Feature | Data.Credit>;
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
export namespace Data {
|
|
1680
|
+
export interface Feature {
|
|
1681
|
+
accessDeniedReason:
|
|
1682
|
+
| 'FeatureNotFound'
|
|
1683
|
+
| 'CustomerNotFound'
|
|
1684
|
+
| 'CustomerIsArchived'
|
|
1685
|
+
| 'CustomerResourceNotFound'
|
|
1686
|
+
| 'NoActiveSubscription'
|
|
1687
|
+
| 'NoFeatureEntitlementInSubscription'
|
|
1688
|
+
| 'RequestedUsageExceedingLimit'
|
|
1689
|
+
| 'RequestedValuesMismatch'
|
|
1690
|
+
| 'BudgetExceeded'
|
|
1691
|
+
| 'Unknown'
|
|
1692
|
+
| 'FeatureTypeMismatch'
|
|
1693
|
+
| 'Revoked'
|
|
1694
|
+
| 'InsufficientCredits'
|
|
1695
|
+
| 'EntitlementNotFound'
|
|
1696
|
+
| null;
|
|
1697
|
+
|
|
1698
|
+
isGranted: boolean;
|
|
1699
|
+
|
|
1700
|
+
type: 'FEATURE';
|
|
1701
|
+
|
|
1702
|
+
currentUsage?: number;
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
1706
|
+
*/
|
|
1707
|
+
entitlementUpdatedAt?: string;
|
|
1708
|
+
|
|
1709
|
+
feature?: Feature.Feature;
|
|
1710
|
+
|
|
1711
|
+
hasUnlimitedUsage?: boolean;
|
|
1712
|
+
|
|
1713
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
|
|
1714
|
+
|
|
1715
|
+
usageLimit?: number | null;
|
|
1716
|
+
|
|
1717
|
+
/**
|
|
1718
|
+
* The anchor for calculating the usage period for metered entitlements with a
|
|
1719
|
+
* reset period configured
|
|
1720
|
+
*/
|
|
1721
|
+
usagePeriodAnchor?: string;
|
|
1722
|
+
|
|
1723
|
+
/**
|
|
1724
|
+
* The end date of the usage period for metered entitlements with a reset period
|
|
1725
|
+
* configured
|
|
1726
|
+
*/
|
|
1727
|
+
usagePeriodEnd?: string;
|
|
1728
|
+
|
|
1729
|
+
/**
|
|
1730
|
+
* The start date of the usage period for metered entitlements with a reset period
|
|
1731
|
+
* configured
|
|
1732
|
+
*/
|
|
1733
|
+
usagePeriodStart?: string;
|
|
1734
|
+
|
|
1735
|
+
/**
|
|
1736
|
+
* The next time the entitlement should be recalculated
|
|
1737
|
+
*/
|
|
1738
|
+
validUntil?: string;
|
|
1739
|
+
}
|
|
1740
|
+
|
|
1741
|
+
export namespace Feature {
|
|
1742
|
+
export interface Feature {
|
|
1743
|
+
/**
|
|
1744
|
+
* The unique reference ID of the entitlement.
|
|
1745
|
+
*/
|
|
1746
|
+
id: string;
|
|
1747
|
+
|
|
1748
|
+
/**
|
|
1749
|
+
* The human-readable name of the entitlement, shown in UI elements.
|
|
1750
|
+
*/
|
|
1751
|
+
displayName: string;
|
|
1752
|
+
|
|
1753
|
+
/**
|
|
1754
|
+
* The current status of the feature.
|
|
1755
|
+
*/
|
|
1756
|
+
featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
|
|
1757
|
+
|
|
1758
|
+
/**
|
|
1759
|
+
* The type of feature associated with the entitlement.
|
|
1760
|
+
*/
|
|
1761
|
+
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
1762
|
+
}
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
export interface Credit {
|
|
1766
|
+
accessDeniedReason:
|
|
1767
|
+
| 'FeatureNotFound'
|
|
1768
|
+
| 'CustomerNotFound'
|
|
1769
|
+
| 'CustomerIsArchived'
|
|
1770
|
+
| 'CustomerResourceNotFound'
|
|
1771
|
+
| 'NoActiveSubscription'
|
|
1772
|
+
| 'NoFeatureEntitlementInSubscription'
|
|
1773
|
+
| 'RequestedUsageExceedingLimit'
|
|
1774
|
+
| 'RequestedValuesMismatch'
|
|
1775
|
+
| 'BudgetExceeded'
|
|
1776
|
+
| 'Unknown'
|
|
1777
|
+
| 'FeatureTypeMismatch'
|
|
1778
|
+
| 'Revoked'
|
|
1779
|
+
| 'InsufficientCredits'
|
|
1780
|
+
| 'EntitlementNotFound'
|
|
1781
|
+
| null;
|
|
1782
|
+
|
|
1783
|
+
/**
|
|
1784
|
+
* The currency associated with a credit entitlement.
|
|
1785
|
+
*/
|
|
1786
|
+
currency: Credit.Currency;
|
|
1787
|
+
|
|
1788
|
+
currentUsage: number;
|
|
1789
|
+
|
|
1790
|
+
isGranted: boolean;
|
|
1791
|
+
|
|
1792
|
+
type: 'CREDIT';
|
|
1793
|
+
|
|
1794
|
+
usageLimit: number;
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* Timestamp of the last update to the credit usage.
|
|
1798
|
+
*/
|
|
1799
|
+
usageUpdatedAt: string;
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
* Timestamp of the last update to the entitlement grant or configuration.
|
|
1803
|
+
*/
|
|
1804
|
+
entitlementUpdatedAt?: string;
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
* The end date of the current billing period for recurring credit grants.
|
|
1808
|
+
*/
|
|
1809
|
+
usagePeriodEnd?: string;
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
* The next time the entitlement should be recalculated
|
|
1813
|
+
*/
|
|
1814
|
+
validUntil?: string;
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
export namespace Credit {
|
|
1818
|
+
/**
|
|
1819
|
+
* The currency associated with a credit entitlement.
|
|
1820
|
+
*/
|
|
1821
|
+
export interface Currency {
|
|
1822
|
+
/**
|
|
1823
|
+
* The unique identifier of the custom currency.
|
|
1824
|
+
*/
|
|
1825
|
+
currencyId: string;
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* The display name of the currency.
|
|
1829
|
+
*/
|
|
1830
|
+
displayName: string;
|
|
1831
|
+
|
|
1832
|
+
/**
|
|
1833
|
+
* A description of the currency.
|
|
1834
|
+
*/
|
|
1835
|
+
description?: string | null;
|
|
1836
|
+
|
|
1837
|
+
/**
|
|
1838
|
+
* Additional metadata associated with the currency.
|
|
1839
|
+
*/
|
|
1840
|
+
metadata?: { [key: string]: string } | null;
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* The plural form of the currency unit.
|
|
1844
|
+
*/
|
|
1845
|
+
unitPlural?: string | null;
|
|
1846
|
+
|
|
1847
|
+
/**
|
|
1848
|
+
* The singular form of the currency unit.
|
|
1849
|
+
*/
|
|
1850
|
+
unitSingular?: string | null;
|
|
1851
|
+
}
|
|
1852
|
+
}
|
|
1853
|
+
}
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
export interface CustomerUpdateParams {
|
|
1857
|
+
/**
|
|
1858
|
+
* The billing currency of the customer
|
|
1859
|
+
*/
|
|
1860
|
+
billingCurrency?:
|
|
1861
|
+
| 'usd'
|
|
1862
|
+
| 'aed'
|
|
1863
|
+
| 'all'
|
|
1864
|
+
| 'amd'
|
|
1865
|
+
| 'ang'
|
|
1866
|
+
| 'aud'
|
|
1867
|
+
| 'awg'
|
|
1868
|
+
| 'azn'
|
|
1869
|
+
| 'bam'
|
|
1870
|
+
| 'bbd'
|
|
1871
|
+
| 'bdt'
|
|
1872
|
+
| 'bgn'
|
|
1873
|
+
| 'bif'
|
|
1874
|
+
| 'bmd'
|
|
1875
|
+
| 'bnd'
|
|
1876
|
+
| 'bsd'
|
|
1877
|
+
| 'bwp'
|
|
1878
|
+
| 'byn'
|
|
1879
|
+
| 'bzd'
|
|
1880
|
+
| 'brl'
|
|
1881
|
+
| 'cad'
|
|
1882
|
+
| 'cdf'
|
|
1883
|
+
| 'chf'
|
|
1884
|
+
| 'cny'
|
|
1885
|
+
| 'czk'
|
|
1886
|
+
| 'dkk'
|
|
1887
|
+
| 'dop'
|
|
1888
|
+
| 'dzd'
|
|
1889
|
+
| 'egp'
|
|
1890
|
+
| 'etb'
|
|
1891
|
+
| 'eur'
|
|
1892
|
+
| 'fjd'
|
|
1893
|
+
| 'gbp'
|
|
1894
|
+
| 'gel'
|
|
1895
|
+
| 'gip'
|
|
1896
|
+
| 'gmd'
|
|
1897
|
+
| 'gyd'
|
|
1898
|
+
| 'hkd'
|
|
1899
|
+
| 'hrk'
|
|
1900
|
+
| 'htg'
|
|
1901
|
+
| 'idr'
|
|
1902
|
+
| 'ils'
|
|
1903
|
+
| 'inr'
|
|
1904
|
+
| 'isk'
|
|
1905
|
+
| 'jmd'
|
|
1906
|
+
| 'jpy'
|
|
1907
|
+
| 'kes'
|
|
1908
|
+
| 'kgs'
|
|
1909
|
+
| 'khr'
|
|
1910
|
+
| 'kmf'
|
|
1911
|
+
| 'krw'
|
|
1912
|
+
| 'kyd'
|
|
1913
|
+
| 'kzt'
|
|
1914
|
+
| 'lbp'
|
|
1915
|
+
| 'lkr'
|
|
1916
|
+
| 'lrd'
|
|
1917
|
+
| 'lsl'
|
|
1918
|
+
| 'mad'
|
|
1919
|
+
| 'mdl'
|
|
1920
|
+
| 'mga'
|
|
1921
|
+
| 'mkd'
|
|
1922
|
+
| 'mmk'
|
|
1923
|
+
| 'mnt'
|
|
1924
|
+
| 'mop'
|
|
1925
|
+
| 'mro'
|
|
1926
|
+
| 'mvr'
|
|
1927
|
+
| 'mwk'
|
|
1928
|
+
| 'mxn'
|
|
1929
|
+
| 'myr'
|
|
1930
|
+
| 'mzn'
|
|
1931
|
+
| 'nad'
|
|
1932
|
+
| 'ngn'
|
|
1933
|
+
| 'nok'
|
|
1934
|
+
| 'npr'
|
|
1935
|
+
| 'nzd'
|
|
1936
|
+
| 'pgk'
|
|
1937
|
+
| 'php'
|
|
1938
|
+
| 'pkr'
|
|
1939
|
+
| 'pln'
|
|
1940
|
+
| 'qar'
|
|
1941
|
+
| 'ron'
|
|
1942
|
+
| 'rsd'
|
|
1943
|
+
| 'rub'
|
|
1944
|
+
| 'rwf'
|
|
1945
|
+
| 'sar'
|
|
1946
|
+
| 'sbd'
|
|
1947
|
+
| 'scr'
|
|
1948
|
+
| 'sek'
|
|
1949
|
+
| 'sgd'
|
|
1950
|
+
| 'sle'
|
|
1951
|
+
| 'sll'
|
|
1952
|
+
| 'sos'
|
|
1953
|
+
| 'szl'
|
|
1954
|
+
| 'thb'
|
|
1955
|
+
| 'tjs'
|
|
1956
|
+
| 'top'
|
|
1957
|
+
| 'try'
|
|
1958
|
+
| 'ttd'
|
|
1959
|
+
| 'tzs'
|
|
1960
|
+
| 'uah'
|
|
1961
|
+
| 'uzs'
|
|
1962
|
+
| 'vnd'
|
|
1963
|
+
| 'vuv'
|
|
1964
|
+
| 'wst'
|
|
1965
|
+
| 'xaf'
|
|
1966
|
+
| 'xcd'
|
|
1967
|
+
| 'yer'
|
|
1968
|
+
| 'zar'
|
|
1969
|
+
| 'zmw'
|
|
1970
|
+
| 'clp'
|
|
1971
|
+
| 'djf'
|
|
1972
|
+
| 'gnf'
|
|
1973
|
+
| 'ugx'
|
|
1974
|
+
| 'pyg'
|
|
1975
|
+
| 'xof'
|
|
1976
|
+
| 'xpf'
|
|
1977
|
+
| null;
|
|
1978
|
+
|
|
1979
|
+
/**
|
|
1980
|
+
* The unique identifier for the entity in the billing provider
|
|
1981
|
+
*/
|
|
1982
|
+
billingId?: string | null;
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* Customer level coupon
|
|
1986
|
+
*/
|
|
1987
|
+
couponId?: (string & {}) | '' | null;
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* The email of the customer
|
|
1991
|
+
*/
|
|
1992
|
+
email?: string | null;
|
|
1993
|
+
|
|
1994
|
+
/**
|
|
1995
|
+
* List of integrations
|
|
1996
|
+
*/
|
|
1997
|
+
integrations?: Array<CustomerUpdateParams.Integration>;
|
|
1998
|
+
|
|
1999
|
+
/**
|
|
2000
|
+
* Language to use for this customer
|
|
2001
|
+
*/
|
|
2002
|
+
language?: string | null;
|
|
2003
|
+
|
|
2004
|
+
/**
|
|
2005
|
+
* Additional metadata
|
|
2006
|
+
*/
|
|
2007
|
+
metadata?: { [key: string]: string };
|
|
2008
|
+
|
|
2009
|
+
/**
|
|
2010
|
+
* The name of the customer
|
|
2011
|
+
*/
|
|
2012
|
+
name?: string | null;
|
|
2013
|
+
|
|
2014
|
+
/**
|
|
2015
|
+
* Vendor-specific billing passthrough fields.
|
|
2016
|
+
*/
|
|
2017
|
+
passthrough?: CustomerUpdateParams.Passthrough;
|
|
2018
|
+
|
|
2019
|
+
/**
|
|
2020
|
+
* Timezone to use for this customer
|
|
2021
|
+
*/
|
|
2022
|
+
timezone?: string | null;
|
|
2023
|
+
}
|
|
2024
|
+
|
|
2025
|
+
export namespace CustomerUpdateParams {
|
|
2026
|
+
/**
|
|
2027
|
+
* External billing or CRM integration link
|
|
2028
|
+
*/
|
|
2029
|
+
export interface Integration {
|
|
2030
|
+
/**
|
|
2031
|
+
* Integration details
|
|
2032
|
+
*/
|
|
2033
|
+
id: string;
|
|
2034
|
+
|
|
2035
|
+
/**
|
|
2036
|
+
* Synced entity id
|
|
2037
|
+
*/
|
|
2038
|
+
syncedEntityId: string | null;
|
|
2039
|
+
|
|
2040
|
+
/**
|
|
2041
|
+
* The vendor identifier of integration
|
|
2042
|
+
*/
|
|
2043
|
+
vendorIdentifier:
|
|
2044
|
+
| 'AUTH0'
|
|
2045
|
+
| 'ZUORA'
|
|
443
2046
|
| 'STRIPE'
|
|
444
2047
|
| 'HUBSPOT'
|
|
445
2048
|
| 'AWS_MARKETPLACE'
|
|
@@ -449,6 +2052,328 @@ export namespace CustomerUpdateParams {
|
|
|
449
2052
|
| 'OPEN_FGA'
|
|
450
2053
|
| 'APP_STORE';
|
|
451
2054
|
}
|
|
2055
|
+
|
|
2056
|
+
/**
|
|
2057
|
+
* Vendor-specific billing passthrough fields.
|
|
2058
|
+
*/
|
|
2059
|
+
export interface Passthrough {
|
|
2060
|
+
/**
|
|
2061
|
+
* Stripe-specific billing fields for the customer.
|
|
2062
|
+
*/
|
|
2063
|
+
stripe?: Passthrough.Stripe;
|
|
2064
|
+
|
|
2065
|
+
/**
|
|
2066
|
+
* Zuora-specific billing fields for the customer.
|
|
2067
|
+
*/
|
|
2068
|
+
zuora?: Passthrough.Zuora;
|
|
2069
|
+
}
|
|
2070
|
+
|
|
2071
|
+
export namespace Passthrough {
|
|
2072
|
+
/**
|
|
2073
|
+
* Stripe-specific billing fields for the customer.
|
|
2074
|
+
*/
|
|
2075
|
+
export interface Stripe {
|
|
2076
|
+
/**
|
|
2077
|
+
* Physical address
|
|
2078
|
+
*/
|
|
2079
|
+
billingAddress?: Stripe.BillingAddress;
|
|
2080
|
+
|
|
2081
|
+
/**
|
|
2082
|
+
* Customer name
|
|
2083
|
+
*/
|
|
2084
|
+
customerName?: string;
|
|
2085
|
+
|
|
2086
|
+
/**
|
|
2087
|
+
* Invoice custom fields
|
|
2088
|
+
*/
|
|
2089
|
+
invoiceCustomFields?: { [key: string]: string };
|
|
2090
|
+
|
|
2091
|
+
/**
|
|
2092
|
+
* Additional metadata
|
|
2093
|
+
*/
|
|
2094
|
+
metadata?: { [key: string]: string };
|
|
2095
|
+
|
|
2096
|
+
/**
|
|
2097
|
+
* Billing provider payment method id, attached to this customer
|
|
2098
|
+
*/
|
|
2099
|
+
paymentMethodId?: string;
|
|
2100
|
+
|
|
2101
|
+
/**
|
|
2102
|
+
* Physical address
|
|
2103
|
+
*/
|
|
2104
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
2105
|
+
|
|
2106
|
+
/**
|
|
2107
|
+
* Tax IDs
|
|
2108
|
+
*/
|
|
2109
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2112
|
+
export namespace Stripe {
|
|
2113
|
+
/**
|
|
2114
|
+
* Physical address
|
|
2115
|
+
*/
|
|
2116
|
+
export interface BillingAddress {
|
|
2117
|
+
/**
|
|
2118
|
+
* City name
|
|
2119
|
+
*/
|
|
2120
|
+
city?: string;
|
|
2121
|
+
|
|
2122
|
+
/**
|
|
2123
|
+
* Country code or name
|
|
2124
|
+
*/
|
|
2125
|
+
country?: string;
|
|
2126
|
+
|
|
2127
|
+
/**
|
|
2128
|
+
* Street address line 1
|
|
2129
|
+
*/
|
|
2130
|
+
line1?: string;
|
|
2131
|
+
|
|
2132
|
+
/**
|
|
2133
|
+
* Street address line 2
|
|
2134
|
+
*/
|
|
2135
|
+
line2?: string;
|
|
2136
|
+
|
|
2137
|
+
/**
|
|
2138
|
+
* Postal or ZIP code
|
|
2139
|
+
*/
|
|
2140
|
+
postalCode?: string;
|
|
2141
|
+
|
|
2142
|
+
/**
|
|
2143
|
+
* State or province
|
|
2144
|
+
*/
|
|
2145
|
+
state?: string;
|
|
2146
|
+
}
|
|
2147
|
+
|
|
2148
|
+
/**
|
|
2149
|
+
* Physical address
|
|
2150
|
+
*/
|
|
2151
|
+
export interface ShippingAddress {
|
|
2152
|
+
/**
|
|
2153
|
+
* City name
|
|
2154
|
+
*/
|
|
2155
|
+
city?: string;
|
|
2156
|
+
|
|
2157
|
+
/**
|
|
2158
|
+
* Country code or name
|
|
2159
|
+
*/
|
|
2160
|
+
country?: string;
|
|
2161
|
+
|
|
2162
|
+
/**
|
|
2163
|
+
* Street address line 1
|
|
2164
|
+
*/
|
|
2165
|
+
line1?: string;
|
|
2166
|
+
|
|
2167
|
+
/**
|
|
2168
|
+
* Street address line 2
|
|
2169
|
+
*/
|
|
2170
|
+
line2?: string;
|
|
2171
|
+
|
|
2172
|
+
/**
|
|
2173
|
+
* Postal or ZIP code
|
|
2174
|
+
*/
|
|
2175
|
+
postalCode?: string;
|
|
2176
|
+
|
|
2177
|
+
/**
|
|
2178
|
+
* State or province
|
|
2179
|
+
*/
|
|
2180
|
+
state?: string;
|
|
2181
|
+
}
|
|
2182
|
+
|
|
2183
|
+
/**
|
|
2184
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
2185
|
+
*/
|
|
2186
|
+
export interface TaxID {
|
|
2187
|
+
/**
|
|
2188
|
+
* The type of tax exemption identifier, such as VAT.
|
|
2189
|
+
*/
|
|
2190
|
+
type: string;
|
|
2191
|
+
|
|
2192
|
+
/**
|
|
2193
|
+
* The actual tax identifier value
|
|
2194
|
+
*/
|
|
2195
|
+
value: string;
|
|
2196
|
+
}
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
/**
|
|
2200
|
+
* Zuora-specific billing fields for the customer.
|
|
2201
|
+
*/
|
|
2202
|
+
export interface Zuora {
|
|
2203
|
+
/**
|
|
2204
|
+
* Physical address
|
|
2205
|
+
*/
|
|
2206
|
+
billingAddress?: Zuora.BillingAddress;
|
|
2207
|
+
|
|
2208
|
+
/**
|
|
2209
|
+
* Customers selected currency
|
|
2210
|
+
*/
|
|
2211
|
+
currency?:
|
|
2212
|
+
| 'usd'
|
|
2213
|
+
| 'aed'
|
|
2214
|
+
| 'all'
|
|
2215
|
+
| 'amd'
|
|
2216
|
+
| 'ang'
|
|
2217
|
+
| 'aud'
|
|
2218
|
+
| 'awg'
|
|
2219
|
+
| 'azn'
|
|
2220
|
+
| 'bam'
|
|
2221
|
+
| 'bbd'
|
|
2222
|
+
| 'bdt'
|
|
2223
|
+
| 'bgn'
|
|
2224
|
+
| 'bif'
|
|
2225
|
+
| 'bmd'
|
|
2226
|
+
| 'bnd'
|
|
2227
|
+
| 'bsd'
|
|
2228
|
+
| 'bwp'
|
|
2229
|
+
| 'byn'
|
|
2230
|
+
| 'bzd'
|
|
2231
|
+
| 'brl'
|
|
2232
|
+
| 'cad'
|
|
2233
|
+
| 'cdf'
|
|
2234
|
+
| 'chf'
|
|
2235
|
+
| 'cny'
|
|
2236
|
+
| 'czk'
|
|
2237
|
+
| 'dkk'
|
|
2238
|
+
| 'dop'
|
|
2239
|
+
| 'dzd'
|
|
2240
|
+
| 'egp'
|
|
2241
|
+
| 'etb'
|
|
2242
|
+
| 'eur'
|
|
2243
|
+
| 'fjd'
|
|
2244
|
+
| 'gbp'
|
|
2245
|
+
| 'gel'
|
|
2246
|
+
| 'gip'
|
|
2247
|
+
| 'gmd'
|
|
2248
|
+
| 'gyd'
|
|
2249
|
+
| 'hkd'
|
|
2250
|
+
| 'hrk'
|
|
2251
|
+
| 'htg'
|
|
2252
|
+
| 'idr'
|
|
2253
|
+
| 'ils'
|
|
2254
|
+
| 'inr'
|
|
2255
|
+
| 'isk'
|
|
2256
|
+
| 'jmd'
|
|
2257
|
+
| 'jpy'
|
|
2258
|
+
| 'kes'
|
|
2259
|
+
| 'kgs'
|
|
2260
|
+
| 'khr'
|
|
2261
|
+
| 'kmf'
|
|
2262
|
+
| 'krw'
|
|
2263
|
+
| 'kyd'
|
|
2264
|
+
| 'kzt'
|
|
2265
|
+
| 'lbp'
|
|
2266
|
+
| 'lkr'
|
|
2267
|
+
| 'lrd'
|
|
2268
|
+
| 'lsl'
|
|
2269
|
+
| 'mad'
|
|
2270
|
+
| 'mdl'
|
|
2271
|
+
| 'mga'
|
|
2272
|
+
| 'mkd'
|
|
2273
|
+
| 'mmk'
|
|
2274
|
+
| 'mnt'
|
|
2275
|
+
| 'mop'
|
|
2276
|
+
| 'mro'
|
|
2277
|
+
| 'mvr'
|
|
2278
|
+
| 'mwk'
|
|
2279
|
+
| 'mxn'
|
|
2280
|
+
| 'myr'
|
|
2281
|
+
| 'mzn'
|
|
2282
|
+
| 'nad'
|
|
2283
|
+
| 'ngn'
|
|
2284
|
+
| 'nok'
|
|
2285
|
+
| 'npr'
|
|
2286
|
+
| 'nzd'
|
|
2287
|
+
| 'pgk'
|
|
2288
|
+
| 'php'
|
|
2289
|
+
| 'pkr'
|
|
2290
|
+
| 'pln'
|
|
2291
|
+
| 'qar'
|
|
2292
|
+
| 'ron'
|
|
2293
|
+
| 'rsd'
|
|
2294
|
+
| 'rub'
|
|
2295
|
+
| 'rwf'
|
|
2296
|
+
| 'sar'
|
|
2297
|
+
| 'sbd'
|
|
2298
|
+
| 'scr'
|
|
2299
|
+
| 'sek'
|
|
2300
|
+
| 'sgd'
|
|
2301
|
+
| 'sle'
|
|
2302
|
+
| 'sll'
|
|
2303
|
+
| 'sos'
|
|
2304
|
+
| 'szl'
|
|
2305
|
+
| 'thb'
|
|
2306
|
+
| 'tjs'
|
|
2307
|
+
| 'top'
|
|
2308
|
+
| 'try'
|
|
2309
|
+
| 'ttd'
|
|
2310
|
+
| 'tzs'
|
|
2311
|
+
| 'uah'
|
|
2312
|
+
| 'uzs'
|
|
2313
|
+
| 'vnd'
|
|
2314
|
+
| 'vuv'
|
|
2315
|
+
| 'wst'
|
|
2316
|
+
| 'xaf'
|
|
2317
|
+
| 'xcd'
|
|
2318
|
+
| 'yer'
|
|
2319
|
+
| 'zar'
|
|
2320
|
+
| 'zmw'
|
|
2321
|
+
| 'clp'
|
|
2322
|
+
| 'djf'
|
|
2323
|
+
| 'gnf'
|
|
2324
|
+
| 'ugx'
|
|
2325
|
+
| 'pyg'
|
|
2326
|
+
| 'xof'
|
|
2327
|
+
| 'xpf';
|
|
2328
|
+
|
|
2329
|
+
/**
|
|
2330
|
+
* Additional metadata
|
|
2331
|
+
*/
|
|
2332
|
+
metadata?: { [key: string]: string };
|
|
2333
|
+
|
|
2334
|
+
/**
|
|
2335
|
+
* Billing provider payment method id, attached to this customer
|
|
2336
|
+
*/
|
|
2337
|
+
paymentMethodId?: string;
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2340
|
+
export namespace Zuora {
|
|
2341
|
+
/**
|
|
2342
|
+
* Physical address
|
|
2343
|
+
*/
|
|
2344
|
+
export interface BillingAddress {
|
|
2345
|
+
/**
|
|
2346
|
+
* City name
|
|
2347
|
+
*/
|
|
2348
|
+
city?: string;
|
|
2349
|
+
|
|
2350
|
+
/**
|
|
2351
|
+
* Country code or name
|
|
2352
|
+
*/
|
|
2353
|
+
country?: string;
|
|
2354
|
+
|
|
2355
|
+
/**
|
|
2356
|
+
* Street address line 1
|
|
2357
|
+
*/
|
|
2358
|
+
line1?: string;
|
|
2359
|
+
|
|
2360
|
+
/**
|
|
2361
|
+
* Street address line 2
|
|
2362
|
+
*/
|
|
2363
|
+
line2?: string;
|
|
2364
|
+
|
|
2365
|
+
/**
|
|
2366
|
+
* Postal or ZIP code
|
|
2367
|
+
*/
|
|
2368
|
+
postalCode?: string;
|
|
2369
|
+
|
|
2370
|
+
/**
|
|
2371
|
+
* State or province
|
|
2372
|
+
*/
|
|
2373
|
+
state?: string;
|
|
2374
|
+
}
|
|
2375
|
+
}
|
|
2376
|
+
}
|
|
452
2377
|
}
|
|
453
2378
|
|
|
454
2379
|
export interface CustomerListParams extends MyCursorIDPageParams {
|
|
@@ -495,11 +2420,45 @@ export namespace CustomerListParams {
|
|
|
495
2420
|
}
|
|
496
2421
|
}
|
|
497
2422
|
|
|
2423
|
+
export interface CustomerCheckEntitlementParams {
|
|
2424
|
+
/**
|
|
2425
|
+
* Currency ID (refId) to check for credit entitlements. Mutually exclusive with
|
|
2426
|
+
* `featureId`.
|
|
2427
|
+
*/
|
|
2428
|
+
currencyId?: string;
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Feature ID (refId) to check. Mutually exclusive with `currencyId`.
|
|
2432
|
+
*/
|
|
2433
|
+
featureId?: string;
|
|
2434
|
+
|
|
2435
|
+
/**
|
|
2436
|
+
* Requested usage amount to evaluate against the entitlement limit (numeric
|
|
2437
|
+
* features only)
|
|
2438
|
+
*/
|
|
2439
|
+
requestedUsage?: number;
|
|
2440
|
+
|
|
2441
|
+
/**
|
|
2442
|
+
* Requested values to evaluate against allowed values (enum features only)
|
|
2443
|
+
*/
|
|
2444
|
+
requestedValues?: Array<string>;
|
|
2445
|
+
|
|
2446
|
+
/**
|
|
2447
|
+
* Resource ID to scope the entitlement check to a specific resource
|
|
2448
|
+
*/
|
|
2449
|
+
resourceId?: string;
|
|
2450
|
+
}
|
|
2451
|
+
|
|
498
2452
|
export interface CustomerImportParams {
|
|
499
2453
|
/**
|
|
500
2454
|
* List of customer objects to import
|
|
501
2455
|
*/
|
|
502
2456
|
customers: Array<CustomerImportParams.Customer>;
|
|
2457
|
+
|
|
2458
|
+
/**
|
|
2459
|
+
* Integration details
|
|
2460
|
+
*/
|
|
2461
|
+
integrationId?: string;
|
|
503
2462
|
}
|
|
504
2463
|
|
|
505
2464
|
export namespace CustomerImportParams {
|
|
@@ -519,6 +2478,11 @@ export namespace CustomerImportParams {
|
|
|
519
2478
|
*/
|
|
520
2479
|
name: string | null;
|
|
521
2480
|
|
|
2481
|
+
/**
|
|
2482
|
+
* Id in the billing provider
|
|
2483
|
+
*/
|
|
2484
|
+
billingId?: string;
|
|
2485
|
+
|
|
522
2486
|
/**
|
|
523
2487
|
* Additional metadata
|
|
524
2488
|
*/
|
|
@@ -529,6 +2493,11 @@ export namespace CustomerImportParams {
|
|
|
529
2493
|
*/
|
|
530
2494
|
paymentMethodId?: string;
|
|
531
2495
|
|
|
2496
|
+
/**
|
|
2497
|
+
* The unique identifier for the customer in Salesforce integration
|
|
2498
|
+
*/
|
|
2499
|
+
salesforceId?: string;
|
|
2500
|
+
|
|
532
2501
|
/**
|
|
533
2502
|
* Timestamp of when the record was last updated
|
|
534
2503
|
*/
|
|
@@ -544,10 +2513,137 @@ export interface CustomerProvisionParams {
|
|
|
544
2513
|
*/
|
|
545
2514
|
id: string;
|
|
546
2515
|
|
|
2516
|
+
/**
|
|
2517
|
+
* The billing currency of the customer
|
|
2518
|
+
*/
|
|
2519
|
+
billingCurrency?:
|
|
2520
|
+
| 'usd'
|
|
2521
|
+
| 'aed'
|
|
2522
|
+
| 'all'
|
|
2523
|
+
| 'amd'
|
|
2524
|
+
| 'ang'
|
|
2525
|
+
| 'aud'
|
|
2526
|
+
| 'awg'
|
|
2527
|
+
| 'azn'
|
|
2528
|
+
| 'bam'
|
|
2529
|
+
| 'bbd'
|
|
2530
|
+
| 'bdt'
|
|
2531
|
+
| 'bgn'
|
|
2532
|
+
| 'bif'
|
|
2533
|
+
| 'bmd'
|
|
2534
|
+
| 'bnd'
|
|
2535
|
+
| 'bsd'
|
|
2536
|
+
| 'bwp'
|
|
2537
|
+
| 'byn'
|
|
2538
|
+
| 'bzd'
|
|
2539
|
+
| 'brl'
|
|
2540
|
+
| 'cad'
|
|
2541
|
+
| 'cdf'
|
|
2542
|
+
| 'chf'
|
|
2543
|
+
| 'cny'
|
|
2544
|
+
| 'czk'
|
|
2545
|
+
| 'dkk'
|
|
2546
|
+
| 'dop'
|
|
2547
|
+
| 'dzd'
|
|
2548
|
+
| 'egp'
|
|
2549
|
+
| 'etb'
|
|
2550
|
+
| 'eur'
|
|
2551
|
+
| 'fjd'
|
|
2552
|
+
| 'gbp'
|
|
2553
|
+
| 'gel'
|
|
2554
|
+
| 'gip'
|
|
2555
|
+
| 'gmd'
|
|
2556
|
+
| 'gyd'
|
|
2557
|
+
| 'hkd'
|
|
2558
|
+
| 'hrk'
|
|
2559
|
+
| 'htg'
|
|
2560
|
+
| 'idr'
|
|
2561
|
+
| 'ils'
|
|
2562
|
+
| 'inr'
|
|
2563
|
+
| 'isk'
|
|
2564
|
+
| 'jmd'
|
|
2565
|
+
| 'jpy'
|
|
2566
|
+
| 'kes'
|
|
2567
|
+
| 'kgs'
|
|
2568
|
+
| 'khr'
|
|
2569
|
+
| 'kmf'
|
|
2570
|
+
| 'krw'
|
|
2571
|
+
| 'kyd'
|
|
2572
|
+
| 'kzt'
|
|
2573
|
+
| 'lbp'
|
|
2574
|
+
| 'lkr'
|
|
2575
|
+
| 'lrd'
|
|
2576
|
+
| 'lsl'
|
|
2577
|
+
| 'mad'
|
|
2578
|
+
| 'mdl'
|
|
2579
|
+
| 'mga'
|
|
2580
|
+
| 'mkd'
|
|
2581
|
+
| 'mmk'
|
|
2582
|
+
| 'mnt'
|
|
2583
|
+
| 'mop'
|
|
2584
|
+
| 'mro'
|
|
2585
|
+
| 'mvr'
|
|
2586
|
+
| 'mwk'
|
|
2587
|
+
| 'mxn'
|
|
2588
|
+
| 'myr'
|
|
2589
|
+
| 'mzn'
|
|
2590
|
+
| 'nad'
|
|
2591
|
+
| 'ngn'
|
|
2592
|
+
| 'nok'
|
|
2593
|
+
| 'npr'
|
|
2594
|
+
| 'nzd'
|
|
2595
|
+
| 'pgk'
|
|
2596
|
+
| 'php'
|
|
2597
|
+
| 'pkr'
|
|
2598
|
+
| 'pln'
|
|
2599
|
+
| 'qar'
|
|
2600
|
+
| 'ron'
|
|
2601
|
+
| 'rsd'
|
|
2602
|
+
| 'rub'
|
|
2603
|
+
| 'rwf'
|
|
2604
|
+
| 'sar'
|
|
2605
|
+
| 'sbd'
|
|
2606
|
+
| 'scr'
|
|
2607
|
+
| 'sek'
|
|
2608
|
+
| 'sgd'
|
|
2609
|
+
| 'sle'
|
|
2610
|
+
| 'sll'
|
|
2611
|
+
| 'sos'
|
|
2612
|
+
| 'szl'
|
|
2613
|
+
| 'thb'
|
|
2614
|
+
| 'tjs'
|
|
2615
|
+
| 'top'
|
|
2616
|
+
| 'try'
|
|
2617
|
+
| 'ttd'
|
|
2618
|
+
| 'tzs'
|
|
2619
|
+
| 'uah'
|
|
2620
|
+
| 'uzs'
|
|
2621
|
+
| 'vnd'
|
|
2622
|
+
| 'vuv'
|
|
2623
|
+
| 'wst'
|
|
2624
|
+
| 'xaf'
|
|
2625
|
+
| 'xcd'
|
|
2626
|
+
| 'yer'
|
|
2627
|
+
| 'zar'
|
|
2628
|
+
| 'zmw'
|
|
2629
|
+
| 'clp'
|
|
2630
|
+
| 'djf'
|
|
2631
|
+
| 'gnf'
|
|
2632
|
+
| 'ugx'
|
|
2633
|
+
| 'pyg'
|
|
2634
|
+
| 'xof'
|
|
2635
|
+
| 'xpf'
|
|
2636
|
+
| null;
|
|
2637
|
+
|
|
2638
|
+
/**
|
|
2639
|
+
* The unique identifier for the entity in the billing provider
|
|
2640
|
+
*/
|
|
2641
|
+
billingId?: string | null;
|
|
2642
|
+
|
|
547
2643
|
/**
|
|
548
2644
|
* Customer level coupon
|
|
549
2645
|
*/
|
|
550
|
-
couponId?: string | null;
|
|
2646
|
+
couponId?: (string & {}) | '' | null;
|
|
551
2647
|
|
|
552
2648
|
/**
|
|
553
2649
|
* The default payment method details
|
|
@@ -564,6 +2660,11 @@ export interface CustomerProvisionParams {
|
|
|
564
2660
|
*/
|
|
565
2661
|
integrations?: Array<CustomerProvisionParams.Integration>;
|
|
566
2662
|
|
|
2663
|
+
/**
|
|
2664
|
+
* Language to use for this customer
|
|
2665
|
+
*/
|
|
2666
|
+
language?: string | null;
|
|
2667
|
+
|
|
567
2668
|
/**
|
|
568
2669
|
* Additional metadata
|
|
569
2670
|
*/
|
|
@@ -573,6 +2674,16 @@ export interface CustomerProvisionParams {
|
|
|
573
2674
|
* The name of the customer
|
|
574
2675
|
*/
|
|
575
2676
|
name?: string | null;
|
|
2677
|
+
|
|
2678
|
+
/**
|
|
2679
|
+
* Vendor-specific billing passthrough fields.
|
|
2680
|
+
*/
|
|
2681
|
+
passthrough?: CustomerProvisionParams.Passthrough;
|
|
2682
|
+
|
|
2683
|
+
/**
|
|
2684
|
+
* Timezone to use for this customer
|
|
2685
|
+
*/
|
|
2686
|
+
timezone?: string | null;
|
|
576
2687
|
}
|
|
577
2688
|
|
|
578
2689
|
export namespace CustomerProvisionParams {
|
|
@@ -635,24 +2746,359 @@ export namespace CustomerProvisionParams {
|
|
|
635
2746
|
| 'OPEN_FGA'
|
|
636
2747
|
| 'APP_STORE';
|
|
637
2748
|
}
|
|
2749
|
+
|
|
2750
|
+
/**
|
|
2751
|
+
* Vendor-specific billing passthrough fields.
|
|
2752
|
+
*/
|
|
2753
|
+
export interface Passthrough {
|
|
2754
|
+
/**
|
|
2755
|
+
* Stripe-specific billing fields for the customer.
|
|
2756
|
+
*/
|
|
2757
|
+
stripe?: Passthrough.Stripe;
|
|
2758
|
+
|
|
2759
|
+
/**
|
|
2760
|
+
* Zuora-specific billing fields for the customer.
|
|
2761
|
+
*/
|
|
2762
|
+
zuora?: Passthrough.Zuora;
|
|
2763
|
+
}
|
|
2764
|
+
|
|
2765
|
+
export namespace Passthrough {
|
|
2766
|
+
/**
|
|
2767
|
+
* Stripe-specific billing fields for the customer.
|
|
2768
|
+
*/
|
|
2769
|
+
export interface Stripe {
|
|
2770
|
+
/**
|
|
2771
|
+
* Physical address
|
|
2772
|
+
*/
|
|
2773
|
+
billingAddress?: Stripe.BillingAddress;
|
|
2774
|
+
|
|
2775
|
+
/**
|
|
2776
|
+
* Customer name
|
|
2777
|
+
*/
|
|
2778
|
+
customerName?: string;
|
|
2779
|
+
|
|
2780
|
+
/**
|
|
2781
|
+
* Invoice custom fields
|
|
2782
|
+
*/
|
|
2783
|
+
invoiceCustomFields?: { [key: string]: string };
|
|
2784
|
+
|
|
2785
|
+
/**
|
|
2786
|
+
* Additional metadata
|
|
2787
|
+
*/
|
|
2788
|
+
metadata?: { [key: string]: string };
|
|
2789
|
+
|
|
2790
|
+
/**
|
|
2791
|
+
* Billing provider payment method id, attached to this customer
|
|
2792
|
+
*/
|
|
2793
|
+
paymentMethodId?: string;
|
|
2794
|
+
|
|
2795
|
+
/**
|
|
2796
|
+
* Physical address
|
|
2797
|
+
*/
|
|
2798
|
+
shippingAddress?: Stripe.ShippingAddress;
|
|
2799
|
+
|
|
2800
|
+
/**
|
|
2801
|
+
* Tax IDs
|
|
2802
|
+
*/
|
|
2803
|
+
taxIds?: Array<Stripe.TaxID>;
|
|
2804
|
+
}
|
|
2805
|
+
|
|
2806
|
+
export namespace Stripe {
|
|
2807
|
+
/**
|
|
2808
|
+
* Physical address
|
|
2809
|
+
*/
|
|
2810
|
+
export interface BillingAddress {
|
|
2811
|
+
/**
|
|
2812
|
+
* City name
|
|
2813
|
+
*/
|
|
2814
|
+
city?: string;
|
|
2815
|
+
|
|
2816
|
+
/**
|
|
2817
|
+
* Country code or name
|
|
2818
|
+
*/
|
|
2819
|
+
country?: string;
|
|
2820
|
+
|
|
2821
|
+
/**
|
|
2822
|
+
* Street address line 1
|
|
2823
|
+
*/
|
|
2824
|
+
line1?: string;
|
|
2825
|
+
|
|
2826
|
+
/**
|
|
2827
|
+
* Street address line 2
|
|
2828
|
+
*/
|
|
2829
|
+
line2?: string;
|
|
2830
|
+
|
|
2831
|
+
/**
|
|
2832
|
+
* Postal or ZIP code
|
|
2833
|
+
*/
|
|
2834
|
+
postalCode?: string;
|
|
2835
|
+
|
|
2836
|
+
/**
|
|
2837
|
+
* State or province
|
|
2838
|
+
*/
|
|
2839
|
+
state?: string;
|
|
2840
|
+
}
|
|
2841
|
+
|
|
2842
|
+
/**
|
|
2843
|
+
* Physical address
|
|
2844
|
+
*/
|
|
2845
|
+
export interface ShippingAddress {
|
|
2846
|
+
/**
|
|
2847
|
+
* City name
|
|
2848
|
+
*/
|
|
2849
|
+
city?: string;
|
|
2850
|
+
|
|
2851
|
+
/**
|
|
2852
|
+
* Country code or name
|
|
2853
|
+
*/
|
|
2854
|
+
country?: string;
|
|
2855
|
+
|
|
2856
|
+
/**
|
|
2857
|
+
* Street address line 1
|
|
2858
|
+
*/
|
|
2859
|
+
line1?: string;
|
|
2860
|
+
|
|
2861
|
+
/**
|
|
2862
|
+
* Street address line 2
|
|
2863
|
+
*/
|
|
2864
|
+
line2?: string;
|
|
2865
|
+
|
|
2866
|
+
/**
|
|
2867
|
+
* Postal or ZIP code
|
|
2868
|
+
*/
|
|
2869
|
+
postalCode?: string;
|
|
2870
|
+
|
|
2871
|
+
/**
|
|
2872
|
+
* State or province
|
|
2873
|
+
*/
|
|
2874
|
+
state?: string;
|
|
2875
|
+
}
|
|
2876
|
+
|
|
2877
|
+
/**
|
|
2878
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
2879
|
+
*/
|
|
2880
|
+
export interface TaxID {
|
|
2881
|
+
/**
|
|
2882
|
+
* The type of tax exemption identifier, such as VAT.
|
|
2883
|
+
*/
|
|
2884
|
+
type: string;
|
|
2885
|
+
|
|
2886
|
+
/**
|
|
2887
|
+
* The actual tax identifier value
|
|
2888
|
+
*/
|
|
2889
|
+
value: string;
|
|
2890
|
+
}
|
|
2891
|
+
}
|
|
2892
|
+
|
|
2893
|
+
/**
|
|
2894
|
+
* Zuora-specific billing fields for the customer.
|
|
2895
|
+
*/
|
|
2896
|
+
export interface Zuora {
|
|
2897
|
+
/**
|
|
2898
|
+
* Physical address
|
|
2899
|
+
*/
|
|
2900
|
+
billingAddress?: Zuora.BillingAddress;
|
|
2901
|
+
|
|
2902
|
+
/**
|
|
2903
|
+
* Customers selected currency
|
|
2904
|
+
*/
|
|
2905
|
+
currency?:
|
|
2906
|
+
| 'usd'
|
|
2907
|
+
| 'aed'
|
|
2908
|
+
| 'all'
|
|
2909
|
+
| 'amd'
|
|
2910
|
+
| 'ang'
|
|
2911
|
+
| 'aud'
|
|
2912
|
+
| 'awg'
|
|
2913
|
+
| 'azn'
|
|
2914
|
+
| 'bam'
|
|
2915
|
+
| 'bbd'
|
|
2916
|
+
| 'bdt'
|
|
2917
|
+
| 'bgn'
|
|
2918
|
+
| 'bif'
|
|
2919
|
+
| 'bmd'
|
|
2920
|
+
| 'bnd'
|
|
2921
|
+
| 'bsd'
|
|
2922
|
+
| 'bwp'
|
|
2923
|
+
| 'byn'
|
|
2924
|
+
| 'bzd'
|
|
2925
|
+
| 'brl'
|
|
2926
|
+
| 'cad'
|
|
2927
|
+
| 'cdf'
|
|
2928
|
+
| 'chf'
|
|
2929
|
+
| 'cny'
|
|
2930
|
+
| 'czk'
|
|
2931
|
+
| 'dkk'
|
|
2932
|
+
| 'dop'
|
|
2933
|
+
| 'dzd'
|
|
2934
|
+
| 'egp'
|
|
2935
|
+
| 'etb'
|
|
2936
|
+
| 'eur'
|
|
2937
|
+
| 'fjd'
|
|
2938
|
+
| 'gbp'
|
|
2939
|
+
| 'gel'
|
|
2940
|
+
| 'gip'
|
|
2941
|
+
| 'gmd'
|
|
2942
|
+
| 'gyd'
|
|
2943
|
+
| 'hkd'
|
|
2944
|
+
| 'hrk'
|
|
2945
|
+
| 'htg'
|
|
2946
|
+
| 'idr'
|
|
2947
|
+
| 'ils'
|
|
2948
|
+
| 'inr'
|
|
2949
|
+
| 'isk'
|
|
2950
|
+
| 'jmd'
|
|
2951
|
+
| 'jpy'
|
|
2952
|
+
| 'kes'
|
|
2953
|
+
| 'kgs'
|
|
2954
|
+
| 'khr'
|
|
2955
|
+
| 'kmf'
|
|
2956
|
+
| 'krw'
|
|
2957
|
+
| 'kyd'
|
|
2958
|
+
| 'kzt'
|
|
2959
|
+
| 'lbp'
|
|
2960
|
+
| 'lkr'
|
|
2961
|
+
| 'lrd'
|
|
2962
|
+
| 'lsl'
|
|
2963
|
+
| 'mad'
|
|
2964
|
+
| 'mdl'
|
|
2965
|
+
| 'mga'
|
|
2966
|
+
| 'mkd'
|
|
2967
|
+
| 'mmk'
|
|
2968
|
+
| 'mnt'
|
|
2969
|
+
| 'mop'
|
|
2970
|
+
| 'mro'
|
|
2971
|
+
| 'mvr'
|
|
2972
|
+
| 'mwk'
|
|
2973
|
+
| 'mxn'
|
|
2974
|
+
| 'myr'
|
|
2975
|
+
| 'mzn'
|
|
2976
|
+
| 'nad'
|
|
2977
|
+
| 'ngn'
|
|
2978
|
+
| 'nok'
|
|
2979
|
+
| 'npr'
|
|
2980
|
+
| 'nzd'
|
|
2981
|
+
| 'pgk'
|
|
2982
|
+
| 'php'
|
|
2983
|
+
| 'pkr'
|
|
2984
|
+
| 'pln'
|
|
2985
|
+
| 'qar'
|
|
2986
|
+
| 'ron'
|
|
2987
|
+
| 'rsd'
|
|
2988
|
+
| 'rub'
|
|
2989
|
+
| 'rwf'
|
|
2990
|
+
| 'sar'
|
|
2991
|
+
| 'sbd'
|
|
2992
|
+
| 'scr'
|
|
2993
|
+
| 'sek'
|
|
2994
|
+
| 'sgd'
|
|
2995
|
+
| 'sle'
|
|
2996
|
+
| 'sll'
|
|
2997
|
+
| 'sos'
|
|
2998
|
+
| 'szl'
|
|
2999
|
+
| 'thb'
|
|
3000
|
+
| 'tjs'
|
|
3001
|
+
| 'top'
|
|
3002
|
+
| 'try'
|
|
3003
|
+
| 'ttd'
|
|
3004
|
+
| 'tzs'
|
|
3005
|
+
| 'uah'
|
|
3006
|
+
| 'uzs'
|
|
3007
|
+
| 'vnd'
|
|
3008
|
+
| 'vuv'
|
|
3009
|
+
| 'wst'
|
|
3010
|
+
| 'xaf'
|
|
3011
|
+
| 'xcd'
|
|
3012
|
+
| 'yer'
|
|
3013
|
+
| 'zar'
|
|
3014
|
+
| 'zmw'
|
|
3015
|
+
| 'clp'
|
|
3016
|
+
| 'djf'
|
|
3017
|
+
| 'gnf'
|
|
3018
|
+
| 'ugx'
|
|
3019
|
+
| 'pyg'
|
|
3020
|
+
| 'xof'
|
|
3021
|
+
| 'xpf';
|
|
3022
|
+
|
|
3023
|
+
/**
|
|
3024
|
+
* Additional metadata
|
|
3025
|
+
*/
|
|
3026
|
+
metadata?: { [key: string]: string };
|
|
3027
|
+
|
|
3028
|
+
/**
|
|
3029
|
+
* Billing provider payment method id, attached to this customer
|
|
3030
|
+
*/
|
|
3031
|
+
paymentMethodId?: string;
|
|
3032
|
+
}
|
|
3033
|
+
|
|
3034
|
+
export namespace Zuora {
|
|
3035
|
+
/**
|
|
3036
|
+
* Physical address
|
|
3037
|
+
*/
|
|
3038
|
+
export interface BillingAddress {
|
|
3039
|
+
/**
|
|
3040
|
+
* City name
|
|
3041
|
+
*/
|
|
3042
|
+
city?: string;
|
|
3043
|
+
|
|
3044
|
+
/**
|
|
3045
|
+
* Country code or name
|
|
3046
|
+
*/
|
|
3047
|
+
country?: string;
|
|
3048
|
+
|
|
3049
|
+
/**
|
|
3050
|
+
* Street address line 1
|
|
3051
|
+
*/
|
|
3052
|
+
line1?: string;
|
|
3053
|
+
|
|
3054
|
+
/**
|
|
3055
|
+
* Street address line 2
|
|
3056
|
+
*/
|
|
3057
|
+
line2?: string;
|
|
3058
|
+
|
|
3059
|
+
/**
|
|
3060
|
+
* Postal or ZIP code
|
|
3061
|
+
*/
|
|
3062
|
+
postalCode?: string;
|
|
3063
|
+
|
|
3064
|
+
/**
|
|
3065
|
+
* State or province
|
|
3066
|
+
*/
|
|
3067
|
+
state?: string;
|
|
3068
|
+
}
|
|
3069
|
+
}
|
|
3070
|
+
}
|
|
3071
|
+
}
|
|
3072
|
+
|
|
3073
|
+
export interface CustomerRetrieveEntitlementsParams {
|
|
3074
|
+
/**
|
|
3075
|
+
* Resource ID to scope entitlements to a specific resource
|
|
3076
|
+
*/
|
|
3077
|
+
resourceId?: string;
|
|
638
3078
|
}
|
|
639
3079
|
|
|
640
3080
|
Customers.PaymentMethod = PaymentMethod;
|
|
641
3081
|
Customers.PromotionalEntitlements = PromotionalEntitlements;
|
|
3082
|
+
Customers.Integrations = Integrations;
|
|
642
3083
|
|
|
643
3084
|
export declare namespace Customers {
|
|
644
3085
|
export {
|
|
3086
|
+
type CustomerIntegrationResponse as CustomerIntegrationResponse,
|
|
645
3087
|
type CustomerResponse as CustomerResponse,
|
|
646
3088
|
type CustomerListResponse as CustomerListResponse,
|
|
3089
|
+
type CustomerCheckEntitlementResponse as CustomerCheckEntitlementResponse,
|
|
647
3090
|
type CustomerImportResponse as CustomerImportResponse,
|
|
648
3091
|
type CustomerListResourcesResponse as CustomerListResourcesResponse,
|
|
3092
|
+
type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
|
|
649
3093
|
type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
|
|
650
3094
|
type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
|
|
651
3095
|
type CustomerUpdateParams as CustomerUpdateParams,
|
|
652
3096
|
type CustomerListParams as CustomerListParams,
|
|
3097
|
+
type CustomerCheckEntitlementParams as CustomerCheckEntitlementParams,
|
|
653
3098
|
type CustomerImportParams as CustomerImportParams,
|
|
654
3099
|
type CustomerListResourcesParams as CustomerListResourcesParams,
|
|
655
3100
|
type CustomerProvisionParams as CustomerProvisionParams,
|
|
3101
|
+
type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
|
|
656
3102
|
};
|
|
657
3103
|
|
|
658
3104
|
export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
|
|
@@ -667,4 +3113,15 @@ export declare namespace Customers {
|
|
|
667
3113
|
type PromotionalEntitlementListParams as PromotionalEntitlementListParams,
|
|
668
3114
|
type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
|
|
669
3115
|
};
|
|
3116
|
+
|
|
3117
|
+
export {
|
|
3118
|
+
Integrations as Integrations,
|
|
3119
|
+
type IntegrationListResponse as IntegrationListResponse,
|
|
3120
|
+
type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage,
|
|
3121
|
+
type IntegrationRetrieveParams as IntegrationRetrieveParams,
|
|
3122
|
+
type IntegrationUpdateParams as IntegrationUpdateParams,
|
|
3123
|
+
type IntegrationListParams as IntegrationListParams,
|
|
3124
|
+
type IntegrationLinkParams as IntegrationLinkParams,
|
|
3125
|
+
type IntegrationUnlinkParams as IntegrationUnlinkParams,
|
|
3126
|
+
};
|
|
670
3127
|
}
|