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

package/src/resources/v1/credits/custom-currencies.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 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';
 import { path } from '../../../internal/utils/path';
 
@@ -12,35 +13,93 @@ import { path } from '../../../internal/utils/path';
 export class CustomCurrencies extends APIResource {
   /**
    * Creates a new custom currency in the environment.
-   */
-  create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrency> {
-    return this._client.post('/api/v1/credits/custom-currencies', { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.create({
+   *     id: 'id',
+   *     displayName: 'displayName',
+   *   });
+   * ```
+   */
+  create(params: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/credits/custom-currencies', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates an existing custom currency. Only the supplied fields are modified.
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.update(
+   *     'currencyId',
+   *   );
+   * ```
    */
   update(
     currencyID: string,
-    body: CustomCurrencyUpdateParams,
+    params: CustomCurrencyUpdateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomCurrency> {
-    return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, { body, ...options });
+  ): APIPromise<CustomCurrencyResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a paginated list of custom currencies in the environment. Archived
    * currencies are excluded by default; pass `status=ARCHIVED` (or
    * `status=ACTIVE,ARCHIVED`) to include them.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
-    query: CustomCurrencyListParams | null | undefined = {},
+    params: CustomCurrencyListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList(
       '/api/v1/credits/custom-currencies',
       MyCursorIDPage<CustomCurrencyListResponse>,
-      { query, ...options },
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          {
+            ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+            ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+          },
+          options?.headers,
+        ]),
+      },
     );
   }
 
@@ -48,31 +107,91 @@ export class CustomCurrencies extends APIResource {
    * Archives a custom currency. Fails if the currency is still associated with any
    * active plan or addon — use the associated-entities endpoint first to inspect
    * dependencies.
-   */
-  archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrency> {
-    return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, options);
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.archive(
+   *     'currencyId',
+   *   );
+   * ```
+   */
+  archive(
+    currencyID: string,
+    params: CustomCurrencyArchiveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomCurrencyResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Lists the active plans and addons that reference a custom currency. Useful
    * before archiving to inspect dependencies.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.credits.customCurrencies.listAssociatedEntities(
+   *     'currencyId',
+   *   );
+   * ```
    */
   listAssociatedEntities(
     currencyID: string,
+    params: CustomCurrencyListAssociatedEntitiesParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomCurrencyListAssociatedEntitiesResponse> {
-    return this._client.get(
-      path`/api/v1/credits/custom-currencies/${currencyID}/associated-entities`,
-      options,
-    );
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.get(path`/api/v1/credits/custom-currencies/${currencyID}/associated-entities`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Restores a previously archived custom currency. Fails if another active currency
    * with the same ID already exists.
-   */
-  unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrency> {
-    return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, options);
+   *
+   * @example
+   * ```ts
+   * const customCurrencyResponse =
+   *   await client.v1.credits.customCurrencies.unarchive(
+   *     'currencyId',
+   *   );
+   * ```
+   */
+  unarchive(
+    currencyID: string,
+    params: CustomCurrencyUnarchiveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomCurrencyResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -81,14 +200,14 @@ export type CustomCurrencyListResponsesMyCursorIDPage = MyCursorIDPage<CustomCur
 /**
  * Response object
  */
-export interface CustomCurrency {
+export interface CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
-  data: CustomCurrency.Data;
+  data: CustomCurrencyResponse.Data;
 }
 
-export namespace CustomCurrency {
+export namespace CustomCurrencyResponse {
   /**
    * A custom currency used to denominate credit-based entitlements and pricing
    */
@@ -255,35 +374,48 @@ export namespace CustomCurrencyListAssociatedEntitiesResponse {
 
 export interface CustomCurrencyCreateParams {
   /**
-   * The unique identifier for the new custom currency
+   * Body param: The unique identifier for the new custom currency
    */
   id: string;
 
   /**
-   * The display name of the custom currency
+   * Body param: The display name of the custom currency
    */
   displayName: string;
 
   /**
-   * Description of the currency
+   * Body param: Description of the currency
    */
   description?: string;
 
   /**
-   * Additional metadata to attach to the custom currency
+   * Body param: Additional metadata to attach to the custom currency
    */
   metadata?: { [key: string]: string };
 
   /**
-   * The symbol used to represent the custom currency
+   * Body param: The symbol used to represent the custom currency
    */
   symbol?: string;
 
   /**
-   * Singular and plural unit labels for a custom currency. Both fields are required
-   * when supplied.
+   * Body param: Singular and plural unit labels for a custom currency. Both fields
+   * are required when supplied.
    */
   units?: CustomCurrencyCreateParams.Units;
+
+  /**
+   * 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 CustomCurrencyCreateParams {
@@ -306,31 +438,45 @@ export namespace CustomCurrencyCreateParams {
 
 export interface CustomCurrencyUpdateParams {
   /**
-   * A human-readable description of the custom currency. Send an empty string to
-   * clear.
+   * Body param: A human-readable description of the custom currency. Send an empty
+   * string to clear.
    */
   description?: string | null;
 
   /**
-   * The display name of the custom currency
+   * Body param: The display name of the custom currency
    */
   displayName?: string;
 
   /**
-   * Additional metadata to attach to the custom currency
+   * Body param: Additional metadata to attach to the custom currency
    */
   metadata?: { [key: string]: string } | null;
 
   /**
-   * The symbol used to represent the custom currency. Send an empty string to clear.
+   * Body param: The symbol used to represent the custom currency. Send an empty
+   * string to clear.
    */
   symbol?: string | null;
 
   /**
-   * Singular and plural unit labels for a custom currency. Both fields are required
-   * when supplied.
+   * Body param: Singular and plural unit labels for a custom currency. Both fields
+   * are required when supplied.
    */
   units?: CustomCurrencyUpdateParams.Units;
+
+  /**
+   * 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 CustomCurrencyUpdateParams {
@@ -353,20 +499,81 @@ export namespace CustomCurrencyUpdateParams {
 
 export interface CustomCurrencyListParams extends MyCursorIDPageParams {
   /**
-   * Filter by custom currency status. Supports comma-separated values (e.g.,
-   * `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
+   * Query param: Filter by custom currency status. Supports comma-separated values
+   * (e.g., `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
    */
   status?: Array<'ACTIVE' | 'ARCHIVED'>;
+
+  /**
+   * 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 CustomCurrencyArchiveParams {
+  /**
+   * 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 CustomCurrencyListAssociatedEntitiesParams {
+  /**
+   * 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 CustomCurrencyUnarchiveParams {
+  /**
+   * 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 CustomCurrencies {
   export {
-    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,
+    type CustomCurrencyArchiveParams as CustomCurrencyArchiveParams,
+    type CustomCurrencyListAssociatedEntitiesParams as CustomCurrencyListAssociatedEntitiesParams,
+    type CustomCurrencyUnarchiveParams as CustomCurrencyUnarchiveParams,
   };
 }