@stigg/typescript 0.1.0-beta.64 → 0.1.0-beta.66
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 +29 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +59 -0
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +59 -0
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +59 -0
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +59 -0
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +31 -0
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +31 -0
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +31 -0
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +31 -0
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/contracts.d.mts +30 -0
- package/resources/v1/contracts.d.mts.map +1 -1
- package/resources/v1/contracts.d.ts +30 -0
- package/resources/v1/contracts.d.ts.map +1 -1
- package/resources/v1/contracts.js +30 -0
- package/resources/v1/contracts.js.map +1 -1
- package/resources/v1/contracts.mjs +30 -0
- package/resources/v1/contracts.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +36 -0
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +36 -0
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +36 -0
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +36 -0
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/consumption.d.mts +26 -0
- package/resources/v1/credits/consumption.d.mts.map +1 -1
- package/resources/v1/credits/consumption.d.ts +26 -0
- package/resources/v1/credits/consumption.d.ts.map +1 -1
- package/resources/v1/credits/consumption.js +26 -0
- package/resources/v1/credits/consumption.js.map +1 -1
- package/resources/v1/credits/consumption.mjs +26 -0
- package/resources/v1/credits/consumption.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +25 -0
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +25 -0
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +25 -0
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +25 -0
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +49 -0
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +49 -0
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +49 -0
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +49 -0
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +28 -0
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +28 -0
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +28 -0
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +28 -0
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/reservations.d.mts +10 -0
- package/resources/v1/credits/reservations.d.mts.map +1 -1
- package/resources/v1/credits/reservations.d.ts +10 -0
- package/resources/v1/credits/reservations.d.ts.map +1 -1
- package/resources/v1/credits/reservations.js +10 -0
- package/resources/v1/credits/reservations.js.map +1 -1
- package/resources/v1/credits/reservations.mjs +10 -0
- package/resources/v1/credits/reservations.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +198 -7
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +198 -7
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +106 -6
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +106 -6
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/entities/entities.d.mts +332 -0
- package/resources/v1/customers/entities/entities.d.mts.map +1 -0
- package/resources/v1/customers/entities/entities.d.ts +332 -0
- package/resources/v1/customers/entities/entities.d.ts.map +1 -0
- package/resources/v1/customers/entities/entities.js +139 -0
- package/resources/v1/customers/entities/entities.js.map +1 -0
- package/resources/v1/customers/entities/entities.mjs +134 -0
- package/resources/v1/customers/entities/entities.mjs.map +1 -0
- package/resources/v1/customers/entities/entitlements.d.mts +260 -0
- package/resources/v1/customers/entities/entitlements.d.mts.map +1 -0
- package/resources/v1/customers/entities/entitlements.d.ts +260 -0
- package/resources/v1/customers/entities/entitlements.d.ts.map +1 -0
- package/resources/v1/customers/entities/entitlements.js +87 -0
- package/resources/v1/customers/entities/entitlements.js.map +1 -0
- package/resources/v1/customers/entities/entitlements.mjs +83 -0
- package/resources/v1/customers/entities/entitlements.mjs.map +1 -0
- package/resources/v1/customers/entities/index.d.mts +3 -0
- package/resources/v1/customers/entities/index.d.mts.map +1 -0
- package/resources/v1/customers/entities/index.d.ts +3 -0
- package/resources/v1/customers/entities/index.d.ts.map +1 -0
- package/resources/v1/customers/entities/index.js +9 -0
- package/resources/v1/customers/entities/index.js.map +1 -0
- package/resources/v1/customers/entities/index.mjs +4 -0
- package/resources/v1/customers/entities/index.mjs.map +1 -0
- package/resources/v1/customers/entities.d.mts +2 -0
- package/resources/v1/customers/entities.d.mts.map +1 -0
- package/resources/v1/customers/entities.d.ts +2 -0
- package/resources/v1/customers/entities.d.ts.map +1 -0
- package/resources/v1/customers/entities.js +6 -0
- package/resources/v1/customers/entities.js.map +1 -0
- package/resources/v1/customers/entities.mjs +3 -0
- package/resources/v1/customers/entities.mjs.map +1 -0
- package/resources/v1/customers/index.d.mts +1 -0
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +1 -0
- 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 +47 -0
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +47 -0
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +47 -0
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +47 -0
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +16 -0
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +16 -0
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +16 -0
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +16 -0
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +51 -0
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +51 -0
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +51 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +51 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/entity-types.d.mts +291 -0
- package/resources/v1/entity-types.d.mts.map +1 -0
- package/resources/v1/entity-types.d.ts +291 -0
- package/resources/v1/entity-types.d.ts.map +1 -0
- package/resources/v1/entity-types.js +128 -0
- package/resources/v1/entity-types.js.map +1 -0
- package/resources/v1/entity-types.mjs +124 -0
- package/resources/v1/entity-types.mjs.map +1 -0
- package/resources/v1/events/beta/customers.d.mts +8 -0
- package/resources/v1/events/beta/customers.d.mts.map +1 -1
- package/resources/v1/events/beta/customers.d.ts +8 -0
- package/resources/v1/events/beta/customers.d.ts.map +1 -1
- package/resources/v1/events/beta/customers.js +8 -0
- package/resources/v1/events/beta/customers.js.map +1 -1
- package/resources/v1/events/beta/customers.mjs +8 -0
- package/resources/v1/events/beta/customers.mjs.map +1 -1
- package/resources/v1/events/data-export/data-export.d.mts +12 -0
- package/resources/v1/events/data-export/data-export.d.mts.map +1 -1
- package/resources/v1/events/data-export/data-export.d.ts +12 -0
- package/resources/v1/events/data-export/data-export.d.ts.map +1 -1
- package/resources/v1/events/data-export/data-export.js +12 -0
- package/resources/v1/events/data-export/data-export.js.map +1 -1
- package/resources/v1/events/data-export/data-export.mjs +12 -0
- package/resources/v1/events/data-export/data-export.mjs.map +1 -1
- package/resources/v1/events/data-export/destinations.d.mts +26 -0
- package/resources/v1/events/data-export/destinations.d.mts.map +1 -1
- package/resources/v1/events/data-export/destinations.d.ts +26 -0
- package/resources/v1/events/data-export/destinations.d.ts.map +1 -1
- package/resources/v1/events/data-export/destinations.js +26 -0
- package/resources/v1/events/data-export/destinations.js.map +1 -1
- package/resources/v1/events/data-export/destinations.mjs +26 -0
- package/resources/v1/events/data-export/destinations.mjs.map +1 -1
- package/resources/v1/events/events.d.mts +21 -0
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +21 -0
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +21 -0
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +21 -0
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +43 -0
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +43 -0
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +43 -0
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +43 -0
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -0
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -0
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +3 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -0
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +31 -0
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +31 -0
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +31 -0
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +31 -0
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +69 -0
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +69 -0
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +69 -0
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +69 -0
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +43 -0
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +43 -0
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +43 -0
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +43 -0
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +16 -0
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +16 -0
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +16 -0
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +16 -0
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +6 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +6 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +6 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +6 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +81 -0
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +81 -0
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +81 -0
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +81 -0
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +13 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +13 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +13 -0
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +13 -0
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +20 -0
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +20 -0
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +20 -0
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +20 -0
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +4 -0
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +4 -0
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -0
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1-beta/customers/assignments.d.mts +12 -33
- package/resources/v1-beta/customers/assignments.d.mts.map +1 -1
- package/resources/v1-beta/customers/assignments.d.ts +12 -33
- package/resources/v1-beta/customers/assignments.d.ts.map +1 -1
- package/resources/v1-beta/customers/assignments.js +7 -33
- package/resources/v1-beta/customers/assignments.js.map +1 -1
- package/resources/v1-beta/customers/assignments.mjs +7 -33
- package/resources/v1-beta/customers/assignments.mjs.map +1 -1
- package/resources/v1-beta/customers/entities.d.mts +18 -55
- package/resources/v1-beta/customers/entities.d.mts.map +1 -1
- package/resources/v1-beta/customers/entities.d.ts +18 -55
- package/resources/v1-beta/customers/entities.d.ts.map +1 -1
- package/resources/v1-beta/customers/entities.js +18 -55
- package/resources/v1-beta/customers/entities.js.map +1 -1
- package/resources/v1-beta/customers/entities.mjs +18 -55
- package/resources/v1-beta/customers/entities.mjs.map +1 -1
- package/resources/v1-beta/customers/entitlements.d.mts +7 -10
- package/resources/v1-beta/customers/entitlements.d.mts.map +1 -1
- package/resources/v1-beta/customers/entitlements.d.ts +7 -10
- package/resources/v1-beta/customers/entitlements.d.ts.map +1 -1
- package/resources/v1-beta/customers/entitlements.js +2 -5
- package/resources/v1-beta/customers/entitlements.js.map +1 -1
- package/resources/v1-beta/customers/entitlements.mjs +2 -5
- package/resources/v1-beta/customers/entitlements.mjs.map +1 -1
- package/resources/v1-beta/entity-types.d.mts +18 -28
- package/resources/v1-beta/entity-types.d.mts.map +1 -1
- package/resources/v1-beta/entity-types.d.ts +18 -28
- package/resources/v1-beta/entity-types.d.ts.map +1 -1
- package/resources/v1-beta/entity-types.js +6 -28
- package/resources/v1-beta/entity-types.js.map +1 -1
- package/resources/v1-beta/entity-types.mjs +6 -28
- package/resources/v1-beta/entity-types.mjs.map +1 -1
- package/src/resources/v1/addons/addons.ts +59 -0
- package/src/resources/v1/addons/entitlements.ts +31 -0
- package/src/resources/v1/contracts.ts +30 -0
- package/src/resources/v1/coupons.ts +36 -0
- package/src/resources/v1/credits/consumption.ts +26 -0
- package/src/resources/v1/credits/credits.ts +25 -0
- package/src/resources/v1/credits/custom-currencies.ts +49 -0
- package/src/resources/v1/credits/grants.ts +28 -0
- package/src/resources/v1/credits/reservations.ts +10 -0
- package/src/resources/v1/customers/customers.ts +237 -7
- package/src/resources/v1/customers/entities/entities.ts +470 -0
- package/src/resources/v1/customers/entities/entitlements.ts +347 -0
- package/src/resources/v1/customers/entities/index.ts +22 -0
- package/src/resources/v1/customers/entities.ts +3 -0
- package/src/resources/v1/customers/index.ts +12 -0
- package/src/resources/v1/customers/integrations.ts +47 -0
- package/src/resources/v1/customers/payment-method.ts +16 -0
- package/src/resources/v1/customers/promotional-entitlements.ts +51 -0
- package/src/resources/v1/entity-types.ts +402 -0
- package/src/resources/v1/events/beta/customers.ts +8 -0
- package/src/resources/v1/events/data-export/data-export.ts +12 -0
- package/src/resources/v1/events/data-export/destinations.ts +26 -0
- package/src/resources/v1/events/events.ts +21 -0
- package/src/resources/v1/features.ts +43 -0
- package/src/resources/v1/index.ts +12 -0
- package/src/resources/v1/plans/entitlements.ts +31 -0
- package/src/resources/v1/plans/plans.ts +69 -0
- package/src/resources/v1/products.ts +43 -0
- package/src/resources/v1/subscriptions/future-update.ts +16 -0
- package/src/resources/v1/subscriptions/invoice.ts +6 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +81 -0
- package/src/resources/v1/subscriptions/usage.ts +13 -0
- package/src/resources/v1/usage.ts +20 -0
- package/src/resources/v1/v1.ts +28 -0
- package/src/resources/v1-beta/customers/assignments.ts +12 -33
- package/src/resources/v1-beta/customers/entities.ts +18 -55
- package/src/resources/v1-beta/customers/entitlements.ts +7 -10
- package/src/resources/v1-beta/entity-types.ts +21 -28
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -9,15 +9,66 @@ export declare class PromotionalEntitlements extends APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Grants promotional entitlements to a customer, providing feature access outside
|
|
11
11
|
* their subscription. Entitlements can be time-limited or permanent.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const promotionalEntitlement =
|
|
16
|
+
* await client.v1.customers.promotionalEntitlements.create(
|
|
17
|
+
* 'x',
|
|
18
|
+
* {
|
|
19
|
+
* promotionalEntitlements: [
|
|
20
|
+
* {
|
|
21
|
+
* customEndDate: '2019-12-27T18:11:19.117Z',
|
|
22
|
+
* enumValues: ['string'],
|
|
23
|
+
* featureId: 'featureId',
|
|
24
|
+
* hasSoftLimit: true,
|
|
25
|
+
* hasUnlimitedUsage: true,
|
|
26
|
+
* isVisible: true,
|
|
27
|
+
* monthlyResetPeriodConfiguration: {
|
|
28
|
+
* accordingTo: 'SubscriptionStart',
|
|
29
|
+
* },
|
|
30
|
+
* period: '1 week',
|
|
31
|
+
* resetPeriod: 'YEAR',
|
|
32
|
+
* usageLimit: -9007199254740991,
|
|
33
|
+
* weeklyResetPeriodConfiguration: {
|
|
34
|
+
* accordingTo: 'SubscriptionStart',
|
|
35
|
+
* },
|
|
36
|
+
* yearlyResetPeriodConfiguration: {
|
|
37
|
+
* accordingTo: 'SubscriptionStart',
|
|
38
|
+
* },
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* },
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
12
44
|
*/
|
|
13
45
|
create(id: string, params: PromotionalEntitlementCreateParams, options?: RequestOptions): APIPromise<PromotionalEntitlementCreateResponse>;
|
|
14
46
|
/**
|
|
15
47
|
* Retrieves a paginated list of a customer's promotional entitlements.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* // Automatically fetches more pages as needed.
|
|
52
|
+
* for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
|
|
53
|
+
* 'x',
|
|
54
|
+
* )) {
|
|
55
|
+
* // ...
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
16
58
|
*/
|
|
17
59
|
list(id: string, params?: PromotionalEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse>;
|
|
18
60
|
/**
|
|
19
61
|
* Revokes a previously granted promotional entitlement from a customer for a
|
|
20
62
|
* specific feature.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response =
|
|
67
|
+
* await client.v1.customers.promotionalEntitlements.revoke(
|
|
68
|
+
* 'featureId',
|
|
69
|
+
* { id: 'id' },
|
|
70
|
+
* );
|
|
71
|
+
* ```
|
|
21
72
|
*/
|
|
22
73
|
revoke(featureID: string, params: PromotionalEntitlementRevokeParams, options?: RequestOptions): APIPromise<PromotionalEntitlementRevokeResponse>;
|
|
23
74
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promotional-entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IACtD
|
|
1
|
+
{"version":3,"file":"promotional-entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAenD;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iDAAiD,EAAE,kCAAkC,CAAC;IAmBrG;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAapD;AAED,MAAM,MAAM,iDAAiD,GAC3D,cAAc,CAAC,kCAAkC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,KAAK,CAAC,oCAAoC,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IAE5E;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,wBAAwB,EACpB,kCAAkC,CAAC,uBAAuB,GAC1D,kCAAkC,CAAC,wBAAwB,GAC3D,kCAAkC,CAAC,uBAAuB,GAC1D,IAAI,CAAC;IAET;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;KACtD;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;;;;;OAMG;IACH,IAAI,EAAE,oCAAoC,CAAC,IAAI,CAAC;CACjD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,uBAAuB,EAAE,KAAK,CAAC,kCAAkC,CAAC,sBAAsB,CAAC,CAAC;IAE1F;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;;;OAIG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,+BAA+B,EAAE,sBAAsB,CAAC,+BAA+B,GAAG,IAAI,CAAC;QAE/F;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;QAE7F;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;KAC9F;IAED,UAAiB,sBAAsB,CAAC;QACtC;;;WAGG;QACH,UAAiB,+BAA+B;YAC9C;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;KACF;CACF;AAED,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E;;OAEG;IACH,SAAS,CAAC,EAAE,gCAAgC,CAAC,SAAS,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC,CAAC;IAEhD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
|
|
@@ -13,6 +13,38 @@ class PromotionalEntitlements extends resource_1.APIResource {
|
|
|
13
13
|
/**
|
|
14
14
|
* Grants promotional entitlements to a customer, providing feature access outside
|
|
15
15
|
* their subscription. Entitlements can be time-limited or permanent.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const promotionalEntitlement =
|
|
20
|
+
* await client.v1.customers.promotionalEntitlements.create(
|
|
21
|
+
* 'x',
|
|
22
|
+
* {
|
|
23
|
+
* promotionalEntitlements: [
|
|
24
|
+
* {
|
|
25
|
+
* customEndDate: '2019-12-27T18:11:19.117Z',
|
|
26
|
+
* enumValues: ['string'],
|
|
27
|
+
* featureId: 'featureId',
|
|
28
|
+
* hasSoftLimit: true,
|
|
29
|
+
* hasUnlimitedUsage: true,
|
|
30
|
+
* isVisible: true,
|
|
31
|
+
* monthlyResetPeriodConfiguration: {
|
|
32
|
+
* accordingTo: 'SubscriptionStart',
|
|
33
|
+
* },
|
|
34
|
+
* period: '1 week',
|
|
35
|
+
* resetPeriod: 'YEAR',
|
|
36
|
+
* usageLimit: -9007199254740991,
|
|
37
|
+
* weeklyResetPeriodConfiguration: {
|
|
38
|
+
* accordingTo: 'SubscriptionStart',
|
|
39
|
+
* },
|
|
40
|
+
* yearlyResetPeriodConfiguration: {
|
|
41
|
+
* accordingTo: 'SubscriptionStart',
|
|
42
|
+
* },
|
|
43
|
+
* },
|
|
44
|
+
* ],
|
|
45
|
+
* },
|
|
46
|
+
* );
|
|
47
|
+
* ```
|
|
16
48
|
*/
|
|
17
49
|
create(id, params, options) {
|
|
18
50
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -30,6 +62,16 @@ class PromotionalEntitlements extends resource_1.APIResource {
|
|
|
30
62
|
}
|
|
31
63
|
/**
|
|
32
64
|
* Retrieves a paginated list of a customer's promotional entitlements.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* // Automatically fetches more pages as needed.
|
|
69
|
+
* for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
|
|
70
|
+
* 'x',
|
|
71
|
+
* )) {
|
|
72
|
+
* // ...
|
|
73
|
+
* }
|
|
74
|
+
* ```
|
|
33
75
|
*/
|
|
34
76
|
list(id, params = {}, options) {
|
|
35
77
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -48,6 +90,15 @@ class PromotionalEntitlements extends resource_1.APIResource {
|
|
|
48
90
|
/**
|
|
49
91
|
* Revokes a previously granted promotional entitlement from a customer for a
|
|
50
92
|
* specific feature.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const response =
|
|
97
|
+
* await client.v1.customers.promotionalEntitlements.revoke(
|
|
98
|
+
* 'featureId',
|
|
99
|
+
* { id: 'id' },
|
|
100
|
+
* );
|
|
101
|
+
* ```
|
|
51
102
|
*/
|
|
52
103
|
revoke(featureID, params, options) {
|
|
53
104
|
const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promotional-entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,sBAAW;IACtD
|
|
1
|
+
{"version":3,"file":"promotional-entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,sBAAW;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,2BAA2B,EAAE;YAC/E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8D,EAAE,EAChE,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,qBAAqB,EAAE,2BAA2B,EACtD,CAAA,2BAAkD,CAAA,EAClD;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,6BAA6B,SAAS,EAAE,EAAE;YAC9F,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA1HD,0DA0HC"}
|
|
@@ -10,6 +10,38 @@ export class PromotionalEntitlements extends APIResource {
|
|
|
10
10
|
/**
|
|
11
11
|
* Grants promotional entitlements to a customer, providing feature access outside
|
|
12
12
|
* their subscription. Entitlements can be time-limited or permanent.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const promotionalEntitlement =
|
|
17
|
+
* await client.v1.customers.promotionalEntitlements.create(
|
|
18
|
+
* 'x',
|
|
19
|
+
* {
|
|
20
|
+
* promotionalEntitlements: [
|
|
21
|
+
* {
|
|
22
|
+
* customEndDate: '2019-12-27T18:11:19.117Z',
|
|
23
|
+
* enumValues: ['string'],
|
|
24
|
+
* featureId: 'featureId',
|
|
25
|
+
* hasSoftLimit: true,
|
|
26
|
+
* hasUnlimitedUsage: true,
|
|
27
|
+
* isVisible: true,
|
|
28
|
+
* monthlyResetPeriodConfiguration: {
|
|
29
|
+
* accordingTo: 'SubscriptionStart',
|
|
30
|
+
* },
|
|
31
|
+
* period: '1 week',
|
|
32
|
+
* resetPeriod: 'YEAR',
|
|
33
|
+
* usageLimit: -9007199254740991,
|
|
34
|
+
* weeklyResetPeriodConfiguration: {
|
|
35
|
+
* accordingTo: 'SubscriptionStart',
|
|
36
|
+
* },
|
|
37
|
+
* yearlyResetPeriodConfiguration: {
|
|
38
|
+
* accordingTo: 'SubscriptionStart',
|
|
39
|
+
* },
|
|
40
|
+
* },
|
|
41
|
+
* ],
|
|
42
|
+
* },
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
13
45
|
*/
|
|
14
46
|
create(id, params, options) {
|
|
15
47
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -27,6 +59,16 @@ export class PromotionalEntitlements extends APIResource {
|
|
|
27
59
|
}
|
|
28
60
|
/**
|
|
29
61
|
* Retrieves a paginated list of a customer's promotional entitlements.
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```ts
|
|
65
|
+
* // Automatically fetches more pages as needed.
|
|
66
|
+
* for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
|
|
67
|
+
* 'x',
|
|
68
|
+
* )) {
|
|
69
|
+
* // ...
|
|
70
|
+
* }
|
|
71
|
+
* ```
|
|
30
72
|
*/
|
|
31
73
|
list(id, params = {}, options) {
|
|
32
74
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -45,6 +87,15 @@ export class PromotionalEntitlements extends APIResource {
|
|
|
45
87
|
/**
|
|
46
88
|
* Revokes a previously granted promotional entitlement from a customer for a
|
|
47
89
|
* specific feature.
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* const response =
|
|
94
|
+
* await client.v1.customers.promotionalEntitlements.revoke(
|
|
95
|
+
* 'featureId',
|
|
96
|
+
* { id: 'id' },
|
|
97
|
+
* );
|
|
98
|
+
* ```
|
|
48
99
|
*/
|
|
49
100
|
revoke(featureID, params, options) {
|
|
50
101
|
const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promotional-entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAClG,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,WAAW;IACtD
|
|
1
|
+
{"version":3,"file":"promotional-entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAClG,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,WAAW;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CACJ,EAAU,EACV,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,2BAA2B,EAAE;YAC/E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8D,EAAE,EAChE,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,qBAAqB,EAAE,2BAA2B,EACtD,CAAA,cAAkD,CAAA,EAClD;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,6BAA6B,SAAS,EAAE,EAAE;YAC9F,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
|
+
export declare class EntityTypes extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Returns a cursor-paginated list of entity types defined in the environment.
|
|
8
|
+
* Entity types are vendor-defined categories of resource that can be governed
|
|
9
|
+
* (e.g. Org, Team, User). Archived entity types are excluded unless
|
|
10
|
+
* includeArchived=true.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // Automatically fetches more pages as needed.
|
|
15
|
+
* for await (const entityTypeListResponse of client.v1.entityTypes.list()) {
|
|
16
|
+
* // ...
|
|
17
|
+
* }
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
list(params?: EntityTypeListParams | null | undefined, options?: RequestOptions): PagePromise<EntityTypeListResponsesMyCursorIDPage, EntityTypeListResponse>;
|
|
21
|
+
/**
|
|
22
|
+
* Archives entity types in bulk by id. An entity type with active entities cannot
|
|
23
|
+
* be archived: archive its entities first, or the whole request fails with 400.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const response = await client.v1.entityTypes.archive({
|
|
28
|
+
* ids: ['team'],
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
archive(params: EntityTypeArchiveParams, options?: RequestOptions): APIPromise<EntityTypeArchiveResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Returns whether any active entity of this entity type exists, across every
|
|
35
|
+
* customer. An entity type can be archived only when this is false. An unknown
|
|
36
|
+
* entity type returns false.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const response =
|
|
41
|
+
* await client.v1.entityTypes.checkActiveEntities('id');
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
checkActiveEntities(id: string, params?: EntityTypeCheckActiveEntitiesParams | null | undefined, options?: RequestOptions): APIPromise<EntityTypeCheckActiveEntitiesResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Batched create-or-update of entity types. Existing types matched by id are
|
|
47
|
+
* updated; new ids are created. Idempotent — re-submitting the same payload
|
|
48
|
+
* converges to the same state. An upsert of an archived entity type restores it.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const response = await client.v1.entityTypes.upsert({
|
|
53
|
+
* types: [
|
|
54
|
+
* {
|
|
55
|
+
* id: 'org',
|
|
56
|
+
* displayName: 'Organization',
|
|
57
|
+
* description:
|
|
58
|
+
* 'A customer organization — the top of the hierarchy, holding the account-wide budget.',
|
|
59
|
+
* attributionKeys: ['organizationId'],
|
|
60
|
+
* },
|
|
61
|
+
* {
|
|
62
|
+
* id: 'team',
|
|
63
|
+
* displayName: 'Team',
|
|
64
|
+
* attributionKeys: ['teamId'],
|
|
65
|
+
* },
|
|
66
|
+
* ],
|
|
67
|
+
* });
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
upsert(params: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse>;
|
|
71
|
+
}
|
|
72
|
+
export type EntityTypeListResponsesMyCursorIDPage = MyCursorIDPage<EntityTypeListResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* A vendor-defined category of resource that can be governed (e.g. Org, Team,
|
|
75
|
+
* User). Vendors define entity types once per environment; their customers create
|
|
76
|
+
* instances (entities) of these types and the governance engine tracks usage and
|
|
77
|
+
* enforces limits per instance.
|
|
78
|
+
*/
|
|
79
|
+
export interface EntityTypeListResponse {
|
|
80
|
+
/**
|
|
81
|
+
* The unique identifier for the entity
|
|
82
|
+
*/
|
|
83
|
+
id: string;
|
|
84
|
+
/**
|
|
85
|
+
* Timestamp of when the record was deleted
|
|
86
|
+
*/
|
|
87
|
+
archivedAt: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
90
|
+
* ["orgId"]). Empty array means no attribution.
|
|
91
|
+
*/
|
|
92
|
+
attributionKeys: Array<string>;
|
|
93
|
+
/**
|
|
94
|
+
* Timestamp of when the record was created
|
|
95
|
+
*/
|
|
96
|
+
createdAt: string;
|
|
97
|
+
/**
|
|
98
|
+
* What this entity type represents and what it is for governing, or null when none
|
|
99
|
+
* is set
|
|
100
|
+
*/
|
|
101
|
+
description: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* The display name for the entity type
|
|
104
|
+
*/
|
|
105
|
+
displayName: string;
|
|
106
|
+
/**
|
|
107
|
+
* Timestamp of when the record was last updated
|
|
108
|
+
*/
|
|
109
|
+
updatedAt: string;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Wrapped response echoing the entity type ids that were acted on by an archive
|
|
113
|
+
* call
|
|
114
|
+
*/
|
|
115
|
+
export interface EntityTypeArchiveResponse {
|
|
116
|
+
/**
|
|
117
|
+
* List of entity type identifiers that were acted on
|
|
118
|
+
*/
|
|
119
|
+
data: EntityTypeArchiveResponse.Data;
|
|
120
|
+
}
|
|
121
|
+
export declare namespace EntityTypeArchiveResponse {
|
|
122
|
+
/**
|
|
123
|
+
* List of entity type identifiers that were acted on
|
|
124
|
+
*/
|
|
125
|
+
interface Data {
|
|
126
|
+
/**
|
|
127
|
+
* Entity type identifiers to act on
|
|
128
|
+
*/
|
|
129
|
+
ids: Array<string>;
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Wrapped response with whether an entity type has active entities
|
|
134
|
+
*/
|
|
135
|
+
export interface EntityTypeCheckActiveEntitiesResponse {
|
|
136
|
+
/**
|
|
137
|
+
* Whether an entity type has active entities
|
|
138
|
+
*/
|
|
139
|
+
data: EntityTypeCheckActiveEntitiesResponse.Data;
|
|
140
|
+
}
|
|
141
|
+
export declare namespace EntityTypeCheckActiveEntitiesResponse {
|
|
142
|
+
/**
|
|
143
|
+
* Whether an entity type has active entities
|
|
144
|
+
*/
|
|
145
|
+
interface Data {
|
|
146
|
+
/**
|
|
147
|
+
* Whether at least one active (non-archived) entity of the entity type exists,
|
|
148
|
+
* across every customer
|
|
149
|
+
*/
|
|
150
|
+
hasActiveEntities: boolean;
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Entity types after upsert.
|
|
155
|
+
*/
|
|
156
|
+
export interface EntityTypeUpsertResponse {
|
|
157
|
+
data: Array<EntityTypeUpsertResponse.Data>;
|
|
158
|
+
}
|
|
159
|
+
export declare namespace EntityTypeUpsertResponse {
|
|
160
|
+
/**
|
|
161
|
+
* A vendor-defined category of resource that can be governed (e.g. Org, Team,
|
|
162
|
+
* User). Vendors define entity types once per environment; their customers create
|
|
163
|
+
* instances (entities) of these types and the governance engine tracks usage and
|
|
164
|
+
* enforces limits per instance.
|
|
165
|
+
*/
|
|
166
|
+
interface Data {
|
|
167
|
+
/**
|
|
168
|
+
* The unique identifier for the entity
|
|
169
|
+
*/
|
|
170
|
+
id: string;
|
|
171
|
+
/**
|
|
172
|
+
* Timestamp of when the record was deleted
|
|
173
|
+
*/
|
|
174
|
+
archivedAt: string | null;
|
|
175
|
+
/**
|
|
176
|
+
* Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
177
|
+
* ["orgId"]). Empty array means no attribution.
|
|
178
|
+
*/
|
|
179
|
+
attributionKeys: Array<string>;
|
|
180
|
+
/**
|
|
181
|
+
* Timestamp of when the record was created
|
|
182
|
+
*/
|
|
183
|
+
createdAt: string;
|
|
184
|
+
/**
|
|
185
|
+
* What this entity type represents and what it is for governing, or null when none
|
|
186
|
+
* is set
|
|
187
|
+
*/
|
|
188
|
+
description: string | null;
|
|
189
|
+
/**
|
|
190
|
+
* The display name for the entity type
|
|
191
|
+
*/
|
|
192
|
+
displayName: string;
|
|
193
|
+
/**
|
|
194
|
+
* Timestamp of when the record was last updated
|
|
195
|
+
*/
|
|
196
|
+
updatedAt: string;
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
export interface EntityTypeListParams extends MyCursorIDPageParams {
|
|
200
|
+
/**
|
|
201
|
+
* Query param: Whether to include archived entity types. One of: true, false
|
|
202
|
+
*/
|
|
203
|
+
includeArchived?: 'true' | 'false';
|
|
204
|
+
/**
|
|
205
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
206
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
207
|
+
*/
|
|
208
|
+
'X-ACCOUNT-ID'?: string;
|
|
209
|
+
/**
|
|
210
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
211
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
212
|
+
* intrinsic to the key).
|
|
213
|
+
*/
|
|
214
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
215
|
+
}
|
|
216
|
+
export interface EntityTypeArchiveParams {
|
|
217
|
+
/**
|
|
218
|
+
* Body param: Entity type identifiers to act on
|
|
219
|
+
*/
|
|
220
|
+
ids: Array<string>;
|
|
221
|
+
/**
|
|
222
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
223
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
224
|
+
*/
|
|
225
|
+
'X-ACCOUNT-ID'?: string;
|
|
226
|
+
/**
|
|
227
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
228
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
229
|
+
* intrinsic to the key).
|
|
230
|
+
*/
|
|
231
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
232
|
+
}
|
|
233
|
+
export interface EntityTypeCheckActiveEntitiesParams {
|
|
234
|
+
/**
|
|
235
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
236
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
237
|
+
*/
|
|
238
|
+
'X-ACCOUNT-ID'?: string;
|
|
239
|
+
/**
|
|
240
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
241
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
242
|
+
* key).
|
|
243
|
+
*/
|
|
244
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
245
|
+
}
|
|
246
|
+
export interface EntityTypeUpsertParams {
|
|
247
|
+
/**
|
|
248
|
+
* Body param: Entity types to upsert (1–100 per request)
|
|
249
|
+
*/
|
|
250
|
+
types: Array<EntityTypeUpsertParams.Type>;
|
|
251
|
+
/**
|
|
252
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
253
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
254
|
+
*/
|
|
255
|
+
'X-ACCOUNT-ID'?: string;
|
|
256
|
+
/**
|
|
257
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
258
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
259
|
+
* intrinsic to the key).
|
|
260
|
+
*/
|
|
261
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
262
|
+
}
|
|
263
|
+
export declare namespace EntityTypeUpsertParams {
|
|
264
|
+
/**
|
|
265
|
+
* A single entity type definition.
|
|
266
|
+
*/
|
|
267
|
+
interface Type {
|
|
268
|
+
/**
|
|
269
|
+
* The unique identifier for the entity
|
|
270
|
+
*/
|
|
271
|
+
id: string;
|
|
272
|
+
/**
|
|
273
|
+
* Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
274
|
+
* ["orgId"]). Empty array means no attribution.
|
|
275
|
+
*/
|
|
276
|
+
attributionKeys: Array<string>;
|
|
277
|
+
/**
|
|
278
|
+
* The display name for the entity type
|
|
279
|
+
*/
|
|
280
|
+
displayName: string;
|
|
281
|
+
/**
|
|
282
|
+
* What this entity type represents and what it is for governing. Omit to preserve
|
|
283
|
+
* the stored value, or send an empty string or null to clear it.
|
|
284
|
+
*/
|
|
285
|
+
description?: string | null;
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
export declare namespace EntityTypes {
|
|
289
|
+
export { type EntityTypeListResponse as EntityTypeListResponse, type EntityTypeArchiveResponse as EntityTypeArchiveResponse, type EntityTypeCheckActiveEntitiesResponse as EntityTypeCheckActiveEntitiesResponse, type EntityTypeUpsertResponse as EntityTypeUpsertResponse, type EntityTypeListResponsesMyCursorIDPage as EntityTypeListResponsesMyCursorIDPage, type EntityTypeListParams as EntityTypeListParams, type EntityTypeArchiveParams as EntityTypeArchiveParams, type EntityTypeCheckActiveEntitiesParams as EntityTypeCheckActiveEntitiesParams, type EntityTypeUpsertParams as EntityTypeUpsertParams, };
|
|
290
|
+
}
|
|
291
|
+
//# sourceMappingURL=entity-types.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entity-types.d.mts","sourceRoot":"","sources":["../../src/resources/v1/entity-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,kCAA8B;AAE/F,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAe7E;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAezG;;;;;;;;;;OAUG;IACH,mBAAmB,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAcpD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAcvG;AAED,MAAM,MAAM,qCAAqC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,IAAI,EAAE,qCAAqC,CAAC,IAAI,CAAC;CAClD;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,iBAAiB,EAAE,OAAO,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;OAKG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAE1C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|