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

package/src/resources/v1/index.ts

@@ -64,9 +64,9 @@ export {
 } from './customers/index';
 export {
   Events,
-  type EventEstimateCostResponse,
+  type EventEstimateResponse,
   type EventReportResponse,
-  type EventEstimateCostParams,
+  type EventEstimateParams,
   type EventReportParams,
 } from './events/index';
 export {
@@ -136,10 +136,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/usage.ts

@@ -15,10 +15,7 @@ export class Usage extends APIResource {
    * estimated cost per credit currency, the current balance, and the balance after
    * the estimated consumption.
    */
-  estimateCost(
-    params: UsageEstimateCostParams,
-    options?: RequestOptions,
-  ): APIPromise<UsageEstimateCostResponse> {
+  estimate(params: UsageEstimateParams, options?: RequestOptions): APIPromise<UsageEstimateResponse> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
     return this._client.post('/api/v1/usage/estimate', {
       body,
@@ -78,14 +75,14 @@ export class Usage extends APIResource {
 /**
  * Response object
  */
-export interface UsageEstimateCostResponse {
+export interface UsageEstimateResponse {
   /**
    * Estimated credit cost, current balance and balance after
    */
-  data: UsageEstimateCostResponse.Data;
+  data: UsageEstimateResponse.Data;
 }
 
-export namespace UsageEstimateCostResponse {
+export namespace UsageEstimateResponse {
   /**
    * Estimated credit cost, current balance and balance after
    */
@@ -376,7 +373,7 @@ export namespace UsageReportResponse {
   }
 }
 
-export interface UsageEstimateCostParams {
+export interface UsageEstimateParams {
   /**
    * Body param: Customer id
    */
@@ -530,10 +527,10 @@ export namespace UsageReportParams {
 
 export declare namespace Usage {
   export {
-    type UsageEstimateCostResponse as UsageEstimateCostResponse,
+    type UsageEstimateResponse as UsageEstimateResponse,
     type UsageHistoryResponse as UsageHistoryResponse,
     type UsageReportResponse as UsageReportResponse,
-    type UsageEstimateCostParams as UsageEstimateCostParams,
+    type UsageEstimateParams as UsageEstimateParams,
     type UsageHistoryParams as UsageHistoryParams,
     type UsageReportParams as UsageReportParams,
   };

package/src/resources/v1/v1.ts

@@ -42,8 +42,8 @@ import {
 import * as UsageAPI from './usage';
 import {
   Usage,
-  UsageEstimateCostParams,
-  UsageEstimateCostResponse,
+  UsageEstimateParams,
+  UsageEstimateResponse,
   UsageHistoryParams,
   UsageHistoryResponse,
   UsageReportParams,
@@ -105,8 +105,8 @@ import {
 } from './customers/customers';
 import * as EventsAPI from './events/events';
 import {
-  EventEstimateCostParams,
-  EventEstimateCostResponse,
+  EventEstimateParams,
+  EventEstimateResponse,
   EventReportParams,
   EventReportResponse,
   Events,
@@ -237,9 +237,9 @@ export declare namespace V1 {
 
   export {
     Events as Events,
-    type EventEstimateCostResponse as EventEstimateCostResponse,
+    type EventEstimateResponse as EventEstimateResponse,
     type EventReportResponse as EventReportResponse,
-    type EventEstimateCostParams as EventEstimateCostParams,
+    type EventEstimateParams as EventEstimateParams,
     type EventReportParams as EventReportParams,
   };
 
@@ -312,10 +312,10 @@ export declare namespace V1 {
 
   export {
     Usage as Usage,
-    type UsageEstimateCostResponse as UsageEstimateCostResponse,
+    type UsageEstimateResponse as UsageEstimateResponse,
     type UsageHistoryResponse as UsageHistoryResponse,
     type UsageReportResponse as UsageReportResponse,
-    type UsageEstimateCostParams as UsageEstimateCostParams,
+    type UsageEstimateParams as UsageEstimateParams,
     type UsageHistoryParams as UsageHistoryParams,
     type UsageReportParams as UsageReportParams,
   };

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

@@ -27,217 +27,11 @@ import {
 } from './entities';
 import * as EntitlementsAPI from './entitlements';
 import { EntitlementCheckParams, EntitlementCheckResponse, Entitlements } from './entitlements';
-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 {
   entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
   entities: EntitiesAPI.Entities = new EntitiesAPI.Entities(this._client);
   assignments: AssignmentsAPI.Assignments = new AssignmentsAPI.Assignments(this._client);
-
-  /**
-   * 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.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1Beta.customers.retrieveGovernance('id');
-   * ```
-   */
-  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;
 }
 
 Customers.Entitlements = Entitlements;
@@ -245,11 +39,6 @@ Customers.Entities = Entities;
 Customers.Assignments = Assignments;
 
 export declare namespace Customers {
-  export {
-    type CustomerRetrieveGovernanceResponse as CustomerRetrieveGovernanceResponse,
-    type CustomerRetrieveGovernanceParams as CustomerRetrieveGovernanceParams,
-  };
-
   export {
     Entitlements as Entitlements,
     type EntitlementCheckResponse as EntitlementCheckResponse,

package/src/resources/v1-beta/customers/index.ts

@@ -8,11 +8,7 @@ export {
   type AssignmentUpsertParams,
   type AssignmentListResponsesMyCursorIDPage,
 } from './assignments';
-export {
-  Customers,
-  type CustomerRetrieveGovernanceResponse,
-  type CustomerRetrieveGovernanceParams,
-} from './customers';
+export { Customers } from './customers';
 export {
   Entities,
   type EntityRetrieveResponse,

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

@@ -1,10 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Customers,
-  type CustomerRetrieveGovernanceResponse,
-  type CustomerRetrieveGovernanceParams,
-} from './customers/index';
+export { Customers } from './customers/index';
 export {
   EntityTypes,
   type EntityTypeListResponse,

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

@@ -11,11 +11,7 @@ import {
   EntityTypes,
 } from './entity-types';
 import * as CustomersAPI from './customers/customers';
-import {
-  CustomerRetrieveGovernanceParams,
-  CustomerRetrieveGovernanceResponse,
-  Customers,
-} from './customers/customers';
+import { Customers } from './customers/customers';
 
 export class V1Beta extends APIResource {
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
@@ -26,11 +22,7 @@ V1Beta.Customers = Customers;
 V1Beta.EntityTypes = EntityTypes;
 
 export declare namespace V1Beta {
-  export {
-    Customers as Customers,
-    type CustomerRetrieveGovernanceResponse as CustomerRetrieveGovernanceResponse,
-    type CustomerRetrieveGovernanceParams as CustomerRetrieveGovernanceParams,
-  };
+  export { Customers as Customers };
 
   export {
     EntityTypes as EntityTypes,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-beta.46'; // x-release-please-version
+export const VERSION = '0.1.0-beta.47'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.46";
+export declare const VERSION = "0.1.0-beta.47";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.46";
+export declare const VERSION = "0.1.0-beta.47";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-beta.46'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.47'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-beta.46'; // x-release-please-version
+export const VERSION = '0.1.0-beta.47'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map