@usehercules/sdk 1.10.1 → 1.11.0

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

@@ -2,7 +2,7 @@ import { APIResource } from "../../../../core/resource.mjs";
 import * as ResourcesAPI from "./resources.mjs";
 import { ResourceAttachParams, ResourceAttachResponse, ResourceListParams, ResourceListResponse, ResourceListResponsesCursorIDPage, ResourceRemoveParams, Resources } from "./resources.mjs";
 import * as VariantsAPI from "./variants.mjs";
-import { VariantArchiveParams, VariantArchiveResponse, VariantCreateParams, VariantCreateResponse, VariantGetParams, VariantGetResponse, VariantListParams, VariantListResponse, VariantListResponsesCursorIDPage, VariantUpdateParams, VariantUpdateResponse, Variants } from "./variants.mjs";
+import { Variant as VariantsAPIVariant, VariantArchiveParams, VariantCreateParams, VariantGetParams, VariantListParams, VariantUpdateParams, Variants, VariantsCursorIDPage } from "./variants.mjs";
 import { APIPromise } from "../../../../core/api-promise.mjs";
 import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
 import { RequestOptions } from "../../../../internal/request-options.mjs";
@@ -15,37 +15,37 @@ export declare class Products extends APIResource {
      * resources to define which features or content customers on this product can
      * access.
      */
-    create(body: ProductCreateParams, options?: RequestOptions): APIPromise<ProductCreateResponse>;
+    create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
     /**
      * Updates an existing product. Use this to modify the product name, description,
      * or active status. Pricing cannot be changed after creation—create a new product
      * instead.
      */
-    update(productID: string, body?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<ProductUpdateResponse>;
+    update(productID: string, body?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
     /**
      * Retrieves a paginated list of subscription products. Products define the pricing
      * and billing intervals for subscriptions. Each product can have resources
      * attached that grant access to features or content.
      */
-    list(query?: ProductListParams | null | undefined, options?: RequestOptions): PagePromise<ProductListResponsesCursorIDPage, ProductListResponse>;
+    list(query?: ProductListParams | null | undefined, options?: RequestOptions): PagePromise<ProductsCursorIDPage, Product>;
     /**
      * Archives a product, preventing new subscriptions. Existing subscriptions remain
      * active. Use this instead of deletion to preserve subscription history.
      */
-    archive(productID: string, options?: RequestOptions): APIPromise<ProductArchiveResponse>;
+    archive(productID: string, options?: RequestOptions): APIPromise<Product>;
     /**
      * Retrieves a product by ID. Returns the product object including pricing details
      * and status.
      */
-    get(productID: string, options?: RequestOptions): APIPromise<ProductGetResponse>;
+    get(productID: string, options?: RequestOptions): APIPromise<Product>;
 }
-export type ProductListResponsesCursorIDPage = CursorIDPage<ProductListResponse>;
+export type ProductsCursorIDPage = CursorIDPage<Product>;
 /**
  * A product that customers can purchase. Products can be one-time purchases or
  * recurring subscriptions. Attach resources to a product to grant features to
  * customers.
  */
-export interface ProductCreateResponse {
+export interface Product {
     /**
      * Unique identifier for the topic subscription
      */
@@ -66,11 +66,11 @@ export interface ProductCreateResponse {
      * ID of the subscription group this product belongs to. Subscription groups define
      * shared billing configuration. All products must belong to a subscription group.
      */
-    product_group_id: string;
+    subscription_group_id: string;
     /**
      * Price configuration for a product. Can be one-time or recurring (subscription).
      */
-    default_price?: ProductCreateResponse.DefaultPrice | null;
+    default_price?: Product.DefaultPrice | null;
     /**
      * Detailed description of what the product includes
      */
@@ -78,7 +78,7 @@ export interface ProductCreateResponse {
     /**
      * Media attachments (images, videos) for the product
      */
-    media?: Array<ProductCreateResponse.Media>;
+    media?: Array<Product.Media>;
     /**
      * Custom metadata for the product
      */
@@ -89,669 +89,13 @@ export interface ProductCreateResponse {
      * Resources attached to this product. Customers get access to these resources when
      * they purchase the product.
      */
-    resources?: Array<ProductCreateResponse.Resource>;
+    resources?: Array<Product.Resource>;
     /**
      * Tags for categorizing and filtering products
      */
     tags?: Array<string>;
 }
-export declare namespace ProductCreateResponse {
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    interface DefaultPrice {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Three-letter ISO currency code (e.g., usd, eur)
-         */
-        currency: string;
-        /**
-         * Billing frequency for recurring prices: day, week, month, or year. Null for
-         * one-time prices.
-         */
-        interval: 'day' | 'week' | 'month' | 'year' | null;
-        /**
-         * Number of intervals between billings for recurring prices. Null for one-time
-         * prices.
-         */
-        interval_count: number | null;
-        /**
-         * Price type: one_time for single purchases, recurring for subscriptions
-         */
-        type: 'one_time' | 'recurring';
-        /**
-         * Price amount in the smallest currency unit (e.g., cents)
-         */
-        unit_amount: number | null;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * A resource that can be attached to products to grant access to customers.
-     * Resources represent monetizable content or features in your app.
-     */
-    interface Resource {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Whether the resource is active and grants access
-         */
-        active: boolean;
-        /**
-         * Timestamp when the resource was created
-         */
-        created: string;
-        /**
-         * Type of resource
-         */
-        type: 'feature';
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        custom_entitlement?: Resource.CustomEntitlement | null;
-    }
-    namespace Resource {
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        interface CustomEntitlement {
-            /**
-             * The feature key that identifies what access is granted (e.g., 'pro_features')
-             */
-            id: string;
-            /**
-             * Custom metadata for the feature grant
-             */
-            metadata?: {
-                [key: string]: unknown;
-            };
-        }
-    }
-}
-/**
- * A product that customers can purchase. Products can be one-time purchases or
- * recurring subscriptions. Attach resources to a product to grant features to
- * customers.
- */
-export interface ProductUpdateResponse {
-    /**
-     * Unique identifier for the topic subscription
-     */
-    id: string;
-    /**
-     * Whether the product is available for new purchases
-     */
-    active: boolean;
-    /**
-     * Timestamp when the product was created
-     */
-    created: string;
-    /**
-     * Display name for the product (e.g., Pro, Business, Teams)
-     */
-    name: string;
-    /**
-     * ID of the subscription group this product belongs to. Subscription groups define
-     * shared billing configuration. All products must belong to a subscription group.
-     */
-    product_group_id: string;
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    default_price?: ProductUpdateResponse.DefaultPrice | null;
-    /**
-     * Detailed description of what the product includes
-     */
-    description?: string | null;
-    /**
-     * Media attachments (images, videos) for the product
-     */
-    media?: Array<ProductUpdateResponse.Media>;
-    /**
-     * Custom metadata for the product
-     */
-    metadata?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Resources attached to this product. Customers get access to these resources when
-     * they purchase the product.
-     */
-    resources?: Array<ProductUpdateResponse.Resource>;
-    /**
-     * Tags for categorizing and filtering products
-     */
-    tags?: Array<string>;
-}
-export declare namespace ProductUpdateResponse {
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    interface DefaultPrice {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Three-letter ISO currency code (e.g., usd, eur)
-         */
-        currency: string;
-        /**
-         * Billing frequency for recurring prices: day, week, month, or year. Null for
-         * one-time prices.
-         */
-        interval: 'day' | 'week' | 'month' | 'year' | null;
-        /**
-         * Number of intervals between billings for recurring prices. Null for one-time
-         * prices.
-         */
-        interval_count: number | null;
-        /**
-         * Price type: one_time for single purchases, recurring for subscriptions
-         */
-        type: 'one_time' | 'recurring';
-        /**
-         * Price amount in the smallest currency unit (e.g., cents)
-         */
-        unit_amount: number | null;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * A resource that can be attached to products to grant access to customers.
-     * Resources represent monetizable content or features in your app.
-     */
-    interface Resource {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Whether the resource is active and grants access
-         */
-        active: boolean;
-        /**
-         * Timestamp when the resource was created
-         */
-        created: string;
-        /**
-         * Type of resource
-         */
-        type: 'feature';
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        custom_entitlement?: Resource.CustomEntitlement | null;
-    }
-    namespace Resource {
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        interface CustomEntitlement {
-            /**
-             * The feature key that identifies what access is granted (e.g., 'pro_features')
-             */
-            id: string;
-            /**
-             * Custom metadata for the feature grant
-             */
-            metadata?: {
-                [key: string]: unknown;
-            };
-        }
-    }
-}
-/**
- * A product that customers can purchase. Products can be one-time purchases or
- * recurring subscriptions. Attach resources to a product to grant features to
- * customers.
- */
-export interface ProductListResponse {
-    /**
-     * Unique identifier for the topic subscription
-     */
-    id: string;
-    /**
-     * Whether the product is available for new purchases
-     */
-    active: boolean;
-    /**
-     * Timestamp when the product was created
-     */
-    created: string;
-    /**
-     * Display name for the product (e.g., Pro, Business, Teams)
-     */
-    name: string;
-    /**
-     * ID of the subscription group this product belongs to. Subscription groups define
-     * shared billing configuration. All products must belong to a subscription group.
-     */
-    product_group_id: string;
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    default_price?: ProductListResponse.DefaultPrice | null;
-    /**
-     * Detailed description of what the product includes
-     */
-    description?: string | null;
-    /**
-     * Media attachments (images, videos) for the product
-     */
-    media?: Array<ProductListResponse.Media>;
-    /**
-     * Custom metadata for the product
-     */
-    metadata?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Resources attached to this product. Customers get access to these resources when
-     * they purchase the product.
-     */
-    resources?: Array<ProductListResponse.Resource>;
-    /**
-     * Tags for categorizing and filtering products
-     */
-    tags?: Array<string>;
-}
-export declare namespace ProductListResponse {
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    interface DefaultPrice {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Three-letter ISO currency code (e.g., usd, eur)
-         */
-        currency: string;
-        /**
-         * Billing frequency for recurring prices: day, week, month, or year. Null for
-         * one-time prices.
-         */
-        interval: 'day' | 'week' | 'month' | 'year' | null;
-        /**
-         * Number of intervals between billings for recurring prices. Null for one-time
-         * prices.
-         */
-        interval_count: number | null;
-        /**
-         * Price type: one_time for single purchases, recurring for subscriptions
-         */
-        type: 'one_time' | 'recurring';
-        /**
-         * Price amount in the smallest currency unit (e.g., cents)
-         */
-        unit_amount: number | null;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * A resource that can be attached to products to grant access to customers.
-     * Resources represent monetizable content or features in your app.
-     */
-    interface Resource {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Whether the resource is active and grants access
-         */
-        active: boolean;
-        /**
-         * Timestamp when the resource was created
-         */
-        created: string;
-        /**
-         * Type of resource
-         */
-        type: 'feature';
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        custom_entitlement?: Resource.CustomEntitlement | null;
-    }
-    namespace Resource {
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        interface CustomEntitlement {
-            /**
-             * The feature key that identifies what access is granted (e.g., 'pro_features')
-             */
-            id: string;
-            /**
-             * Custom metadata for the feature grant
-             */
-            metadata?: {
-                [key: string]: unknown;
-            };
-        }
-    }
-}
-/**
- * A product that customers can purchase. Products can be one-time purchases or
- * recurring subscriptions. Attach resources to a product to grant features to
- * customers.
- */
-export interface ProductArchiveResponse {
-    /**
-     * Unique identifier for the topic subscription
-     */
-    id: string;
-    /**
-     * Whether the product is available for new purchases
-     */
-    active: boolean;
-    /**
-     * Timestamp when the product was created
-     */
-    created: string;
-    /**
-     * Display name for the product (e.g., Pro, Business, Teams)
-     */
-    name: string;
-    /**
-     * ID of the subscription group this product belongs to. Subscription groups define
-     * shared billing configuration. All products must belong to a subscription group.
-     */
-    product_group_id: string;
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    default_price?: ProductArchiveResponse.DefaultPrice | null;
-    /**
-     * Detailed description of what the product includes
-     */
-    description?: string | null;
-    /**
-     * Media attachments (images, videos) for the product
-     */
-    media?: Array<ProductArchiveResponse.Media>;
-    /**
-     * Custom metadata for the product
-     */
-    metadata?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Resources attached to this product. Customers get access to these resources when
-     * they purchase the product.
-     */
-    resources?: Array<ProductArchiveResponse.Resource>;
-    /**
-     * Tags for categorizing and filtering products
-     */
-    tags?: Array<string>;
-}
-export declare namespace ProductArchiveResponse {
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    interface DefaultPrice {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Three-letter ISO currency code (e.g., usd, eur)
-         */
-        currency: string;
-        /**
-         * Billing frequency for recurring prices: day, week, month, or year. Null for
-         * one-time prices.
-         */
-        interval: 'day' | 'week' | 'month' | 'year' | null;
-        /**
-         * Number of intervals between billings for recurring prices. Null for one-time
-         * prices.
-         */
-        interval_count: number | null;
-        /**
-         * Price type: one_time for single purchases, recurring for subscriptions
-         */
-        type: 'one_time' | 'recurring';
-        /**
-         * Price amount in the smallest currency unit (e.g., cents)
-         */
-        unit_amount: number | null;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * A resource that can be attached to products to grant access to customers.
-     * Resources represent monetizable content or features in your app.
-     */
-    interface Resource {
-        /**
-         * Unique identifier for the topic subscription
-         */
-        id: string;
-        /**
-         * Whether the resource is active and grants access
-         */
-        active: boolean;
-        /**
-         * Timestamp when the resource was created
-         */
-        created: string;
-        /**
-         * Type of resource
-         */
-        type: 'feature';
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        custom_entitlement?: Resource.CustomEntitlement | null;
-    }
-    namespace Resource {
-        /**
-         * Feature grant data. Required when type is 'feature'.
-         */
-        interface CustomEntitlement {
-            /**
-             * The feature key that identifies what access is granted (e.g., 'pro_features')
-             */
-            id: string;
-            /**
-             * Custom metadata for the feature grant
-             */
-            metadata?: {
-                [key: string]: unknown;
-            };
-        }
-    }
-}
-/**
- * A product that customers can purchase. Products can be one-time purchases or
- * recurring subscriptions. Attach resources to a product to grant features to
- * customers.
- */
-export interface ProductGetResponse {
-    /**
-     * Unique identifier for the topic subscription
-     */
-    id: string;
-    /**
-     * Whether the product is available for new purchases
-     */
-    active: boolean;
-    /**
-     * Timestamp when the product was created
-     */
-    created: string;
-    /**
-     * Display name for the product (e.g., Pro, Business, Teams)
-     */
-    name: string;
-    /**
-     * ID of the subscription group this product belongs to. Subscription groups define
-     * shared billing configuration. All products must belong to a subscription group.
-     */
-    product_group_id: string;
-    /**
-     * Price configuration for a product. Can be one-time or recurring (subscription).
-     */
-    default_price?: ProductGetResponse.DefaultPrice | null;
-    /**
-     * Detailed description of what the product includes
-     */
-    description?: string | null;
-    /**
-     * Media attachments (images, videos) for the product
-     */
-    media?: Array<ProductGetResponse.Media>;
-    /**
-     * Custom metadata for the product
-     */
-    metadata?: {
-        [key: string]: unknown;
-    };
-    /**
-     * Resources attached to this product. Customers get access to these resources when
-     * they purchase the product.
-     */
-    resources?: Array<ProductGetResponse.Resource>;
-    /**
-     * Tags for categorizing and filtering products
-     */
-    tags?: Array<string>;
-}
-export declare namespace ProductGetResponse {
+export declare namespace Product {
     /**
      * Price configuration for a product. Can be one-time or recurring (subscription).
      */
@@ -893,7 +237,7 @@ export interface ProductCreateParams {
      * ID of the subscription group this product belongs to. Subscription groups define
      * shared billing configuration.
      */
-    product_group_id?: string;
+    subscription_group_id?: string;
     /**
      * Tags for categorizing and filtering products
      */
@@ -1020,7 +364,7 @@ export interface ProductUpdateParams {
      * ID of the subscription group to move this product to. All products must belong
      * to a subscription group.
      */
-    product_group_id?: string;
+    subscription_group_id?: string;
     /**
      * Tags for categorizing and filtering products
      */
@@ -1052,8 +396,8 @@ export interface ProductListParams extends CursorIDPageParams {
     active?: 'true' | 'false';
 }
 export declare namespace Products {
-    export { type ProductCreateResponse as ProductCreateResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductArchiveResponse as ProductArchiveResponse, type ProductGetResponse as ProductGetResponse, type ProductListResponsesCursorIDPage as ProductListResponsesCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
+    export { type Product as Product, type ProductsCursorIDPage as ProductsCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
     export { Resources as Resources, type ResourceListResponse as ResourceListResponse, type ResourceAttachResponse as ResourceAttachResponse, type ResourceListResponsesCursorIDPage as ResourceListResponsesCursorIDPage, type ResourceListParams as ResourceListParams, type ResourceAttachParams as ResourceAttachParams, type ResourceRemoveParams as ResourceRemoveParams, };
-    export { Variants as Variants, type VariantCreateResponse as VariantCreateResponse, type VariantUpdateResponse as VariantUpdateResponse, type VariantListResponse as VariantListResponse, type VariantArchiveResponse as VariantArchiveResponse, type VariantGetResponse as VariantGetResponse, type VariantListResponsesCursorIDPage as VariantListResponsesCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantArchiveParams as VariantArchiveParams, type VariantGetParams as VariantGetParams, };
+    export { Variants as Variants, type VariantsAPIVariant as Variant, type VariantsCursorIDPage as VariantsCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantArchiveParams as VariantArchiveParams, type VariantGetParams as VariantGetParams, };
 }
 //# sourceMappingURL=products.d.mts.map