@stigg/typescript 0.1.0-beta.46 → 0.1.0-beta.48

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`).
+     */
+    entityTypeId: 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 ID (present when the configured capability is a credit
+     * currency).
+     */
+    currencyId?: string;
+
+    /**
+     * The metered feature ID (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

@@ -7,8 +7,8 @@ import {
   DestinationCreateResponse,
   DestinationDeleteParams,
   DestinationDeleteResponse,
-  DestinationUpdateParams,
-  DestinationUpdateResponse,
+  DestinationUpdateSelectionParams,
+  DestinationUpdateSelectionResponse,
   Destinations,
 } from './destinations';
 import { APIPromise } from '../../../../core/api-promise';
@@ -307,10 +307,10 @@ export declare namespace DataExport {
   export {
     Destinations as Destinations,
     type DestinationCreateResponse as DestinationCreateResponse,
-    type DestinationUpdateResponse as DestinationUpdateResponse,
     type DestinationDeleteResponse as DestinationDeleteResponse,
+    type DestinationUpdateSelectionResponse as DestinationUpdateSelectionResponse,
     type DestinationCreateParams as DestinationCreateParams,
-    type DestinationUpdateParams as DestinationUpdateParams,
     type DestinationDeleteParams as DestinationDeleteParams,
+    type DestinationUpdateSelectionParams as DestinationUpdateSelectionParams,
   };
 }

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

@@ -28,18 +28,17 @@ export class Destinations extends APIResource {
   }
 
   /**
-   * Update a destination's entity selection. Pushes the new enabled_models to the
-   * provider first, then persists the selection. Applies on the next scheduled
-   * transfer.
+   * Disconnect a destination: stops the provider sync (deletes the provider
+   * destination) and removes it from the DATA_EXPORT integration. Non-destructive —
+   * the warehouse table is left intact. Idempotent.
    */
-  update(
+  delete(
     destinationID: string,
-    params: DestinationUpdateParams,
+    params: DestinationDeleteParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DestinationUpdateResponse> {
-    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
-    return this._client.patch(path`/api/v1/data-export/destinations/${destinationID}`, {
-      body,
+  ): APIPromise<DestinationDeleteResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.delete(path`/api/v1/data-export/destinations/${destinationID}`, {
       ...options,
       headers: buildHeaders([
         {
@@ -52,17 +51,18 @@ export class Destinations extends APIResource {
   }
 
   /**
-   * Disconnect a destination: stops the provider sync (deletes the provider
-   * destination) and removes it from the DATA_EXPORT integration. Non-destructive —
-   * the warehouse table is left intact. Idempotent.
+   * Update a destination's entity selection. Pushes the new enabled_models to the
+   * provider first, then persists the selection. Applies on the next scheduled
+   * transfer.
    */
-  delete(
+  updateSelection(
     destinationID: string,
-    params: DestinationDeleteParams | null | undefined = {},
+    params: DestinationUpdateSelectionParams,
     options?: RequestOptions,
-  ): APIPromise<DestinationDeleteResponse> {
-    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
-    return this._client.delete(path`/api/v1/data-export/destinations/${destinationID}`, {
+  ): APIPromise<DestinationUpdateSelectionResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/data-export/destinations/${destinationID}`, {
+      body,
       ...options,
       headers: buildHeaders([
         {
@@ -171,14 +171,14 @@ export namespace DestinationCreateResponse {
 /**
  * Response object
  */
-export interface DestinationUpdateResponse {
+export interface DestinationDeleteResponse {
   /**
    * Current destinations under the DATA_EXPORT integration.
    */
-  data: DestinationUpdateResponse.Data;
+  data: DestinationDeleteResponse.Data;
 }
 
-export namespace DestinationUpdateResponse {
+export namespace DestinationDeleteResponse {
   /**
    * Current destinations under the DATA_EXPORT integration.
    */
@@ -264,14 +264,14 @@ export namespace DestinationUpdateResponse {
 /**
  * Response object
  */
-export interface DestinationDeleteResponse {
+export interface DestinationUpdateSelectionResponse {
   /**
    * Current destinations under the DATA_EXPORT integration.
    */
-  data: DestinationDeleteResponse.Data;
+  data: DestinationUpdateSelectionResponse.Data;
 }
 
-export namespace DestinationDeleteResponse {
+export namespace DestinationUpdateSelectionResponse {
   /**
    * Current destinations under the DATA_EXPORT integration.
    */
@@ -384,7 +384,22 @@ export interface DestinationCreateParams {
   'X-ENVIRONMENT-ID'?: string;
 }
 
-export interface DestinationUpdateParams {
+export interface DestinationDeleteParams {
+  /**
+   * 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 DestinationUpdateSelectionParams {
   /**
    * Body param
    */
@@ -409,28 +424,13 @@ export interface DestinationUpdateParams {
   'X-ENVIRONMENT-ID'?: string;
 }
 
-export interface DestinationDeleteParams {
-  /**
-   * 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 declare namespace Destinations {
   export {
     type DestinationCreateResponse as DestinationCreateResponse,
-    type DestinationUpdateResponse as DestinationUpdateResponse,
     type DestinationDeleteResponse as DestinationDeleteResponse,
+    type DestinationUpdateSelectionResponse as DestinationUpdateSelectionResponse,
     type DestinationCreateParams as DestinationCreateParams,
-    type DestinationUpdateParams as DestinationUpdateParams,
     type DestinationDeleteParams as DestinationDeleteParams,
+    type DestinationUpdateSelectionParams as DestinationUpdateSelectionParams,
   };
 }

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

@@ -12,9 +12,9 @@ export {
 export {
   Destinations,
   type DestinationCreateResponse,
-  type DestinationUpdateResponse,
   type DestinationDeleteResponse,
+  type DestinationUpdateSelectionResponse,
   type DestinationCreateParams,
-  type DestinationUpdateParams,
   type DestinationDeleteParams,
+  type DestinationUpdateSelectionParams,
 } from './destinations';

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

@@ -1,6 +1,8 @@
 // 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,
@@ -20,16 +22,14 @@ import { RequestOptions } from '../../../internal/request-options';
  */
 export class Events extends APIResource {
   dataExport: DataExportAPI.DataExport = new DataExportAPI.DataExport(this._client);
+  beta: BetaAPI.Beta = new BetaAPI.Beta(this._client);
 
   /**
    * Estimates the credit cost of a usage event without ingesting it. Returns the
    * estimated cost per credit currency, the current balance, and the balance after
    * the estimated consumption.
    */
-  estimateCost(
-    params: EventEstimateCostParams,
-    options?: RequestOptions,
-  ): APIPromise<EventEstimateCostResponse> {
+  estimate(params: EventEstimateParams, options?: RequestOptions): APIPromise<EventEstimateResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
     return this._client.post('/api/v1/events/estimate', {
       body,
@@ -67,14 +67,14 @@ export class Events extends APIResource {
 /**
  * Response object
  */
-export interface EventEstimateCostResponse {
+export interface EventEstimateResponse {
   /**
    * Estimated credit cost, current balance and balance after
    */
-  data: EventEstimateCostResponse.Data;
+  data: EventEstimateResponse.Data;
 }
 
-export namespace EventEstimateCostResponse {
+export namespace EventEstimateResponse {
   /**
    * Estimated credit cost, current balance and balance after
    */
@@ -155,7 +155,7 @@ export interface EventReportResponse {
   data: unknown;
 }
 
-export interface EventEstimateCostParams {
+export interface EventEstimateParams {
   /**
    * Body param: Customer id
    */
@@ -248,12 +248,13 @@ export namespace EventReportParams {
 }
 
 Events.DataExport = DataExport;
+Events.Beta = Beta;
 
 export declare namespace Events {
   export {
-    type EventEstimateCostResponse as EventEstimateCostResponse,
+    type EventEstimateResponse as EventEstimateResponse,
     type EventReportResponse as EventReportResponse,
-    type EventEstimateCostParams as EventEstimateCostParams,
+    type EventEstimateParams as EventEstimateParams,
     type EventReportParams as EventReportParams,
   };
 
@@ -266,4 +267,6 @@ export declare namespace Events {
     type DataExportMintScopedTokenParams as DataExportMintScopedTokenParams,
     type DataExportTriggerSyncParams as DataExportTriggerSyncParams,
   };
+
+  export { Beta as Beta };
 }

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

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Beta } from './beta/index';
 export {
   DataExport,
   type DataExportListModelsResponse,
@@ -11,8 +12,8 @@ export {
 } from './data-export/index';
 export {
   Events,
-  type EventEstimateCostResponse,
+  type EventEstimateResponse,
   type EventReportResponse,
-  type EventEstimateCostParams,
+  type EventEstimateParams,
   type EventReportParams,
 } from './events';

package/src/resources/v1/index.ts

@@ -19,6 +19,20 @@ export {
   type AddonListResponsesMyCursorIDPage,
   type AddonListChargesResponsesMyCursorIDPage,
 } from './addons/index';
+export {
+  Contracts,
+  type ContractCreateResponse,
+  type ContractRetrieveResponse,
+  type ContractUpdateResponse,
+  type ContractListResponse,
+  type ContractDeleteResponse,
+  type ContractCreateParams,
+  type ContractRetrieveParams,
+  type ContractUpdateParams,
+  type ContractListParams,
+  type ContractDeleteParams,
+  type ContractListResponsesMyCursorIDPage,
+} from './contracts';
 export {
   Coupons,
   type Coupon,
@@ -47,6 +61,8 @@ export {
   type CustomerListResponse,
   type CustomerCheckEntitlementResponse,
   type CustomerImportResponse,
+  type CustomerListContractsResponse,
+  type CustomerListInvoicesResponse,
   type CustomerListResourcesResponse,
   type CustomerRetrieveEntitlementsResponse,
   type CustomerRetrieveParams,
@@ -55,18 +71,21 @@ export {
   type CustomerArchiveParams,
   type CustomerCheckEntitlementParams,
   type CustomerImportParams,
+  type CustomerListContractsParams,
+  type CustomerListInvoicesParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
   type CustomerRetrieveEntitlementsParams,
   type CustomerUnarchiveParams,
   type CustomerListResponsesMyCursorIDPage,
+  type CustomerListInvoicesResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers/index';
 export {
   Events,
-  type EventEstimateCostResponse,
+  type EventEstimateResponse,
   type EventReportResponse,
-  type EventEstimateCostParams,
+  type EventEstimateParams,
   type EventReportParams,
 } from './events/index';
 export {
@@ -136,10 +155,10 @@ export {
 } from './subscriptions/index';
 export {
   Usage,
-  type UsageEstimateCostResponse,
+  type UsageEstimateResponse,
   type UsageHistoryResponse,
   type UsageReportResponse,
-  type UsageEstimateCostParams,
+  type UsageEstimateParams,
   type UsageHistoryParams,
   type UsageReportParams,
 } from './usage';

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

@@ -2035,6 +2035,17 @@ export namespace PlanUpdateParams {
        */
       billingCadence?: 'RECURRING' | 'ONE_OFF';
 
+      /**
+       * Credit entitlement to grant when a credit overage targets a currency not yet
+       * granted on the plan
+       */
+      creditEntitlement?: OveragePricingModel.CreditEntitlement;
+
+      /**
+       * The refId of the custom currency this credit overage applies to
+       */
+      currencyId?: string;
+
       /**
        * Entitlement configuration for the overage feature
        */
@@ -2044,11 +2055,6 @@ export namespace PlanUpdateParams {
        * The feature ID for overage pricing
        */
       featureId?: string;
-
-      /**
-       * Custom currency ID for overage top-up
-       */
-      topUpCustomCurrencyId?: string;
     }
 
     export namespace OveragePricingModel {
@@ -2529,6 +2535,27 @@ export namespace PlanUpdateParams {
         }
       }
 
+      /**
+       * Credit entitlement to grant when a credit overage targets a currency not yet
+       * granted on the plan
+       */
+      export interface CreditEntitlement {
+        /**
+         * The base credit balance granted per cadence
+         */
+        amount: number;
+
+        /**
+         * The credit grant cadence (MONTH or YEAR)
+         */
+        cadence: 'MONTH' | 'YEAR';
+
+        /**
+         * The refId of the custom currency to grant
+         */
+        customCurrencyId: string;
+      }
+
       /**
        * Entitlement configuration for the overage feature
        */

package/src/resources/v1/subscriptions/subscriptions.ts

@@ -336,6 +336,11 @@ export namespace Subscription {
       | 'AutoCancellationRule'
       | null;
 
+    /**
+     * The Stigg contract this subscription is linked to, when any
+     */
+    contractId?: string | null;
+
     /**
      * Coupons applied to the subscription
      */
@@ -1392,6 +1397,11 @@ export interface SubscriptionListResponse {
     | 'AutoCancellationRule'
     | null;
 
+  /**
+   * The Stigg contract this subscription is linked to, when any
+   */
+  contractId?: string | null;
+
   /**
    * Coupons applied to the subscription
    */
@@ -3039,6 +3049,11 @@ export namespace SubscriptionProvisionResponse {
         | 'AutoCancellationRule'
         | null;
 
+      /**
+       * The Stigg contract this subscription is linked to, when any
+       */
+      contractId?: string | null;
+
       /**
        * Coupons applied to the subscription
        */