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

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

@@ -9,13 +9,16 @@ export {
   type CustomerImportResponse,
   type CustomerListResourcesResponse,
   type CustomerRetrieveEntitlementsResponse,
+  type CustomerRetrieveParams,
   type CustomerUpdateParams,
   type CustomerListParams,
+  type CustomerArchiveParams,
   type CustomerCheckEntitlementParams,
   type CustomerImportParams,
   type CustomerListResourcesParams,
   type CustomerProvisionParams,
   type CustomerRetrieveEntitlementsParams,
+  type CustomerUnarchiveParams,
   type CustomerListResponsesMyCursorIDPage,
   type CustomerListResourcesResponsesMyCursorIDPage,
 } from './customers';
@@ -29,7 +32,11 @@ export {
   type IntegrationUnlinkParams,
   type IntegrationListResponsesMyCursorIDPage,
 } from './integrations';
-export { PaymentMethod, type PaymentMethodAttachParams } from './payment-method';
+export {
+  PaymentMethod,
+  type PaymentMethodAttachParams,
+  type PaymentMethodDetachParams,
+} from './payment-method';
 export {
   PromotionalEntitlements,
   type PromotionalEntitlementCreateResponse,

package/src/resources/v1/customers/integrations.ts

@@ -4,76 +4,171 @@ import { APIResource } from '../../../core/resource';
 import * as CustomersAPI from './customers';
 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';
 
 export class Integrations extends APIResource {
   /**
    * Retrieves a specific integration for a customer by integration ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.retrieve(
+   *     'integrationId',
+   *     { id: 'id' },
+   *   );
+   * ```
    */
   retrieve(
     integrationID: string,
     params: IntegrationRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
-    const { id } = params;
-    return this._client.get(path`/api/v1/customers/${id}/integrations/${integrationID}`, options);
+    const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+    return this._client.get(path`/api/v1/customers/${id}/integrations/${integrationID}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates a customer's integration link, such as changing the synced external
    * entity ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.update(
+   *     'integrationId',
+   *     { id: 'id', syncedEntityId: 'syncedEntityId' },
+   *   );
+   * ```
    */
   update(
     integrationID: string,
     params: IntegrationUpdateParams,
     options?: RequestOptions,
   ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
-    const { id, ...body } = params;
+    const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
     return this._client.patch(path`/api/v1/customers/${id}/integrations/${integrationID}`, {
       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 a customer's external integrations (billing, CRM,
    * etc.).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const integrationListResponse of client.v1.customers.integrations.list(
+   *   'x',
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     id: string,
-    query: IntegrationListParams | null | undefined = {},
+    params: IntegrationListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<IntegrationListResponsesMyCursorIDPage, IntegrationListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList(
       path`/api/v1/customers/${id}/integrations`,
       MyCursorIDPage<IntegrationListResponse>,
-      { query, ...options },
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          {
+            ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+            ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+          },
+          options?.headers,
+        ]),
+      },
     );
   }
 
   /**
    * Links a customer to an external integration by specifying the vendor and
    * external entity ID.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.link('x', {
+   *     id: 'id',
+   *     syncedEntityId: 'syncedEntityId',
+   *     vendorIdentifier: 'AUTH0',
+   *   });
+   * ```
    */
   link(
     id: string,
-    body: IntegrationLinkParams,
+    params: IntegrationLinkParams,
     options?: RequestOptions,
   ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
-    return this._client.post(path`/api/v1/customers/${id}/integrations`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/customers/${id}/integrations`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Removes the link between a customer and an external integration.
+   *
+   * @example
+   * ```ts
+   * const customerIntegrationResponse =
+   *   await client.v1.customers.integrations.unlink(
+   *     'integrationId',
+   *     { id: 'id' },
+   *   );
+   * ```
    */
   unlink(
     integrationID: string,
     params: IntegrationUnlinkParams,
     options?: RequestOptions,
   ): APIPromise<CustomersAPI.CustomerIntegrationResponse> {
-    const { id } = params;
-    return this._client.delete(path`/api/v1/customers/${id}/integrations/${integrationID}`, options);
+    const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+    return this._client.delete(path`/api/v1/customers/${id}/integrations/${integrationID}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -106,7 +201,9 @@ export interface IntegrationListResponse {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
 
   /**
    * Price billing sync revision data containing billing ID, link URL, and price
@@ -169,9 +266,22 @@ export namespace IntegrationListResponse {
 
 export interface IntegrationRetrieveParams {
   /**
-   * Customer slug
+   * Path param: Customer slug
    */
   id: 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 IntegrationUpdateParams {
@@ -184,12 +294,25 @@ export interface IntegrationUpdateParams {
    * Body param: Synced entity id
    */
   syncedEntityId: string | null;
+
+  /**
+   * 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 IntegrationListParams extends MyCursorIDPageParams {
   /**
-   * Filter by vendor identifier. Supports comma-separated values for multiple
-   * vendors (e.g., STRIPE,HUBSPOT)
+   * Query param: Filter by vendor identifier. Supports comma-separated values for
+   * multiple vendors (e.g., STRIPE,HUBSPOT)
    */
   vendorIdentifier?: Array<
     | 'AUTH0'
@@ -202,22 +325,37 @@ export interface IntegrationListParams extends MyCursorIDPageParams {
     | 'BIG_QUERY'
     | 'OPEN_FGA'
     | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL'
   >;
+
+  /**
+   * 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 IntegrationLinkParams {
   /**
-   * Integration details
+   * Body param: Integration details
    */
   id: string;
 
   /**
-   * Synced entity id
+   * Body param: Synced entity id
    */
   syncedEntityId: string;
 
   /**
-   * The vendor identifier of integration
+   * Body param: The vendor identifier of integration
    */
   vendorIdentifier:
     | 'AUTH0'
@@ -229,14 +367,42 @@ export interface IntegrationLinkParams {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
+
+  /**
+   * 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 IntegrationUnlinkParams {
   /**
-   * Customer slug
+   * Path param: Customer slug
    */
   id: 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 declare namespace Integrations {

package/src/resources/v1/customers/payment-method.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as CustomersAPI from './customers';
 import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -13,37 +14,78 @@ export class PaymentMethod extends APIResource {
   /**
    * Attaches a payment method to a customer for billing. Required for paid
    * subscriptions when integrated with a billing provider.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.paymentMethod.attach('x', {
+   *     integrationId: 'integrationId',
+   *     paymentMethodId: 'paymentMethodId',
+   *     vendorIdentifier: 'AUTH0',
+   *   });
+   * ```
    */
   attach(
     id: string,
-    body: PaymentMethodAttachParams,
+    params: PaymentMethodAttachParams,
     options?: RequestOptions,
   ): APIPromise<CustomersAPI.CustomerResponse> {
-    return this._client.post(path`/api/v1/customers/${id}/payment-method`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/customers/${id}/payment-method`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Removes the payment method from a customer. Ensure active paid subscriptions
    * have an alternative payment method.
+   *
+   * @example
+   * ```ts
+   * const customerResponse =
+   *   await client.v1.customers.paymentMethod.detach('x');
+   * ```
    */
-  detach(id: string, options?: RequestOptions): APIPromise<CustomersAPI.CustomerResponse> {
-    return this._client.delete(path`/api/v1/customers/${id}/payment-method`, options);
+  detach(
+    id: string,
+    params: PaymentMethodDetachParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.CustomerResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.delete(path`/api/v1/customers/${id}/payment-method`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
 export interface PaymentMethodAttachParams {
   /**
-   * Integration details
+   * Body param: Integration details
    */
   integrationId: string;
 
   /**
-   * Billing provider payment method id
+   * Body param: Billing provider payment method id
    */
   paymentMethodId: string;
 
   /**
-   * The vendor identifier of integration
+   * Body param: The vendor identifier of integration
    */
   vendorIdentifier:
     | 'AUTH0'
@@ -55,10 +97,12 @@ export interface PaymentMethodAttachParams {
     | 'SALESFORCE'
     | 'BIG_QUERY'
     | 'OPEN_FGA'
-    | 'APP_STORE';
+    | 'APP_STORE'
+    | 'RECEIVED'
+    | 'PREQUEL';
 
   /**
-   * Customers selected currency
+   * Body param: Customers selected currency
    */
   billingCurrency?:
     | 'usd'
@@ -178,8 +222,39 @@ export interface PaymentMethodAttachParams {
     | 'xof'
     | 'xpf'
     | null;
+
+  /**
+   * 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 PaymentMethodDetachParams {
+  /**
+   * 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 PaymentMethod {
-  export { type PaymentMethodAttachParams as PaymentMethodAttachParams };
+  export {
+    type PaymentMethodAttachParams as PaymentMethodAttachParams,
+    type PaymentMethodDetachParams as PaymentMethodDetachParams,
+  };
 }