@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.21

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

@@ -1,21 +1,18 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as AutoRechargeAPI from './auto-recharge';
-import {
-  AutoRecharge,
-  AutoRechargeGetAutoRechargeParams,
-  AutoRechargeGetAutoRechargeResponse,
-} from './auto-recharge';
 import * as CustomCurrenciesAPI from './custom-currencies';
 import {
   CustomCurrencies,
-  CustomCurrency,
+  CustomCurrencyArchiveParams,
   CustomCurrencyCreateParams,
+  CustomCurrencyListAssociatedEntitiesParams,
   CustomCurrencyListAssociatedEntitiesResponse,
   CustomCurrencyListParams,
   CustomCurrencyListResponse,
   CustomCurrencyListResponsesMyCursorIDPage,
+  CustomCurrencyResponse,
+  CustomCurrencyUnarchiveParams,
   CustomCurrencyUpdateParams,
 } from './custom-currencies';
 import * as GrantsAPI from './grants';
@@ -25,10 +22,12 @@ import {
   GrantListParams,
   GrantListResponse,
   GrantListResponsesMyCursorIDPage,
+  GrantVoidParams,
   Grants,
 } from './grants';
 import { APIPromise } from '../../../core/api-promise';
 import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Credits extends APIResource {
@@ -36,32 +35,169 @@ export class Credits extends APIResource {
   customCurrencies: CustomCurrenciesAPI.CustomCurrencies = new CustomCurrenciesAPI.CustomCurrencies(
     this._client,
   );
-  autoRecharge: AutoRechargeAPI.AutoRecharge = new AutoRechargeAPI.AutoRecharge(this._client);
+
+  /**
+   * Retrieves the automatic recharge configuration for a customer and currency.
+   * Returns default settings if no configuration exists.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getAutoRecharge({
+   *   currencyId: 'currencyId',
+   *   customerId: 'customerId',
+   * });
+   * ```
+   */
+  getAutoRecharge(
+    params: CreditGetAutoRechargeParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditGetAutoRechargeResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
+    return this._client.get('/api/v1/credits/auto-recharge', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
 
   /**
    * Retrieves credit usage time-series data for a customer, grouped by feature, over
    * a specified time range.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.credits.getUsage({
+   *   customerId: 'customerId',
+   * });
+   * ```
    */
-  getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
-    return this._client.get('/api/v1/credits/usage', { query, ...options });
+  getUsage(params: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
+    return this._client.get('/api/v1/credits/usage', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a paginated list of credit ledger events for a customer.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const creditListLedgerResponse of client.v1.credits.listLedger(
+   *   { customerId: 'customerId' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listLedger(
-    query: CreditListLedgerParams,
+    params: CreditListLedgerParams,
     options?: RequestOptions,
   ): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
     return this._client.getAPIList('/api/v1/credits/ledger', MyCursorIDPage<CreditListLedgerResponse>, {
       query,
       ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 }
 
 export type CreditListLedgerResponsesMyCursorIDPage = MyCursorIDPage<CreditListLedgerResponse>;
 
+/**
+ * Response object
+ */
+export interface CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  data: CreditGetAutoRechargeResponse.Data;
+}
+
+export namespace CreditGetAutoRechargeResponse {
+  /**
+   * Automatic recharge configuration for a customer and currency
+   */
+  export interface Data {
+    /**
+     * The unique configuration ID
+     */
+    id: string | null;
+
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string | null;
+
+    /**
+     * The currency ID for this configuration
+     */
+    currencyId: string;
+
+    /**
+     * The customer ID this configuration belongs to
+     */
+    customerId: string;
+
+    /**
+     * Expiration period for auto-recharge grants (1_MONTH or 1_YEAR)
+     */
+    grantExpirationPeriod: '1_MONTH' | '1_YEAR';
+
+    /**
+     * Whether automatic recharge is enabled
+     */
+    isEnabled: boolean;
+
+    /**
+     * Maximum monthly spend limit for automatic recharges
+     */
+    maxSpendLimit: number | null;
+
+    /**
+     * The target credit balance to recharge to
+     */
+    targetBalance: number;
+
+    /**
+     * The threshold type (CREDIT_AMOUNT or DOLLAR_AMOUNT)
+     */
+    thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT';
+
+    /**
+     * The threshold value that triggers a recharge
+     */
+    thresholdValue: number;
+
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string | null;
+  }
+}
+
 /**
  * Response object
  */
@@ -82,6 +218,13 @@ export namespace CreditGetUsageResponse {
      */
     currency: Data.Currency | null;
 
+    /**
+     * Cursor-based pagination for the returned series. `next`/`prev` are opaque
+     * cursors; pass them back as `after`/`before` to traverse pages. The series axis
+     * is `groupBy` when provided, otherwise `featureId`
+     */
+    pagination: Data.Pagination;
+
     /**
      * Credit usage series grouped by feature
      */
@@ -119,19 +262,37 @@ export namespace CreditGetUsageResponse {
       symbol: string | null;
     }
 
+    /**
+     * Cursor-based pagination for the returned series. `next`/`prev` are opaque
+     * cursors; pass them back as `after`/`before` to traverse pages. The series axis
+     * is `groupBy` when provided, otherwise `featureId`
+     */
+    export interface Pagination {
+      /**
+       * Cursor for fetching the next page of results, or null if no additional pages
+       * exist
+       */
+      next: string | null;
+
+      /**
+       * Cursor for fetching the previous page of results, or null if at the beginning
+       */
+      prev: string | null;
+    }
+
     /**
      * Credit usage data for a single feature
      */
     export interface Series {
       /**
-       * The feature ID
+       * The feature ID; null when grouping by dimensions only
        */
-      featureId: string;
+      featureId: string | null;
 
       /**
-       * The display name of the feature
+       * The display name of the feature; null when grouping by dimensions only
        */
-      featureName: string;
+      featureName: string | null;
 
       /**
        * Time-series data points for this feature
@@ -142,6 +303,11 @@ export namespace CreditGetUsageResponse {
        * Total credits consumed by this feature in the time range
        */
       totalCredits: number;
+
+      /**
+       * Dimension key/value pairs identifying this series when groupBy is applied
+       */
+      tags?: Array<Series.Tag>;
     }
 
     export namespace Series {
@@ -159,6 +325,21 @@ export namespace CreditGetUsageResponse {
          */
         value: number;
       }
+
+      /**
+       * Dimension key/value pair identifying a credit usage series
+       */
+      export interface Tag {
+        /**
+         * The dimension key
+         */
+        key: string;
+
+        /**
+         * The dimension value for this series
+         */
+        value: string;
+      }
     }
   }
 }
@@ -220,67 +401,140 @@ export interface CreditListLedgerResponse {
   timestamp: string;
 }
 
+export interface CreditGetAutoRechargeParams {
+  /**
+   * Query param: Filter by currency ID (required)
+   */
+  currencyId: string;
+
+  /**
+   * Query param: Filter by customer ID (required)
+   */
+  customerId: 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 CreditGetUsageParams {
   /**
-   * Filter by customer ID (required)
+   * Query param: Filter by customer ID (required)
    */
   customerId: string;
 
   /**
-   * Filter by currency ID
+   * Query param: Return items that come after this cursor
+   */
+  after?: string;
+
+  /**
+   * Query param: Return items that come before this cursor
+   */
+  before?: string;
+
+  /**
+   * Query param: Filter by currency ID
    */
   currencyId?: string;
 
   /**
-   * End date for the credit usage time range (ISO 8601). Defaults to now when
-   * startDate is provided
+   * Query param: End date for the credit usage time range (ISO 8601). Defaults to
+   * now when startDate is provided
    */
   endDate?: string;
 
   /**
-   * Filter by resource ID
+   * Query param: Comma-separated list of feature dimension keys to group usage
+   * series by (up to 3). Each key matches /^[a-zA-Z0-9_$-]+$/
+   */
+  groupBy?: string;
+
+  /**
+   * Query param: Maximum number of items to return
+   */
+  limit?: number;
+
+  /**
+   * Query param: Filter by resource ID
    */
   resourceId?: string;
 
   /**
-   * Start date for the credit usage time range (ISO 8601). Takes precedence over
-   * timeRange when provided
+   * Query param: Start date for the credit usage time range (ISO 8601). Takes
+   * precedence over timeRange when provided
    */
   startDate?: string;
 
   /**
-   * Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults
-   * to LAST_MONTH
+   * Query param: Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH,
+   * LAST_YEAR). Defaults to LAST_MONTH
    */
   timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR';
+
+  /**
+   * 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 CreditListLedgerParams extends MyCursorIDPageParams {
   /**
-   * Filter by customer ID (required)
+   * Query param: Filter by customer ID (required)
    */
   customerId: string;
 
   /**
-   * Filter by currency ID
+   * Query param: Filter by currency ID
    */
   currencyId?: string;
 
   /**
-   * Filter by resource ID
+   * Query param: Filter by resource ID
    */
   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;
 }
 
 Credits.Grants = Grants;
 Credits.CustomCurrencies = CustomCurrencies;
-Credits.AutoRecharge = AutoRecharge;
 
 export declare namespace Credits {
   export {
+    type CreditGetAutoRechargeResponse as CreditGetAutoRechargeResponse,
     type CreditGetUsageResponse as CreditGetUsageResponse,
     type CreditListLedgerResponse as CreditListLedgerResponse,
     type CreditListLedgerResponsesMyCursorIDPage as CreditListLedgerResponsesMyCursorIDPage,
+    type CreditGetAutoRechargeParams as CreditGetAutoRechargeParams,
     type CreditGetUsageParams as CreditGetUsageParams,
     type CreditListLedgerParams as CreditListLedgerParams,
   };
@@ -292,22 +546,20 @@ export declare namespace Credits {
     type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage,
     type GrantCreateParams as GrantCreateParams,
     type GrantListParams as GrantListParams,
+    type GrantVoidParams as GrantVoidParams,
   };
 
   export {
     CustomCurrencies as CustomCurrencies,
-    type CustomCurrency as CustomCurrency,
+    type CustomCurrencyResponse as CustomCurrencyResponse,
     type CustomCurrencyListResponse as CustomCurrencyListResponse,
     type CustomCurrencyListAssociatedEntitiesResponse as CustomCurrencyListAssociatedEntitiesResponse,
     type CustomCurrencyListResponsesMyCursorIDPage as CustomCurrencyListResponsesMyCursorIDPage,
     type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
     type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,
     type CustomCurrencyListParams as CustomCurrencyListParams,
-  };
-
-  export {
-    AutoRecharge as AutoRecharge,
-    type AutoRechargeGetAutoRechargeResponse as AutoRechargeGetAutoRechargeResponse,
-    type AutoRechargeGetAutoRechargeParams as AutoRechargeGetAutoRechargeParams,
+    type CustomCurrencyArchiveParams as CustomCurrencyArchiveParams,
+    type CustomCurrencyListAssociatedEntitiesParams as CustomCurrencyListAssociatedEntitiesParams,
+    type CustomCurrencyUnarchiveParams as CustomCurrencyUnarchiveParams,
   };
 }