@stigg/typescript 0.1.0-beta.14 → 0.1.0-beta.15

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,

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);

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-beta/v1-beta.ts → v1/events/beta/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 V1Beta extends APIResource {
+export class Beta extends APIResource {
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   entityTypes: EntityTypesAPI.EntityTypes = new EntityTypesAPI.EntityTypes(this._client);
 }
 
-V1Beta.Customers = Customers;
-V1Beta.EntityTypes = EntityTypes;
+Beta.Customers = Customers;
+Beta.EntityTypes = EntityTypes;
 
-export declare namespace V1Beta {
+export declare namespace Beta {
   export { Customers as Customers };
 
   export {

package/src/resources/{v1-beta → v1/events/beta}/customers/assignments.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 { 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 { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
 
 export class Assignments extends APIResource {
   /**
@@ -15,7 +15,7 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const assignmentListResponse of client.v1Beta.customers.assignments.list(
+   * for await (const assignmentListResponse of client.v1.events.beta.customers.assignments.list(
    *   'id',
    * )) {
    *   // ...
@@ -43,22 +43,25 @@ export class Assignments extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1Beta.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.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(

package/src/resources/{v1-beta → v1/events/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-beta → v1/events/beta}/customers/entities.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 { 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 { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
 
 export class Entities extends APIResource {
   /**
@@ -13,9 +13,10 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const entity =
-   *   await client.v1Beta.customers.entities.retrieve('x', {
-   *     id: 'id',
-   *   });
+   *   await client.v1.events.beta.customers.entities.retrieve(
+   *     'x',
+   *     { id: 'id' },
+   *   );
    * ```
    */
   retrieve(
@@ -33,7 +34,7 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityListResponse of client.v1Beta.customers.entities.list(
+   * for await (const entityListResponse of client.v1.events.beta.customers.entities.list(
    *   'id',
    * )) {
    *   // ...
@@ -58,9 +59,10 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1Beta.customers.entities.archive('id', {
-   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
-   *   });
+   *   await client.v1.events.beta.customers.entities.archive(
+   *     'id',
+   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+   *   );
    * ```
    */
   archive(
@@ -77,9 +79,10 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1Beta.customers.entities.unarchive('id', {
-   *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
-   *   });
+   *   await client.v1.events.beta.customers.entities.unarchive(
+   *     'id',
+   *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+   *   );
    * ```
    */
   unarchive(
@@ -97,20 +100,26 @@ export class Entities extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   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' },
-   *       },
-   *     ],
-   *   });
+   *   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' },
+   *         },
+   *       ],
+   *     },
+   *   );
    * ```
    */
   upsert(id: string, body: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse> {

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

@@ -1,9 +1,9 @@
 // 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 { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
+import { APIResource } from '../../../../../core/resource';
+import { APIPromise } from '../../../../../core/api-promise';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
 
 export class Entitlements extends APIResource {
   /**
@@ -14,7 +14,9 @@ export class Entitlements extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1Beta.customers.entitlements.check('x');
+   *   await client.v1.events.beta.customers.entitlements.check(
+   *     'x',
+   *   );
    * ```
    */
   check(

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

@@ -1,9 +1,9 @@
 // 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 { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../../core/pagination';
+import { RequestOptions } from '../../../../internal/request-options';
 
 export class EntityTypes extends APIResource {
   /**
@@ -14,7 +14,7 @@ export class EntityTypes extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const entityTypeListResponse of client.v1Beta.entityTypes.list()) {
+   * for await (const entityTypeListResponse of client.v1.events.beta.entityTypes.list()) {
    *   // ...
    * }
    * ```
@@ -36,20 +36,21 @@ export class EntityTypes extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1Beta.entityTypes.upsert({
-   *   types: [
-   *     {
-   *       id: 'org',
-   *       displayName: 'Organization',
-   *       attributionKeys: ['organizationId'],
-   *     },
-   *     {
-   *       id: 'team',
-   *       displayName: 'Team',
-   *       attributionKeys: ['teamId'],
-   *     },
-   *   ],
-   * });
+   * const response =
+   *   await client.v1.events.beta.entityTypes.upsert({
+   *     types: [
+   *       {
+   *         id: 'org',
+   *         displayName: 'Organization',
+   *         attributionKeys: ['organizationId'],
+   *       },
+   *       {
+   *         id: 'team',
+   *         displayName: 'Team',
+   *         attributionKeys: ['teamId'],
+   *       },
+   *     ],
+   *   });
    * ```
    */
   upsert(body: EntityTypeUpsertParams, options?: RequestOptions): APIPromise<EntityTypeUpsertResponse> {

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

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

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

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './v1-beta/index';
+export * from './beta/index';

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

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BetaAPI from './beta/beta';
+import { Beta } from './beta/beta';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * Operations related to usage & metering
+ */
+export class Events extends APIResource {
+  beta: BetaAPI.Beta = new BetaAPI.Beta(this._client);
+
+  /**
+   * Reports raw usage events for event-based metering. Events are ingested
+   * asynchronously and aggregated into usage totals.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.events.report({
+   *   events: [
+   *     {
+   *       customerId: 'customerId',
+   *       eventName: 'x',
+   *       idempotencyKey: 'x',
+   *     },
+   *   ],
+   * });
+   * ```
+   */
+  report(body: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
+    return this._client.post('/api/v1/events', { body, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface EventReportResponse {
+  /**
+   * Empty success response confirming that events were successfully ingested and
+   * queued for processing by Stigg's metering system.
+   */
+  data: unknown;
+}
+
+export interface EventReportParams {
+  /**
+   * A list of usage events to report
+   */
+  events: Array<EventReportParams.Event>;
+}
+
+export namespace EventReportParams {
+  /**
+   * Raw usage event
+   */
+  export interface Event {
+    /**
+     * Customer id
+     */
+    customerId: string;
+
+    /**
+     * The name of the usage event
+     */
+    eventName: string;
+
+    /**
+     * Idempotency key
+     */
+    idempotencyKey: string;
+
+    /**
+     * Dimensions associated with the usage event
+     */
+    dimensions?: { [key: string]: string | number | boolean };
+
+    /**
+     * Resource id
+     */
+    resourceId?: string | null;
+
+    /**
+     * Timestamp
+     */
+    timestamp?: string;
+  }
+}
+
+Events.Beta = Beta;
+
+export declare namespace Events {
+  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
+
+  export { Beta as Beta };
+}

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

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta/index';
+export { Events, type EventReportResponse, type EventReportParams } from './events';

package/src/resources/v1/events.ts

@@ -1,77 +1,3 @@
 // 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 { RequestOptions } from '../../internal/request-options';
-
-/**
- * Operations related to usage & metering
- */
-export class Events extends APIResource {
-  /**
-   * Reports raw usage events for event-based metering. Events are ingested
-   * asynchronously and aggregated into usage totals.
-   */
-  report(body: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
-    return this._client.post('/api/v1/events', { body, ...options });
-  }
-}
-
-/**
- * Response object
- */
-export interface EventReportResponse {
-  /**
-   * Empty success response confirming that events were successfully ingested and
-   * queued for processing by Stigg's metering system.
-   */
-  data: unknown;
-}
-
-export interface EventReportParams {
-  /**
-   * A list of usage events to report
-   */
-  events: Array<EventReportParams.Event>;
-}
-
-export namespace EventReportParams {
-  /**
-   * Raw usage event
-   */
-  export interface Event {
-    /**
-     * Customer id
-     */
-    customerId: string;
-
-    /**
-     * The name of the usage event
-     */
-    eventName: string;
-
-    /**
-     * Idempotency key
-     */
-    idempotencyKey: string;
-
-    /**
-     * Dimensions associated with the usage event
-     */
-    dimensions?: { [key: string]: string | number | boolean };
-
-    /**
-     * Resource id
-     */
-    resourceId?: string | null;
-
-    /**
-     * Timestamp
-     */
-    timestamp?: string;
-  }
-}
-
-export declare namespace Events {
-  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
-}
+export * from './events/index';