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

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

@@ -3,6 +3,7 @@
 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';
 
@@ -13,41 +14,123 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * Grants promotional entitlements to a customer, providing feature access outside
    * their subscription. Entitlements can be time-limited or permanent.
+   *
+   * @example
+   * ```ts
+   * const promotionalEntitlement =
+   *   await client.v1.customers.promotionalEntitlements.create(
+   *     'x',
+   *     {
+   *       promotionalEntitlements: [
+   *         {
+   *           customEndDate: '2019-12-27T18:11:19.117Z',
+   *           enumValues: ['string'],
+   *           featureId: 'featureId',
+   *           hasSoftLimit: true,
+   *           hasUnlimitedUsage: true,
+   *           isVisible: true,
+   *           monthlyResetPeriodConfiguration: {
+   *             accordingTo: 'SubscriptionStart',
+   *           },
+   *           period: '1 week',
+   *           resetPeriod: 'YEAR',
+   *           usageLimit: -9007199254740991,
+   *           weeklyResetPeriodConfiguration: {
+   *             accordingTo: 'SubscriptionStart',
+   *           },
+   *           yearlyResetPeriodConfiguration: {
+   *             accordingTo: 'SubscriptionStart',
+   *           },
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
    */
   create(
     id: string,
-    body: PromotionalEntitlementCreateParams,
+    params: PromotionalEntitlementCreateParams,
     options?: RequestOptions,
   ): APIPromise<PromotionalEntitlementCreateResponse> {
-    return this._client.post(path`/api/v1/customers/${id}/promotional-entitlements`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/customers/${id}/promotional-entitlements`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a paginated list of a customer's promotional entitlements.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const promotionalEntitlementListResponse of client.v1.customers.promotionalEntitlements.list(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     id: string,
-    query: PromotionalEntitlementListParams | null | undefined = {},
+    params: PromotionalEntitlementListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList(
       path`/api/v1/customers/${id}/promotional-entitlements`,
       MyCursorIDPage<PromotionalEntitlementListResponse>,
-      { query, ...options },
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          {
+            ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+            ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+          },
+          options?.headers,
+        ]),
+      },
     );
   }
 
   /**
    * Revokes a previously granted promotional entitlement from a customer for a
    * specific feature.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.customers.promotionalEntitlements.revoke(
+   *     'featureId',
+   *     { id: 'id' },
+   *   );
+   * ```
    */
   revoke(
     featureID: string,
     params: PromotionalEntitlementRevokeParams,
     options?: RequestOptions,
   ): APIPromise<PromotionalEntitlementRevokeResponse> {
-    const { id } = params;
-    return this._client.delete(path`/api/v1/customers/${id}/promotional-entitlements/${featureID}`, options);
+    const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+    return this._client.delete(path`/api/v1/customers/${id}/promotional-entitlements/${featureID}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -494,9 +577,22 @@ export namespace PromotionalEntitlementRevokeResponse {
 
 export interface PromotionalEntitlementCreateParams {
   /**
-   * Promotional entitlements to grant
+   * Body param: Promotional entitlements to grant
    */
   promotionalEntitlements: Array<PromotionalEntitlementCreateParams.PromotionalEntitlement>;
+
+  /**
+   * 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.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
 }
 
 export namespace PromotionalEntitlementCreateParams {
@@ -614,15 +710,28 @@ export namespace PromotionalEntitlementCreateParams {
 
 export interface PromotionalEntitlementListParams extends MyCursorIDPageParams {
   /**
-   * Filter by creation date using range operators: gt, gte, lt, lte
+   * Query param: Filter by creation date using range operators: gt, gte, lt, lte
    */
   createdAt?: PromotionalEntitlementListParams.CreatedAt;
 
   /**
-   * Filter by promotional entitlement status. Supports comma-separated values for
-   * multiple statuses
+   * Query param: Filter by promotional entitlement status. Supports comma-separated
+   * values for multiple statuses
    */
   status?: Array<'Active' | 'Expired' | 'Paused'>;
+
+  /**
+   * 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.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
 }
 
 export namespace PromotionalEntitlementListParams {
@@ -654,9 +763,22 @@ export namespace PromotionalEntitlementListParams {
 
 export interface PromotionalEntitlementRevokeParams {
   /**
-   * The unique identifier of the customer
+   * Path param: The unique identifier of the customer
    */
   id: string;
+
+  /**
+   * 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.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
 }
 
 export declare namespace PromotionalEntitlements {

package/src/resources/v1/events/beta/beta.ts

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

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

@@ -0,0 +1,277 @@
+// 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';
+
+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.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const assignmentListResponse of client.v1.events.beta.customers.assignments.list(
+   *   'id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    id: string,
+    params: AssignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AssignmentListResponsesMyCursorIDPage, AssignmentListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
+    return this._client.getAPIList(
+      path`/api/v1-beta/customers/${id}/assignments`,
+      MyCursorIDPage<AssignmentListResponse>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          {
+            ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+            ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+          },
+          options?.headers,
+        ]),
+      },
+    );
+  }
+
+  /**
+   * 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.
+   *
+   * @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',
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
+   */
+  upsert(
+    id: string,
+    params: AssignmentUpsertParams,
+    options?: RequestOptions,
+  ): APIPromise<AssignmentUpsertResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.put(path`/api/v1-beta/customers/${id}/assignments`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export type AssignmentListResponsesMyCursorIDPage = MyCursorIDPage<AssignmentListResponse>;
+
+/**
+ * A capability assignment for an entity belonging to a customer. Defines how much
+ * of the capability the entity may consume (`usageLimit`) and how often the
+ * counter resets (`cadence`).
+ */
+export interface AssignmentListResponse {
+  /**
+   * Synthetic UUID identifier — also the cursor anchor for paginated lists
+   */
+  id: string;
+
+  /**
+   * Usage-reset cadence. Currently only `MONTH` is supported
+   */
+  cadence: 'MONTH';
+
+  /**
+   * The capability refId this assignment grants
+   */
+  capabilityId: string;
+
+  /**
+   * Timestamp of when the record was created
+   */
+  createdAt: string;
+
+  /**
+   * The entity refId this assignment is attached to
+   */
+  entityId: string;
+
+  /**
+   * Timestamp of when the record was last updated
+   */
+  updatedAt: string;
+
+  /**
+   * Maximum usage allowed within one cadence window
+   */
+  usageLimit: number;
+}
+
+/**
+ * Assignments after upsert.
+ */
+export interface AssignmentUpsertResponse {
+  data: Array<AssignmentUpsertResponse.Data>;
+}
+
+export namespace AssignmentUpsertResponse {
+  /**
+   * A capability assignment for an entity belonging to a customer. Defines how much
+   * of the capability the entity may consume (`usageLimit`) and how often the
+   * counter resets (`cadence`).
+   */
+  export interface Data {
+    /**
+     * Synthetic UUID identifier — also the cursor anchor for paginated lists
+     */
+    id: string;
+
+    /**
+     * Usage-reset cadence. Currently only `MONTH` is supported
+     */
+    cadence: 'MONTH';
+
+    /**
+     * The capability refId this assignment grants
+     */
+    capabilityId: string;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+
+    /**
+     * The entity refId this assignment is attached to
+     */
+    entityId: string;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Maximum usage allowed within one cadence window
+     */
+    usageLimit: number;
+  }
+}
+
+export interface AssignmentListParams extends MyCursorIDPageParams {
+  /**
+   * Query param: Filter assignments to a specific capability refId
+   */
+  capabilityId?: string;
+
+  /**
+   * Query param: Filter assignments to a specific entity refId
+   */
+  entityId?: string;
+
+  /**
+   * 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.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
+}
+
+export interface AssignmentUpsertParams {
+  /**
+   * Body param: Assignments to upsert (1–100 per request)
+   */
+  assignments: Array<AssignmentUpsertParams.Assignment>;
+
+  /**
+   * 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.
+   */
+  'X-ACCOUNT-ID'?: string;
+
+  /**
+   * Header param: Environment ID — required when authenticating with a user JWT
+   * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+   * intrinsic to the key).
+   */
+  'X-ENVIRONMENT-ID'?: string;
+}
+
+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.
+   */
+  export interface Assignment {
+    /**
+     * The capability refId this assignment grants
+     */
+    capabilityId: string;
+
+    /**
+     * The entity refId this assignment is attached to
+     */
+    entityId: string;
+
+    /**
+     * Usage-reset cadence (required on create). Currently only `MONTH` is supported
+     */
+    cadence?: 'MONTH';
+
+    /**
+     * Maximum usage allowed within one cadence window (required on create)
+     */
+    usageLimit?: number;
+  }
+}
+
+export declare namespace Assignments {
+  export {
+    type AssignmentListResponse as AssignmentListResponse,
+    type AssignmentUpsertResponse as AssignmentUpsertResponse,
+    type AssignmentListResponsesMyCursorIDPage as AssignmentListResponsesMyCursorIDPage,
+    type AssignmentListParams as AssignmentListParams,
+    type AssignmentUpsertParams as AssignmentUpsertParams,
+  };
+}

package/src/resources/v1/events/beta/customers/customers.ts

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as AssignmentsAPI from './assignments';
+import {
+  AssignmentListParams,
+  AssignmentListResponse,
+  AssignmentListResponsesMyCursorIDPage,
+  AssignmentUpsertParams,
+  AssignmentUpsertResponse,
+  Assignments,
+} from './assignments';
+import * as EntitiesAPI from './entities';
+import {
+  Entities,
+  EntityArchiveParams,
+  EntityArchiveResponse,
+  EntityListParams,
+  EntityListResponse,
+  EntityListResponsesMyCursorIDPage,
+  EntityRetrieveParams,
+  EntityRetrieveResponse,
+  EntityUnarchiveParams,
+  EntityUnarchiveResponse,
+  EntityUpsertParams,
+  EntityUpsertResponse,
+} from './entities';
+import * as EntitlementsAPI from './entitlements';
+import { EntitlementCheckParams, EntitlementCheckResponse, Entitlements } from './entitlements';
+
+export class Customers extends APIResource {
+  entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
+  entities: EntitiesAPI.Entities = new EntitiesAPI.Entities(this._client);
+  assignments: AssignmentsAPI.Assignments = new AssignmentsAPI.Assignments(this._client);
+}
+
+Customers.Entitlements = Entitlements;
+Customers.Entities = Entities;
+Customers.Assignments = Assignments;
+
+export declare namespace Customers {
+  export {
+    Entitlements as Entitlements,
+    type EntitlementCheckResponse as EntitlementCheckResponse,
+    type EntitlementCheckParams as EntitlementCheckParams,
+  };
+
+  export {
+    Entities as Entities,
+    type EntityRetrieveResponse as EntityRetrieveResponse,
+    type EntityListResponse as EntityListResponse,
+    type EntityArchiveResponse as EntityArchiveResponse,
+    type EntityUnarchiveResponse as EntityUnarchiveResponse,
+    type EntityUpsertResponse as EntityUpsertResponse,
+    type EntityListResponsesMyCursorIDPage as EntityListResponsesMyCursorIDPage,
+    type EntityRetrieveParams as EntityRetrieveParams,
+    type EntityListParams as EntityListParams,
+    type EntityArchiveParams as EntityArchiveParams,
+    type EntityUnarchiveParams as EntityUnarchiveParams,
+    type EntityUpsertParams as EntityUpsertParams,
+  };
+
+  export {
+    Assignments as Assignments,
+    type AssignmentListResponse as AssignmentListResponse,
+    type AssignmentUpsertResponse as AssignmentUpsertResponse,
+    type AssignmentListResponsesMyCursorIDPage as AssignmentListResponsesMyCursorIDPage,
+    type AssignmentListParams as AssignmentListParams,
+    type AssignmentUpsertParams as AssignmentUpsertParams,
+  };
+}