@usehercules/sdk 1.10.1 → 1.12.0

package/resources/commerce/products/variants.d.mts

@@ -0,0 +1,294 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Variants extends APIResource {
+    /**
+     * Creates a new variant with pricing for a product. Use variants to offer multiple
+     * pricing tiers or configurations (e.g., Basic at $10/month, Pro at $25/month). A
+     * Stripe Price is automatically created.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.create(
+     *     'product_id',
+     *     { name: 'name' },
+     *   );
+     * ```
+     */
+    create(productID: string, body: VariantCreateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Updates an existing variant. Use this to modify the name, description, or active
+     * status. Pricing cannot be changed after creation—create a new variant instead.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.update(
+     *     'variant_id',
+     *     { product_id: 'product_id' },
+     *   );
+     * ```
+     */
+    update(variantID: string, params: VariantUpdateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Retrieves all variants for a product. Variants represent different pricing tiers
+     * or configurations (e.g., Basic, Pro, Enterprise) within a single product.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const variant of client.commerce.products.variants.list(
+     *   'product_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(productID: string, query?: VariantListParams | null | undefined, options?: RequestOptions): PagePromise<VariantsCursorIDPage, Variant>;
+    /**
+     * Retrieves a variant by ID. Returns the variant object including pricing details
+     * and status.
+     *
+     * @example
+     * ```ts
+     * const variant = await client.commerce.products.variants.get(
+     *   'variant_id',
+     *   { product_id: 'product_id' },
+     * );
+     * ```
+     */
+    get(variantID: string, params: VariantGetParams, options?: RequestOptions): APIPromise<Variant>;
+}
+export type VariantsCursorIDPage = CursorIDPage<Variant>;
+/**
+ * A product variant representing a specific tier or configuration. Each variant
+ * has its own pricing. Variants allow a single product to have multiple pricing
+ * options (e.g., Basic, Pro, Enterprise tiers).
+ */
+export interface Variant {
+    /**
+     * Unique identifier for the variant
+     */
+    id: string;
+    /**
+     * Whether the variant is available for new purchases
+     */
+    active: boolean;
+    /**
+     * Timestamp when the variant was created
+     */
+    created: string;
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the variant
+     */
+    media?: Array<Variant.Media>;
+    /**
+     * Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    recurring?: Variant.Recurring | null;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). 0 for free variants.
+     */
+    unit_amount?: number;
+}
+export declare namespace Variant {
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID
+         */
+        id: string;
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order: number;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * CDN URL of the media resource
+         */
+        url: string;
+        /**
+         * File size in bytes
+         */
+        file_size?: number;
+        /**
+         * Original filename
+         */
+        filename?: string;
+        /**
+         * Optimized thumbnail URL for images
+         */
+        thumbnail_url?: string;
+    }
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    interface Recurring {
+        /**
+         * Billing frequency: day, week, month, or year
+         */
+        interval: 'day' | 'week' | 'month' | 'year';
+        /**
+         * Number of intervals between billings
+         */
+        interval_count?: number;
+    }
+}
+export interface VariantCreateParams {
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Optional custom ID for the variant. Must start with 'var\_'. If not provided,
+     * one will be generated.
+     */
+    id?: string;
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Media attachments by CDN file ID
+     */
+    media?: Array<VariantCreateParams.Media>;
+    /**
+     * Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    recurring?: VariantCreateParams.Recurring;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). Use 0 for free
+     * variants.
+     */
+    unit_amount?: number;
+}
+export declare namespace VariantCreateParams {
+    /**
+     * Media input for attaching to products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID from upload
+         */
+        cdn_file_id: string;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order?: number;
+    }
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    interface Recurring {
+        /**
+         * Billing frequency: day, week, month, or year
+         */
+        interval: 'day' | 'week' | 'month' | 'year';
+        /**
+         * Number of intervals between billings
+         */
+        interval_count?: number;
+    }
+}
+export interface VariantUpdateParams {
+    /**
+     * Path param: The unique identifier of the product
+     */
+    product_id: string;
+    /**
+     * Body param: Whether the variant is available for new purchases
+     */
+    active?: boolean;
+    /**
+     * Body param: Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Body param: Replace all media attachments. Pass empty array to remove all media.
+     */
+    media?: Array<VariantUpdateParams.Media>;
+    /**
+     * Body param: Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Body param: Display name for the variant
+     */
+    name?: string;
+}
+export declare namespace VariantUpdateParams {
+    /**
+     * Media input for attaching to products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID from upload
+         */
+        cdn_file_id: string;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order?: number;
+    }
+}
+export interface VariantListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: boolean;
+}
+export interface VariantGetParams {
+    /**
+     * The unique identifier of the product
+     */
+    product_id: string;
+}
+export declare namespace Variants {
+    export { type Variant as Variant, type VariantsCursorIDPage as VariantsCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantGetParams as VariantGetParams, };
+}
+//# sourceMappingURL=variants.d.mts.map

package/resources/commerce/products/variants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variants.d.mts","sourceRoot":"","sources":["../../../src/resources/commerce/products/variants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAQrG;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAO7C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAIhG;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/commerce/products/variants.d.ts

@@ -0,0 +1,294 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../core/pagination.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Variants extends APIResource {
+    /**
+     * Creates a new variant with pricing for a product. Use variants to offer multiple
+     * pricing tiers or configurations (e.g., Basic at $10/month, Pro at $25/month). A
+     * Stripe Price is automatically created.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.create(
+     *     'product_id',
+     *     { name: 'name' },
+     *   );
+     * ```
+     */
+    create(productID: string, body: VariantCreateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Updates an existing variant. Use this to modify the name, description, or active
+     * status. Pricing cannot be changed after creation—create a new variant instead.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.update(
+     *     'variant_id',
+     *     { product_id: 'product_id' },
+     *   );
+     * ```
+     */
+    update(variantID: string, params: VariantUpdateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Retrieves all variants for a product. Variants represent different pricing tiers
+     * or configurations (e.g., Basic, Pro, Enterprise) within a single product.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const variant of client.commerce.products.variants.list(
+     *   'product_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(productID: string, query?: VariantListParams | null | undefined, options?: RequestOptions): PagePromise<VariantsCursorIDPage, Variant>;
+    /**
+     * Retrieves a variant by ID. Returns the variant object including pricing details
+     * and status.
+     *
+     * @example
+     * ```ts
+     * const variant = await client.commerce.products.variants.get(
+     *   'variant_id',
+     *   { product_id: 'product_id' },
+     * );
+     * ```
+     */
+    get(variantID: string, params: VariantGetParams, options?: RequestOptions): APIPromise<Variant>;
+}
+export type VariantsCursorIDPage = CursorIDPage<Variant>;
+/**
+ * A product variant representing a specific tier or configuration. Each variant
+ * has its own pricing. Variants allow a single product to have multiple pricing
+ * options (e.g., Basic, Pro, Enterprise tiers).
+ */
+export interface Variant {
+    /**
+     * Unique identifier for the variant
+     */
+    id: string;
+    /**
+     * Whether the variant is available for new purchases
+     */
+    active: boolean;
+    /**
+     * Timestamp when the variant was created
+     */
+    created: string;
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the variant
+     */
+    media?: Array<Variant.Media>;
+    /**
+     * Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    recurring?: Variant.Recurring | null;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). 0 for free variants.
+     */
+    unit_amount?: number;
+}
+export declare namespace Variant {
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID
+         */
+        id: string;
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order: number;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * CDN URL of the media resource
+         */
+        url: string;
+        /**
+         * File size in bytes
+         */
+        file_size?: number;
+        /**
+         * Original filename
+         */
+        filename?: string;
+        /**
+         * Optimized thumbnail URL for images
+         */
+        thumbnail_url?: string;
+    }
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    interface Recurring {
+        /**
+         * Billing frequency: day, week, month, or year
+         */
+        interval: 'day' | 'week' | 'month' | 'year';
+        /**
+         * Number of intervals between billings
+         */
+        interval_count?: number;
+    }
+}
+export interface VariantCreateParams {
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Optional custom ID for the variant. Must start with 'var\_'. If not provided,
+     * one will be generated.
+     */
+    id?: string;
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Media attachments by CDN file ID
+     */
+    media?: Array<VariantCreateParams.Media>;
+    /**
+     * Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    recurring?: VariantCreateParams.Recurring;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). Use 0 for free
+     * variants.
+     */
+    unit_amount?: number;
+}
+export declare namespace VariantCreateParams {
+    /**
+     * Media input for attaching to products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID from upload
+         */
+        cdn_file_id: string;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order?: number;
+    }
+    /**
+     * Recurring billing configuration for subscription variants
+     */
+    interface Recurring {
+        /**
+         * Billing frequency: day, week, month, or year
+         */
+        interval: 'day' | 'week' | 'month' | 'year';
+        /**
+         * Number of intervals between billings
+         */
+        interval_count?: number;
+    }
+}
+export interface VariantUpdateParams {
+    /**
+     * Path param: The unique identifier of the product
+     */
+    product_id: string;
+    /**
+     * Body param: Whether the variant is available for new purchases
+     */
+    active?: boolean;
+    /**
+     * Body param: Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Body param: Replace all media attachments. Pass empty array to remove all media.
+     */
+    media?: Array<VariantUpdateParams.Media>;
+    /**
+     * Body param: Custom metadata for the variant
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Body param: Display name for the variant
+     */
+    name?: string;
+}
+export declare namespace VariantUpdateParams {
+    /**
+     * Media input for attaching to products or variants
+     */
+    interface Media {
+        /**
+         * CDN file ID from upload
+         */
+        cdn_file_id: string;
+        /**
+         * Type of media: image or video
+         */
+        type: 'image' | 'video';
+        /**
+         * Display order in gallery (0-indexed)
+         */
+        display_order?: number;
+    }
+}
+export interface VariantListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: boolean;
+}
+export interface VariantGetParams {
+    /**
+     * The unique identifier of the product
+     */
+    product_id: string;
+}
+export declare namespace Variants {
+    export { type Variant as Variant, type VariantsCursorIDPage as VariantsCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantGetParams as VariantGetParams, };
+}
+//# sourceMappingURL=variants.d.ts.map

package/resources/commerce/products/variants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variants.d.ts","sourceRoot":"","sources":["../../../src/resources/commerce/products/variants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAQrG;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAO7C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAIhG;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/{beta/commerce → commerce}/products/variants.js

@@ -2,14 +2,23 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Variants = void 0;
-const resource_1 = require("../../../../core/resource.js");
-const pagination_1 = require("../../../../core/pagination.js");
-const path_1 = require("../../../../internal/utils/path.js");
+const resource_1 = require("../../../core/resource.js");
+const pagination_1 = require("../../../core/pagination.js");
+const path_1 = require("../../../internal/utils/path.js");
 class Variants extends resource_1.APIResource {
     /**
      * Creates a new variant with pricing for a product. Use variants to offer multiple
      * pricing tiers or configurations (e.g., Basic at $10/month, Pro at $25/month). A
      * Stripe Price is automatically created.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.create(
+     *     'product_id',
+     *     { name: 'name' },
+     *   );
+     * ```
      */
     create(productID, body, options) {
         return this._client.post((0, path_1.path) `/v1/commerce/products/${productID}/variants`, { body, ...options });
@@ -17,6 +26,15 @@ class Variants extends resource_1.APIResource {
     /**
      * Updates an existing variant. Use this to modify the name, description, or active
      * status. Pricing cannot be changed after creation—create a new variant instead.
+     *
+     * @example
+     * ```ts
+     * const variant =
+     *   await client.commerce.products.variants.update(
+     *     'variant_id',
+     *     { product_id: 'product_id' },
+     *   );
+     * ```
      */
     update(variantID, params, options) {
         const { product_id, ...body } = params;
@@ -28,21 +46,34 @@ class Variants extends resource_1.APIResource {
     /**
      * Retrieves all variants for a product. Variants represent different pricing tiers
      * or configurations (e.g., Basic, Pro, Enterprise) within a single product.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const variant of client.commerce.products.variants.list(
+     *   'product_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(productID, query = {}, options) {
-        return this._client.getAPIList((0, path_1.path) `/v1/commerce/products/${productID}/variants`, (pagination_1.CursorIDPage), { query, ...options });
-    }
-    /**
-     * Archives a variant, preventing new subscriptions. The associated Stripe Price is
-     * also archived. Existing subscriptions remain active.
-     */
-    archive(variantID, params, options) {
-        const { product_id } = params;
-        return this._client.delete((0, path_1.path) `/v1/commerce/products/${product_id}/variants/${variantID}`, options);
+        return this._client.getAPIList((0, path_1.path) `/v1/commerce/products/${productID}/variants`, (pagination_1.CursorIDPage), {
+            query,
+            ...options,
+        });
     }
     /**
      * Retrieves a variant by ID. Returns the variant object including pricing details
      * and status.
+     *
+     * @example
+     * ```ts
+     * const variant = await client.commerce.products.variants.get(
+     *   'variant_id',
+     *   { product_id: 'product_id' },
+     * );
+     * ```
      */
     get(variantID, params, options) {
         const { product_id } = params;

package/resources/commerce/products/variants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variants.js","sourceRoot":"","sources":["../../../src/resources/commerce/products/variants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAA8F;AAE9F,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAiB,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,aAAa,SAAS,EAAE,EAAE;YACzF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAAiB,EACjB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,WAAW,EAAE,CAAA,yBAAqB,CAAA,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,SAAiB,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,UAAU,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF;AAjFD,4BAiFC"}