@stigg/typescript 0.1.0-beta.64 → 0.1.0-beta.66

package/src/resources/v1-beta/customers/entities.ts

@@ -9,15 +9,10 @@ import { path } from '../../../internal/utils/path';
 
 export class Entities extends APIResource {
   /**
-   * Retrieves a single entity for the given customer by its identifier.
+   * Retrieves a single entity for the given customer by its identifier. Deprecated:
+   * use `GET /api/v1/customers/{id}/entities/{entityId}`.
    *
-   * @example
-   * ```ts
-   * const entity =
-   *   await client.v1Beta.customers.entities.retrieve('x', {
-   *     id: 'id',
-   *   });
-   * ```
+   * @deprecated Use `v1.customers.entities.retrieve` instead.
    */
   retrieve(
     entityID: string,
@@ -38,17 +33,10 @@ export class Entities extends APIResource {
   }
 
   /**
-   * Retrieves a paginated list of entities for the given customer.
+   * Retrieves a paginated list of entities for the given customer. Deprecated: use
+   * `GET /api/v1/customers/{id}/entities`.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const entityListResponse of client.v1Beta.customers.entities.list(
-   *   'id',
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use `v1.customers.entities.list` instead.
    */
   list(
     id: string,
@@ -74,15 +62,11 @@ export class Entities extends APIResource {
   }
 
   /**
-   * Archives entities in bulk for the given customer by id.
+   * Archives entities in bulk for the given customer by id. Upsert an archived
+   * entity to restore it. Deprecated: use
+   * `POST /api/v1/customers/{id}/entities/archive`.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.entities.archive('id', {
-   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
-   *   });
-   * ```
+   * @deprecated Use `v1.customers.entities.archive` instead.
    */
   archive(
     id: string,
@@ -104,15 +88,11 @@ export class Entities extends APIResource {
   }
 
   /**
-   * Restores previously archived entities in bulk for the given customer by id.
+   * Deprecated: use `PUT /api/v1/customers/{id}/entities` with the entity id to
+   * restore it. Restores previously archived entities in bulk for the given customer
+   * by id.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.entities.unarchive('id', {
-   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
-   *   });
-   * ```
+   * @deprecated Use `v1.customers.entities.upsert` with the entity id to restore an archived entity.
    */
   unarchive(
     id: string,
@@ -135,28 +115,11 @@ export class Entities extends APIResource {
 
   /**
    * Creates or updates entities in bulk for the given customer. Existing entities
-   * matched by id are updated; new ids are created.
+   * matched by id are updated; new ids are created. An upsert of an archived entity
+   * restores it. An entity on an archived entity type fails with 400. Deprecated:
+   * use `PUT /api/v1/customers/{id}/entities`.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.entities.upsert('id', {
-   *     entities: [
-   *       {
-   *         id: 'user-7f3a0c1d',
-   *         displayName: 'Jane Doe',
-   *         entityTypeId: 'user',
-   *         metadata: { email: 'jane@acme.com', role: 'admin' },
-   *       },
-   *       {
-   *         id: 'user-c4d1b2e9',
-   *         displayName: 'John Roe',
-   *         entityTypeId: 'user',
-   *         metadata: { email: 'john@acme.com' },
-   *       },
-   *     ],
-   *   });
-   * ```
+   * @deprecated Use `v1.customers.entities.upsert` instead.
    */
   upsert(id: string, params: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;

package/src/resources/v1-beta/customers/entitlements.ts

@@ -11,12 +11,9 @@ export class Entitlements extends APIResource {
    * Experimental — request and response shapes may change without notice. Same
    * semantics as `Check entitlement`, plus an optional `dimensions` query param that
    * resolves to per-entity governance limits surfaced as `chains` on the response.
+   * Deprecated: use `GET /api/v1/customers/{id}/entitlements/check`.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.entitlements.check('x');
-   * ```
+   * @deprecated Use `v1.customers.check_entitlement` instead.
    */
   check(
     id: string,
@@ -148,7 +145,7 @@ export namespace EntitlementCheckResponse {
       scopeEntityIds: Array<string>;
 
       /**
-       * Hard usage limit for this node; null when no assignment is configured.
+       * Hard usage limit for this node; null when the entity has no entity entitlement.
        */
       usageLimit: number | null;
     }
@@ -320,7 +317,7 @@ export namespace EntitlementCheckResponse {
       scopeEntityIds: Array<string>;
 
       /**
-       * Hard usage limit for this node; null when no assignment is configured.
+       * Hard usage limit for this node; null when the entity has no entity entitlement.
        */
       usageLimit: number | null;
     }
@@ -362,9 +359,9 @@ export interface EntitlementCheckParams {
   currencyId?: string;
 
   /**
-   * Query param: Optional attribution map (e.g. `dimensions[userId]=u1`). When
-   * provided, the response includes a `chains` array with per-entity governance
-   * limits.
+   * Query param: Attribution map of the entities the usage is attributed to (e.g.
+   * `dimensions[userId]=u1`). When provided, their governance budgets are checked
+   * too and the response includes `chains`.
    */
   dimensions?: { [key: string]: string };
 

package/src/resources/v1-beta/entity-types.ts

@@ -10,15 +10,10 @@ export class EntityTypes extends APIResource {
   /**
    * Returns a cursor-paginated list of entity types defined in the environment.
    * Entity types are vendor-defined categories of resource that can be governed
-   * (e.g. Org, Team, User).
+   * (e.g. Org, Team, User). Archived entity types are excluded unless
+   * includeArchived=true. Deprecated: use `GET /api/v1/entity-types`.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const entityTypeListResponse of client.v1Beta.entityTypes.list()) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use `v1.entity_types.list` instead.
    */
   list(
     params: EntityTypeListParams | null | undefined = {},
@@ -41,27 +36,10 @@ export class EntityTypes extends APIResource {
   /**
    * Batched create-or-update of entity types. Existing types matched by id are
    * updated; new ids are created. Idempotent — re-submitting the same payload
-   * converges to the same state.
+   * converges to the same state. An upsert of an archived entity type restores it.
+   * Deprecated: use `PUT /api/v1/entity-types`.
    *
-   * @example
-   * ```ts
-   * const response = await client.v1Beta.entityTypes.upsert({
-   *   types: [
-   *     {
-   *       id: 'org',
-   *       displayName: 'Organization',
-   *       description:
-   *         'A customer organization — the top of the hierarchy, holding the account-wide budget.',
-   *       attributionKeys: ['organizationId'],
-   *     },
-   *     {
-   *       id: 'team',
-   *       displayName: 'Team',
-   *       attributionKeys: ['teamId'],
-   *     },
-   *   ],
-   * });
-   * ```
+   * @deprecated Use `v1.entity_types.upsert` instead.
    */
   upsert(params: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -93,6 +71,11 @@ export interface EntityTypeListResponse {
    */
   id: string;
 
+  /**
+   * Timestamp of when the record was deleted
+   */
+  archivedAt: string | null;
+
   /**
    * Dimension keys used to attribute usage events to instances of this type (e.g.
    * ["orgId"]). Empty array means no attribution.
@@ -141,6 +124,11 @@ export namespace EntityTypeUpsertResponse {
      */
     id: string;
 
+    /**
+     * Timestamp of when the record was deleted
+     */
+    archivedAt: string | null;
+
     /**
      * Dimension keys used to attribute usage events to instances of this type (e.g.
      * ["orgId"]). Empty array means no attribution.
@@ -171,6 +159,11 @@ export namespace EntityTypeUpsertResponse {
 }
 
 export interface EntityTypeListParams extends MyCursorIDPageParams {
+  /**
+   * Query param: Whether to include archived entity types. One of: true, false
+   */
+  includeArchived?: 'true' | 'false';
+
   /**
    * Header param: Account ID — optional when authenticating with a user JWT (Bearer
    * token); falls back to the user's first membership. Ignored for API-key auth.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-beta.64'; // x-release-please-version
+export const VERSION = '0.1.0-beta.66'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.64";
+export declare const VERSION = "0.1.0-beta.66";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.64";
+export declare const VERSION = "0.1.0-beta.66";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-beta.64'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.66'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-beta.64'; // x-release-please-version
+export const VERSION = '0.1.0-beta.66'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map