@stigg/typescript 0.1.0-beta.55 → 0.1.0-beta.57

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

@@ -39,28 +39,6 @@ export class DataExport extends APIResource {
     });
   }
 
-  /**
-   * 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.
@@ -146,38 +124,6 @@ export namespace DataExportListModelsResponse {
   }
 }
 
-/**
- * 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
  */
@@ -242,36 +188,6 @@ export interface DataExportListModelsParams {
   '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.
@@ -297,10 +213,8 @@ 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,
   };
 

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

@@ -3,10 +3,8 @@
 export {
   DataExport,
   type DataExportListModelsResponse,
-  type DataExportMintScopedTokenResponse,
   type DataExportTriggerSyncResponse,
   type DataExportListModelsParams,
-  type DataExportMintScopedTokenParams,
   type DataExportTriggerSyncParams,
 } from './data-export';
 export {

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

@@ -8,8 +8,6 @@ import {
   DataExport,
   DataExportListModelsParams,
   DataExportListModelsResponse,
-  DataExportMintScopedTokenParams,
-  DataExportMintScopedTokenResponse,
   DataExportTriggerSyncParams,
   DataExportTriggerSyncResponse,
 } from './data-export/data-export';
@@ -45,8 +43,8 @@ export class Events extends APIResource {
   }
 
   /**
-   * Reports raw usage events for event-based metering. Events are ingested
-   * asynchronously and aggregated into usage totals.
+   * Reports raw usage events for event-based metering. Events are validated and
+   * stored synchronously, then aggregated into usage totals asynchronously.
    */
   report(params: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -172,7 +170,10 @@ export interface EventEstimateParams {
   dimensions?: { [key: string]: string | number | boolean };
 
   /**
-   * Body param: Resource id
+   * Body param: The customer resource this usage applies to. Optional — only
+   * required if the customer has multiple resources (for example, one subscription
+   * per workspace or site) and usage needs to be tracked separately per resource;
+   * omit it to report usage at the customer level.
    */
   resourceId?: string | null;
 
@@ -226,7 +227,9 @@ export namespace EventReportParams {
     eventName: string;
 
     /**
-     * Idempotency key
+     * A key you provide to safely retry the same usage report without double-counting
+     * it. Reports with a previously-seen idempotency key are deduplicated for 7 days;
+     * after that window a retry is treated as new usage.
      */
     idempotencyKey: string;
 
@@ -236,7 +239,10 @@ export namespace EventReportParams {
     dimensions?: { [key: string]: string | number | boolean };
 
     /**
-     * Resource id
+     * The customer resource this usage applies to. Optional — only required if the
+     * customer has multiple resources (for example, one subscription per workspace or
+     * site) and usage needs to be tracked separately per resource; omit it to report
+     * usage at the customer level.
      */
     resourceId?: string | null;
 
@@ -261,10 +267,8 @@ export declare namespace Events {
   export {
     DataExport as DataExport,
     type DataExportListModelsResponse as DataExportListModelsResponse,
-    type DataExportMintScopedTokenResponse as DataExportMintScopedTokenResponse,
     type DataExportTriggerSyncResponse as DataExportTriggerSyncResponse,
     type DataExportListModelsParams as DataExportListModelsParams,
-    type DataExportMintScopedTokenParams as DataExportMintScopedTokenParams,
     type DataExportTriggerSyncParams as DataExportTriggerSyncParams,
   };
 

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

@@ -4,10 +4,8 @@ export { Beta } from './beta/index';
 export {
   DataExport,
   type DataExportListModelsResponse,
-  type DataExportMintScopedTokenResponse,
   type DataExportTriggerSyncResponse,
   type DataExportListModelsParams,
-  type DataExportMintScopedTokenParams,
   type DataExportTriggerSyncParams,
 } from './data-export/index';
 export {

package/src/resources/v1/features.ts

@@ -185,7 +185,8 @@ export namespace Feature {
     featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
 
     /**
-     * The type of the feature
+     * The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric limit or
+     * quantity), or ENUM (one of a fixed set of values).
      */
     featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -205,7 +206,16 @@ export namespace Feature {
     metadata: { [key: string]: string };
 
     /**
-     * The meter type for the feature
+     * Event meter that turns reported events into usage for a metered feature
+     */
+    meter: Data.Meter | null;
+
+    /**
+     * How usage accumulates for this feature. `Incremental` and `Fluctuating` features
+     * track usage from reported events; `None` means the feature's value isn't
+     * usage-tracked — it's just a numeric or enum value carried by the plan (for
+     * example, a seat count or a tier setting) rather than something customers
+     * consume.
      */
     meterType: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -233,6 +243,84 @@ export namespace Feature {
       value: string;
     }
 
+    /**
+     * Event meter that turns reported events into usage for a metered feature
+     */
+    export interface Meter {
+      /**
+       * How the matching events are aggregated into a usage value
+       */
+      aggregation: Meter.Aggregation;
+
+      /**
+       * Event filters. Conditions within a filter are ANDed, and filters are ORed
+       */
+      filters: Array<Meter.Filter>;
+    }
+
+    export namespace Meter {
+      /**
+       * How the matching events are aggregated into a usage value
+       */
+      export interface Aggregation {
+        /**
+         * Aggregation function applied to the matching events
+         */
+        function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+        /**
+         * Aggregation field name
+         */
+        field?: string | null;
+      }
+
+      /**
+       * A set of conditions an event must all match
+       */
+      export interface Filter {
+        /**
+         * Conditions the event must match
+         */
+        conditions: Array<Filter.Condition>;
+      }
+
+      export namespace Filter {
+        /**
+         * Meter filter condition
+         */
+        export interface Condition {
+          /**
+           * Condition field name
+           */
+          field: string;
+
+          /**
+           * Comparison applied to the condition field
+           */
+          operation:
+            | 'EQUALS'
+            | 'NOT_EQUALS'
+            | 'GREATER_THAN'
+            | 'GREATER_THAN_OR_EQUAL'
+            | 'LESS_THAN'
+            | 'LESS_THAN_OR_EQUAL'
+            | 'IS_NULL'
+            | 'IS_NOT_NULL'
+            | 'CONTAINS'
+            | 'STARTS_WITH'
+            | 'ENDS_WITH'
+            | 'IN';
+
+          /**
+           * Condition value
+           */
+          value?: string | null;
+
+          values?: Array<string> | null;
+        }
+      }
+    }
+
     /**
      * Unit transformation to be applied to the reported usage
      */
@@ -295,7 +383,8 @@ export interface FeatureListFeaturesResponse {
   featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
 
   /**
-   * The type of the feature
+   * The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric limit or
+   * quantity), or ENUM (one of a fixed set of values).
    */
   featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -315,7 +404,16 @@ export interface FeatureListFeaturesResponse {
   metadata: { [key: string]: string };
 
   /**
-   * The meter type for the feature
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  meter: FeatureListFeaturesResponse.Meter | null;
+
+  /**
+   * How usage accumulates for this feature. `Incremental` and `Fluctuating` features
+   * track usage from reported events; `None` means the feature's value isn't
+   * usage-tracked — it's just a numeric or enum value carried by the plan (for
+   * example, a seat count or a tier setting) rather than something customers
+   * consume.
    */
   meterType: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -343,6 +441,84 @@ export namespace FeatureListFeaturesResponse {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    aggregation: Meter.Aggregation;
+
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
+    filters: Array<Meter.Filter>;
+  }
+
+  export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
+      function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+      /**
+       * Aggregation field name
+       */
+      field?: string | null;
+    }
+
+    /**
+     * A set of conditions an event must all match
+     */
+    export interface Filter {
+      /**
+       * Conditions the event must match
+       */
+      conditions: Array<Filter.Condition>;
+    }
+
+    export namespace Filter {
+      /**
+       * Meter filter condition
+       */
+      export interface Condition {
+        /**
+         * Condition field name
+         */
+        field: string;
+
+        /**
+         * Comparison applied to the condition field
+         */
+        operation:
+          | 'EQUALS'
+          | 'NOT_EQUALS'
+          | 'GREATER_THAN'
+          | 'GREATER_THAN_OR_EQUAL'
+          | 'LESS_THAN'
+          | 'LESS_THAN_OR_EQUAL'
+          | 'IS_NULL'
+          | 'IS_NOT_NULL'
+          | 'CONTAINS'
+          | 'STARTS_WITH'
+          | 'ENDS_WITH'
+          | 'IN';
+
+        /**
+         * Condition value
+         */
+        value?: string | null;
+
+        values?: Array<string> | null;
+      }
+    }
+  }
+
   /**
    * Unit transformation to be applied to the reported usage
    */
@@ -396,7 +572,8 @@ export interface FeatureCreateFeatureParams {
   displayName: string;
 
   /**
-   * Body param: The type of the feature
+   * Body param: The type of the feature: BOOLEAN (on/off access), NUMBER (a numeric
+   * limit or quantity), or ENUM (one of a fixed set of values).
    */
   featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
 
@@ -431,7 +608,17 @@ export interface FeatureCreateFeatureParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param: The meter type for the feature
+   * Body param: Event meter that turns reported events into usage for a metered
+   * feature
+   */
+  meter?: FeatureCreateFeatureParams.Meter;
+
+  /**
+   * Body param: How usage accumulates for this feature. `Incremental` and
+   * `Fluctuating` features track usage from reported events; `None` means the
+   * feature's value isn't usage-tracked — it's just a numeric or enum value carried
+   * by the plan (for example, a seat count or a tier setting) rather than something
+   * customers consume.
    */
   meterType?: 'None' | 'FLUCTUATING' | 'INCREMENTAL';
 
@@ -467,6 +654,78 @@ export namespace FeatureCreateFeatureParams {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
+  export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    aggregation: Meter.Aggregation;
+
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
+    filters: Array<Meter.Filter>;
+  }
+
+  export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
+    export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
+      function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
+
+      /**
+       * Aggregation field name
+       */
+      field?: string;
+    }
+
+    export interface Filter {
+      /**
+       * Conditions the event must match
+       */
+      conditions: Array<Filter.Condition>;
+    }
+
+    export namespace Filter {
+      export interface Condition {
+        /**
+         * Condition field name
+         */
+        field: string;
+
+        /**
+         * Comparison applied to the condition field
+         */
+        operation:
+          | 'EQUALS'
+          | 'NOT_EQUALS'
+          | 'GREATER_THAN'
+          | 'GREATER_THAN_OR_EQUAL'
+          | 'LESS_THAN'
+          | 'LESS_THAN_OR_EQUAL'
+          | 'IS_NULL'
+          | 'IS_NOT_NULL'
+          | 'CONTAINS'
+          | 'STARTS_WITH'
+          | 'ENDS_WITH'
+          | 'IN';
+
+        /**
+         * Condition value
+         */
+        value?: string;
+
+        values?: Array<string>;
+      }
+    }
+  }
+
   /**
    * Unit transformation to be applied to the reported usage
    */
@@ -625,7 +884,8 @@ export interface FeatureUpdateFeatureParams {
   metadata?: { [key: string]: string };
 
   /**
-   * Body param
+   * Body param: Event meter that turns reported events into usage for a metered
+   * feature
    */
   meter?: FeatureUpdateFeatureParams.Meter;
 
@@ -661,14 +921,29 @@ export namespace FeatureUpdateFeatureParams {
     value: string;
   }
 
+  /**
+   * Event meter that turns reported events into usage for a metered feature
+   */
   export interface Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
     aggregation: Meter.Aggregation;
 
+    /**
+     * Event filters. Conditions within a filter are ANDed, and filters are ORed
+     */
     filters: Array<Meter.Filter>;
   }
 
   export namespace Meter {
+    /**
+     * How the matching events are aggregated into a usage value
+     */
     export interface Aggregation {
+      /**
+       * Aggregation function applied to the matching events
+       */
       function: 'SUM' | 'MAX' | 'MIN' | 'AVG' | 'COUNT' | 'UNIQUE';
 
       /**
@@ -678,6 +953,9 @@ export namespace FeatureUpdateFeatureParams {
     }
 
     export interface Filter {
+      /**
+       * Conditions the event must match
+       */
       conditions: Array<Filter.Condition>;
     }
 
@@ -688,6 +966,9 @@ export namespace FeatureUpdateFeatureParams {
          */
         field: string;
 
+        /**
+         * Comparison applied to the condition field
+         */
         operation:
           | 'EQUALS'
           | 'NOT_EQUALS'