dodopayments 2.23.2 → 2.24.0

package/resources/product-collections/product-collections.d.mts

@@ -0,0 +1,307 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as MiscAPI from "../misc.mjs";
+import * as ProductsAPI from "../products/products.mjs";
+import * as GroupsAPI from "./groups/groups.mjs";
+import { GroupCreateParams, GroupCreateResponse, GroupDeleteParams, GroupUpdateParams, Groups } from "./groups/groups.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { DefaultPageNumberPagination, type DefaultPageNumberPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class ProductCollections extends APIResource {
+    groups: GroupsAPI.Groups;
+    create(body: ProductCollectionCreateParams, options?: RequestOptions): APIPromise<ProductCollectionCreateResponse>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<ProductCollectionRetrieveResponse>;
+    update(id: string, body: ProductCollectionUpdateParams, options?: RequestOptions): APIPromise<void>;
+    list(query?: ProductCollectionListParams | null | undefined, options?: RequestOptions): PagePromise<ProductCollectionListResponsesDefaultPageNumberPagination, ProductCollectionListResponse>;
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    unarchive(id: string, options?: RequestOptions): APIPromise<ProductCollectionUnarchiveResponse>;
+    updateImages(id: string, params?: ProductCollectionUpdateImagesParams | null | undefined, options?: RequestOptions): APIPromise<ProductCollectionUpdateImagesResponse>;
+}
+export type ProductCollectionListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<ProductCollectionListResponse>;
+export interface ProductCollectionCreateResponse {
+    /**
+     * Unique identifier for the product collection
+     */
+    id: string;
+    /**
+     * Brand ID for the collection
+     */
+    brand_id: string;
+    /**
+     * Timestamp when the collection was created
+     */
+    created_at: string;
+    /**
+     * Groups in this collection
+     */
+    groups: Array<ProductCollectionCreateResponse.Group>;
+    /**
+     * Name of the collection
+     */
+    name: string;
+    /**
+     * Timestamp when the collection was last updated
+     */
+    updated_at: string;
+    /**
+     * Description of the collection
+     */
+    description?: string | null;
+    /**
+     * URL of the collection image
+     */
+    image?: string | null;
+}
+export declare namespace ProductCollectionCreateResponse {
+    interface Group {
+        group_id: string;
+        products: Array<Group.Product>;
+        status: boolean;
+        group_name?: string | null;
+    }
+    namespace Group {
+        interface Product {
+            id: string;
+            addons_count: number;
+            files_count: number;
+            /**
+             * Whether this product has any credit entitlements attached
+             */
+            has_credit_entitlements: boolean;
+            is_recurring: boolean;
+            license_key_enabled: boolean;
+            meters_count: number;
+            product_id: string;
+            status: boolean;
+            currency?: MiscAPI.Currency | null;
+            description?: string | null;
+            name?: string | null;
+            price?: number | null;
+            /**
+             * One-time price details.
+             */
+            price_detail?: ProductsAPI.Price | null;
+            /**
+             * Represents the different categories of taxation applicable to various products
+             * and services.
+             */
+            tax_category?: MiscAPI.TaxCategory | null;
+            tax_inclusive?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionRetrieveResponse {
+    /**
+     * Unique identifier for the product collection
+     */
+    id: string;
+    /**
+     * Brand ID for the collection
+     */
+    brand_id: string;
+    /**
+     * Timestamp when the collection was created
+     */
+    created_at: string;
+    /**
+     * Groups in this collection
+     */
+    groups: Array<ProductCollectionRetrieveResponse.Group>;
+    /**
+     * Name of the collection
+     */
+    name: string;
+    /**
+     * Timestamp when the collection was last updated
+     */
+    updated_at: string;
+    /**
+     * Description of the collection
+     */
+    description?: string | null;
+    /**
+     * URL of the collection image
+     */
+    image?: string | null;
+}
+export declare namespace ProductCollectionRetrieveResponse {
+    interface Group {
+        group_id: string;
+        products: Array<Group.Product>;
+        status: boolean;
+        group_name?: string | null;
+    }
+    namespace Group {
+        interface Product {
+            id: string;
+            addons_count: number;
+            files_count: number;
+            /**
+             * Whether this product has any credit entitlements attached
+             */
+            has_credit_entitlements: boolean;
+            is_recurring: boolean;
+            license_key_enabled: boolean;
+            meters_count: number;
+            product_id: string;
+            status: boolean;
+            currency?: MiscAPI.Currency | null;
+            description?: string | null;
+            name?: string | null;
+            price?: number | null;
+            /**
+             * One-time price details.
+             */
+            price_detail?: ProductsAPI.Price | null;
+            /**
+             * Represents the different categories of taxation applicable to various products
+             * and services.
+             */
+            tax_category?: MiscAPI.TaxCategory | null;
+            tax_inclusive?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionListResponse {
+    /**
+     * Collection ID
+     */
+    id: string;
+    /**
+     * Timestamp when created
+     */
+    created_at: string;
+    /**
+     * Collection name
+     */
+    name: string;
+    /**
+     * Number of products in the collection
+     */
+    products_count: number;
+    /**
+     * Timestamp when last updated
+     */
+    updated_at: string;
+    /**
+     * Collection description
+     */
+    description?: string | null;
+    /**
+     * Collection image URL
+     */
+    image?: string | null;
+}
+export interface ProductCollectionUnarchiveResponse {
+    /**
+     * Collection ID that was unarchived
+     */
+    collection_id: string;
+    /**
+     * Product IDs that were excluded because they are archived
+     */
+    excluded_product_ids: Array<string>;
+    /**
+     * Success message
+     */
+    message: string;
+}
+export interface ProductCollectionUpdateImagesResponse {
+    /**
+     * Presigned S3 URL for uploading the image
+     */
+    url: string;
+    /**
+     * Optional image ID (present when force_update is true)
+     */
+    image_id?: string | null;
+}
+export interface ProductCollectionCreateParams {
+    /**
+     * Groups of products in this collection
+     */
+    groups: Array<ProductCollectionCreateParams.Group>;
+    /**
+     * Name of the product collection
+     */
+    name: string;
+    /**
+     * Brand id for the collection, if not provided will default to primary brand
+     */
+    brand_id?: string | null;
+    /**
+     * Optional description of the product collection
+     */
+    description?: string | null;
+}
+export declare namespace ProductCollectionCreateParams {
+    interface Group {
+        /**
+         * Products in this group
+         */
+        products: Array<Group.Product>;
+        /**
+         * Optional group name. Multiple groups can have null names, but named groups must
+         * be unique per collection
+         */
+        group_name?: string | null;
+        /**
+         * Status of the group (defaults to true if not provided)
+         */
+        status?: boolean | null;
+    }
+    namespace Group {
+        interface Product {
+            /**
+             * Product ID to include in the group
+             */
+            product_id: string;
+            /**
+             * Status of the product in this group (defaults to true if not provided)
+             */
+            status?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionUpdateParams {
+    /**
+     * Optional brand_id update
+     */
+    brand_id?: string | null;
+    /**
+     * Optional description update - pass null to remove, omit to keep unchanged
+     */
+    description?: string | null;
+    /**
+     * Optional new order for groups (array of group UUIDs in desired order)
+     */
+    group_order?: Array<string> | null;
+    /**
+     * Optional image update - pass null to remove, omit to keep unchanged
+     */
+    image_id?: string | null;
+    /**
+     * Optional new name for the collection
+     */
+    name?: string | null;
+}
+export interface ProductCollectionListParams extends DefaultPageNumberPaginationParams {
+    /**
+     * List archived collections
+     */
+    archived?: boolean;
+    /**
+     * Filter by Brand id
+     */
+    brand_id?: string;
+}
+export interface ProductCollectionUpdateImagesParams {
+    /**
+     * If true, generates a new image ID to force cache invalidation
+     */
+    force_update?: boolean | null;
+}
+export declare namespace ProductCollections {
+    export { type ProductCollectionCreateResponse as ProductCollectionCreateResponse, type ProductCollectionRetrieveResponse as ProductCollectionRetrieveResponse, type ProductCollectionListResponse as ProductCollectionListResponse, type ProductCollectionUnarchiveResponse as ProductCollectionUnarchiveResponse, type ProductCollectionUpdateImagesResponse as ProductCollectionUpdateImagesResponse, type ProductCollectionListResponsesDefaultPageNumberPagination as ProductCollectionListResponsesDefaultPageNumberPagination, type ProductCollectionCreateParams as ProductCollectionCreateParams, type ProductCollectionUpdateParams as ProductCollectionUpdateParams, type ProductCollectionListParams as ProductCollectionListParams, type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams, };
+    export { Groups as Groups, type GroupCreateResponse as GroupCreateResponse, type GroupCreateParams as GroupCreateParams, type GroupUpdateParams as GroupUpdateParams, type GroupDeleteParams as GroupDeleteParams, };
+}
+//# sourceMappingURL=product-collections.d.mts.map

package/resources/product-collections/product-collections.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"product-collections.d.mts","sourceRoot":"","sources":["../../src/resources/product-collections/product-collections.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,WAAW;OAChB,KAAK,SAAS;OACd,EACL,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,EACP;OACM,EAAE,UAAU,EAAE;OACd,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAGzB,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D,MAAM,CACJ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI7F,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yDAAyD,EAAE,6BAA6B,CAAC;IAQxG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI/F,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAIrD;AAED,MAAM,MAAM,yDAAyD,GACnE,2BAA2B,CAAC,6BAA6B,CAAC,CAAC;AAE7D,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,KAAK;QACpB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,YAAY,EAAE,MAAM,CAAC;YAErB,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,uBAAuB,EAAE,OAAO,CAAC;YAEjC,YAAY,EAAE,OAAO,CAAC;YAEtB,mBAAmB,EAAE,OAAO,CAAC;YAE7B,YAAY,EAAE,MAAM,CAAC;YAErB,UAAU,EAAE,MAAM,CAAC;YAEnB,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,YAAY,CAAC,EAAE,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC;YAExC;;;eAGG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;YAE1C,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,KAAK;QACpB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,YAAY,EAAE,MAAM,CAAC;YAErB,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,uBAAuB,EAAE,OAAO,CAAC;YAEjC,YAAY,EAAE,OAAO,CAAC;YAEtB,mBAAmB,EAAE,OAAO,CAAC;YAE7B,YAAY,EAAE,MAAM,CAAC;YAErB,UAAU,EAAE,MAAM,CAAC;YAEnB,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,YAAY,CAAC,EAAE,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC;YAExC;;;eAGG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;YAE1C,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yDAAyD,IAAI,yDAAyD,EAC3H,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/product-collections/product-collections.d.ts

@@ -0,0 +1,307 @@
+import { APIResource } from "../../core/resource.js";
+import * as MiscAPI from "../misc.js";
+import * as ProductsAPI from "../products/products.js";
+import * as GroupsAPI from "./groups/groups.js";
+import { GroupCreateParams, GroupCreateResponse, GroupDeleteParams, GroupUpdateParams, Groups } from "./groups/groups.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { DefaultPageNumberPagination, type DefaultPageNumberPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class ProductCollections extends APIResource {
+    groups: GroupsAPI.Groups;
+    create(body: ProductCollectionCreateParams, options?: RequestOptions): APIPromise<ProductCollectionCreateResponse>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<ProductCollectionRetrieveResponse>;
+    update(id: string, body: ProductCollectionUpdateParams, options?: RequestOptions): APIPromise<void>;
+    list(query?: ProductCollectionListParams | null | undefined, options?: RequestOptions): PagePromise<ProductCollectionListResponsesDefaultPageNumberPagination, ProductCollectionListResponse>;
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    unarchive(id: string, options?: RequestOptions): APIPromise<ProductCollectionUnarchiveResponse>;
+    updateImages(id: string, params?: ProductCollectionUpdateImagesParams | null | undefined, options?: RequestOptions): APIPromise<ProductCollectionUpdateImagesResponse>;
+}
+export type ProductCollectionListResponsesDefaultPageNumberPagination = DefaultPageNumberPagination<ProductCollectionListResponse>;
+export interface ProductCollectionCreateResponse {
+    /**
+     * Unique identifier for the product collection
+     */
+    id: string;
+    /**
+     * Brand ID for the collection
+     */
+    brand_id: string;
+    /**
+     * Timestamp when the collection was created
+     */
+    created_at: string;
+    /**
+     * Groups in this collection
+     */
+    groups: Array<ProductCollectionCreateResponse.Group>;
+    /**
+     * Name of the collection
+     */
+    name: string;
+    /**
+     * Timestamp when the collection was last updated
+     */
+    updated_at: string;
+    /**
+     * Description of the collection
+     */
+    description?: string | null;
+    /**
+     * URL of the collection image
+     */
+    image?: string | null;
+}
+export declare namespace ProductCollectionCreateResponse {
+    interface Group {
+        group_id: string;
+        products: Array<Group.Product>;
+        status: boolean;
+        group_name?: string | null;
+    }
+    namespace Group {
+        interface Product {
+            id: string;
+            addons_count: number;
+            files_count: number;
+            /**
+             * Whether this product has any credit entitlements attached
+             */
+            has_credit_entitlements: boolean;
+            is_recurring: boolean;
+            license_key_enabled: boolean;
+            meters_count: number;
+            product_id: string;
+            status: boolean;
+            currency?: MiscAPI.Currency | null;
+            description?: string | null;
+            name?: string | null;
+            price?: number | null;
+            /**
+             * One-time price details.
+             */
+            price_detail?: ProductsAPI.Price | null;
+            /**
+             * Represents the different categories of taxation applicable to various products
+             * and services.
+             */
+            tax_category?: MiscAPI.TaxCategory | null;
+            tax_inclusive?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionRetrieveResponse {
+    /**
+     * Unique identifier for the product collection
+     */
+    id: string;
+    /**
+     * Brand ID for the collection
+     */
+    brand_id: string;
+    /**
+     * Timestamp when the collection was created
+     */
+    created_at: string;
+    /**
+     * Groups in this collection
+     */
+    groups: Array<ProductCollectionRetrieveResponse.Group>;
+    /**
+     * Name of the collection
+     */
+    name: string;
+    /**
+     * Timestamp when the collection was last updated
+     */
+    updated_at: string;
+    /**
+     * Description of the collection
+     */
+    description?: string | null;
+    /**
+     * URL of the collection image
+     */
+    image?: string | null;
+}
+export declare namespace ProductCollectionRetrieveResponse {
+    interface Group {
+        group_id: string;
+        products: Array<Group.Product>;
+        status: boolean;
+        group_name?: string | null;
+    }
+    namespace Group {
+        interface Product {
+            id: string;
+            addons_count: number;
+            files_count: number;
+            /**
+             * Whether this product has any credit entitlements attached
+             */
+            has_credit_entitlements: boolean;
+            is_recurring: boolean;
+            license_key_enabled: boolean;
+            meters_count: number;
+            product_id: string;
+            status: boolean;
+            currency?: MiscAPI.Currency | null;
+            description?: string | null;
+            name?: string | null;
+            price?: number | null;
+            /**
+             * One-time price details.
+             */
+            price_detail?: ProductsAPI.Price | null;
+            /**
+             * Represents the different categories of taxation applicable to various products
+             * and services.
+             */
+            tax_category?: MiscAPI.TaxCategory | null;
+            tax_inclusive?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionListResponse {
+    /**
+     * Collection ID
+     */
+    id: string;
+    /**
+     * Timestamp when created
+     */
+    created_at: string;
+    /**
+     * Collection name
+     */
+    name: string;
+    /**
+     * Number of products in the collection
+     */
+    products_count: number;
+    /**
+     * Timestamp when last updated
+     */
+    updated_at: string;
+    /**
+     * Collection description
+     */
+    description?: string | null;
+    /**
+     * Collection image URL
+     */
+    image?: string | null;
+}
+export interface ProductCollectionUnarchiveResponse {
+    /**
+     * Collection ID that was unarchived
+     */
+    collection_id: string;
+    /**
+     * Product IDs that were excluded because they are archived
+     */
+    excluded_product_ids: Array<string>;
+    /**
+     * Success message
+     */
+    message: string;
+}
+export interface ProductCollectionUpdateImagesResponse {
+    /**
+     * Presigned S3 URL for uploading the image
+     */
+    url: string;
+    /**
+     * Optional image ID (present when force_update is true)
+     */
+    image_id?: string | null;
+}
+export interface ProductCollectionCreateParams {
+    /**
+     * Groups of products in this collection
+     */
+    groups: Array<ProductCollectionCreateParams.Group>;
+    /**
+     * Name of the product collection
+     */
+    name: string;
+    /**
+     * Brand id for the collection, if not provided will default to primary brand
+     */
+    brand_id?: string | null;
+    /**
+     * Optional description of the product collection
+     */
+    description?: string | null;
+}
+export declare namespace ProductCollectionCreateParams {
+    interface Group {
+        /**
+         * Products in this group
+         */
+        products: Array<Group.Product>;
+        /**
+         * Optional group name. Multiple groups can have null names, but named groups must
+         * be unique per collection
+         */
+        group_name?: string | null;
+        /**
+         * Status of the group (defaults to true if not provided)
+         */
+        status?: boolean | null;
+    }
+    namespace Group {
+        interface Product {
+            /**
+             * Product ID to include in the group
+             */
+            product_id: string;
+            /**
+             * Status of the product in this group (defaults to true if not provided)
+             */
+            status?: boolean | null;
+        }
+    }
+}
+export interface ProductCollectionUpdateParams {
+    /**
+     * Optional brand_id update
+     */
+    brand_id?: string | null;
+    /**
+     * Optional description update - pass null to remove, omit to keep unchanged
+     */
+    description?: string | null;
+    /**
+     * Optional new order for groups (array of group UUIDs in desired order)
+     */
+    group_order?: Array<string> | null;
+    /**
+     * Optional image update - pass null to remove, omit to keep unchanged
+     */
+    image_id?: string | null;
+    /**
+     * Optional new name for the collection
+     */
+    name?: string | null;
+}
+export interface ProductCollectionListParams extends DefaultPageNumberPaginationParams {
+    /**
+     * List archived collections
+     */
+    archived?: boolean;
+    /**
+     * Filter by Brand id
+     */
+    brand_id?: string;
+}
+export interface ProductCollectionUpdateImagesParams {
+    /**
+     * If true, generates a new image ID to force cache invalidation
+     */
+    force_update?: boolean | null;
+}
+export declare namespace ProductCollections {
+    export { type ProductCollectionCreateResponse as ProductCollectionCreateResponse, type ProductCollectionRetrieveResponse as ProductCollectionRetrieveResponse, type ProductCollectionListResponse as ProductCollectionListResponse, type ProductCollectionUnarchiveResponse as ProductCollectionUnarchiveResponse, type ProductCollectionUpdateImagesResponse as ProductCollectionUpdateImagesResponse, type ProductCollectionListResponsesDefaultPageNumberPagination as ProductCollectionListResponsesDefaultPageNumberPagination, type ProductCollectionCreateParams as ProductCollectionCreateParams, type ProductCollectionUpdateParams as ProductCollectionUpdateParams, type ProductCollectionListParams as ProductCollectionListParams, type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams, };
+    export { Groups as Groups, type GroupCreateResponse as GroupCreateResponse, type GroupCreateParams as GroupCreateParams, type GroupUpdateParams as GroupUpdateParams, type GroupDeleteParams as GroupDeleteParams, };
+}
+//# sourceMappingURL=product-collections.d.ts.map

package/resources/product-collections/product-collections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"product-collections.d.ts","sourceRoot":"","sources":["../../src/resources/product-collections/product-collections.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,WAAW;OAChB,KAAK,SAAS;OACd,EACL,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,EACP;OACM,EAAE,UAAU,EAAE;OACd,EACL,2BAA2B,EAC3B,KAAK,iCAAiC,EACtC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAGzB,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D,MAAM,CACJ,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI7F,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnG,IAAI,CACF,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yDAAyD,EAAE,6BAA6B,CAAC;IAQxG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI/F,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAIrD;AAED,MAAM,MAAM,yDAAyD,GACnE,2BAA2B,CAAC,6BAA6B,CAAC,CAAC;AAE7D,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,KAAK;QACpB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,YAAY,EAAE,MAAM,CAAC;YAErB,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,uBAAuB,EAAE,OAAO,CAAC;YAEjC,YAAY,EAAE,OAAO,CAAC;YAEtB,mBAAmB,EAAE,OAAO,CAAC;YAE7B,YAAY,EAAE,MAAM,CAAC;YAErB,UAAU,EAAE,MAAM,CAAC;YAEnB,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,YAAY,CAAC,EAAE,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC;YAExC;;;eAGG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;YAE1C,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC;IAEvD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,iCAAiC,CAAC;IACjD,UAAiB,KAAK;QACpB,QAAQ,EAAE,MAAM,CAAC;QAEjB,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,CAAC;QAEhB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB,EAAE,EAAE,MAAM,CAAC;YAEX,YAAY,EAAE,MAAM,CAAC;YAErB,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,uBAAuB,EAAE,OAAO,CAAC;YAEjC,YAAY,EAAE,OAAO,CAAC;YAEtB,mBAAmB,EAAE,OAAO,CAAC;YAE7B,YAAY,EAAE,MAAM,CAAC;YAErB,UAAU,EAAE,MAAM,CAAC;YAEnB,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;YAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,YAAY,CAAC,EAAE,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC;YAExC;;;eAGG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;YAE1C,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,KAAK;QACpB;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE/B;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,2BAA4B,SAAQ,iCAAiC;IACpF;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAID,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,yDAAyD,IAAI,yDAAyD,EAC3H,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/product-collections/product-collections.js

@@ -0,0 +1,49 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductCollections = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const GroupsAPI = tslib_1.__importStar(require("./groups/groups.js"));
+const groups_1 = require("./groups/groups.js");
+const pagination_1 = require("../../core/pagination.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class ProductCollections extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.groups = new GroupsAPI.Groups(this._client);
+    }
+    create(body, options) {
+        return this._client.post('/product-collections', { body, ...options });
+    }
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/product-collections/${id}`, options);
+    }
+    update(id, body, options) {
+        return this._client.patch((0, path_1.path) `/product-collections/${id}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    list(query = {}, options) {
+        return this._client.getAPIList('/product-collections', (pagination_1.DefaultPageNumberPagination), { query, ...options });
+    }
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/product-collections/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    unarchive(id, options) {
+        return this._client.post((0, path_1.path) `/product-collections/${id}/unarchive`, options);
+    }
+    updateImages(id, params = {}, options) {
+        const { force_update } = params ?? {};
+        return this._client.put((0, path_1.path) `/product-collections/${id}/images`, { query: { force_update }, ...options });
+    }
+}
+exports.ProductCollections = ProductCollections;
+ProductCollections.Groups = groups_1.Groups;
+//# sourceMappingURL=product-collections.js.map