@stigg/typescript 0.1.0-beta.16 → 0.1.0-beta.18

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/data-export/data-export.ts

@@ -0,0 +1,170 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as DestinationsAPI from './destinations';
+import {
+  DestinationCreateParams,
+  DestinationCreateResponse,
+  DestinationDeleteResponse,
+  Destinations,
+} from './destinations';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+
+export class DataExport extends APIResource {
+  destinations: DestinationsAPI.Destinations = new DestinationsAPI.Destinations(this._client);
+
+  /**
+   * Mint a scoped JWT for the FE embedded SDK. Lazy-creates the DATA_EXPORT
+   * integration if needed.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.events.dataExport.mintScopedToken({
+   *     applicationOrigin: 'x',
+   *   });
+   * ```
+   */
+  mintScopedToken(
+    body: DataExportMintScopedTokenParams,
+    options?: RequestOptions,
+  ): APIPromise<DataExportMintScopedTokenResponse> {
+    return this._client.post('/api/v1/data-export/scoped-token', { body, ...options });
+  }
+
+  /**
+   * Trigger a sync for one destination or all destinations under the provider
+   * entity.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.events.dataExport.triggerSync();
+   * ```
+   */
+  triggerSync(
+    body: DataExportTriggerSyncParams,
+    options?: RequestOptions,
+  ): APIPromise<DataExportTriggerSyncResponse> {
+    return this._client.post('/api/v1/data-export/sync', { body, ...options });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DataExportMintScopedTokenResponse {
+  /**
+   * Scoped token + expiry + provider-specific metadata for the FE SDK.
+   */
+  data: DataExportMintScopedTokenResponse.Data;
+}
+
+export namespace DataExportMintScopedTokenResponse {
+  /**
+   * Scoped token + expiry + provider-specific metadata for the FE SDK.
+   */
+  export interface Data {
+    /**
+     * Provider scoped JWT
+     */
+    token: string;
+
+    /**
+     * ISO8601 token expiry
+     */
+    expiresAt: string;
+
+    /**
+     * Provider-specific extras the FE embedded SDK needs
+     */
+    providerMetadata: { [key: string]: unknown };
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DataExportTriggerSyncResponse {
+  /**
+   * Per-destination trigger results across the batch.
+   */
+  data: DataExportTriggerSyncResponse.Data;
+}
+
+export namespace DataExportTriggerSyncResponse {
+  /**
+   * Per-destination trigger results across the batch.
+   */
+  export interface Data {
+    /**
+     * Per-destination trigger results
+     */
+    results: Array<Data.Result>;
+  }
+
+  export namespace Data {
+    /**
+     * Per-destination trigger results.
+     */
+    export interface Result {
+      /**
+       * Provider destination ID
+       */
+      destinationId: string;
+
+      /**
+       * True if a transfer was kicked
+       */
+      triggered: boolean;
+
+      /**
+       * Error message if triggered=false on a hard failure
+       */
+      errorMessage?: string;
+
+      /**
+       * Provider-side transfer ID
+       */
+      transferId?: string;
+    }
+  }
+}
+
+export interface DataExportMintScopedTokenParams {
+  /**
+   * FE origin the resulting JWT is bound to (provider-side anti-fraud)
+   */
+  applicationOrigin: string;
+
+  /**
+   * Pin the token to a specific warehouse connect flow
+   */
+  destinationType?: string;
+}
+
+export interface DataExportTriggerSyncParams {
+  /**
+   * Provider destination ID to sync. Omit to sync all destinations.
+   */
+  destinationId?: string;
+}
+
+DataExport.Destinations = Destinations;
+
+export declare namespace DataExport {
+  export {
+    type DataExportMintScopedTokenResponse as DataExportMintScopedTokenResponse,
+    type DataExportTriggerSyncResponse as DataExportTriggerSyncResponse,
+    type DataExportMintScopedTokenParams as DataExportMintScopedTokenParams,
+    type DataExportTriggerSyncParams as DataExportTriggerSyncParams,
+  };
+
+  export {
+    Destinations as Destinations,
+    type DestinationCreateResponse as DestinationCreateResponse,
+    type DestinationDeleteResponse as DestinationDeleteResponse,
+    type DestinationCreateParams as DestinationCreateParams,
+  };
+}