@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
|
@@ -4,79 +4,42 @@ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../..
|
|
|
4
4
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
5
5
|
export declare class Entities extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves a single entity for the given customer by its identifier.
|
|
7
|
+
* Retrieves a single entity for the given customer by its identifier. Deprecated:
|
|
8
|
+
* use `GET /api/v1/customers/{id}/entities/{entityId}`.
|
|
8
9
|
*
|
|
9
|
-
* @
|
|
10
|
-
* ```ts
|
|
11
|
-
* const entity =
|
|
12
|
-
* await client.v1Beta.customers.entities.retrieve('x', {
|
|
13
|
-
* id: 'id',
|
|
14
|
-
* });
|
|
15
|
-
* ```
|
|
10
|
+
* @deprecated Use `v1.customers.entities.retrieve` instead.
|
|
16
11
|
*/
|
|
17
12
|
retrieve(entityID: string, params: EntityRetrieveParams, options?: RequestOptions): APIPromise<EntityRetrieveResponse>;
|
|
18
13
|
/**
|
|
19
|
-
* Retrieves a paginated list of entities for the given customer.
|
|
14
|
+
* Retrieves a paginated list of entities for the given customer. Deprecated: use
|
|
15
|
+
* `GET /api/v1/customers/{id}/entities`.
|
|
20
16
|
*
|
|
21
|
-
* @
|
|
22
|
-
* ```ts
|
|
23
|
-
* // Automatically fetches more pages as needed.
|
|
24
|
-
* for await (const entityListResponse of client.v1Beta.customers.entities.list(
|
|
25
|
-
* 'id',
|
|
26
|
-
* )) {
|
|
27
|
-
* // ...
|
|
28
|
-
* }
|
|
29
|
-
* ```
|
|
17
|
+
* @deprecated Use `v1.customers.entities.list` instead.
|
|
30
18
|
*/
|
|
31
19
|
list(id: string, params?: EntityListParams | null | undefined, options?: RequestOptions): PagePromise<EntityListResponsesMyCursorIDPage, EntityListResponse>;
|
|
32
20
|
/**
|
|
33
|
-
* Archives entities in bulk for the given customer by id.
|
|
21
|
+
* Archives entities in bulk for the given customer by id. Upsert an archived
|
|
22
|
+
* entity to restore it. Deprecated: use
|
|
23
|
+
* `POST /api/v1/customers/{id}/entities/archive`.
|
|
34
24
|
*
|
|
35
|
-
* @
|
|
36
|
-
* ```ts
|
|
37
|
-
* const response =
|
|
38
|
-
* await client.v1Beta.customers.entities.archive('id', {
|
|
39
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
40
|
-
* });
|
|
41
|
-
* ```
|
|
25
|
+
* @deprecated Use `v1.customers.entities.archive` instead.
|
|
42
26
|
*/
|
|
43
27
|
archive(id: string, params: EntityArchiveParams, options?: RequestOptions): APIPromise<EntityArchiveResponse>;
|
|
44
28
|
/**
|
|
45
|
-
*
|
|
29
|
+
* Deprecated: use `PUT /api/v1/customers/{id}/entities` with the entity id to
|
|
30
|
+
* restore it. Restores previously archived entities in bulk for the given customer
|
|
31
|
+
* by id.
|
|
46
32
|
*
|
|
47
|
-
* @
|
|
48
|
-
* ```ts
|
|
49
|
-
* const response =
|
|
50
|
-
* await client.v1Beta.customers.entities.unarchive('id', {
|
|
51
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
52
|
-
* });
|
|
53
|
-
* ```
|
|
33
|
+
* @deprecated Use `v1.customers.entities.upsert` with the entity id to restore an archived entity.
|
|
54
34
|
*/
|
|
55
35
|
unarchive(id: string, params: EntityUnarchiveParams, options?: RequestOptions): APIPromise<EntityUnarchiveResponse>;
|
|
56
36
|
/**
|
|
57
37
|
* Creates or updates entities in bulk for the given customer. Existing entities
|
|
58
|
-
* matched by id are updated; new ids are created.
|
|
38
|
+
* matched by id are updated; new ids are created. An upsert of an archived entity
|
|
39
|
+
* restores it. An entity on an archived entity type fails with 400. Deprecated:
|
|
40
|
+
* use `PUT /api/v1/customers/{id}/entities`.
|
|
59
41
|
*
|
|
60
|
-
* @
|
|
61
|
-
* ```ts
|
|
62
|
-
* const response =
|
|
63
|
-
* await client.v1Beta.customers.entities.upsert('id', {
|
|
64
|
-
* entities: [
|
|
65
|
-
* {
|
|
66
|
-
* id: 'user-7f3a0c1d',
|
|
67
|
-
* displayName: 'Jane Doe',
|
|
68
|
-
* entityTypeId: 'user',
|
|
69
|
-
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
70
|
-
* },
|
|
71
|
-
* {
|
|
72
|
-
* id: 'user-c4d1b2e9',
|
|
73
|
-
* displayName: 'John Roe',
|
|
74
|
-
* entityTypeId: 'user',
|
|
75
|
-
* metadata: { email: 'john@acme.com' },
|
|
76
|
-
* },
|
|
77
|
-
* ],
|
|
78
|
-
* });
|
|
79
|
-
* ```
|
|
42
|
+
* @deprecated Use `v1.customers.entities.upsert` instead.
|
|
80
43
|
*/
|
|
81
44
|
upsert(id: string, params: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse>;
|
|
82
45
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.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,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.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,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;OAKG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;OAKG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;OAMG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;OAMG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;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,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;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,mBAAmB;IAClC;;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,qBAAqB;IACpC;;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,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -8,15 +8,10 @@ const headers_1 = require("../../../internal/headers.js");
|
|
|
8
8
|
const path_1 = require("../../../internal/utils/path.js");
|
|
9
9
|
class Entities extends resource_1.APIResource {
|
|
10
10
|
/**
|
|
11
|
-
* Retrieves a single entity for the given customer by its identifier.
|
|
11
|
+
* Retrieves a single entity for the given customer by its identifier. Deprecated:
|
|
12
|
+
* use `GET /api/v1/customers/{id}/entities/{entityId}`.
|
|
12
13
|
*
|
|
13
|
-
* @
|
|
14
|
-
* ```ts
|
|
15
|
-
* const entity =
|
|
16
|
-
* await client.v1Beta.customers.entities.retrieve('x', {
|
|
17
|
-
* id: 'id',
|
|
18
|
-
* });
|
|
19
|
-
* ```
|
|
14
|
+
* @deprecated Use `v1.customers.entities.retrieve` instead.
|
|
20
15
|
*/
|
|
21
16
|
retrieve(entityID, params, options) {
|
|
22
17
|
const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
|
|
@@ -32,17 +27,10 @@ class Entities extends resource_1.APIResource {
|
|
|
32
27
|
});
|
|
33
28
|
}
|
|
34
29
|
/**
|
|
35
|
-
* Retrieves a paginated list of entities for the given customer.
|
|
30
|
+
* Retrieves a paginated list of entities for the given customer. Deprecated: use
|
|
31
|
+
* `GET /api/v1/customers/{id}/entities`.
|
|
36
32
|
*
|
|
37
|
-
* @
|
|
38
|
-
* ```ts
|
|
39
|
-
* // Automatically fetches more pages as needed.
|
|
40
|
-
* for await (const entityListResponse of client.v1Beta.customers.entities.list(
|
|
41
|
-
* 'id',
|
|
42
|
-
* )) {
|
|
43
|
-
* // ...
|
|
44
|
-
* }
|
|
45
|
-
* ```
|
|
33
|
+
* @deprecated Use `v1.customers.entities.list` instead.
|
|
46
34
|
*/
|
|
47
35
|
list(id, params = {}, options) {
|
|
48
36
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -59,15 +47,11 @@ class Entities extends resource_1.APIResource {
|
|
|
59
47
|
});
|
|
60
48
|
}
|
|
61
49
|
/**
|
|
62
|
-
* Archives entities in bulk for the given customer by id.
|
|
50
|
+
* Archives entities in bulk for the given customer by id. Upsert an archived
|
|
51
|
+
* entity to restore it. Deprecated: use
|
|
52
|
+
* `POST /api/v1/customers/{id}/entities/archive`.
|
|
63
53
|
*
|
|
64
|
-
* @
|
|
65
|
-
* ```ts
|
|
66
|
-
* const response =
|
|
67
|
-
* await client.v1Beta.customers.entities.archive('id', {
|
|
68
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
69
|
-
* });
|
|
70
|
-
* ```
|
|
54
|
+
* @deprecated Use `v1.customers.entities.archive` instead.
|
|
71
55
|
*/
|
|
72
56
|
archive(id, params, options) {
|
|
73
57
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -84,15 +68,11 @@ class Entities extends resource_1.APIResource {
|
|
|
84
68
|
});
|
|
85
69
|
}
|
|
86
70
|
/**
|
|
87
|
-
*
|
|
71
|
+
* Deprecated: use `PUT /api/v1/customers/{id}/entities` with the entity id to
|
|
72
|
+
* restore it. Restores previously archived entities in bulk for the given customer
|
|
73
|
+
* by id.
|
|
88
74
|
*
|
|
89
|
-
* @
|
|
90
|
-
* ```ts
|
|
91
|
-
* const response =
|
|
92
|
-
* await client.v1Beta.customers.entities.unarchive('id', {
|
|
93
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
94
|
-
* });
|
|
95
|
-
* ```
|
|
75
|
+
* @deprecated Use `v1.customers.entities.upsert` with the entity id to restore an archived entity.
|
|
96
76
|
*/
|
|
97
77
|
unarchive(id, params, options) {
|
|
98
78
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -110,28 +90,11 @@ class Entities extends resource_1.APIResource {
|
|
|
110
90
|
}
|
|
111
91
|
/**
|
|
112
92
|
* Creates or updates entities in bulk for the given customer. Existing entities
|
|
113
|
-
* matched by id are updated; new ids are created.
|
|
93
|
+
* matched by id are updated; new ids are created. An upsert of an archived entity
|
|
94
|
+
* restores it. An entity on an archived entity type fails with 400. Deprecated:
|
|
95
|
+
* use `PUT /api/v1/customers/{id}/entities`.
|
|
114
96
|
*
|
|
115
|
-
* @
|
|
116
|
-
* ```ts
|
|
117
|
-
* const response =
|
|
118
|
-
* await client.v1Beta.customers.entities.upsert('id', {
|
|
119
|
-
* entities: [
|
|
120
|
-
* {
|
|
121
|
-
* id: 'user-7f3a0c1d',
|
|
122
|
-
* displayName: 'Jane Doe',
|
|
123
|
-
* entityTypeId: 'user',
|
|
124
|
-
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
125
|
-
* },
|
|
126
|
-
* {
|
|
127
|
-
* id: 'user-c4d1b2e9',
|
|
128
|
-
* displayName: 'John Roe',
|
|
129
|
-
* entityTypeId: 'user',
|
|
130
|
-
* metadata: { email: 'john@acme.com' },
|
|
131
|
-
* },
|
|
132
|
-
* ],
|
|
133
|
-
* });
|
|
134
|
-
* ```
|
|
97
|
+
* @deprecated Use `v1.customers.entities.upsert` instead.
|
|
135
98
|
*/
|
|
136
99
|
upsert(id, params, options) {
|
|
137
100
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAClG,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;OAKG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,aAAa,QAAQ,EAAE,EAAE;YAC/E,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;;;;;OAKG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,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,0BAA0B,EAAE,WAAW,EAC3C,CAAA,2BAAkC,CAAA,EAClC;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;;;;;;OAMG;IACH,OAAO,CACL,EAAU,EACV,MAA2B,EAC3B,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,0BAA0B,EAAE,mBAAmB,EAAE;YAC5E,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;;;;;;OAMG;IACH,SAAS,CACP,EAAU,EACV,MAA6B,EAC7B,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,0BAA0B,EAAE,qBAAqB,EAAE;YAC9E,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;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,WAAW,EAAE;YACnE,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;CACF;AAhID,4BAgIC"}
|
|
@@ -5,15 +5,10 @@ import { buildHeaders } from "../../../internal/headers.mjs";
|
|
|
5
5
|
import { path } from "../../../internal/utils/path.mjs";
|
|
6
6
|
export class Entities extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves a single entity for the given customer by its identifier.
|
|
8
|
+
* Retrieves a single entity for the given customer by its identifier. Deprecated:
|
|
9
|
+
* use `GET /api/v1/customers/{id}/entities/{entityId}`.
|
|
9
10
|
*
|
|
10
|
-
* @
|
|
11
|
-
* ```ts
|
|
12
|
-
* const entity =
|
|
13
|
-
* await client.v1Beta.customers.entities.retrieve('x', {
|
|
14
|
-
* id: 'id',
|
|
15
|
-
* });
|
|
16
|
-
* ```
|
|
11
|
+
* @deprecated Use `v1.customers.entities.retrieve` instead.
|
|
17
12
|
*/
|
|
18
13
|
retrieve(entityID, params, options) {
|
|
19
14
|
const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
|
|
@@ -29,17 +24,10 @@ export class Entities extends APIResource {
|
|
|
29
24
|
});
|
|
30
25
|
}
|
|
31
26
|
/**
|
|
32
|
-
* Retrieves a paginated list of entities for the given customer.
|
|
27
|
+
* Retrieves a paginated list of entities for the given customer. Deprecated: use
|
|
28
|
+
* `GET /api/v1/customers/{id}/entities`.
|
|
33
29
|
*
|
|
34
|
-
* @
|
|
35
|
-
* ```ts
|
|
36
|
-
* // Automatically fetches more pages as needed.
|
|
37
|
-
* for await (const entityListResponse of client.v1Beta.customers.entities.list(
|
|
38
|
-
* 'id',
|
|
39
|
-
* )) {
|
|
40
|
-
* // ...
|
|
41
|
-
* }
|
|
42
|
-
* ```
|
|
30
|
+
* @deprecated Use `v1.customers.entities.list` instead.
|
|
43
31
|
*/
|
|
44
32
|
list(id, params = {}, options) {
|
|
45
33
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -56,15 +44,11 @@ export class Entities extends APIResource {
|
|
|
56
44
|
});
|
|
57
45
|
}
|
|
58
46
|
/**
|
|
59
|
-
* Archives entities in bulk for the given customer by id.
|
|
47
|
+
* Archives entities in bulk for the given customer by id. Upsert an archived
|
|
48
|
+
* entity to restore it. Deprecated: use
|
|
49
|
+
* `POST /api/v1/customers/{id}/entities/archive`.
|
|
60
50
|
*
|
|
61
|
-
* @
|
|
62
|
-
* ```ts
|
|
63
|
-
* const response =
|
|
64
|
-
* await client.v1Beta.customers.entities.archive('id', {
|
|
65
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
66
|
-
* });
|
|
67
|
-
* ```
|
|
51
|
+
* @deprecated Use `v1.customers.entities.archive` instead.
|
|
68
52
|
*/
|
|
69
53
|
archive(id, params, options) {
|
|
70
54
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -81,15 +65,11 @@ export class Entities extends APIResource {
|
|
|
81
65
|
});
|
|
82
66
|
}
|
|
83
67
|
/**
|
|
84
|
-
*
|
|
68
|
+
* Deprecated: use `PUT /api/v1/customers/{id}/entities` with the entity id to
|
|
69
|
+
* restore it. Restores previously archived entities in bulk for the given customer
|
|
70
|
+
* by id.
|
|
85
71
|
*
|
|
86
|
-
* @
|
|
87
|
-
* ```ts
|
|
88
|
-
* const response =
|
|
89
|
-
* await client.v1Beta.customers.entities.unarchive('id', {
|
|
90
|
-
* ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
|
|
91
|
-
* });
|
|
92
|
-
* ```
|
|
72
|
+
* @deprecated Use `v1.customers.entities.upsert` with the entity id to restore an archived entity.
|
|
93
73
|
*/
|
|
94
74
|
unarchive(id, params, options) {
|
|
95
75
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -107,28 +87,11 @@ export class Entities extends APIResource {
|
|
|
107
87
|
}
|
|
108
88
|
/**
|
|
109
89
|
* Creates or updates entities in bulk for the given customer. Existing entities
|
|
110
|
-
* matched by id are updated; new ids are created.
|
|
90
|
+
* matched by id are updated; new ids are created. An upsert of an archived entity
|
|
91
|
+
* restores it. An entity on an archived entity type fails with 400. Deprecated:
|
|
92
|
+
* use `PUT /api/v1/customers/{id}/entities`.
|
|
111
93
|
*
|
|
112
|
-
* @
|
|
113
|
-
* ```ts
|
|
114
|
-
* const response =
|
|
115
|
-
* await client.v1Beta.customers.entities.upsert('id', {
|
|
116
|
-
* entities: [
|
|
117
|
-
* {
|
|
118
|
-
* id: 'user-7f3a0c1d',
|
|
119
|
-
* displayName: 'Jane Doe',
|
|
120
|
-
* entityTypeId: 'user',
|
|
121
|
-
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
122
|
-
* },
|
|
123
|
-
* {
|
|
124
|
-
* id: 'user-c4d1b2e9',
|
|
125
|
-
* displayName: 'John Roe',
|
|
126
|
-
* entityTypeId: 'user',
|
|
127
|
-
* metadata: { email: 'john@acme.com' },
|
|
128
|
-
* },
|
|
129
|
-
* ],
|
|
130
|
-
* });
|
|
131
|
-
* ```
|
|
94
|
+
* @deprecated Use `v1.customers.entities.upsert` instead.
|
|
132
95
|
*/
|
|
133
96
|
upsert(id, params, options) {
|
|
134
97
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.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,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.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,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;OAKG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,aAAa,QAAQ,EAAE,EAAE;YAC/E,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;;;;;OAKG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,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,0BAA0B,EAAE,WAAW,EAC3C,CAAA,cAAkC,CAAA,EAClC;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;;;;;;OAMG;IACH,OAAO,CACL,EAAU,EACV,MAA2B,EAC3B,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,0BAA0B,EAAE,mBAAmB,EAAE;YAC5E,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;;;;;;OAMG;IACH,SAAS,CACP,EAAU,EACV,MAA6B,EAC7B,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,0BAA0B,EAAE,qBAAqB,EAAE;YAC9E,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;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,WAAW,EAAE;YACnE,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;CACF"}
|
|
@@ -6,12 +6,9 @@ export declare class Entitlements extends APIResource {
|
|
|
6
6
|
* Experimental — request and response shapes may change without notice. Same
|
|
7
7
|
* semantics as `Check entitlement`, plus an optional `dimensions` query param that
|
|
8
8
|
* resolves to per-entity governance limits surfaced as `chains` on the response.
|
|
9
|
+
* Deprecated: use `GET /api/v1/customers/{id}/entitlements/check`.
|
|
9
10
|
*
|
|
10
|
-
* @
|
|
11
|
-
* ```ts
|
|
12
|
-
* const response =
|
|
13
|
-
* await client.v1Beta.customers.entitlements.check('x');
|
|
14
|
-
* ```
|
|
11
|
+
* @deprecated Use `v1.customers.check_entitlement` instead.
|
|
15
12
|
*/
|
|
16
13
|
check(id: string, params?: EntitlementCheckParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementCheckResponse>;
|
|
17
14
|
}
|
|
@@ -91,7 +88,7 @@ export declare namespace EntitlementCheckResponse {
|
|
|
91
88
|
*/
|
|
92
89
|
scopeEntityIds: Array<string>;
|
|
93
90
|
/**
|
|
94
|
-
* Hard usage limit for this node; null when no
|
|
91
|
+
* Hard usage limit for this node; null when the entity has no entity entitlement.
|
|
95
92
|
*/
|
|
96
93
|
usageLimit: number | null;
|
|
97
94
|
}
|
|
@@ -221,7 +218,7 @@ export declare namespace EntitlementCheckResponse {
|
|
|
221
218
|
*/
|
|
222
219
|
scopeEntityIds: Array<string>;
|
|
223
220
|
/**
|
|
224
|
-
* Hard usage limit for this node; null when no
|
|
221
|
+
* Hard usage limit for this node; null when the entity has no entity entitlement.
|
|
225
222
|
*/
|
|
226
223
|
usageLimit: number | null;
|
|
227
224
|
}
|
|
@@ -257,9 +254,9 @@ export interface EntitlementCheckParams {
|
|
|
257
254
|
*/
|
|
258
255
|
currencyId?: string;
|
|
259
256
|
/**
|
|
260
|
-
* Query param:
|
|
261
|
-
* provided,
|
|
262
|
-
*
|
|
257
|
+
* Query param: Attribution map of the entities the usage is attributed to (e.g.
|
|
258
|
+
* `dimensions[userId]=u1`). When provided, their governance budgets are checked
|
|
259
|
+
* too and the response includes `chains`.
|
|
263
260
|
*/
|
|
264
261
|
dimensions?: {
|
|
265
262
|
[key: string]: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAcxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC;CAC1E;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,SAAS,CAAC;QAEhB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAErC,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAEhE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;;;eAIG;YACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE9B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,aAAa,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;YAE9C;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SAC5C;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC;QAErB,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,QAAQ,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;QAExC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;;;eAIG;YACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE9B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -6,12 +6,9 @@ export declare class Entitlements extends APIResource {
|
|
|
6
6
|
* Experimental — request and response shapes may change without notice. Same
|
|
7
7
|
* semantics as `Check entitlement`, plus an optional `dimensions` query param that
|
|
8
8
|
* resolves to per-entity governance limits surfaced as `chains` on the response.
|
|
9
|
+
* Deprecated: use `GET /api/v1/customers/{id}/entitlements/check`.
|
|
9
10
|
*
|
|
10
|
-
* @
|
|
11
|
-
* ```ts
|
|
12
|
-
* const response =
|
|
13
|
-
* await client.v1Beta.customers.entitlements.check('x');
|
|
14
|
-
* ```
|
|
11
|
+
* @deprecated Use `v1.customers.check_entitlement` instead.
|
|
15
12
|
*/
|
|
16
13
|
check(id: string, params?: EntitlementCheckParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementCheckResponse>;
|
|
17
14
|
}
|
|
@@ -91,7 +88,7 @@ export declare namespace EntitlementCheckResponse {
|
|
|
91
88
|
*/
|
|
92
89
|
scopeEntityIds: Array<string>;
|
|
93
90
|
/**
|
|
94
|
-
* Hard usage limit for this node; null when no
|
|
91
|
+
* Hard usage limit for this node; null when the entity has no entity entitlement.
|
|
95
92
|
*/
|
|
96
93
|
usageLimit: number | null;
|
|
97
94
|
}
|
|
@@ -221,7 +218,7 @@ export declare namespace EntitlementCheckResponse {
|
|
|
221
218
|
*/
|
|
222
219
|
scopeEntityIds: Array<string>;
|
|
223
220
|
/**
|
|
224
|
-
* Hard usage limit for this node; null when no
|
|
221
|
+
* Hard usage limit for this node; null when the entity has no entity entitlement.
|
|
225
222
|
*/
|
|
226
223
|
usageLimit: number | null;
|
|
227
224
|
}
|
|
@@ -257,9 +254,9 @@ export interface EntitlementCheckParams {
|
|
|
257
254
|
*/
|
|
258
255
|
currencyId?: string;
|
|
259
256
|
/**
|
|
260
|
-
* Query param:
|
|
261
|
-
* provided,
|
|
262
|
-
*
|
|
257
|
+
* Query param: Attribution map of the entities the usage is attributed to (e.g.
|
|
258
|
+
* `dimensions[userId]=u1`). When provided, their governance budgets are checked
|
|
259
|
+
* too and the response includes `chains`.
|
|
263
260
|
*/
|
|
264
261
|
dimensions?: {
|
|
265
262
|
[key: string]: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAcxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC;CAC1E;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,SAAS,CAAC;QAEhB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAErC,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAEhE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;;;eAIG;YACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE9B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,aAAa,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;YAE9C;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SAC5C;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC;QAErB,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,QAAQ,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;QAExC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;;;eAIG;YACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE9B;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;SAC3C;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -10,12 +10,9 @@ class Entitlements extends resource_1.APIResource {
|
|
|
10
10
|
* Experimental — request and response shapes may change without notice. Same
|
|
11
11
|
* semantics as `Check entitlement`, plus an optional `dimensions` query param that
|
|
12
12
|
* resolves to per-entity governance limits surfaced as `chains` on the response.
|
|
13
|
+
* Deprecated: use `GET /api/v1/customers/{id}/entitlements/check`.
|
|
13
14
|
*
|
|
14
|
-
* @
|
|
15
|
-
* ```ts
|
|
16
|
-
* const response =
|
|
17
|
-
* await client.v1Beta.customers.entitlements.check('x');
|
|
18
|
-
* ```
|
|
15
|
+
* @deprecated Use `v1.customers.check_entitlement` instead.
|
|
19
16
|
*/
|
|
20
17
|
check(id, params = {}, options) {
|
|
21
18
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;OAOG;IACH,KAAK,CACH,EAAU,EACV,SAAoD,EAAE,EACtD,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,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,qBAAqB,EAAE;YAC7E,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,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,oCA2BC"}
|
|
@@ -7,12 +7,9 @@ export class Entitlements extends APIResource {
|
|
|
7
7
|
* Experimental — request and response shapes may change without notice. Same
|
|
8
8
|
* semantics as `Check entitlement`, plus an optional `dimensions` query param that
|
|
9
9
|
* resolves to per-entity governance limits surfaced as `chains` on the response.
|
|
10
|
+
* Deprecated: use `GET /api/v1/customers/{id}/entitlements/check`.
|
|
10
11
|
*
|
|
11
|
-
* @
|
|
12
|
-
* ```ts
|
|
13
|
-
* const response =
|
|
14
|
-
* await client.v1Beta.customers.entitlements.check('x');
|
|
15
|
-
* ```
|
|
12
|
+
* @deprecated Use `v1.customers.check_entitlement` instead.
|
|
16
13
|
*/
|
|
17
14
|
check(id, params = {}, options) {
|
|
18
15
|
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C
|
|
1
|
+
{"version":3,"file":"entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,KAAK,CACH,EAAU,EACV,SAAoD,EAAE,EACtD,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,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,qBAAqB,EAAE;YAC7E,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,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -6,41 +6,19 @@ export declare class EntityTypes extends APIResource {
|
|
|
6
6
|
/**
|
|
7
7
|
* Returns a cursor-paginated list of entity types defined in the environment.
|
|
8
8
|
* Entity types are vendor-defined categories of resource that can be governed
|
|
9
|
-
* (e.g. Org, Team, User).
|
|
9
|
+
* (e.g. Org, Team, User). Archived entity types are excluded unless
|
|
10
|
+
* includeArchived=true. Deprecated: use `GET /api/v1/entity-types`.
|
|
10
11
|
*
|
|
11
|
-
* @
|
|
12
|
-
* ```ts
|
|
13
|
-
* // Automatically fetches more pages as needed.
|
|
14
|
-
* for await (const entityTypeListResponse of client.v1Beta.entityTypes.list()) {
|
|
15
|
-
* // ...
|
|
16
|
-
* }
|
|
17
|
-
* ```
|
|
12
|
+
* @deprecated Use `v1.entity_types.list` instead.
|
|
18
13
|
*/
|
|
19
14
|
list(params?: EntityTypeListParams | null | undefined, options?: RequestOptions): PagePromise<EntityTypeListResponsesMyCursorIDPage, EntityTypeListResponse>;
|
|
20
15
|
/**
|
|
21
16
|
* Batched create-or-update of entity types. Existing types matched by id are
|
|
22
17
|
* updated; new ids are created. Idempotent — re-submitting the same payload
|
|
23
|
-
* converges to the same state.
|
|
18
|
+
* converges to the same state. An upsert of an archived entity type restores it.
|
|
19
|
+
* Deprecated: use `PUT /api/v1/entity-types`.
|
|
24
20
|
*
|
|
25
|
-
* @
|
|
26
|
-
* ```ts
|
|
27
|
-
* const response = await client.v1Beta.entityTypes.upsert({
|
|
28
|
-
* types: [
|
|
29
|
-
* {
|
|
30
|
-
* id: 'org',
|
|
31
|
-
* displayName: 'Organization',
|
|
32
|
-
* description:
|
|
33
|
-
* 'A customer organization — the top of the hierarchy, holding the account-wide budget.',
|
|
34
|
-
* attributionKeys: ['organizationId'],
|
|
35
|
-
* },
|
|
36
|
-
* {
|
|
37
|
-
* id: 'team',
|
|
38
|
-
* displayName: 'Team',
|
|
39
|
-
* attributionKeys: ['teamId'],
|
|
40
|
-
* },
|
|
41
|
-
* ],
|
|
42
|
-
* });
|
|
43
|
-
* ```
|
|
21
|
+
* @deprecated Use `v1.entity_types.upsert` instead.
|
|
44
22
|
*/
|
|
45
23
|
upsert(params: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse>;
|
|
46
24
|
}
|
|
@@ -56,6 +34,10 @@ export interface EntityTypeListResponse {
|
|
|
56
34
|
* The unique identifier for the entity
|
|
57
35
|
*/
|
|
58
36
|
id: string;
|
|
37
|
+
/**
|
|
38
|
+
* Timestamp of when the record was deleted
|
|
39
|
+
*/
|
|
40
|
+
archivedAt: string | null;
|
|
59
41
|
/**
|
|
60
42
|
* Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
61
43
|
* ["orgId"]). Empty array means no attribution.
|
|
@@ -97,6 +79,10 @@ export declare namespace EntityTypeUpsertResponse {
|
|
|
97
79
|
* The unique identifier for the entity
|
|
98
80
|
*/
|
|
99
81
|
id: string;
|
|
82
|
+
/**
|
|
83
|
+
* Timestamp of when the record was deleted
|
|
84
|
+
*/
|
|
85
|
+
archivedAt: string | null;
|
|
100
86
|
/**
|
|
101
87
|
* Dimension keys used to attribute usage events to instances of this type (e.g.
|
|
102
88
|
* ["orgId"]). Empty array means no attribution.
|
|
@@ -122,6 +108,10 @@ export declare namespace EntityTypeUpsertResponse {
|
|
|
122
108
|
}
|
|
123
109
|
}
|
|
124
110
|
export interface EntityTypeListParams extends MyCursorIDPageParams {
|
|
111
|
+
/**
|
|
112
|
+
* Query param: Whether to include archived entity types. One of: true, false
|
|
113
|
+
*/
|
|
114
|
+
includeArchived?: 'true' | 'false';
|
|
125
115
|
/**
|
|
126
116
|
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
127
117
|
* token); falls back to the user's first membership. Ignored for API-key auth.
|