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

package/resources/v1-beta/entity-types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"entity-types.d.mts","sourceRoot":"","sources":["../../src/resources/v1-beta/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;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAe7E;;;;;;;;;;;;;;;;;;;;;;;;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;;;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;;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;;;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;;;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,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"entity-types.d.mts","sourceRoot":"","sources":["../../src/resources/v1-beta/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;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAe7E;;;;;;;OAOG;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;;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,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,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

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

@@ -6,41 +6,19 @@ export declare 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, options?: RequestOptions): PagePromise<EntityTypeListResponsesMyCursorIDPage, EntityTypeListResponse>;
     /**
      * 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>;
 }
@@ -56,6 +34,10 @@ export interface EntityTypeListResponse {
      * The unique identifier for the entity
      */
     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.
@@ -97,6 +79,10 @@ export declare namespace EntityTypeUpsertResponse {
          * The unique identifier for the entity
          */
         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.
@@ -122,6 +108,10 @@ export declare 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/resources/v1-beta/entity-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity-types.d.ts","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,iCAA8B;AAE/F,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAe7E;;;;;;;;;;;;;;;;;;;;;;;;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;;;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;;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;;;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;;;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,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"entity-types.d.ts","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,iCAA8B;AAE/F,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,IAAI,CACF,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAe7E;;;;;;;OAOG;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;;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,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,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1-beta/entity-types.js

@@ -9,15 +9,10 @@ class EntityTypes extends resource_1.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 = {}, options) {
         const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
@@ -36,27 +31,10 @@ class EntityTypes extends resource_1.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, options) {
         const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;

package/resources/v1-beta/entity-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity-types.js","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAC/F,uDAAsD;AAGtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,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,CAAC,2BAA2B,EAAE,CAAA,2BAAsC,CAAA,EAAE;YAClG,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,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;AAvED,kCAuEC"}
+{"version":3,"file":"entity-types.js","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAC/F,uDAAsD;AAGtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;OAOG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,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,CAAC,2BAA2B,EAAE,CAAA,2BAAsC,CAAA,EAAE;YAClG,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;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,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;AAjDD,kCAiDC"}

package/resources/v1-beta/entity-types.mjs

@@ -6,15 +6,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 = {}, options) {
         const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
@@ -33,27 +28,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, options) {
         const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;

package/resources/v1-beta/entity-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"entity-types.mjs","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAC/F,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,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,CAAC,2BAA2B,EAAE,CAAA,cAAsC,CAAA,EAAE;YAClG,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,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"}
+{"version":3,"file":"entity-types.mjs","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAC/F,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,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,CAAC,2BAA2B,EAAE,CAAA,cAAsC,CAAA,EAAE;YAClG,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;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,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"}

package/src/resources/v1/addons/addons.ts

