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

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

@@ -39,6 +39,13 @@ export class Customers extends APIResource {
   /**
    * Retrieves a customer by their unique identifier, including billing information
    * and subscription status.
+   *
+   * @example
+   * ```ts
+   * const customerResponse = await client.v1.customers.retrieve(
+   *   'x',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.get(path`/api/v1/customers/${id}`, options);
@@ -47,6 +54,13 @@ export class Customers extends APIResource {
   /**
    * Updates an existing customer's properties such as name, email, and billing
    * information.
+   *
+   * @example
+   * ```ts
+   * const customerResponse = await client.v1.customers.update(
+   *   'x',
+   * );
+   * ```
    */
   update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.patch(path`/api/v1/customers/${id}`, { body, ...options });
@@ -54,6 +68,14 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of customers in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customerListResponse of client.v1.customers.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: CustomerListParams | null | undefined = {},
@@ -68,6 +90,13 @@ export class Customers extends APIResource {
   /**
    * Archives a customer, preventing new subscriptions. Optionally cancels existing
    * subscriptions.
+   *
+   * @example
+   * ```ts
+   * const customerResponse = await client.v1.customers.archive(
+   *   'x',
+   * );
+   * ```
    */
   archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/archive`, options);
@@ -82,6 +111,13 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.customers.checkEntitlement(
+   *   'x',
+   * );
+   * ```
    */
   checkEntitlement(
     id: string,
@@ -94,6 +130,19 @@ export class Customers extends APIResource {
   /**
    * Imports multiple customers in bulk. Used for migrating customer data from
    * external systems.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.customers.import({
+   *   customers: [
+   *     {
+   *       id: 'id',
+   *       email: 'dev@stainless.com',
+   *       name: 'name',
+   *     },
+   *   ],
+   * });
+   * ```
    */
   import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
     return this._client.post('/api/v1/customers/import', { body, ...options });
@@ -101,6 +150,16 @@ export class Customers extends APIResource {
 
   /**
    * Retrieves a paginated list of resources within the same customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customerListResourcesResponse of client.v1.customers.listResources(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listResources(
     id: string,
@@ -117,6 +176,12 @@ export class Customers extends APIResource {
   /**
    * Creates a new customer and optionally provisions an initial subscription in a
    * single operation.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.provision({ id: 'id' });
+   * ```
    */
   provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post('/api/v1/customers', { body, ...options });
@@ -130,6 +195,12 @@ export class Customers extends APIResource {
    * mechanisms, and low-latency guarantees. It is not recommended for hot-path
    * entitlement checks. For production use, consider using the Stigg Node Server SDK
    * with caching or the Sidecar for low-latency cached responses.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.customers.retrieveEntitlements('x');
+   * ```
    */
   retrieveEntitlements(
     id: string,
@@ -141,6 +212,12 @@ export class Customers extends APIResource {
 
   /**
    * Restores an archived customer, allowing them to create new subscriptions again.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.unarchive('x');
+   * ```
    */
   unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
     return this._client.post(path`/api/v1/customers/${id}/unarchive`, options);
@@ -189,7 +266,9 @@ export namespace CustomerIntegrationResponse {
       | 'SALESFORCE'
       | 'BIG_QUERY'
       | 'OPEN_FGA'
-      | 'APP_STORE';
+      | 'APP_STORE'
+      | 'RECEIVED'
+      | 'PREQUEL';
 
     /**
      * Price billing sync revision data containing billing ID, link URL, and price
@@ -517,7 +596,9 @@ export namespace CustomerResponse {
         | 'SALESFORCE'
         | 'BIG_QUERY'
         | 'OPEN_FGA'
-        | 'APP_STORE';
+        | 'APP_STORE'
+        | 'RECEIVED'
+        | 'PREQUEL';
     }
 
     /**
@@ -1099,7 +1180,9 @@ export namespace CustomerListResponse {
       | 'SALESFORCE'
       | 'BIG_QUERY'
       | 'OPEN_FGA'
-      | 'APP_STORE';
+      | 'APP_STORE'
+      | 'RECEIVED'
+      | 'PREQUEL';
   }
 
   /**
@@ -2050,7 +2133,9 @@ export namespace CustomerUpdateParams {
       | 'SALESFORCE'
       | 'BIG_QUERY'
       | 'OPEN_FGA'
-      | 'APP_STORE';
+      | 'APP_STORE'
+      | 'RECEIVED'
+      | 'PREQUEL';
   }
 
   /**
@@ -2744,7 +2829,9 @@ export namespace CustomerProvisionParams {
       | 'SALESFORCE'
       | 'BIG_QUERY'
       | 'OPEN_FGA'
-      | 'APP_STORE';
+      | 'APP_STORE'
+      | 'RECEIVED'
+      | 'PREQUEL';
   }
 
   /**

package/src/resources/v1/customers/integrations.ts

@@ -10,6 +10,15 @@ import { path } from '../../../internal/utils/path';
 export class Integrations extends APIResource {
   /**
    * Retrieves a specific integration for a customer by integration ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.retrieve(
+   *     'integrationId',
+   *     { id: 'id' },
+   *   );
+   * ```
    */
   retrieve(
     integrationID: string,
@@ -23,6 +32,15 @@ export class Integrations extends APIResource {
   /**
    * Updates a customer's integration link, such as changing the synced external
    * entity ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.update(
+   *     'integrationId',
+   *     { id: 'id', syncedEntityId: 'syncedEntityId' },
+   *   );
+   * ```
    */
   update(
     integrationID: string,
@@ -39,6 +57,16 @@ export class Integrations extends APIResource {
   /**
    * Retrieves a paginated list of a customer's external integrations (billing, CRM,
    * etc.).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const integrationListResponse of client.v1.customers.integrations.list(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     id: string,
@@ -55,6 +83,16 @@ export class Integrations extends APIResource {
   /**
    * Links a customer to an external integration by specifying the vendor and
    * external entity ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.link('x', {
+   *     id: 'id',
+   *     syncedEntityId: 'syncedEntityId',
+   *     vendorIdentifier: 'AUTH0',
+   *   });
+   * ```
    */
   link(
     id: string,
@@ -66,6 +104,15 @@ export class Integrations extends APIResource {
 
   /**
    * Removes the link between a customer and an external integration.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.unlink(
+   *     'integrationId',
+   *     { id: 'id' },
+   *   );
+   * ```
    */
   unlink(
     integrationID: string,
@@ -106,7 +153,9 @@ export interface IntegrationListResponse {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
 
   /**
    * Price billing sync revision data containing billing ID, link URL, and price
@@ -202,6 +251,8 @@ export interface IntegrationListParams extends MyCursorIDPageParams {
     | 'BIG_QUERY'
     | 'OPEN_FGA'
     | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL'
   >;
 }
 
@@ -229,7 +280,9 @@ export interface IntegrationLinkParams {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
 }
 
 export interface IntegrationUnlinkParams {

package/src/resources/v1/customers/payment-method.ts

@@ -13,6 +13,16 @@ export class PaymentMethod extends APIResource {
   /**
    * Attaches a payment method to a customer for billing. Required for paid
    * subscriptions when integrated with a billing provider.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.paymentMethod.attach('x', {
+   *     integrationId: 'integrationId',
+   *     paymentMethodId: 'paymentMethodId',
+   *     vendorIdentifier: 'AUTH0',
+   *   });
+   * ```
    */
   attach(
     id: string,
@@ -25,6 +35,12 @@ export class PaymentMethod extends APIResource {
   /**
    * Removes the payment method from a customer. Ensure active paid subscriptions
    * have an alternative payment method.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.paymentMethod.detach('x');
+   * ```
    */
   detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
     return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);
@@ -55,7 +71,9 @@ export interface PaymentMethodAttachParams {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
 
   /**
    * Customers selected currency

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

@@ -13,6 +13,38 @@ 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,
@@ -24,6 +56,16 @@ export class PromotionalEntitlements extends APIResource {
 
   /**
    * 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,
@@ -40,6 +82,15 @@ export class PromotionalEntitlements extends APIResource {
   /**
    * 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,

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,228 @@
+// 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 { 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,
+    query: AssignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AssignmentListResponsesMyCursorIDPage, AssignmentListResponse> {
+    return this._client.getAPIList(
+      path`/api/v1-beta/customers/${id}/assignments`,
+      MyCursorIDPage<AssignmentListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * 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,
+    body: AssignmentUpsertParams,
+    options?: RequestOptions,
+  ): APIPromise<AssignmentUpsertResponse> {
+    return this._client.put(path`/api/v1-beta/customers/${id}/assignments`, { body, ...options });
+  }
+}
+
+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 {
+  /**
+   * Filter assignments to a specific capability refId
+   */
+  capabilityId?: string;
+
+  /**
+   * Filter assignments to a specific entity refId
+   */
+  entityId?: string;
+}
+
+export interface AssignmentUpsertParams {
+  /**
+   * Assignments to upsert (1–100 per request)
+   */
+  assignments: Array<AssignmentUpsertParams.Assignment>;
+}
+
+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,
+  };
+}