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

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,
+  };
+}

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

@@ -0,0 +1,243 @@
+// 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';
+
+export class Destinations extends APIResource {
+  /**
+   * Register a destination on the environment's DATA_EXPORT integration.
+   * Lazy-creates the integration row + provider recipient on first call. Idempotent
+   * on destinationId.
+   *
+   * @example
+   * ```ts
+   * const destination =
+   *   await client.v1.events.dataExport.destinations.create({
+   *     destinationId: 'x',
+   *     destinationType: 'x',
+   *   });
+   * ```
+   */
+  create(body: DestinationCreateParams, options?: RequestOptions): APIPromise<DestinationCreateResponse> {
+    return this._client.post('/api/v1/data-export/destinations', { body, ...options });
+  }
+
+  /**
+   * Remove a destination from the DATA_EXPORT integration metadata. Idempotent.
+   *
+   * @example
+   * ```ts
+   * const destination =
+   *   await client.v1.events.dataExport.destinations.delete(
+   *     'x',
+   *   );
+   * ```
+   */
+  delete(destinationID: string, options?: RequestOptions): APIPromise<DestinationDeleteResponse> {
+    return this._client.delete(path`/api/v1/data-export/destinations/${destinationID}`, options);
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DestinationCreateResponse {
+  /**
+   * Current destinations under the DATA_EXPORT integration.
+   */
+  data: DestinationCreateResponse.Data;
+}
+
+export namespace DestinationCreateResponse {
+  /**
+   * Current destinations under the DATA_EXPORT integration.
+   */
+  export interface Data {
+    /**
+     * Current destinations under the DATA_EXPORT integration
+     */
+    destinations: Array<Data.Destination>;
+  }
+
+  export namespace Data {
+    /**
+     * A single destination entry under the DATA_EXPORT integration.
+     */
+    export interface Destination {
+      /**
+       * ISO8601 timestamp of when the destination was connected
+       */
+      connectedAt: string;
+
+      /**
+       * Provider destination ID
+       */
+      destinationId: string;
+
+      /**
+       * Destination type (snowflake, bigquery, ...)
+       */
+      type: string;
+
+      /**
+       * Connection status of the destination (connected, failed)
+       */
+      connectionStatus?: string;
+
+      /**
+       * Latest sync snapshot for the destination, refreshed by the provider webhook
+       */
+      lastSyncStatus?: Destination.LastSyncStatus;
+    }
+
+    export namespace Destination {
+      /**
+       * Latest sync snapshot for the destination, refreshed by the provider webhook
+       */
+      export interface LastSyncStatus {
+        /**
+         * ISO8601 timestamp of when the latest sync finished
+         */
+        finishedAt: string;
+
+        /**
+         * Sync status (PENDING, RUNNING, INCOMPLETE, FAILED, SUCCEEDED, CANCELLED)
+         */
+        status: string;
+
+        /**
+         * Provider transfer ID of the latest sync
+         */
+        transferId: string;
+
+        /**
+         * Party responsible for a failed sync, as reported by the data-export provider
+         */
+        blamedParty?: string;
+
+        /**
+         * Customer-friendly failure message, when the latest sync failed
+         */
+        failureMessage?: string;
+
+        /**
+         * Number of rows transferred in the latest sync
+         */
+        rowsTransferred?: number;
+      }
+    }
+  }
+}
+
+/**
+ * Response object
+ */
+export interface DestinationDeleteResponse {
+  /**
+   * Current destinations under the DATA_EXPORT integration.
+   */
+  data: DestinationDeleteResponse.Data;
+}
+
+export namespace DestinationDeleteResponse {
+  /**
+   * Current destinations under the DATA_EXPORT integration.
+   */
+  export interface Data {
+    /**
+     * Current destinations under the DATA_EXPORT integration
+     */
+    destinations: Array<Data.Destination>;
+  }
+
+  export namespace Data {
+    /**
+     * A single destination entry under the DATA_EXPORT integration.
+     */
+    export interface Destination {
+      /**
+       * ISO8601 timestamp of when the destination was connected
+       */
+      connectedAt: string;
+
+      /**
+       * Provider destination ID
+       */
+      destinationId: string;
+
+      /**
+       * Destination type (snowflake, bigquery, ...)
+       */
+      type: string;
+
+      /**
+       * Connection status of the destination (connected, failed)
+       */
+      connectionStatus?: string;
+
+      /**
+       * Latest sync snapshot for the destination, refreshed by the provider webhook
+       */
+      lastSyncStatus?: Destination.LastSyncStatus;
+    }
+
+    export namespace Destination {
+      /**
+       * Latest sync snapshot for the destination, refreshed by the provider webhook
+       */
+      export interface LastSyncStatus {
+        /**
+         * ISO8601 timestamp of when the latest sync finished
+         */
+        finishedAt: string;
+
+        /**
+         * Sync status (PENDING, RUNNING, INCOMPLETE, FAILED, SUCCEEDED, CANCELLED)
+         */
+        status: string;
+
+        /**
+         * Provider transfer ID of the latest sync
+         */
+        transferId: string;
+
+        /**
+         * Party responsible for a failed sync, as reported by the data-export provider
+         */
+        blamedParty?: string;
+
+        /**
+         * Customer-friendly failure message, when the latest sync failed
+         */
+        failureMessage?: string;
+
+        /**
+         * Number of rows transferred in the latest sync
+         */
+        rowsTransferred?: number;
+      }
+    }
+  }
+}
+
+export interface DestinationCreateParams {
+  /**
+   * The provider destination ID returned by the embedded SDK on connect
+   */
+  destinationId: string;
+
+  /**
+   * The destination type (e.g. snowflake, bigquery)
+   */
+  destinationType: string;
+}
+
+export declare namespace Destinations {
+  export {
+    type DestinationCreateResponse as DestinationCreateResponse,
+    type DestinationDeleteResponse as DestinationDeleteResponse,
+    type DestinationCreateParams as DestinationCreateParams,
+  };
+}

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

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  DataExport,
+  type DataExportMintScopedTokenResponse,
+  type DataExportTriggerSyncResponse,
+  type DataExportMintScopedTokenParams,
+  type DataExportTriggerSyncParams,
+} from './data-export';
+export {
+  Destinations,
+  type DestinationCreateResponse,
+  type DestinationDeleteResponse,
+  type DestinationCreateParams,
+} from './destinations';

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

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

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

@@ -0,0 +1,141 @@
+// 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 * as DataExportAPI from './data-export/data-export';
+import {
+  DataExport,
+  DataExportMintScopedTokenParams,
+  DataExportMintScopedTokenResponse,
+  DataExportTriggerSyncParams,
+  DataExportTriggerSyncResponse,
+} from './data-export/data-export';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * Operations related to usage & metering
+ */
+export class Events extends APIResource {
+  beta: BetaAPI.Beta = new BetaAPI.Beta(this._client);
+  dataExport: DataExportAPI.DataExport = new DataExportAPI.DataExport(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(params: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/events', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * 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 {
+  /**
+   * Body param: A list of usage events to report
+   */
+  events: Array<EventReportParams.Event>;
+
+  /**
+   * 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 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;
+Events.DataExport = DataExport;
+
+export declare namespace Events {
+  export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
+
+  export { Beta as Beta };
+
+  export {
+    DataExport as DataExport,
+    type DataExportMintScopedTokenResponse as DataExportMintScopedTokenResponse,
+    type DataExportTriggerSyncResponse as DataExportTriggerSyncResponse,
+    type DataExportMintScopedTokenParams as DataExportMintScopedTokenParams,
+    type DataExportTriggerSyncParams as DataExportTriggerSyncParams,
+  };
+}

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

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Beta } from './beta/index';
+export {
+  DataExport,
+  type DataExportMintScopedTokenResponse,
+  type DataExportTriggerSyncResponse,
+  type DataExportMintScopedTokenParams,
+  type DataExportTriggerSyncParams,
+} from './data-export/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';