@stigg/typescript 0.1.0-beta.21 → 0.1.0-beta.22

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

@@ -32,13 +32,6 @@ 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,
@@ -61,13 +54,6 @@ export class Subscriptions extends APIResource {
   /**
    * Updates an active subscription's properties including billing period, add-ons,
    * unit quantities, and discounts.
-   *
-   * @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;
@@ -87,14 +73,6 @@ 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 = {},
@@ -117,13 +95,6 @@ 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;
@@ -143,14 +114,6 @@ export class Subscriptions extends APIResource {
   /**
    * Delegates the payment responsibility of a subscription to a different customer.
    * The delegated customer will be billed for this subscription.
-   *
-   * @example
-   * ```ts
-   * const subscription = await client.v1.subscriptions.delegate(
-   *   'x',
-   *   { targetCustomerId: 'targetCustomerId' },
-   * );
-   * ```
    */
   delegate(
     id: string,
@@ -174,19 +137,6 @@ 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;
@@ -206,13 +156,6 @@ 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;
@@ -232,14 +175,6 @@ 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,
@@ -262,14 +197,6 @@ 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,
@@ -292,14 +219,6 @@ 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,12 +13,6 @@ 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,
@@ -42,13 +36,6 @@ 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

@@ -12,17 +12,6 @@ import { path } from '../../internal/utils/path';
 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,
@@ -46,19 +35,6 @@ export class Usage extends APIResource {
   /**
    * Reports usage measurements for metered features. The reported usage is used to
    * track, limit, and bill customer consumption.
-   *
-   * @example
-   * ```ts
-   * const response = await client.v1.usage.report({
-   *   usages: [
-   *     {
-   *       customerId: 'customerId',
-   *       featureId: 'featureId',
-   *       value: -9007199254740991,
-   *     },
-   *   ],
-   * });
-   * ```
    */
   report(params: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;

package/src/resources/{v1/events/beta → v1-beta}/customers/assignments.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../../core/resource';
-import { APIPromise } from '../../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../../core/pagination';
-import { buildHeaders } from '../../../../../internal/headers';
-import { RequestOptions } from '../../../../../internal/request-options';
-import { path } from '../../../../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Assignments extends APIResource {
   /**
@@ -16,7 +16,7 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const assignmentListResponse of client.v1.events.beta.customers.assignments.list(
+   * for await (const assignmentListResponse of client.v1Beta.customers.assignments.list(
    *   'id',
    * )) {
    *   // ...
@@ -55,25 +55,24 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.assignments.upsert(
-   *     'id',
-   *     {
-   *       assignments: [
-   *         {
-   *           entityId: 'workspace-001',
-   *           capabilityId: 'compute-minutes',
-   *           usageLimit: 1000,
-   *           cadence: 'MONTH',
-   *         },
-   *         {
-   *           entityId: 'workspace-002',
-   *           capabilityId: 'compute-minutes',
-   *           usageLimit: 2000,
-   *           cadence: 'MONTH',
-   *         },
-   *       ],
-   *     },
-   *   );
+   *   await client.v1Beta.customers.assignments.upsert('id', {
+   *     assignments: [
+   *       {
+   *         entityId: 'workspace-001',
+   *         featureId: 'compute-minutes',
+   *         usageLimit: 1000,
+   *         cadence: 'MONTH',
+   *       },
+   *       {
+   *         entityId: 'workspace-002',
+   *         currencyId: 'cred-type-tokens',
+   *         usageLimit: 2000,
+   *         cadence: 'MONTH',
+   *         parentId: 'workspace-001',
+   *         scopeEntityIds: ['user-1'],
+   *       },
+   *     ],
+   *   });
    * ```
    */
   upsert(
@@ -114,11 +113,6 @@ export interface AssignmentListResponse {
    */
   cadence: 'MONTH';
 
-  /**
-   * The capability refId this assignment grants
-   */
-  capabilityId: string;
-
   /**
    * Timestamp of when the record was created
    */
@@ -129,6 +123,19 @@ export interface AssignmentListResponse {
    */
   entityId: string;
 
+  /**
+   * Parent entity refId in the hierarchy, or `null` for a root.
+   */
+  parentId: string | null;
+
+  /**
+   * Dimension-scoped sub-budget key: the set of entity refIds this budget applies
+   * to. Empty is the node-wide budget that always matches; a non-empty set only
+   * applies when every listed entity is present in the resolved set
+   * (order-insensitive).
+   */
+  scopeEntityIds: Array<string>;
+
   /**
    * Timestamp of when the record was last updated
    */
@@ -138,6 +145,16 @@ export interface AssignmentListResponse {
    * Maximum usage allowed within one cadence window
    */
   usageLimit: number;
+
+  /**
+   * Currency refId this assignment grants (present for credit capabilities).
+   */
+  currencyId?: string;
+
+  /**
+   * Feature refId this assignment grants (present for feature capabilities).
+   */
+  featureId?: string;
 }
 
 /**
@@ -164,11 +181,6 @@ export namespace AssignmentUpsertResponse {
      */
     cadence: 'MONTH';
 
-    /**
-     * The capability refId this assignment grants
-     */
-    capabilityId: string;
-
     /**
      * Timestamp of when the record was created
      */
@@ -179,6 +191,19 @@ export namespace AssignmentUpsertResponse {
      */
     entityId: string;
 
+    /**
+     * Parent entity refId in the hierarchy, or `null` for a root.
+     */
+    parentId: string | null;
+
+    /**
+     * Dimension-scoped sub-budget key: the set of entity refIds this budget applies
+     * to. Empty is the node-wide budget that always matches; a non-empty set only
+     * applies when every listed entity is present in the resolved set
+     * (order-insensitive).
+     */
+    scopeEntityIds: Array<string>;
+
     /**
      * Timestamp of when the record was last updated
      */
@@ -188,6 +213,16 @@ export namespace AssignmentUpsertResponse {
      * Maximum usage allowed within one cadence window
      */
     usageLimit: number;
+
+    /**
+     * Currency refId this assignment grants (present for credit capabilities).
+     */
+    currencyId?: string;
+
+    /**
+     * Feature refId this assignment grants (present for feature capabilities).
+     */
+    featureId?: string;
   }
 }
 
@@ -238,17 +273,13 @@ export interface AssignmentUpsertParams {
 
 export namespace AssignmentUpsertParams {
   /**
-   * A single assignment to create or update. The natural key is the
-   * `(entityId, capabilityId)` pair. On create both `usageLimit` and `cadence` are
-   * required; on update they may be omitted individually to preserve the existing
-   * value.
+   * A single assignment to create or update. Identify the capability with exactly
+   * one of `featureId` or `currencyId`. The natural key is the
+   * `(entityId, capability, scopeEntityIds)` triple. On create both `usageLimit` and
+   * `cadence` are required; on update they may be omitted individually to preserve
+   * the existing value.
    */
   export interface Assignment {
-    /**
-     * The capability refId this assignment grants
-     */
-    capabilityId: string;
-
     /**
      * The entity refId this assignment is attached to
      */
@@ -259,6 +290,26 @@ export namespace AssignmentUpsertParams {
      */
     cadence?: 'MONTH';
 
+    /**
+     * Currency refId this assignment grants (credit budgets). Mutually exclusive with
+     * `featureId`.
+     */
+    currencyId?: string;
+
+    /**
+     * Feature refId this assignment grants. Mutually exclusive with `currencyId`.
+     */
+    featureId?: string;
+
+    /**
+     * Parent entity refId in the hierarchy. Omit to leave the current parent untouched
+     * (a new node defaults to a root); `null` detaches to a root; a refId sets or
+     * changes the parent. Reparenting an existing node is leaf-only.
+     */
+    parentId?: string | null;
+
+    scopeEntityIds?: Array<string>;
+
     /**
      * Maximum usage allowed within one cadence window (required on create)
      */

package/src/resources/{v1/events/beta → v1-beta}/customers/customers.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../../core/resource';
+import { APIResource } from '../../../core/resource';
 import * as AssignmentsAPI from './assignments';
 import {
   AssignmentListParams,

package/src/resources/{v1/events/beta → v1-beta}/customers/entities.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../../core/resource';
-import { APIPromise } from '../../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../../core/pagination';
-import { buildHeaders } from '../../../../../internal/headers';
-import { RequestOptions } from '../../../../../internal/request-options';
-import { path } from '../../../../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Entities extends APIResource {
   /**
@@ -14,10 +14,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const entity =
-   *   await client.v1.events.beta.customers.entities.retrieve(
-   *     'x',
-   *     { id: 'id' },
-   *   );
+   *   await client.v1Beta.customers.entities.retrieve('x', {
+   *     id: 'id',
+   *   });
    * ```
    */
   retrieve(
@@ -44,7 +43,7 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityListResponse of client.v1.events.beta.customers.entities.list(
+   * for await (const entityListResponse of client.v1Beta.customers.entities.list(
    *   'id',
    * )) {
    *   // ...
@@ -80,10 +79,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.archive(
-   *     'id',
-   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
-   *   );
+   *   await client.v1Beta.customers.entities.archive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
    * ```
    */
   archive(
@@ -111,10 +109,9 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.unarchive(
-   *     'id',
-   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
-   *   );
+   *   await client.v1Beta.customers.entities.unarchive('id', {
+   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+   *   });
    * ```
    */
   unarchive(
@@ -143,26 +140,20 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entities.upsert(
-   *     'id',
-   *     {
-   *       entities: [
-   *         {
-   *           id: 'user-7f3a0c1d',
-   *           typeRefId: 'user',
-   *           metadata: {
-   *             email: 'jane@acme.com',
-   *             role: 'admin',
-   *           },
-   *         },
-   *         {
-   *           id: 'user-c4d1b2e9',
-   *           typeRefId: 'user',
-   *           metadata: { email: 'john@acme.com' },
-   *         },
-   *       ],
-   *     },
-   *   );
+   *   await client.v1Beta.customers.entities.upsert('id', {
+   *     entities: [
+   *       {
+   *         id: 'user-7f3a0c1d',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'jane@acme.com', role: 'admin' },
+   *       },
+   *       {
+   *         id: 'user-c4d1b2e9',
+   *         typeRefId: 'user',
+   *         metadata: { email: 'john@acme.com' },
+   *       },
+   *     ],
+   *   });
    * ```
    */
   upsert(id: string, params: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse> {

package/src/resources/{v1/events/beta → v1-beta}/customers/entitlements.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../../core/resource';
-import { APIPromise } from '../../../../../core/api-promise';
-import { buildHeaders } from '../../../../../internal/headers';
-import { RequestOptions } from '../../../../../internal/request-options';
-import { path } from '../../../../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Entitlements extends APIResource {
   /**
@@ -15,9 +15,7 @@ export class Entitlements extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.events.beta.customers.entitlements.check(
-   *     'x',
-   *   );
+   *   await client.v1Beta.customers.entitlements.check('x');
    * ```
    */
   check(

package/src/resources/{v1/events/beta → v1-beta}/entity-types.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
-import { APIPromise } from '../../../../core/api-promise';
-import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
-import { buildHeaders } from '../../../../internal/headers';
-import { RequestOptions } from '../../../../internal/request-options';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
 
 export class EntityTypes extends APIResource {
   /**
@@ -15,7 +15,7 @@ export class EntityTypes extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityTypeListResponse of client.v1.events.beta.entityTypes.list()) {
+   * for await (const entityTypeListResponse of client.v1Beta.entityTypes.list()) {
    *   // ...
    * }
    * ```
@@ -45,21 +45,20 @@ export class EntityTypes extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.v1.events.beta.entityTypes.upsert({
-   *     types: [
-   *       {
-   *         id: 'org',
-   *         displayName: 'Organization',
-   *         attributionKeys: ['organizationId'],
-   *       },
-   *       {
-   *         id: 'team',
-   *         displayName: 'Team',
-   *         attributionKeys: ['teamId'],
-   *       },
-   *     ],
-   *   });
+   * const response = await client.v1Beta.entityTypes.upsert({
+   *   types: [
+   *     {
+   *       id: 'org',
+   *       displayName: 'Organization',
+   *       attributionKeys: ['organizationId'],
+   *     },
+   *     {
+   *       id: 'team',
+   *       displayName: 'Team',
+   *       attributionKeys: ['teamId'],
+   *     },
+   *   ],
+   * });
    * ```
    */
   upsert(params: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse> {

package/src/resources/{v1/events/beta → v1-beta}/index.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Beta } from './beta';
 export { Customers } from './customers/index';
 export {
   EntityTypes,
@@ -10,3 +9,4 @@ export {
   type EntityTypeUpsertParams,
   type EntityTypeListResponsesMyCursorIDPage,
 } from './entity-types';
+export { V1Beta } from './v1-beta';

package/src/resources/{v1/events/beta/beta.ts → v1-beta/v1-beta.ts}

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../core/resource';
+import { APIResource } from '../../core/resource';
 import * as EntityTypesAPI from './entity-types';
 import {
   EntityTypeListParams,
@@ -13,15 +13,15 @@ import {
 import * as CustomersAPI from './customers/customers';
 import { Customers } from './customers/customers';
 
-export class Beta extends APIResource {
+export class V1Beta extends APIResource {
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   entityTypes: EntityTypesAPI.EntityTypes = new EntityTypesAPI.EntityTypes(this._client);
 }
 
-Beta.Customers = Customers;
-Beta.EntityTypes = EntityTypes;
+V1Beta.Customers = Customers;
+V1Beta.EntityTypes = EntityTypes;
 
-export declare namespace Beta {
+export declare namespace V1Beta {
   export { Customers as Customers };
 
   export {