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

package/src/resources/v1/plans/plans.ts

@@ -26,6 +26,15 @@ export class Plans extends APIResource {
 
   /**
    * Creates a new plan in draft status.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.create({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   productId: 'productId',
+   * });
+   * ```
    */
   create(params: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -45,6 +54,11 @@ export class Plans extends APIResource {
   /**
    * Retrieves a plan by its unique identifier, including entitlements and pricing
    * details.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.retrieve('x');
+   * ```
    */
   retrieve(
     id: string,
@@ -67,6 +81,11 @@ export class Plans extends APIResource {
   /**
    * Updates an existing plan's properties such as display name, description, and
    * metadata.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.update('x');
+   * ```
    */
   update(id: string, params: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -85,6 +104,14 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves a paginated list of plans in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListResponse of client.v1.plans.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: PlanListParams | null | undefined = {},
@@ -106,6 +133,11 @@ export class Plans extends APIResource {
 
   /**
    * Archives a plan, preventing it from being used in new subscriptions.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.archive('x');
+   * ```
    */
   archive(
     id: string,
@@ -127,6 +159,11 @@ export class Plans extends APIResource {
 
   /**
    * Creates a draft version of an existing plan for modification before publishing.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.createDraft('x');
+   * ```
    */
   createDraft(
     id: string,
@@ -148,6 +185,16 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of charges configured on a plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListChargesResponse of client.v1.plans.listCharges(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listCharges(
     id: string,
@@ -174,6 +221,16 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of overage charges configured on a plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listOverageCharges(
     id: string,
@@ -204,6 +261,13 @@ export class Plans extends APIResource {
    * onto the new version immediately (`ALL_CUSTOMERS`) or stay on the version they
    * subscribed to — grandfathered — until you explicitly migrate them, e.g. via the
    * migrate subscription endpoint (`NEW_CUSTOMERS`).
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.plans.publish('x', {
+   *   migrationType: 'NEW_CUSTOMERS',
+   * });
+   * ```
    */
   publish(id: string, params: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -222,6 +286,11 @@ export class Plans extends APIResource {
 
   /**
    * Removes a draft version of a plan.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.plans.removeDraft('x');
+   * ```
    */
   removeDraft(
     id: string,

package/src/resources/v1/products.ts

@@ -14,6 +14,13 @@ export class Products extends APIResource {
   /**
    * Archives a product, preventing new subscriptions. All plans and addons are
    * archived.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.archiveProduct(
+   *   'x',
+   * );
+   * ```
    */
   archiveProduct(
     id: string,
@@ -35,6 +42,14 @@ export class Products extends APIResource {
 
   /**
    * Creates a new product.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.createProduct({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   * });
+   * ```
    */
   createProduct(params: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -53,6 +68,14 @@ export class Products extends APIResource {
 
   /**
    * Duplicates an existing product, including its plans, addons, and configuration.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.duplicateProduct(
+   *   'x',
+   *   { targetId: 'targetId' },
+   * );
+   * ```
    */
   duplicateProduct(
     id: string,
@@ -75,6 +98,14 @@ export class Products extends APIResource {
 
   /**
    * Retrieves a paginated list of products in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const productListProductsResponse of client.v1.products.listProducts()) {
+   *   // ...
+   * }
+   * ```
    */
   listProducts(
     params: ProductListProductsParams | null | undefined = {},
@@ -96,6 +127,13 @@ export class Products extends APIResource {
 
   /**
    * Restores an archived product, allowing new subscriptions to be created.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.unarchiveProduct(
+   *   'x',
+   * );
+   * ```
    */
   unarchiveProduct(
     id: string,
@@ -118,6 +156,11 @@ export class Products extends APIResource {
   /**
    * Updates an existing product's properties such as display name, description, and
    * metadata.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.updateProduct('x');
+   * ```
    */
   updateProduct(
     id: string,

package/src/resources/v1/subscriptions/future-update.ts

@@ -12,6 +12,14 @@ import { path } from '../../../internal/utils/path';
 export class FutureUpdate extends APIResource {
   /**
    * Cancels a subscription update that is pending payment completion.
+   *
+   * @example
+   * ```ts
+   * const cancelSubscription =
+   *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+   *     'x',
+   *   );
+   * ```
    */
   cancelPendingPayment(
     id: string,
@@ -34,6 +42,14 @@ export class FutureUpdate extends APIResource {
   /**
    * Cancels a scheduled subscription update, such as a future downgrade or plan
    * change.
+   *
+   * @example
+   * ```ts
+   * const cancelSubscription =
+   *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+   *     'x',
+   *   );
+   * ```
    */
   cancelSchedule(
     id: string,

package/src/resources/v1/subscriptions/invoice.ts

@@ -13,6 +13,12 @@ export class Invoice extends APIResource {
   /**
    * Marks the latest invoice of a subscription as paid in the billing provider. The
    * invoice must exist and have an OPEN status.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.subscriptions.invoice.markAsPaid('x');
+   * ```
    */
   markAsPaid(
     id: string,

package/src/resources/v1/subscriptions/subscriptions.ts

@@ -32,6 +32,13 @@ export class Subscriptions extends APIResource {
   /**
    * Retrieves a subscription by its unique identifier, including plan details,
    * billing period, status, and add-ons.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.retrieve(
+   *   'x',
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -60,6 +67,13 @@ export class Subscriptions extends APIResource {
    * the array is removed from the subscription. Changes classified as a downgrade
    * may be scheduled for the end of the current billing period instead of applying
    * immediately, depending on your update scheduling configuration.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.update(
+   *   'x',
+   * );
+   * ```
    */
   update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -79,6 +93,14 @@ export class Subscriptions extends APIResource {
   /**
    * Retrieves a paginated list of subscriptions, with optional filters for customer,
    * status, and plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: SubscriptionListParams | null | undefined = {},
@@ -101,6 +123,13 @@ export class Subscriptions extends APIResource {
   /**
    * Cancels an active subscription, either immediately or at a specified time such
    * as end of billing period.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.cancel(
+   *   'x',
+   * );
+   * ```
    */
   cancel(id: string, params: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -122,6 +151,14 @@ export class Subscriptions extends APIResource {
    * managing it. The original customer remains the paying customer for this
    * subscription, unless payment was already delegated to the target customer, in
    * which case the target customer becomes the paying customer as well.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.delegate(
+   *   'x',
+   *   { targetCustomerId: 'targetCustomerId' },
+   * );
+   * ```
    */
   delegate(
     id: string,
@@ -145,6 +182,19 @@ export class Subscriptions extends APIResource {
   /**
    * Imports multiple subscriptions in bulk. Used for migrating subscription data
    * from external systems.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.subscriptions.import({
+   *   subscriptions: [
+   *     {
+   *       id: 'id',
+   *       customerId: 'customerId',
+   *       planId: 'planId',
+   *     },
+   *   ],
+   * });
+   * ```
    */
   import(params: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -164,6 +214,13 @@ export class Subscriptions extends APIResource {
   /**
    * Migrates a subscription to the latest published version of its plan or add-ons.
    * Handles prorated charges or credits automatically.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.migrate(
+   *   'x',
+   * );
+   * ```
    */
   migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -183,6 +240,14 @@ export class Subscriptions extends APIResource {
   /**
    * Previews the pricing impact of creating or updating a subscription without
    * making changes. Returns estimated costs, taxes, and proration details.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.subscriptions.preview({
+   *   customerId: 'customerId',
+   *   planId: 'planId',
+   * });
+   * ```
    */
   preview(
     params: SubscriptionPreviewParams,
@@ -205,6 +270,14 @@ export class Subscriptions extends APIResource {
   /**
    * Creates a new subscription for an existing customer. When payment is required
    * and no payment method exists, returns a checkout URL.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.subscriptions.provision({
+   *   customerId: 'customerId',
+   *   planId: 'planId',
+   * });
+   * ```
    */
   provision(
     params: SubscriptionProvisionParams,
@@ -227,6 +300,14 @@ export class Subscriptions extends APIResource {
   /**
    * Transfers a subscription to a different resource ID. Used for multi-resource
    * products where subscriptions apply to specific entities like websites or apps.
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.v1.subscriptions.transfer(
+   *   'x',
+   *   { destinationResourceId: 'destinationResourceId' },
+   * );
+   * ```
    */
   transfer(
     id: string,

package/src/resources/v1/subscriptions/usage.ts

@@ -13,6 +13,12 @@ export class Usage extends APIResource {
   /**
    * Immediately charges usage for a subscription via the billing integration.
    * Calculates usage since the last charge and creates an invoice.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.subscriptions.usage.chargeUsage('x');
+   * ```
    */
   chargeUsage(
     id: string,
@@ -36,6 +42,13 @@ export class Usage extends APIResource {
   /**
    * Triggers a usage sync for a subscription, reporting current usage to the billing
    * provider.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.subscriptions.usage.sync(
+   *   'x',
+   * );
+   * ```
    */
   sync(
     id: string,

package/src/resources/v1/usage.ts

@@ -14,6 +14,15 @@ export class Usage extends APIResource {
    * Estimates the credit cost of a usage report without recording it. Returns the
    * estimated cost per credit currency, the current balance, and the balance after
    * the estimated consumption.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.usage.estimate({
+   *   customerId: 'customerId',
+   *   featureId: 'featureId',
+   *   value: -9007199254740991,
+   * });
+   * ```
    */
   estimate(params: UsageEstimateParams, options?: RequestOptions): APIPromise<UsageEstimateResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -32,6 +41,17 @@ export class Usage extends APIResource {
 
   /**
    * Retrieves historical usage data for a customer's metered feature over time.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.usage.history(
+   *   'featureId',
+   *   {
+   *     customerId: 'customerId',
+   *     startDate: '2019-12-27T18:11:19.117Z',
+   *   },
+   * );
+   * ```
    */
   history(
     featureID: string,

package/src/resources/v1/v1.ts

@@ -28,6 +28,19 @@ import {
   CouponUpdateCouponParams,
   Coupons,
 } from './coupons';
+import * as EntityTypesAPI from './entity-types';
+import {
+  EntityTypeArchiveParams,
+  EntityTypeArchiveResponse,
+  EntityTypeCheckActiveEntitiesParams,
+  EntityTypeCheckActiveEntitiesResponse,
+  EntityTypeListParams,
+  EntityTypeListResponse,
+  EntityTypeListResponsesMyCursorIDPage,
+  EntityTypeUpsertParams,
+  EntityTypeUpsertResponse,
+  EntityTypes,
+} from './entity-types';
 import * as FeaturesAPI from './features';
 import {
   Feature,
@@ -187,6 +200,7 @@ export class V1 extends APIResource {
   usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
   products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
   contracts: ContractsAPI.Contracts = new ContractsAPI.Contracts(this._client);
+  entityTypes: EntityTypesAPI.EntityTypes = new EntityTypesAPI.EntityTypes(this._client);
 }
 
 V1.Customers = Customers;
@@ -200,6 +214,7 @@ V1.Plans = Plans;
 V1.Usage = Usage;
 V1.Products = Products;
 V1.Contracts = Contracts;
+V1.EntityTypes = EntityTypes;
 
 export declare namespace V1 {
   export {
@@ -374,4 +389,17 @@ export declare namespace V1 {
     type ContractListParams as ContractListParams,
     type ContractDeleteParams as ContractDeleteParams,
   };
+
+  export {
+    EntityTypes as EntityTypes,
+    type EntityTypeListResponse as EntityTypeListResponse,
+    type EntityTypeArchiveResponse as EntityTypeArchiveResponse,
+    type EntityTypeCheckActiveEntitiesResponse as EntityTypeCheckActiveEntitiesResponse,
+    type EntityTypeUpsertResponse as EntityTypeUpsertResponse,
+    type EntityTypeListResponsesMyCursorIDPage as EntityTypeListResponsesMyCursorIDPage,
+    type EntityTypeListParams as EntityTypeListParams,
+    type EntityTypeArchiveParams as EntityTypeArchiveParams,
+    type EntityTypeCheckActiveEntitiesParams as EntityTypeCheckActiveEntitiesParams,
+    type EntityTypeUpsertParams as EntityTypeUpsertParams,
+  };
 }

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

@@ -11,17 +11,10 @@ export class Assignments extends APIResource {
   /**
    * Returns a cursor-paginated list of capability assignments for the given
    * customer. An assignment ties an entity to a capability with a usage limit and
-   * reset cadence.
+   * reset cadence. Deprecated: use
+   * `GET /api/v1/customers/{id}/entities/entitlements`.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const assignmentListResponse of client.v1Beta.customers.assignments.list(
-   *   'id',
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use `v1.customers.entities.entitlements.list` instead.
    */
   list(
     id: string,
@@ -50,30 +43,11 @@ export class Assignments extends APIResource {
    * Batched create-or-update of capability assignments. Existing assignments matched
    * by (entityId, capabilityId) are updated; new pairs are created. On update,
    * omitted fields (usageLimit, cadence) are preserved; on create both are required
-   * by the governance service.
+   * by the governance service. Deprecated: use
+   * `PUT /api/v1/customers/{id}/entities/entitlements` with the body key
+   * `entityEntitlements`.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.assignments.upsert('id', {
-   *     assignments: [
-   *       {
-   *         entityId: 'workspace-001',
-   *         featureId: 'compute-minutes',
-   *         usageLimit: 1000,
-   *         cadence: 'P1M',
-   *       },
-   *       {
-   *         entityId: 'workspace-002',
-   *         currencyId: 'cred-type-tokens',
-   *         usageLimit: 2000,
-   *         cadence: 'P1M',
-   *         parentId: 'workspace-001',
-   *         scopeEntityIds: ['user-1'],
-   *       },
-   *     ],
-   *   });
-   * ```
+   * @deprecated Use `v1.customers.entities.entitlements.upsert` instead. Its body key is `entityEntitlements`.
    */
   upsert(
     id: string,
@@ -317,6 +291,11 @@ export namespace AssignmentUpsertParams {
      */
     parentId?: string | null;
 
+    /**
+     * Dimension-scoped sub-budget: the set of entity IDs this budget applies to
+     * (order-insensitive, unique, at most 5). Omit or leave empty for the node-wide
+     * budget.
+     */
     scopeEntityIds?: Array<string>;
 
     /**

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,10 +88,11 @@ export class Entities extends APIResource {
   }
 
   /**
-   * Deprecated: upsert an entity to restore it. 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.
    *
-   * @deprecated
+   * @deprecated Use `v1.customers.entities.upsert` with the entity id to restore an archived entity.
    */
   unarchive(
     id: string,
@@ -131,28 +116,10 @@ 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. An upsert of an archived entity
-   * restores it. An entity on an archived entity type fails with 400.
+   * 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;