@@ -26,6 +26,15 @@ export class Addons extends APIResource {
 
   /**
    * Creates a new addon in draft status, associated with a specific product.
+   *
+   * @example
+   * ```ts
+   * const addon = await client.v1.addons.create({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   productId: 'productId',
+   * });
+   * ```
    */
   create(params: AddonCreateParams, options?: RequestOptions): APIPromise<Addon> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -45,6 +54,11 @@ export class Addons extends APIResource {
   /**
    * Retrieves an addon by its unique identifier, including entitlements and pricing
    * details.
+   *
+   * @example
+   * ```ts
+   * const addon = await client.v1.addons.retrieve('x');
+   * ```
    */
   retrieve(
     id: string,
@@ -67,6 +81,11 @@ export class Addons extends APIResource {
   /**
    * Updates an existing addon's properties such as display name, description, and
    * metadata.
+   *
+   * @example
+   * ```ts
+   * const addon = await client.v1.addons.update('x');
+   * ```
    */
   update(id: string, params: AddonUpdateParams, options?: RequestOptions): APIPromise<Addon> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -85,6 +104,14 @@ export class Addons extends APIResource {
 
   /**
    * Retrieves a paginated list of addons in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const addonListResponse of client.v1.addons.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: AddonListParams | null | undefined = {},
@@ -106,6 +133,11 @@ export class Addons extends APIResource {
 
   /**
    * Archives an addon, preventing it from being used in new subscriptions.
+   *
+   * @example
+   * ```ts
+   * const addon = await client.v1.addons.archive('x');
+   * ```
    */
   archive(
     id: string,
@@ -127,6 +159,11 @@ export class Addons extends APIResource {
 
   /**
    * Creates a draft version of an existing addon for modification before publishing.
+   *
+   * @example
+   * ```ts
+   * const addon = await client.v1.addons.createDraft('x');
+   * ```
    */
   createDraft(
     id: string,
@@ -148,6 +185,16 @@ export class Addons extends APIResource {
 
   /**
    * Retrieves the list of charges configured on an addon.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const addonListChargesResponse of client.v1.addons.listCharges(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listCharges(
     id: string,
@@ -178,6 +225,13 @@ export class Addons extends APIResource {
    * addon are moved onto the new version immediately (`ALL_CUSTOMERS`) or stay on
    * the version they were using — grandfathered — until you explicitly migrate them
    * (`NEW_CUSTOMERS`).
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.addons.publish('x', {
+   *   migrationType: 'NEW_CUSTOMERS',
+   * });
+   * ```
    */
   publish(
     id: string,
@@ -200,6 +254,11 @@ export class Addons extends APIResource {
 
   /**
    * Removes a draft version of an addon.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.addons.removeDraft('x');
+   * ```
    */
   removeDraft(
     id: string,

package/src/resources/v1/addons/entitlements.ts

@@ -9,6 +9,14 @@ import { path } from '../../../internal/utils/path';
 export class Entitlements extends APIResource {
   /**
    * Creates one or more entitlements (feature or credit) on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const entitlement =
+   *   await client.v1.addons.entitlements.create('addonId', {
+   *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+   *   });
+   * ```
    */
   create(
     addonID: string,
@@ -31,6 +39,15 @@ export class Entitlements extends APIResource {
 
   /**
    * Updates an existing entitlement on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.update('id', {
+   *     addonId: 'addonId',
+   *     type: 'FEATURE',
+   *   });
+   * ```
    */
   update(
     id: string,
@@ -53,6 +70,12 @@ export class Entitlements extends APIResource {
 
   /**
    * Retrieves a list of entitlements for an addon.
+   *
+   * @example
+   * ```ts
+   * const entitlements =
+   *   await client.v1.addons.entitlements.list('addonId');
+   * ```
    */
   list(
     addonID: string,
@@ -74,6 +97,14 @@ export class Entitlements extends APIResource {
 
   /**
    * Deletes an entitlement from a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.delete('id', {
+   *     addonId: 'addonId',
+   *   });
+   * ```
    */
   delete(
     id: string,

package/src/resources/v1/contracts.ts

@@ -14,6 +14,13 @@ export class Contracts extends APIResource {
    * inside one transaction — any validation or creation failure rolls the whole
    * contract back. Each subscription entry is either a new subscription to create or
    * a reference to an existing custom subscription. Returns the created contract.
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.create({
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
   create(params: ContractCreateParams, options?: RequestOptions): APIPromise<ContractCreateResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -34,6 +41,11 @@ export class Contracts extends APIResource {
    * Retrieves a single contract by its ID, enriched with a preview of its upcoming
    * (next) invoice when one is available. Returns 404 when no contract with that ID
    * exists in the environment.
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.retrieve('x');
+   * ```
    */
   retrieve(
     id: string,
@@ -57,6 +69,11 @@ export class Contracts extends APIResource {
    * Updates a contract's metadata (name, PO number, activation dates) and optionally
    * re-links its subscriptions. Best-effort re-syncs the change to the connected
    * billing provider.
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.update('x');
+   * ```
    */
   update(
     id: string,
@@ -82,6 +99,14 @@ export class Contracts extends APIResource {
    * that has a billing contract is enriched with a preview of its upcoming (next)
    * invoice when one is available. Supports filtering by customer external ID,
    * state, and name.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const contractListResponse of client.v1.contracts.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: ContractListParams | null | undefined = {},
@@ -104,6 +129,11 @@ export class Contracts extends APIResource {
   /**
    * Deletes a contract: cancels the contract in the connected billing provider and
    * cancels every subscription linked to it.
+   *
+   * @example
+   * ```ts
+   * const contract = await client.v1.contracts.delete('x');
+   * ```
    */
   delete(
     id: string,

package/src/resources/v1/coupons.ts

@@ -14,6 +14,19 @@ export class Coupons extends APIResource {
   /**
    * Creates a new discount coupon with percentage or fixed amount off, applicable to
    * customer subscriptions.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.create({
+   *   id: 'id',
+   *   amountsOff: [{ amount: 0, currency: 'usd' }],
+   *   description: 'description',
+   *   durationInMonths: 1,
+   *   metadata: { foo: 'string' },
+   *   name: 'name',
+   *   percentOff: 1,
+   * });
+   * ```
    */
   create(params: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -32,6 +45,11 @@ export class Coupons extends APIResource {
 
   /**
    * Retrieves a coupon by its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.retrieve('x');
+   * ```
    */
   retrieve(
     id: string,
@@ -53,6 +71,14 @@ export class Coupons extends APIResource {
 
   /**
    * Retrieves a paginated list of coupons in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const couponListResponse of client.v1.coupons.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: CouponListParams | null | undefined = {},
@@ -74,6 +100,11 @@ export class Coupons extends APIResource {
 
   /**
    * Archives a coupon, preventing it from being applied to new subscriptions.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.archiveCoupon('x');
+   * ```
    */
   archiveCoupon(
     id: string,
@@ -95,6 +126,11 @@ export class Coupons extends APIResource {
 
   /**
    * Updates an existing coupon's properties such as name, description, and metadata.
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.updateCoupon('x');
+   * ```
    */
   updateCoupon(id: string, params: CouponUpdateCouponParams, options?: RequestOptions): APIPromise<Coupon> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;

package/src/resources/v1/credits/consumption.ts

@@ -9,6 +9,17 @@ export class Consumption extends APIResource {
   /**
    * Consumes a specified amount of credits directly from a customer wallet, with no
    * feature mapping. Returns the optimistic balance.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.credits.consumption.consume({
+   *     amount: 1,
+   *     currencyId: 'currencyId',
+   *     customerId: 'customerId',
+   *     idempotencyKey: 'x',
+   *   });
+   * ```
    */
   consume(
     params: ConsumptionConsumeParams,
@@ -31,6 +42,21 @@ export class Consumption extends APIResource {
   /**
    * Consumes credits directly from customer wallets asynchronously. Consumptions are
    * reconciled asynchronously into the credit balances.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.credits.consumption.consumeAsync({
+   *     consumptions: [
+   *       {
+   *         amount: 1,
+   *         currencyId: 'currencyId',
+   *         customerId: 'customerId',
+   *         idempotencyKey: 'x',
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   consumeAsync(
     params: ConsumptionConsumeAsyncParams,

package/src/resources/v1/credits/credits.ts

@@ -51,6 +51,14 @@ export class Credits extends APIResource {
   /**
    * Retrieves the automatic recharge configuration for a customer and currency.
    * Returns default settings if no configuration exists.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getAutoRecharge({
+   *   currencyId: 'currencyId',
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
   getAutoRecharge(
     params: CreditGetAutoRechargeParams,
@@ -73,6 +81,13 @@ export class Credits extends APIResource {
   /**
    * Retrieves credit usage time-series data for a customer, grouped by feature, over
    * a specified time range.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getUsage({
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
   getUsage(params: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
@@ -91,6 +106,16 @@ export class Credits extends APIResource {
 
   /**
    * Retrieves a paginated list of credit ledger events for a customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditListLedgerResponse of client.v1.credits.listLedger(
+   *   { customerId: 'customerId' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listLedger(
     params: CreditListLedgerParams,