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

package/src/resources/v1/products.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';
 
@@ -13,55 +14,171 @@ export class Products extends APIResource {
   /**
    * Archives a product, preventing new subscriptions. All plans and addons are
    * archived.
-   */
-  archiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
-    return this._client.post(path`/api/v1/products/${id}/archive`, options);
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.archiveProduct(
+   *   'x',
+   * );
+   * ```
+   */
+  archiveProduct(
+    id: string,
+    params: ProductArchiveProductParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Product> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/products/${id}/archive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Creates a new product.
-   */
-  createProduct(body: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
-    return this._client.post('/api/v1/products', { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.createProduct({
+   *   id: 'id',
+   *   displayName: 'displayName',
+   * });
+   * ```
+   */
+  createProduct(params: ProductCreateProductParams, options?: RequestOptions): APIPromise<Product> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/products', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Duplicates an existing product, including its plans, addons, and configuration.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.duplicateProduct(
+   *   'x',
+   *   { targetId: 'targetId' },
+   * );
+   * ```
    */
   duplicateProduct(
     id: string,
-    body: ProductDuplicateProductParams,
+    params: ProductDuplicateProductParams,
     options?: RequestOptions,
   ): APIPromise<Product> {
-    return this._client.post(path`/api/v1/products/${id}/duplicate`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/products/${id}/duplicate`, {
+      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 products in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const productListProductsResponse of client.v1.products.listProducts()) {
+   *   // ...
+   * }
+   * ```
    */
   listProducts(
-    query: ProductListProductsParams | null | undefined = {},
+    params: ProductListProductsParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ProductListProductsResponsesMyCursorIDPage, ProductListProductsResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList('/api/v1/products', MyCursorIDPage<ProductListProductsResponse>, {
       query,
       ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
   /**
    * Restores an archived product, allowing new subscriptions to be created.
-   */
-  unarchiveProduct(id: string, options?: RequestOptions): APIPromise<Product> {
-    return this._client.post(path`/api/v1/products/${id}/unarchive`, options);
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.unarchiveProduct(
+   *   'x',
+   * );
+   * ```
+   */
+  unarchiveProduct(
+    id: string,
+    params: ProductUnarchiveProductParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Product> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/products/${id}/unarchive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates an existing product's properties such as display name, description, and
    * metadata.
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.products.updateProduct('x');
+   * ```
    */
-  updateProduct(id: string, body: ProductUpdateProductParams, options?: RequestOptions): APIPromise<Product> {
-    return this._client.patch(path`/api/v1/products/${id}`, { body, ...options });
+  updateProduct(
+    id: string,
+    params: ProductUpdateProductParams,
+    options?: RequestOptions,
+  ): APIPromise<Product> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/products/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -255,65 +372,120 @@ export namespace ProductListProductsResponse {
   }
 }
 
+export interface ProductArchiveProductParams {
+  /**
+   * 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 ProductCreateProductParams {
   /**
-   * The unique identifier for the entity
+   * Body param: The unique identifier for the entity
    */
   id: string;
 
   /**
-   * Display name of the product
+   * Body param: Display name of the product
    */
   displayName: string;
 
   /**
-   * Description of the product
+   * Body param: Description of the product
    */
   description?: string | null;
 
   /**
-   * Additional metadata for the product
+   * Body param: Additional metadata for the product
    */
   metadata?: { [key: string]: string } | null;
 
   /**
-   * Indicates if multiple subscriptions to this product are allowed
+   * Body param: Indicates if multiple subscriptions to this product are allowed
    */
   multipleSubscriptions?: boolean;
+
+  /**
+   * 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 ProductDuplicateProductParams {
   /**
-   * The unique identifier for the entity
+   * Body param: The unique identifier for the entity
    */
   targetId: string;
 
   /**
-   * Description of the product
+   * Body param: Description of the product
    */
   description?: string | null;
 
   /**
-   * Display name of the product
+   * Body param: Display name of the product
    */
   displayName?: 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 ProductListProductsParams extends MyCursorIDPageParams {
   /**
-   * Filter by entity ID
+   * Query param: Filter by entity ID
    */
   id?: string;
 
   /**
-   * Filter by creation date using range operators: gt, gte, lt, lte
+   * Query param: Filter by creation date using range operators: gt, gte, lt, lte
    */
   createdAt?: ProductListProductsParams.CreatedAt;
 
   /**
-   * Filter by product status. Supports comma-separated values for multiple statuses
+   * Query param: Filter by product status. Supports comma-separated values for
+   * multiple statuses
    */
   status?: Array<'PUBLISHED' | '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 namespace ProductListProductsParams {
@@ -343,33 +515,64 @@ export namespace ProductListProductsParams {
   }
 }
 
+export interface ProductUnarchiveProductParams {
+  /**
+   * 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 ProductUpdateProductParams {
   /**
-   * Description of the product
+   * Body param: Description of the product
    */
   description?: string | null;
 
   /**
-   * Display name of the product
+   * Body param: Display name of the product
    */
   displayName?: string;
 
   /**
-   * Additional metadata for the product
+   * Body param: Additional metadata for the product
    */
   metadata?: { [key: string]: string } | null;
 
   /**
-   * Indicates if multiple subscriptions to this product are allowed
+   * Body param: Indicates if multiple subscriptions to this product are allowed
    */
   multipleSubscriptions?: boolean;
 
+  /**
+   * Body param
+   */
   productSettings?: ProductUpdateProductParams.ProductSettings;
 
   /**
-   * Rule defining when usage resets upon subscription update.
+   * Body param: Rule defining when usage resets upon subscription update.
    */
   usageResetCutoffRule?: ProductUpdateProductParams.UsageResetCutoffRule;
+
+  /**
+   * 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 ProductUpdateProductParams {
@@ -422,9 +625,11 @@ export declare namespace Products {
     type Product as Product,
     type ProductListProductsResponse as ProductListProductsResponse,
     type ProductListProductsResponsesMyCursorIDPage as ProductListProductsResponsesMyCursorIDPage,
+    type ProductArchiveProductParams as ProductArchiveProductParams,
     type ProductCreateProductParams as ProductCreateProductParams,
     type ProductDuplicateProductParams as ProductDuplicateProductParams,
     type ProductListProductsParams as ProductListProductsParams,
+    type ProductUnarchiveProductParams as ProductUnarchiveProductParams,
     type ProductUpdateProductParams as ProductUpdateProductParams,
   };
 }

package/src/resources/v1/subscriptions/future-update.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -11,17 +12,61 @@ import { path } from '../../../internal/utils/path';
 export class FutureUpdate extends APIResource {
   /**
    * Cancels a subscription update that is pending payment completion.
+   *
+   * @example
+   * ```ts
+   * const cancelSubscription =
+   *   await client.v1.subscriptions.futureUpdate.cancelPendingPayment(
+   *     'x',
+   *   );
+   * ```
    */
-  cancelPendingPayment(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
-    return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, options);
+  cancelPendingPayment(
+    id: string,
+    params: FutureUpdateCancelPendingPaymentParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CancelSubscription> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/pending-payment`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Cancels a scheduled subscription update, such as a future downgrade or plan
    * change.
+   *
+   * @example
+   * ```ts
+   * const cancelSubscription =
+   *   await client.v1.subscriptions.futureUpdate.cancelSchedule(
+   *     'x',
+   *   );
+   * ```
    */
-  cancelSchedule(id: string, options?: RequestOptions): APIPromise<CancelSubscription> {
-    return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, options);
+  cancelSchedule(
+    id: string,
+    params: FutureUpdateCancelScheduleParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CancelSubscription> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.delete(path`/api/v1/subscriptions/${id}/future-update/schedule`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -41,6 +86,40 @@ export namespace CancelSubscription {
   }
 }
 
+export interface FutureUpdateCancelPendingPaymentParams {
+  /**
+   * 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 FutureUpdateCancelScheduleParams {
+  /**
+   * 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 FutureUpdate {
-  export { type CancelSubscription as CancelSubscription };
+  export {
+    type CancelSubscription as CancelSubscription,
+    type FutureUpdateCancelPendingPaymentParams as FutureUpdateCancelPendingPaymentParams,
+    type FutureUpdateCancelScheduleParams as FutureUpdateCancelScheduleParams,
+  };
 }

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

@@ -1,7 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { FutureUpdate, type CancelSubscription } from './future-update';
-export { Invoice, type InvoiceMarkAsPaidResponse } from './invoice';
+export {
+  FutureUpdate,
+  type CancelSubscription,
+  type FutureUpdateCancelPendingPaymentParams,
+  type FutureUpdateCancelScheduleParams,
+} from './future-update';
+export { Invoice, type InvoiceMarkAsPaidResponse, type InvoiceMarkAsPaidParams } from './invoice';
 export {
   Subscriptions,
   type Subscription,
@@ -9,6 +14,7 @@ export {
   type SubscriptionImportResponse,
   type SubscriptionPreviewResponse,
   type SubscriptionProvisionResponse,
+  type SubscriptionRetrieveParams,
   type SubscriptionUpdateParams,
   type SubscriptionListParams,
   type SubscriptionCancelParams,
@@ -25,4 +31,5 @@ export {
   type UsageChargeUsageResponse,
   type UsageSyncResponse,
   type UsageChargeUsageParams,
+  type UsageSyncParams,
 } from './usage';

package/src/resources/v1/subscriptions/invoice.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -12,9 +13,29 @@ export class Invoice extends APIResource {
   /**
    * Marks the latest invoice of a subscription as paid in the billing provider. The
    * invoice must exist and have an OPEN status.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.subscriptions.invoice.markAsPaid('x');
+   * ```
    */
-  markAsPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkAsPaidResponse> {
-    return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, options);
+  markAsPaid(
+    id: string,
+    params: InvoiceMarkAsPaidParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InvoiceMarkAsPaidResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/subscriptions/${id}/invoice/paid`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -40,6 +61,24 @@ export namespace InvoiceMarkAsPaidResponse {
   }
 }
 
+export interface InvoiceMarkAsPaidParams {
+  /**
+   * 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 Invoice {
-  export { type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
+  export {
+    type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse,
+    type InvoiceMarkAsPaidParams as InvoiceMarkAsPaidParams,
+  };
 }