@stigg/typescript 0.1.0-beta.35 → 0.1.0-beta.37

package/src/resources/v1/credits/consumption.ts

@@ -0,0 +1,266 @@
+// 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';
+
+export class Consumption extends APIResource {
+  /**
+   * Consumes a specified amount of credits directly from a customer wallet, with no
+   * feature mapping. Returns the optimistic balance.
+   */
+  consume(
+    params: ConsumptionConsumeParams,
+    options?: RequestOptions,
+  ): APIPromise<ConsumptionConsumeResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/credits/consumption', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Consumes credits directly from customer wallets asynchronously. Consumptions are
+   * reconciled asynchronously into the credit balances.
+   */
+  consumeAsync(
+    params: ConsumptionConsumeAsyncParams,
+    options?: RequestOptions,
+  ): APIPromise<ConsumptionConsumeAsyncResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/credits/consumption/async', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+/**
+ * Response object
+ */
+export interface ConsumptionConsumeResponse {
+  /**
+   * Result of a synchronous direct credit consumption
+   */
+  data: ConsumptionConsumeResponse.Data;
+}
+
+export namespace ConsumptionConsumeResponse {
+  /**
+   * Result of a synchronous direct credit consumption
+   */
+  export interface Data {
+    /**
+     * The amount of credits consumed
+     */
+    amount: number;
+
+    /**
+     * The credit currency the credits were consumed from
+     */
+    currencyId: string;
+
+    /**
+     * The customer the credits were consumed from
+     */
+    customerId: string;
+
+    /**
+     * The timestamp the consumption was attributed to
+     */
+    timestamp: string;
+
+    /**
+     * The optimistic credit balance after consumption (when sync credit consumption is
+     * enabled)
+     */
+    credit?: Data.Credit | null;
+
+    /**
+     * The resource the consumption was attributed to
+     */
+    resourceId?: string | null;
+  }
+
+  export namespace Data {
+    /**
+     * The optimistic credit balance after consumption (when sync credit consumption is
+     * enabled)
+     */
+    export interface Credit {
+      /**
+       * The credit currency identifier
+       */
+      currencyId: string;
+
+      /**
+       * The credits consumed (optimistic — includes not-yet-reconciled usage)
+       */
+      currentUsage: number;
+
+      /**
+       * The grant-version timestamp of this balance, used by the SDK for last-write-wins
+       * reconciliation
+       */
+      timestamp: string;
+
+      /**
+       * The total credits granted
+       */
+      usageLimit: number;
+
+      /**
+       * End of the current credit grant period (when recurring credits reset), if
+       * applicable
+       */
+      usagePeriodEnd?: string | null;
+    }
+  }
+}
+
+/**
+ * Response object
+ */
+export interface ConsumptionConsumeAsyncResponse {
+  /**
+   * Confirmation that the credit consumptions were accepted for processing
+   */
+  data: unknown;
+}
+
+export interface ConsumptionConsumeParams {
+  /**
+   * Body param: The amount of credits to consume
+   */
+  amount: number;
+
+  /**
+   * Body param: The credit currency to consume from (required)
+   */
+  currencyId: string;
+
+  /**
+   * Body param: The customer to consume credits from (required)
+   */
+  customerId: string;
+
+  /**
+   * Body param: A unique key used to deduplicate the consumption (required)
+   */
+  idempotencyKey: string;
+
+  /**
+   * Body param: Optional timestamp the consumption is attributed to
+   */
+  createdAt?: string;
+
+  /**
+   * Body param: Optional dimensions describing the consumption
+   */
+  dimensions?: { [key: string]: string | number | boolean };
+
+  /**
+   * Body param: Optional resource the consumption is attributed to
+   */
+  resourceId?: 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 ConsumptionConsumeAsyncParams {
+  /**
+   * Body param: The credit consumptions to report (up to 1000)
+   */
+  consumptions: Array<ConsumptionConsumeAsyncParams.Consumption>;
+
+  /**
+   * 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 ConsumptionConsumeAsyncParams {
+  /**
+   * Request body for consuming credits directly from a wallet
+   */
+  export interface Consumption {
+    /**
+     * The amount of credits to consume
+     */
+    amount: number;
+
+    /**
+     * The credit currency to consume from (required)
+     */
+    currencyId: string;
+
+    /**
+     * The customer to consume credits from (required)
+     */
+    customerId: string;
+
+    /**
+     * A unique key used to deduplicate the consumption (required)
+     */
+    idempotencyKey: string;
+
+    /**
+     * Optional timestamp the consumption is attributed to
+     */
+    createdAt?: string;
+
+    /**
+     * Optional dimensions describing the consumption
+     */
+    dimensions?: { [key: string]: string | number | boolean };
+
+    /**
+     * Optional resource the consumption is attributed to
+     */
+    resourceId?: string;
+  }
+}
+
+export declare namespace Consumption {
+  export {
+    type ConsumptionConsumeResponse as ConsumptionConsumeResponse,
+    type ConsumptionConsumeAsyncResponse as ConsumptionConsumeAsyncResponse,
+    type ConsumptionConsumeParams as ConsumptionConsumeParams,
+    type ConsumptionConsumeAsyncParams as ConsumptionConsumeAsyncParams,
+  };
+}

package/src/resources/v1/credits/credits.ts

@@ -1,6 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as ConsumptionAPI from './consumption';
+import {
+  Consumption,
+  ConsumptionConsumeAsyncParams,
+  ConsumptionConsumeAsyncResponse,
+  ConsumptionConsumeParams,
+  ConsumptionConsumeResponse,
+} from './consumption';
 import * as CustomCurrenciesAPI from './custom-currencies';
 import {
   CustomCurrencies,
@@ -35,6 +43,7 @@ export class Credits extends APIResource {
   customCurrencies: CustomCurrenciesAPI.CustomCurrencies = new CustomCurrenciesAPI.CustomCurrencies(
     this._client,
   );
+  consumption: ConsumptionAPI.Consumption = new ConsumptionAPI.Consumption(this._client);
 
   /**
    * Retrieves the automatic recharge configuration for a customer and currency.
@@ -502,6 +511,7 @@ export interface CreditListLedgerParams extends MyCursorIDPageParams {
 
 Credits.Grants = Grants;
 Credits.CustomCurrencies = CustomCurrencies;
+Credits.Consumption = Consumption;
 
 export declare namespace Credits {
   export {
@@ -537,4 +547,12 @@ export declare namespace Credits {
     type CustomCurrencyListAssociatedEntitiesParams as CustomCurrencyListAssociatedEntitiesParams,
     type CustomCurrencyUnarchiveParams as CustomCurrencyUnarchiveParams,
   };
+
+  export {
+    Consumption as Consumption,
+    type ConsumptionConsumeResponse as ConsumptionConsumeResponse,
+    type ConsumptionConsumeAsyncResponse as ConsumptionConsumeAsyncResponse,
+    type ConsumptionConsumeParams as ConsumptionConsumeParams,
+    type ConsumptionConsumeAsyncParams as ConsumptionConsumeAsyncParams,
+  };
 }

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

@@ -1,5 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Consumption,
+  type ConsumptionConsumeResponse,
+  type ConsumptionConsumeAsyncResponse,
+  type ConsumptionConsumeParams,
+  type ConsumptionConsumeAsyncParams,
+} from './consumption';
 export {
   Credits,
   type CreditGetAutoRechargeResponse,

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

@@ -72,7 +72,7 @@ export namespace CustomerRetrieveGovernanceResponse {
     /**
      * External id of the entity type (e.g. `team`, `user`).
      */
-    entityType: string;
+    entityTypeId: string;
 
     /**
      * External id of the parent entity in the tree; `null` for a root. Use it to
@@ -110,13 +110,13 @@ export namespace CustomerRetrieveGovernanceResponse {
     utilization: number | null;
 
     /**
-     * The metered currency refId (present when the configured capability is a credit
+     * The metered currency ID (present when the configured capability is a credit
      * currency).
      */
     currencyId?: string;
 
     /**
-     * The metered feature refId (present when the configured capability is a feature).
+     * The metered feature ID (present when the configured capability is a feature).
      */
     featureId?: string;
   }

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

@@ -120,20 +120,19 @@ export interface AssignmentListResponse {
   createdAt: string;
 
   /**
-   * The entity refId this assignment is attached to
+   * The entity ID this assignment is attached to
    */
   entityId: string;
 
   /**
-   * Parent entity refId in the hierarchy, or `null` for a root.
+   * Parent entity ID in the hierarchy, or `null` for a root.
    */
   parentId: string | null;
 
   /**
-   * Dimension-scoped sub-budget key: the set of entity refIds this budget applies
-   * to. Empty is the node-wide budget that always matches; a non-empty set only
-   * applies when every listed entity is present in the resolved set
-   * (order-insensitive).
+   * Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
+   * Empty is the node-wide budget that always matches; a non-empty set only applies
+   * when every listed entity is present in the resolved set (order-insensitive).
    */
   scopeEntityIds: Array<string>;
 
@@ -148,12 +147,12 @@ export interface AssignmentListResponse {
   usageLimit: number | null;
 
   /**
-   * Currency refId this assignment grants (present for credit capabilities).
+   * Currency ID this assignment grants (present for credit capabilities).
    */
   currencyId?: string;
 
   /**
-   * Feature refId this assignment grants (present for feature capabilities).
+   * Feature ID this assignment grants (present for feature capabilities).
    */
   featureId?: string;
 }
@@ -189,20 +188,19 @@ export namespace AssignmentUpsertResponse {
     createdAt: string;
 
     /**
-     * The entity refId this assignment is attached to
+     * The entity ID this assignment is attached to
      */
     entityId: string;
 
     /**
-     * Parent entity refId in the hierarchy, or `null` for a root.
+     * Parent entity ID in the hierarchy, or `null` for a root.
      */
     parentId: string | null;
 
     /**
-     * Dimension-scoped sub-budget key: the set of entity refIds this budget applies
-     * to. Empty is the node-wide budget that always matches; a non-empty set only
-     * applies when every listed entity is present in the resolved set
-     * (order-insensitive).
+     * Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
+     * Empty is the node-wide budget that always matches; a non-empty set only applies
+     * when every listed entity is present in the resolved set (order-insensitive).
      */
     scopeEntityIds: Array<string>;
 
@@ -217,12 +215,12 @@ export namespace AssignmentUpsertResponse {
     usageLimit: number | null;
 
     /**
-     * Currency refId this assignment grants (present for credit capabilities).
+     * Currency ID this assignment grants (present for credit capabilities).
      */
     currencyId?: string;
 
     /**
-     * Feature refId this assignment grants (present for feature capabilities).
+     * Feature ID this assignment grants (present for feature capabilities).
      */
     featureId?: string;
   }
@@ -230,12 +228,12 @@ export namespace AssignmentUpsertResponse {
 
 export interface AssignmentListParams extends MyCursorIDPageParams {
   /**
-   * Query param: Filter assignments to a specific capability refId
+   * Query param: Filter assignments to a specific capability ID
    */
   capabilityId?: string;
 
   /**
-   * Query param: Filter assignments to a specific entity refId
+   * Query param: Filter assignments to a specific entity ID
    */
   entityId?: string;
 
@@ -283,7 +281,7 @@ export namespace AssignmentUpsertParams {
    */
   export interface Assignment {
     /**
-     * The entity refId this assignment is attached to
+     * The entity ID this assignment is attached to
      */
     entityId: string;
 
@@ -294,20 +292,20 @@ export namespace AssignmentUpsertParams {
     cadence?: string;
 
     /**
-     * Currency refId this assignment grants (credit budgets). Mutually exclusive with
+     * Currency ID this assignment grants (credit budgets). Mutually exclusive with
      * `featureId`.
      */
     currencyId?: string;
 
     /**
-     * Feature refId this assignment grants. Mutually exclusive with `currencyId`.
+     * Feature ID this assignment grants. Mutually exclusive with `currencyId`.
      */
     featureId?: string;
 
     /**
-     * Parent entity refId in the hierarchy. Omit to leave the current parent untouched
-     * (a new node defaults to a root); `null` detaches to a root; a refId sets or
-     * changes the parent. Reparenting an existing node is leaf-only.
+     * Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
+     * new node defaults to a root); `null` detaches to a root; an ID sets or changes
+     * the parent. Reparenting an existing node is leaf-only.
      */
     parentId?: string | null;
 

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

@@ -144,12 +144,12 @@ export class Entities extends APIResource {
    *     entities: [
    *       {
    *         id: 'user-7f3a0c1d',
-   *         typeRefId: 'user',
+   *         entityTypeId: 'user',
    *         metadata: { email: 'jane@acme.com', role: 'admin' },
    *       },
    *       {
    *         id: 'user-c4d1b2e9',
-   *         typeRefId: 'user',
+   *         entityTypeId: 'user',
    *         metadata: { email: 'john@acme.com' },
    *       },
    *     ],
@@ -205,14 +205,14 @@ export namespace EntityRetrieveResponse {
     createdAt: string;
 
     /**
-     * Free-form key/value metadata attached to the entity
+     * The entity type identifier this entity instantiates
      */
-    metadata: { [key: string]: string };
+    entityTypeId: string;
 
     /**
-     * The entity type identifier this entity instantiates
+     * Free-form key/value metadata attached to the entity
      */
-    typeId: string;
+    metadata: { [key: string]: string };
 
     /**
      * Timestamp of when the record was last updated
@@ -241,14 +241,14 @@ export interface EntityListResponse {
   createdAt: string;
 
   /**
-   * Free-form key/value metadata attached to the entity
+   * The entity type identifier this entity instantiates
    */
-  metadata: { [key: string]: string };
+  entityTypeId: string;
 
   /**
-   * The entity type identifier this entity instantiates
+   * Free-form key/value metadata attached to the entity
    */
-  typeId: string;
+  metadata: { [key: string]: string };
 
   /**
    * Timestamp of when the record was last updated
@@ -328,14 +328,14 @@ export namespace EntityUpsertResponse {
     createdAt: string;
 
     /**
-     * Free-form key/value metadata attached to the entity
+     * The entity type identifier this entity instantiates
      */
-    metadata: { [key: string]: string };
+    entityTypeId: string;
 
     /**
-     * The entity type identifier this entity instantiates
+     * Free-form key/value metadata attached to the entity
      */
-    typeId: string;
+    metadata: { [key: string]: string };
 
     /**
      * Timestamp of when the record was last updated
@@ -366,15 +366,15 @@ export interface EntityRetrieveParams {
 
 export interface EntityListParams extends MyCursorIDPageParams {
   /**
-   * Query param: Whether to include archived entities. One of: true, false
+   * Query param: Filter results to entities of a specific entity type, by the type's
+   * ID
    */
-  includeArchived?: 'true' | 'false';
+  entityTypeId?: string;
 
   /**
-   * Query param: Filter results to entities of a specific entity type, by the type's
-   * refId
+   * Query param: Whether to include archived entities. One of: true, false
    */
-  typeRefId?: string;
+  includeArchived?: 'true' | 'false';
 
   /**
    * Header param: Account ID — optional when authenticating with a user JWT (Bearer
@@ -461,17 +461,17 @@ export namespace EntityUpsertParams {
     id: string;
 
     /**
-     * Free-form key/value metadata. Patch semantics: empty-string value removes a key,
-     * omitted keys are preserved.
+     * The entity type ID this entity instantiates. Required when creating a new
+     * entity; on a re-upsert may be omitted to preserve the existing type. Governance
+     * returns 400 if missing on create.
      */
-    metadata?: { [key: string]: string };
+    entityTypeId?: string;
 
     /**
-     * The entity type refId this entity instantiates. Required when creating a new
-     * entity; on a re-upsert may be omitted to preserve the existing type. Governance
-     * returns 400 if missing on create.
+     * Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+     * omitted keys are preserved.
      */
-    typeRefId?: string;
+    metadata?: { [key: string]: string };
   }
 }
 

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.35";
+export declare const VERSION = "0.1.0-beta.37";
 //# 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.35'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.37'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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