@stigg/typescript 0.1.0-beta.3 → 0.1.0-beta.31

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

@@ -0,0 +1,212 @@
+// 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';
+
+export class Customers extends APIResource {
+  /**
+   * Queries the customer's governance hierarchy tree, returning a cursor-paginated
+   * list of nodes with their usage configuration (limit, cadence, scope) and current
+   * usage, sortable and filterable by usage. Each node carries `parentId` so the
+   * tree can be rebuilt client-side. Usage is read from a periodically-refreshed
+   * read model and never gates access.
+   */
+  retrieveGovernance(
+    id: string,
+    params: CustomerRetrieveGovernanceParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerRetrieveGovernanceResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
+    return this._client.get(path`/api/v1-beta/customers/${id}/governance`, {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * Paginated list of governance tree nodes, each with its usage configuration and
+ * current usage.
+ */
+export interface CustomerRetrieveGovernanceResponse {
+  data: Array<CustomerRetrieveGovernanceResponse.Data>;
+
+  pagination: CustomerRetrieveGovernanceResponse.Pagination;
+}
+
+export namespace CustomerRetrieveGovernanceResponse {
+  /**
+   * A node of the governance hierarchy tree with its usage configuration (limit,
+   * cadence, scope) and current usage. Usage is read from a periodically-refreshed
+   * read model and may lag the live counter by a short interval; it never gates
+   * access.
+   */
+  export interface Data {
+    /**
+     * Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+     * `PT1M`; `null` when the node has no usage configuration.
+     */
+    cadence: string | null;
+
+    /**
+     * Usage consumed in the current cadence period (may lag the live counter by a
+     * short interval).
+     */
+    currentUsage: number | null;
+
+    /**
+     * External id of the entity at this node.
+     */
+    entityId: string;
+
+    /**
+     * External id of the entity type (e.g. `team`, `user`).
+     */
+    entityType: string;
+
+    /**
+     * External id of the parent entity in the tree; `null` for a root. Use it to
+     * rebuild the tree.
+     */
+    parentId: string | null;
+
+    /**
+     * The configuration scope (entity ids). Empty is the node-wide configuration; a
+     * non-empty set is a dimension-scoped sub-configuration.
+     */
+    scopeEntityIds: Array<string>;
+
+    /**
+     * Hard usage limit for this node per cadence period.
+     */
+    usageLimit: number | null;
+
+    /**
+     * Exclusive end of the cadence period — when usage resets; `null` once the period
+     * has rolled over.
+     */
+    usagePeriodEnd: string | null;
+
+    /**
+     * Start of the cadence period the usage snapshot belongs to; `null` once the
+     * period has rolled over.
+     */
+    usagePeriodStart: string | null;
+
+    /**
+     * `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The
+     * cross-capability-safe sort key.
+     */
+    utilization: number | null;
+
+    /**
+     * The metered currency refId (present when the configured capability is a credit
+     * currency).
+     */
+    currencyId?: string;
+
+    /**
+     * The metered feature refId (present when the configured capability is a feature).
+     */
+    featureId?: string;
+  }
+
+  export interface Pagination {
+    /**
+     * Cursor for fetching the next page of results, or null if no additional pages
+     * exist
+     */
+    next: string | null;
+  }
+}
+
+export interface CustomerRetrieveGovernanceParams {
+  /**
+   * Query param: Return items that come after this cursor
+   */
+  after?: string;
+
+  /**
+   * Query param: Currency ids to include, repeated per value (e.g.
+   * `?currencyIds=credits`). Omit both featureIds and currencyIds for tree mode.
+   */
+  currencyIds?: Array<string>;
+
+  /**
+   * Query param: Case-insensitive substring match on the entity id (`%`/`_` matched
+   * literally).
+   */
+  entityIdSearch?: string;
+
+  /**
+   * Query param: Filter to one or more entity types, repeated per value (e.g.
+   * `?entityTypeIds=team&entityTypeIds=user`).
+   */
+  entityTypeIds?: Array<string>;
+
+  /**
+   * Query param: Feature ids to include, repeated per value (e.g.
+   * `?featureIds=ai-tokens&featureIds=seats`). Omit both featureIds and currencyIds
+   * for tree mode — every node in the hierarchy with no usage configuration
+   * attached.
+   */
+  featureIds?: Array<string>;
+
+  /**
+   * Query param: Maximum number of items to return
+   */
+  limit?: number;
+
+  /**
+   * Query param: Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for
+   * at/over limit).
+   */
+  minUtilization?: number;
+
+  /**
+   * Query param: Sort direction: `asc` or `desc` (default `desc`).
+   */
+  order?: 'asc' | 'desc';
+
+  /**
+   * Query param: Filter by configuration scope: `all` (default), `nodeWide` (`[]`
+   * only), or `scoped` (non-empty only).
+   */
+  scope?: 'all' | 'nodeWide' | 'scoped';
+
+  /**
+   * Query param: Sort key: `utilization` (default, cross-capability-safe),
+   * `currentUsage`, `usageLimit`, `scopeSize`, `id`, or `createdAt`.
+   */
+  sortBy?: 'utilization' | 'currentUsage' | 'usageLimit' | 'scopeSize' | 'id' | 'createdAt';
+
+  /**
+   * 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 Customers {
+  export {
+    type CustomerRetrieveGovernanceResponse as CustomerRetrieveGovernanceResponse,
+    type CustomerRetrieveGovernanceParams as CustomerRetrieveGovernanceParams,
+  };
+}

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

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta';
+export {
+  Customers,
+  type CustomerRetrieveGovernanceResponse,
+  type CustomerRetrieveGovernanceParams,
+} from './customers';

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

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

package/src/resources/v1/events/data-export/data-export.ts

@@ -0,0 +1,312 @@
+// 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,
+  DestinationDeleteParams,
+  DestinationDeleteResponse,
+  Destinations,
+} from './destinations';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+
+export class DataExport extends APIResource {
+  destinations: DestinationsAPI.Destinations = new DestinationsAPI.Destinations(this._client);
+
+  /**
+   * List the catalog of data-export models the customer can opt into when connecting
+   * a destination.
+   */
+  listModels(
+    params: DataExportListModelsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DataExportListModelsResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.get('/api/v1/data-export/models', {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Mint a scoped JWT for the FE embedded SDK. Lazy-creates the DATA_EXPORT
+   * integration if needed.
+   */
+  mintScopedToken(
+    params: DataExportMintScopedTokenParams,
+    options?: RequestOptions,
+  ): APIPromise<DataExportMintScopedTokenResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/data-export/scoped-token', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Trigger a sync for one destination or all destinations under the provider
+   * entity.
+   */
+  triggerSync(
+    params: DataExportTriggerSyncParams,
+    options?: RequestOptions,
+  ): APIPromise<DataExportTriggerSyncResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/data-export/sync', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DataExportListModelsResponse {
+  /**
+   * Grouped catalog of every data-export model a destination can opt into.
+   */
+  data: DataExportListModelsResponse.Data;
+}
+
+export namespace DataExportListModelsResponse {
+  /**
+   * Grouped catalog of every data-export model a destination can opt into.
+   */
+  export interface Data {
+    /**
+     * Groups of data-export models, in display order
+     */
+    groups: Array<Data.Group>;
+  }
+
+  export namespace Data {
+    /**
+     * A group of related data-export models, mirroring the public docs taxonomy.
+     */
+    export interface Group {
+      /**
+       * Stable group identifier
+       */
+      id: string;
+
+      /**
+       * Customer-facing group label
+       */
+      displayName: string;
+
+      /**
+       * Models in this group
+       */
+      models: Array<Group.Model>;
+    }
+
+    export namespace Group {
+      /**
+       * A single data-export model the customer can opt into.
+       */
+      export interface Model {
+        /**
+         * Wire identifier — what gets persisted on the destination and registered with the
+         * provider
+         */
+        id: string;
+
+        /**
+         * Customer-facing label for the model
+         */
+        displayName: string;
+      }
+    }
+  }
+}
+
+/**
+ * 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 DataExportListModelsParams {
+  /**
+   * 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;
+
+  /**
+   * 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 DataExportMintScopedTokenParams {
+  /**
+   * Body param: FE origin the resulting JWT is bound to (provider-side anti-fraud)
+   */
+  applicationOrigin: string;
+
+  /**
+   * Body param: Pin the token to a specific warehouse connect flow
+   */
+  destinationType?: string;
+
+  /**
+   * Body param
+   */
+  enabledModels?: Array<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 DataExportTriggerSyncParams {
+  /**
+   * Body param: Provider destination ID to sync. Omit to sync all destinations.
+   */
+  destinationId?: 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;
+}
+
+DataExport.Destinations = Destinations;
+
+export declare namespace DataExport {
+  export {
+    type DataExportListModelsResponse as DataExportListModelsResponse,
+    type DataExportMintScopedTokenResponse as DataExportMintScopedTokenResponse,
+    type DataExportTriggerSyncResponse as DataExportTriggerSyncResponse,
+    type DataExportListModelsParams as DataExportListModelsParams,
+    type DataExportMintScopedTokenParams as DataExportMintScopedTokenParams,
+    type DataExportTriggerSyncParams as DataExportTriggerSyncParams,
+  };
+
+  export {
+    Destinations as Destinations,
+    type DestinationCreateResponse as DestinationCreateResponse,
+    type DestinationDeleteResponse as DestinationDeleteResponse,
+    type DestinationCreateParams as DestinationCreateParams,
+    type DestinationDeleteParams as DestinationDeleteParams,
+  };
+}