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

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

@@ -0,0 +1,149 @@
+// 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;
+    }
+  }
+}
+
+/**
+ * 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;
+    }
+  }
+}
+
+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,116 @@
+// 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 { 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(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;
+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';

package/src/resources/v1/features.ts

@@ -12,6 +12,13 @@ import { path } from '../../internal/utils/path';
 export class Features extends APIResource {
   /**
    * Archives a feature, preventing it from being used in new entitlements.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.archiveFeature(
+   *   'x',
+   * );
+   * ```
    */
   archiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post(path`/api/v1/features/${id}/archive`, options);
@@ -19,6 +26,15 @@ export class Features extends APIResource {
 
   /**
    * Creates a new feature with the specified type, metering, and configuration.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.createFeature({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   featureType: 'BOOLEAN',
+   * });
+   * ```
    */
   createFeature(body: FeatureCreateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post('/api/v1/features', { body, ...options });
@@ -26,6 +42,14 @@ export class Features extends APIResource {
 
   /**
    * Retrieves a paginated list of features in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const featureListFeaturesResponse of client.v1.features.listFeatures()) {
+   *   // ...
+   * }
+   * ```
    */
   listFeatures(
     query: FeatureListFeaturesParams | null | undefined = {},
@@ -39,6 +63,13 @@ export class Features extends APIResource {
 
   /**
    * Retrieves a feature by its unique identifier.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.retrieveFeature(
+   *   'x',
+   * );
+   * ```
    */
   retrieveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.get(path`/api/v1/features/${id}`, options);
@@ -46,6 +77,13 @@ export class Features extends APIResource {
 
   /**
    * Restores an archived feature, allowing it to be used in entitlements again.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.unarchiveFeature(
+   *   'x',
+   * );
+   * ```
    */
   unarchiveFeature(id: string, options?: RequestOptions): APIPromise<Feature> {
     return this._client.post(path`/api/v1/features/${id}/unarchive`, options);
@@ -54,6 +92,11 @@ export class Features extends APIResource {
   /**
    * Updates an existing feature's properties such as display name, description, and
    * configuration.
+   *
+   * @example
+   * ```ts
+   * const feature = await client.v1.features.updateFeature('x');
+   * ```
    */
   updateFeature(id: string, body: FeatureUpdateFeatureParams, options?: RequestOptions): APIPromise<Feature> {
     return this._client.patch(path`/api/v1/features/${id}`, { body, ...options });

package/src/resources/v1/index.ts

@@ -53,7 +53,7 @@ export {
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers/index';
-export { Events, type EventReportResponse, type EventReportParams } from './events';
+export { Events, type EventReportResponse, type EventReportParams } from './events/index';
 export {
   Features,
   type Feature,

package/src/resources/v1/plans/entitlements.ts

@@ -8,6 +8,14 @@ import { path } from '../../../internal/utils/path';
 export class Entitlements extends APIResource {
   /**
    * Creates one or more entitlements (feature or credit) on a draft plan.
+   *
+   * @example
+   * ```ts
+   * const entitlement =
+   *   await client.v1.plans.entitlements.create('planId', {
+   *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+   *   });
+   * ```
    */
   create(
     planID: string,
@@ -19,6 +27,15 @@ export class Entitlements extends APIResource {
 
   /**
    * Updates an existing entitlement on a draft plan.
+   *
+   * @example
+   * ```ts
+   * const planEntitlement =
+   *   await client.v1.plans.entitlements.update('id', {
+   *     planId: 'planId',
+   *     type: 'FEATURE',
+   *   });
+   * ```
    */
   update(id: string, params: EntitlementUpdateParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
     const { planId, ...body } = params;
@@ -27,6 +44,12 @@ export class Entitlements extends APIResource {
 
   /**
    * Retrieves a list of entitlements for a plan.
+   *
+   * @example
+   * ```ts
+   * const entitlements =
+   *   await client.v1.plans.entitlements.list('planId');
+   * ```
    */
   list(planID: string, options?: RequestOptions): APIPromise<EntitlementListResponse> {
     return this._client.get(path`/api/v1/plans/${planID}/entitlements`, options);
@@ -34,6 +57,14 @@ export class Entitlements extends APIResource {
 
   /**
    * Deletes an entitlement from a draft plan.
+   *
+   * @example
+   * ```ts
+   * const planEntitlement =
+   *   await client.v1.plans.entitlements.delete('id', {
+   *     planId: 'planId',
+   *   });
+   * ```
    */
   delete(id: string, params: EntitlementDeleteParams, options?: RequestOptions): APIPromise<PlanEntitlement> {
     const { planId } = params;

package/src/resources/v1/plans/plans.ts

@@ -24,6 +24,15 @@ export class Plans extends APIResource {
 
   /**
    * Creates a new plan in draft status.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.create({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   *   productId: 'productId',
+   * });
+   * ```
    */
   create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post('/api/v1/plans', { body, ...options });
@@ -32,6 +41,11 @@ export class Plans extends APIResource {
   /**
    * Retrieves a plan by its unique identifier, including entitlements and pricing
    * details.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.retrieve('x');
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.get(path`/api/v1/plans/${id}`, options);
@@ -40,6 +54,11 @@ export class Plans extends APIResource {
   /**
    * Updates an existing plan's properties such as display name, description, and
    * metadata.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.update('x');
+   * ```
    */
   update(id: string, body: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan> {
     return this._client.patch(path`/api/v1/plans/${id}`, { body, ...options });
@@ -47,6 +66,14 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves a paginated list of plans in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListResponse of client.v1.plans.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: PlanListParams | null | undefined = {},
@@ -57,6 +84,11 @@ export class Plans extends APIResource {
 
   /**
    * Archives a plan, preventing it from being used in new subscriptions.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.archive('x');
+   * ```
    */
   archive(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post(path`/api/v1/plans/${id}/archive`, options);
@@ -64,6 +96,11 @@ export class Plans extends APIResource {
 
   /**
    * Creates a draft version of an existing plan for modification before publishing.
+   *
+   * @example
+   * ```ts
+   * const plan = await client.v1.plans.createDraft('x');
+   * ```
    */
   createDraft(id: string, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post(path`/api/v1/plans/${id}/draft`, options);
@@ -71,6 +108,16 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of charges configured on a plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListChargesResponse of client.v1.plans.listCharges(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listCharges(
     id: string,
@@ -86,6 +133,16 @@ export class Plans extends APIResource {
 
   /**
    * Retrieves the list of overage charges configured on a plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListOverageChargesResponse of client.v1.plans.listOverageCharges(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listOverageCharges(
     id: string,
@@ -101,6 +158,13 @@ export class Plans extends APIResource {
 
   /**
    * Publishes a draft plan, making it available for use in subscriptions.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.plans.publish('x', {
+   *   migrationType: 'NEW_CUSTOMERS',
+   * });
+   * ```
    */
   publish(id: string, body: PlanPublishParams, options?: RequestOptions): APIPromise<PlanPublishResponse> {
     return this._client.post(path`/api/v1/plans/${id}/publish`, { body, ...options });
@@ -108,6 +172,11 @@ export class Plans extends APIResource {
 
   /**
    * Removes a draft version of a plan.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.plans.removeDraft('x');
+   * ```
    */
   removeDraft(id: string, options?: RequestOptions): APIPromise<PlanRemoveDraftResponse> {
     return this._client.delete(path`/api/v1/plans/${id}/draft`, options);