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

package/src/resources/v1/addons/entitlements.ts

@@ -2,50 +2,126 @@
 
 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';
 
 export class Entitlements extends APIResource {
   /**
    * Creates one or more entitlements (feature or credit) on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const entitlement =
+   *   await client.v1.addons.entitlements.create('addonId', {
+   *     entitlements: [{ id: 'id', type: 'FEATURE' }],
+   *   });
+   * ```
    */
   create(
     addonID: string,
-    body: EntitlementCreateParams,
+    params: EntitlementCreateParams,
     options?: RequestOptions,
   ): APIPromise<EntitlementCreateResponse> {
-    return this._client.post(path`/api/v1/addons/${addonID}/entitlements`, { body, ...options });
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post(path`/api/v1/addons/${addonID}/entitlements`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates an existing entitlement on a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.update('id', {
+   *     addonId: 'addonId',
+   *     type: 'FEATURE',
+   *   });
+   * ```
    */
   update(
     id: string,
     params: EntitlementUpdateParams,
     options?: RequestOptions,
   ): APIPromise<AddonPackageEntitlement> {
-    const { addonId, ...body } = params;
-    return this._client.patch(path`/api/v1/addons/${addonId}/entitlements/${id}`, { body, ...options });
+    const { addonId, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/addons/${addonId}/entitlements/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a list of entitlements for an addon.
+   *
+   * @example
+   * ```ts
+   * const entitlements =
+   *   await client.v1.addons.entitlements.list('addonId');
+   * ```
    */
-  list(addonID: string, options?: RequestOptions): APIPromise<EntitlementListResponse> {
-    return this._client.get(path`/api/v1/addons/${addonID}/entitlements`, options);
+  list(
+    addonID: string,
+    params: EntitlementListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EntitlementListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.get(path`/api/v1/addons/${addonID}/entitlements`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Deletes an entitlement from a draft addon.
+   *
+   * @example
+   * ```ts
+   * const addonPackageEntitlement =
+   *   await client.v1.addons.entitlements.delete('id', {
+   *     addonId: 'addonId',
+   *   });
+   * ```
    */
   delete(
     id: string,
     params: EntitlementDeleteParams,
     options?: RequestOptions,
   ): APIPromise<AddonPackageEntitlement> {
-    const { addonId } = params;
-    return this._client.delete(path`/api/v1/addons/${addonId}/entitlements/${id}`, options);
+    const { addonId, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+    return this._client.delete(path`/api/v1/addons/${addonId}/entitlements/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -735,9 +811,22 @@ export namespace EntitlementListResponse {
 
 export interface EntitlementCreateParams {
   /**
-   * Entitlements to create
+   * Body param: Entitlements to create
    */
   entitlements: Array<EntitlementCreateParams.Feature | EntitlementCreateParams.Credit>;
+
+  /**
+   * 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 EntitlementCreateParams {
@@ -1028,6 +1117,19 @@ export declare namespace EntitlementUpdateParams {
      * Body param: Configuration for yearly reset period
      */
     yearlyResetPeriodConfiguration?: UpdateFeatureEntitlementRequest.YearlyResetPeriodConfiguration | 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 namespace UpdateFeatureEntitlementRequest {
@@ -1131,14 +1233,55 @@ export declare namespace EntitlementUpdateParams {
      * Body param: Display order of the entitlement
      */
     order?: number;
+
+    /**
+     * 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 EntitlementListParams {
+  /**
+   * 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 EntitlementDeleteParams {
   /**
-   * The addon ID
+   * Path param: The addon ID
    */
   addonId: 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 Entitlements {
@@ -1148,6 +1291,7 @@ export declare namespace Entitlements {
     type EntitlementListResponse as EntitlementListResponse,
     type EntitlementCreateParams as EntitlementCreateParams,
     type EntitlementUpdateParams as EntitlementUpdateParams,
+    type EntitlementListParams as EntitlementListParams,
     type EntitlementDeleteParams as EntitlementDeleteParams,
   };
 }

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

@@ -4,13 +4,20 @@ export {
   Addons,
   type Addon,
   type AddonListResponse,
+  type AddonListChargesResponse,
   type AddonPublishResponse,
   type AddonRemoveDraftResponse,
   type AddonCreateParams,
+  type AddonRetrieveParams,
   type AddonUpdateParams,
   type AddonListParams,
+  type AddonArchiveParams,
+  type AddonCreateDraftParams,
+  type AddonListChargesParams,
   type AddonPublishParams,
+  type AddonRemoveDraftParams,
   type AddonListResponsesMyCursorIDPage,
+  type AddonListChargesResponsesMyCursorIDPage,
 } from './addons';
 export {
   Entitlements,
@@ -19,5 +26,6 @@ export {
   type EntitlementListResponse,
   type EntitlementCreateParams,
   type EntitlementUpdateParams,
+  type EntitlementListParams,
   type EntitlementDeleteParams,
 } from './entitlements';

package/src/resources/v1/coupons.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,43 +14,137 @@ export class Coupons extends APIResource {
   /**
    * Creates a new discount coupon with percentage or fixed amount off, applicable to
    * customer subscriptions.
-   */
-  create(body: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.post('/api/v1/coupons', { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.create({
+   *   id: 'id',
+   *   amountsOff: [{ amount: 0, currency: 'usd' }],
+   *   description: 'description',
+   *   durationInMonths: 1,
+   *   metadata: { foo: 'string' },
+   *   name: 'name',
+   *   percentOff: 1,
+   * });
+   * ```
+   */
+  create(params: CouponCreateParams, options?: RequestOptions): APIPromise<Coupon> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.post('/api/v1/coupons', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a coupon by its unique identifier.
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.get(path`/api/v1/coupons/${id}`, options);
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.retrieve('x');
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: CouponRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Coupon> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.get(path`/api/v1/coupons/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Retrieves a paginated list of coupons in the environment.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const couponListResponse of client.v1.coupons.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
-    query: CouponListParams | null | undefined = {},
+    params: CouponListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CouponListResponsesMyCursorIDPage, CouponListResponse> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
     return this._client.getAPIList('/api/v1/coupons', MyCursorIDPage<CouponListResponse>, {
       query,
       ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
     });
   }
 
   /**
    * Archives a coupon, preventing it from being applied to new subscriptions.
-   */
-  archiveCoupon(id: string, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.post(path`/api/v1/coupons/${id}/archive`, options);
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.archiveCoupon('x');
+   * ```
+   */
+  archiveCoupon(
+    id: string,
+    params: CouponArchiveCouponParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Coupon> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
+    return this._client.post(path`/api/v1/coupons/${id}/archive`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
    * Updates an existing coupon's properties such as name, description, and metadata.
-   */
-  updateCoupon(id: string, body: CouponUpdateCouponParams, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.patch(path`/api/v1/coupons/${id}`, { body, ...options });
+   *
+   * @example
+   * ```ts
+   * const coupon = await client.v1.coupons.updateCoupon('x');
+   * ```
+   */
+  updateCoupon(id: string, params: CouponUpdateCouponParams, options?: RequestOptions): APIPromise<Coupon> {
+    const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+    return this._client.patch(path`/api/v1/coupons/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+          ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
   }
 }
 
@@ -485,39 +580,52 @@ export namespace CouponListResponse {
 
 export interface CouponCreateParams {
   /**
-   * The unique identifier for the entity
+   * Body param: The unique identifier for the entity
    */
   id: string;
 
   /**
-   * Fixed amount discounts in different currencies
+   * Body param: Fixed amount discounts in different currencies
    */
   amountsOff: Array<CouponCreateParams.AmountsOff> | null;
 
   /**
-   * Description of the coupon
+   * Body param: Description of the coupon
    */
   description: string | null;
 
   /**
-   * Duration of the coupon validity in months
+   * Body param: Duration of the coupon validity in months
    */
   durationInMonths: number | null;
 
   /**
-   * Metadata associated with the entity
+   * Body param: Metadata associated with the entity
    */
   metadata: { [key: string]: string } | null;
 
   /**
-   * Name of the coupon
+   * Body param: Name of the coupon
    */
   name: string;
 
   /**
-   * Percentage discount off the original price
+   * Body param: Percentage discount off the original price
    */
   percentOff: number | 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 namespace CouponCreateParams {
@@ -653,26 +761,55 @@ export namespace CouponCreateParams {
   }
 }
 
+export interface CouponRetrieveParams {
+  /**
+   * 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 CouponListParams 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?: CouponListParams.CreatedAt;
 
   /**
-   * Filter by coupon status. Supports comma-separated values for multiple statuses
+   * Query param: Filter by coupon status. Supports comma-separated values for
+   * multiple statuses
    */
   status?: Array<'ACTIVE' | 'ARCHIVED'>;
 
   /**
-   * Filter by coupon type (FIXED or PERCENTAGE)
+   * Query param: Filter by coupon type (FIXED or PERCENTAGE)
    */
   type?: 'FIXED' | 'PERCENTAGE';
+
+  /**
+   * 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 CouponListParams {
@@ -702,21 +839,49 @@ export namespace CouponListParams {
   }
 }
 
+export interface CouponArchiveCouponParams {
+  /**
+   * 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 CouponUpdateCouponParams {
   /**
-   * Description of the coupon
+   * Body param: Description of the coupon
    */
   description?: string | null;
 
   /**
-   * Metadata associated with the entity
+   * Body param: Metadata associated with the entity
    */
   metadata?: { [key: string]: string } | null;
 
   /**
-   * Name of the coupon
+   * Body param: Name of the coupon
    */
   name?: 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 Coupons {
@@ -725,7 +890,9 @@ export declare namespace Coupons {
     type CouponListResponse as CouponListResponse,
     type CouponListResponsesMyCursorIDPage as CouponListResponsesMyCursorIDPage,
     type CouponCreateParams as CouponCreateParams,
+    type CouponRetrieveParams as CouponRetrieveParams,
     type CouponListParams as CouponListParams,
+    type CouponArchiveCouponParams as CouponArchiveCouponParams,
     type CouponUpdateCouponParams as CouponUpdateCouponParams,
   };
 }