@gpt-platform/client 0.10.4 → 0.11.0

package/dist/namespaces/catalog.d.ts

@@ -0,0 +1,964 @@
+import type { CatalogProduct, CatalogProductVariant, CatalogTaxonomy, CatalogTaxonomyNode, CatalogOptionType, CatalogOptionValue, CatalogView, CatalogPriceList, CatalogPriceListEntry } from "../_internal/types.gen";
+/** Attributes accepted when creating a new catalog product. */
+export type CreateCatalogProductAttributes = {
+    workspace_id: string;
+    name: string;
+    application_id?: string;
+    description?: string;
+    short_description?: string;
+    slug?: string;
+    status?: "draft" | "active" | "archived" | "discontinued";
+    base_price?: string;
+    currency?: string;
+    sku?: string;
+    media?: Record<string, unknown>[];
+    properties?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing catalog product (PATCH semantics). */
+export type UpdateCatalogProductAttributes = {
+    name?: string;
+    description?: string;
+    short_description?: string;
+    slug?: string;
+    status?: "draft" | "active" | "archived" | "discontinued";
+    base_price?: string;
+    currency?: string;
+    sku?: string;
+    media?: Record<string, unknown>[];
+    properties?: Record<string, unknown>;
+    ai_description?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new product variant. */
+export type CreateCatalogProductVariantAttributes = {
+    product_id: string;
+    workspace_id?: string;
+    sku?: string;
+    price_override?: string;
+    properties?: Record<string, unknown>;
+    status?: "active" | "archived" | "discontinued";
+    position?: number;
+    media?: Record<string, unknown>[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing product variant (PATCH semantics). */
+export type UpdateCatalogProductVariantAttributes = {
+    sku?: string;
+    price_override?: string;
+    properties?: Record<string, unknown>;
+    status?: "active" | "archived" | "discontinued";
+    position?: number;
+    media?: Record<string, unknown>[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new taxonomy. */
+export type CreateCatalogTaxonomyAttributes = {
+    application_id: string;
+    name: string;
+    workspace_id?: string;
+    slug?: string;
+    scope?: "application" | "workspace";
+    is_hierarchical?: boolean;
+    is_required?: boolean;
+    max_depth?: number;
+    ai_managed?: boolean;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing taxonomy (PATCH semantics). */
+export type UpdateCatalogTaxonomyAttributes = {
+    name?: string;
+    slug?: string;
+    is_hierarchical?: boolean;
+    is_required?: boolean;
+    max_depth?: number;
+    ai_managed?: boolean;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new taxonomy node. */
+export type CreateCatalogTaxonomyNodeAttributes = {
+    taxonomy_id: string;
+    name: string;
+    parent_id?: string;
+    slug?: string;
+    position?: number;
+    description?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing taxonomy node (PATCH semantics). */
+export type UpdateCatalogTaxonomyNodeAttributes = {
+    name?: string;
+    parent_id?: string;
+    slug?: string;
+    position?: number;
+    description?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new option type. */
+export type CreateCatalogOptionTypeAttributes = {
+    application_id: string;
+    name: string;
+    display_name?: string;
+    presentation?: string;
+    position?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing option type (PATCH semantics). */
+export type UpdateCatalogOptionTypeAttributes = {
+    name?: string;
+    display_name?: string;
+    presentation?: string;
+    position?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new option value. */
+export type CreateCatalogOptionValueAttributes = {
+    option_type_id: string;
+    name: string;
+    display_name?: string;
+    position?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing option value (PATCH semantics). */
+export type UpdateCatalogOptionValueAttributes = {
+    name?: string;
+    display_name?: string;
+    position?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new catalog view. */
+export type CreateCatalogViewAttributes = {
+    workspace_id: string;
+    name: string;
+    slug?: string;
+    description?: string;
+    channel_target?: string;
+    max_items?: number;
+    price_list_id?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing catalog view (PATCH semantics). */
+export type UpdateCatalogViewAttributes = {
+    name?: string;
+    slug?: string;
+    description?: string;
+    channel_target?: string;
+    max_items?: number;
+    price_list_id?: string;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new price list. */
+export type CreateCatalogPriceListAttributes = {
+    application_id: string;
+    name: string;
+    workspace_id?: string;
+    slug?: string;
+    currency?: string;
+    priority?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing price list (PATCH semantics). */
+export type UpdateCatalogPriceListAttributes = {
+    name?: string;
+    slug?: string;
+    currency?: string;
+    priority?: number;
+    [key: string]: unknown;
+};
+/** Attributes accepted when creating a new price list entry. */
+export type CreateCatalogPriceListEntryAttributes = {
+    price_list_id: string;
+    product_id?: string;
+    variant_id?: string;
+    price: string;
+    strategy?: "fixed" | "percentage" | "tiered";
+    tiers?: Record<string, unknown>[];
+    [key: string]: unknown;
+};
+/** Attributes accepted when updating an existing price list entry (PATCH semantics). */
+export type UpdateCatalogPriceListEntryAttributes = {
+    price?: string;
+    strategy?: "fixed" | "percentage" | "tiered";
+    tiers?: Record<string, unknown>[];
+    [key: string]: unknown;
+};
+import type { RequestOptions } from "../base-client";
+import { RequestBuilder } from "../request-builder";
+/**
+ * Catalog namespace for products, inventory, pricing, and taxonomy.
+ *
+ * Provides sub-namespaces for managing the full product catalog hierarchy:
+ * products (the root sellable items), variants (SKU-level differentiation
+ * by size/color/etc.), taxonomies (hierarchical category trees scoped to an
+ * application), taxonomy nodes (individual categories within a tree),
+ * option types, option values, catalog views, price lists, and price list entries.
+ *
+ * @example
+ * ```typescript
+ * const client = new GptClient({ apiKey: 'sk_app_...' });
+ *
+ * // List all products in a workspace
+ * const products = await client.catalog.products.list('ws_abc123');
+ *
+ * // Fetch a product and its variants
+ * const product = await client.catalog.products.get('prod_xyz');
+ * const variants = await client.catalog.variants.listByProduct(product.id);
+ * ```
+ */
+export declare function createCatalogNamespace(rb: RequestBuilder): {
+    /**
+     * Products — product catalog management.
+     *
+     * Products are the top-level sellable items in the catalog. Each product
+     * can have zero or more variants representing SKU-level differentiation
+     * (e.g. size S/M/L, color red/blue). Products are scoped to a workspace.
+     */
+    products: {
+        /**
+         * List all products belonging to a workspace.
+         *
+         * Returns a paginated array of products. Use `page` and `pageSize` to
+         * walk through large catalogs.
+         *
+         * @param workspaceId - The ID of the workspace whose products to list.
+         * @param options - Optional pagination controls (`page`, `pageSize`) and
+         *   request-level overrides (headers, signal, etc.).
+         * @returns A promise that resolves to an array of {@link CatalogProduct} records.
+         *
+         * @example
+         * ```typescript
+         * const products = await client.catalog.products.list('ws_abc123', {
+         *   page: 1,
+         *   pageSize: 20,
+         * });
+         * ```
+         */
+        list: (workspaceId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogProduct[]>;
+        /**
+         * Fetch a single product by its unique ID.
+         *
+         * @param id - The unique identifier of the product to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogProduct}.
+         *
+         * @example
+         * ```typescript
+         * const product = await client.catalog.products.get('prod_abc123');
+         * console.log(product.attributes.name);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogProduct>;
+        /**
+         * Create a new product in the catalog.
+         *
+         * @param attributes - Product attributes. Must include `workspace_id` and `name`.
+         *   `base_price` is a decimal string (e.g. `'29.99'`).
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogProduct}.
+         *
+         * @example
+         * ```typescript
+         * const product = await client.catalog.products.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Classic Tote Bag',
+         *   description: 'Durable canvas tote in multiple colors.',
+         *   base_price: '29.99',
+         *   currency: 'USD',
+         *   sku: 'TOTE-001',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogProductAttributes, options?: RequestOptions) => Promise<CatalogProduct>;
+        /**
+         * Update an existing product's attributes (PATCH semantics).
+         *
+         * @param id - The unique identifier of the product to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogProduct}.
+         *
+         * @example
+         * ```typescript
+         * const updated = await client.catalog.products.update('prod_abc123', {
+         *   base_price: '34.99',
+         *   description: 'Now available in a wider colour range.',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogProductAttributes, options?: RequestOptions) => Promise<CatalogProduct>;
+        /**
+         * Permanently delete a product from the catalog.
+         *
+         * @param id - The unique identifier of the product to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.products.delete('prod_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Variants — product variants (SKUs).
+     *
+     * A variant represents a specific, purchasable version of a product
+     * differentiated by one or more options such as size, colour, or material.
+     */
+    variants: {
+        /**
+         * Fetch a single product variant by its unique ID.
+         *
+         * @param id - The unique identifier of the variant to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogProductVariant}.
+         *
+         * @example
+         * ```typescript
+         * const variant = await client.catalog.variants.get('var_abc123');
+         * console.log(variant.attributes.sku);
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogProductVariant>;
+        /**
+         * List all variants that belong to a specific product.
+         *
+         * @param productId - The ID of the parent product whose variants to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogProductVariant} records.
+         *
+         * @example
+         * ```typescript
+         * const variants = await client.catalog.variants.listByProduct('prod_abc123', {
+         *   page: 1,
+         *   pageSize: 50,
+         * });
+         * ```
+         */
+        listByProduct: (productId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogProductVariant[]>;
+        /**
+         * Create a new variant for a product.
+         *
+         * @param attributes - Variant attributes. Must include `product_id`.
+         *   `price_override` is a decimal string (e.g. `'34.99'`).
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogProductVariant}.
+         *
+         * @example
+         * ```typescript
+         * const variant = await client.catalog.variants.create({
+         *   product_id: 'prod_abc123',
+         *   sku: 'TOTE-RED-M',
+         *   price_override: '34.99',
+         *   status: 'active',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogProductVariantAttributes, options?: RequestOptions) => Promise<CatalogProductVariant>;
+        /**
+         * Update an existing product variant's attributes (PATCH semantics).
+         *
+         * @param id - The unique identifier of the variant to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogProductVariant}.
+         *
+         * @example
+         * ```typescript
+         * const variant = await client.catalog.variants.update('var_abc123', {
+         *   price_override: '39.99',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogProductVariantAttributes, options?: RequestOptions) => Promise<CatalogProductVariant>;
+        /**
+         * Permanently delete a product variant.
+         *
+         * @param id - The unique identifier of the variant to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.variants.delete('var_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Option Types — product option definitions (e.g. Size, Color).
+     *
+     * Option types are application-scoped definitions for variant differentiation.
+     * Each option type has option values (e.g. Size has S, M, L, XL).
+     */
+    optionTypes: {
+        /**
+         * List all option types defined for an application.
+         *
+         * @param applicationId - The ID of the application whose option types to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogOptionType} records.
+         *
+         * @example
+         * ```typescript
+         * const types = await client.catalog.optionTypes.listByApplication('app_abc');
+         * ```
+         */
+        listByApplication: (applicationId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogOptionType[]>;
+        /**
+         * Fetch a single option type by its unique ID.
+         *
+         * @param id - The unique identifier of the option type.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogOptionType}.
+         *
+         * @example
+         * ```typescript
+         * const optionType = await client.catalog.optionTypes.get('ot_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogOptionType>;
+        /**
+         * Create a new option type for an application.
+         *
+         * @param attributes - Option type attributes. Must include `application_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogOptionType}.
+         *
+         * @example
+         * ```typescript
+         * const sizeType = await client.catalog.optionTypes.create({
+         *   application_id: 'app_abc',
+         *   name: 'size',
+         *   display_name: 'Size',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogOptionTypeAttributes, options?: RequestOptions) => Promise<CatalogOptionType>;
+        /**
+         * Update an existing option type (PATCH semantics).
+         *
+         * @param id - The unique identifier of the option type to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogOptionType}.
+         *
+         * @example
+         * ```typescript
+         * const updated = await client.catalog.optionTypes.update('ot_abc123', {
+         *   display_name: 'Shoe Size',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogOptionTypeAttributes, options?: RequestOptions) => Promise<CatalogOptionType>;
+        /**
+         * Permanently delete an option type.
+         *
+         * @param id - The unique identifier of the option type to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.optionTypes.delete('ot_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Option Values — individual values within an option type (e.g. "Small", "Red").
+     */
+    optionValues: {
+        /**
+         * List all option values for an option type.
+         *
+         * @param optionTypeId - The ID of the option type whose values to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogOptionValue} records.
+         *
+         * @example
+         * ```typescript
+         * const values = await client.catalog.optionValues.listByOptionType('ot_abc123');
+         * ```
+         */
+        listByOptionType: (optionTypeId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogOptionValue[]>;
+        /**
+         * Fetch a single option value by its unique ID.
+         *
+         * @param id - The unique identifier of the option value.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogOptionValue}.
+         *
+         * @example
+         * ```typescript
+         * const value = await client.catalog.optionValues.get('ov_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogOptionValue>;
+        /**
+         * Create a new option value within an option type.
+         *
+         * @param attributes - Option value attributes. Must include `option_type_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogOptionValue}.
+         *
+         * @example
+         * ```typescript
+         * const small = await client.catalog.optionValues.create({
+         *   option_type_id: 'ot_abc123',
+         *   name: 'small',
+         *   display_name: 'S',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogOptionValueAttributes, options?: RequestOptions) => Promise<CatalogOptionValue>;
+        /**
+         * Update an existing option value (PATCH semantics).
+         *
+         * @param id - The unique identifier of the option value to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogOptionValue}.
+         *
+         * @example
+         * ```typescript
+         * const updated = await client.catalog.optionValues.update('ov_abc123', {
+         *   display_name: 'Small (S)',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogOptionValueAttributes, options?: RequestOptions) => Promise<CatalogOptionValue>;
+        /**
+         * Permanently delete an option value.
+         *
+         * @param id - The unique identifier of the option value to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.optionValues.delete('ov_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Taxonomies — product classification trees.
+     *
+     * A taxonomy is a named hierarchical category system scoped to an
+     * application. Taxonomies are the containers; individual categories
+     * within them are managed via {@link taxonomyNodes}.
+     */
+    taxonomies: {
+        /**
+         * List all taxonomies defined for an application.
+         *
+         * @param applicationId - The ID of the application whose taxonomies to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogTaxonomy} records.
+         *
+         * @example
+         * ```typescript
+         * const taxonomies = await client.catalog.taxonomies.listByApplication('app_abc123');
+         * ```
+         */
+        listByApplication: (applicationId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogTaxonomy[]>;
+        /**
+         * Fetch a single taxonomy by its unique ID.
+         *
+         * @param id - The unique identifier of the taxonomy to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogTaxonomy}.
+         *
+         * @example
+         * ```typescript
+         * const taxonomy = await client.catalog.taxonomies.get('tax_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogTaxonomy>;
+        /**
+         * Create a new taxonomy for an application.
+         *
+         * @param attributes - Taxonomy attributes. Must include `application_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogTaxonomy}.
+         *
+         * @example
+         * ```typescript
+         * const taxonomy = await client.catalog.taxonomies.create({
+         *   application_id: 'app_abc123',
+         *   name: 'Product Categories',
+         *   is_hierarchical: true,
+         *   max_depth: 5,
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogTaxonomyAttributes, options?: RequestOptions) => Promise<CatalogTaxonomy>;
+        /**
+         * Update an existing taxonomy's attributes (PATCH semantics).
+         *
+         * @param id - The unique identifier of the taxonomy to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogTaxonomy}.
+         *
+         * @example
+         * ```typescript
+         * const taxonomy = await client.catalog.taxonomies.update('tax_abc123', {
+         *   name: 'Catalog Categories',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogTaxonomyAttributes, options?: RequestOptions) => Promise<CatalogTaxonomy>;
+        /**
+         * Permanently delete a taxonomy and all of its nodes.
+         *
+         * @param id - The unique identifier of the taxonomy to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.taxonomies.delete('tax_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Taxonomy nodes — individual nodes within a taxonomy tree.
+     *
+     * Each node represents a single category (e.g. "T-Shirts") within a
+     * taxonomy. Nodes can be nested by setting `parent_id`.
+     */
+    taxonomyNodes: {
+        /**
+         * List all nodes that belong to a specific taxonomy.
+         *
+         * @param taxonomyId - The ID of the taxonomy whose nodes to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogTaxonomyNode} records.
+         *
+         * @example
+         * ```typescript
+         * const nodes = await client.catalog.taxonomyNodes.listByTaxonomy('tax_abc123');
+         * const roots = nodes.filter((n) => !n.attributes.parent_id);
+         * ```
+         */
+        listByTaxonomy: (taxonomyId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogTaxonomyNode[]>;
+        /**
+         * Fetch a single taxonomy node by its unique ID.
+         *
+         * @param id - The unique identifier of the node to retrieve.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogTaxonomyNode}.
+         *
+         * @example
+         * ```typescript
+         * const node = await client.catalog.taxonomyNodes.get('node_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
+        /**
+         * Create a new node within a taxonomy.
+         *
+         * @param attributes - Node attributes. Must include `taxonomy_id` and `name`.
+         *   Set `parent_id` to nest under an existing node.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogTaxonomyNode}.
+         *
+         * @example
+         * ```typescript
+         * const tops = await client.catalog.taxonomyNodes.create({
+         *   taxonomy_id: 'tax_abc123',
+         *   name: 'Tops',
+         *   parent_id: clothing.id,
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogTaxonomyNodeAttributes, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
+        /**
+         * Update an existing taxonomy node (PATCH semantics).
+         *
+         * @param id - The unique identifier of the node to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogTaxonomyNode}.
+         *
+         * @example
+         * ```typescript
+         * const node = await client.catalog.taxonomyNodes.update('node_abc123', {
+         *   name: 'Apparel',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogTaxonomyNodeAttributes, options?: RequestOptions) => Promise<CatalogTaxonomyNode>;
+        /**
+         * Permanently delete a taxonomy node.
+         *
+         * @param id - The unique identifier of the node to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.taxonomyNodes.delete('node_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Catalog Views — composable, rule-based product lenses.
+     *
+     * Views filter and sort products for specific channels or use cases.
+     */
+    views: {
+        /**
+         * List all catalog views in a workspace.
+         *
+         * @param workspaceId - The ID of the workspace whose views to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogView} records.
+         *
+         * @example
+         * ```typescript
+         * const views = await client.catalog.views.listByWorkspace('ws_abc123');
+         * ```
+         */
+        listByWorkspace: (workspaceId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogView[]>;
+        /**
+         * Fetch a single catalog view by its unique ID.
+         *
+         * @param id - The unique identifier of the view.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogView}.
+         *
+         * @example
+         * ```typescript
+         * const view = await client.catalog.views.get('cv_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogView>;
+        /**
+         * Create a new catalog view.
+         *
+         * @param attributes - View attributes. Must include `workspace_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogView}.
+         *
+         * @example
+         * ```typescript
+         * const view = await client.catalog.views.create({
+         *   workspace_id: 'ws_abc123',
+         *   name: 'Featured Products',
+         *   channel_target: 'web',
+         *   max_items: 20,
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogViewAttributes, options?: RequestOptions) => Promise<CatalogView>;
+        /**
+         * Update an existing catalog view (PATCH semantics).
+         *
+         * @param id - The unique identifier of the view to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogView}.
+         *
+         * @example
+         * ```typescript
+         * const view = await client.catalog.views.update('cv_abc123', {
+         *   max_items: 50,
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogViewAttributes, options?: RequestOptions) => Promise<CatalogView>;
+        /**
+         * Permanently delete a catalog view.
+         *
+         * @param id - The unique identifier of the view to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.views.delete('cv_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Price Lists — named price configurations.
+     *
+     * Price lists are application-scoped and define pricing for products/variants
+     * with fixed, percentage, or tiered strategies.
+     */
+    priceLists: {
+        /**
+         * List all price lists for an application.
+         *
+         * @param applicationId - The ID of the application whose price lists to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogPriceList} records.
+         *
+         * @example
+         * ```typescript
+         * const lists = await client.catalog.priceLists.listByApplication('app_abc');
+         * ```
+         */
+        listByApplication: (applicationId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogPriceList[]>;
+        /**
+         * Fetch a single price list by its unique ID.
+         *
+         * @param id - The unique identifier of the price list.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the matching {@link CatalogPriceList}.
+         *
+         * @example
+         * ```typescript
+         * const list = await client.catalog.priceLists.get('pl_abc123');
+         * ```
+         */
+        get: (id: string, options?: RequestOptions) => Promise<CatalogPriceList>;
+        /**
+         * Create a new price list for an application.
+         *
+         * @param attributes - Price list attributes. Must include `application_id` and `name`.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogPriceList}.
+         *
+         * @example
+         * ```typescript
+         * const list = await client.catalog.priceLists.create({
+         *   application_id: 'app_abc',
+         *   name: 'Wholesale Pricing',
+         *   currency: 'USD',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogPriceListAttributes, options?: RequestOptions) => Promise<CatalogPriceList>;
+        /**
+         * Update an existing price list (PATCH semantics).
+         *
+         * @param id - The unique identifier of the price list to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogPriceList}.
+         *
+         * @example
+         * ```typescript
+         * const list = await client.catalog.priceLists.update('pl_abc123', {
+         *   name: 'VIP Pricing',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogPriceListAttributes, options?: RequestOptions) => Promise<CatalogPriceList>;
+        /**
+         * Permanently delete a price list.
+         *
+         * @param id - The unique identifier of the price list to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.priceLists.delete('pl_abc123');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+    /**
+     * Price List Entries — individual pricing rules within a price list.
+     */
+    priceListEntries: {
+        /**
+         * List all entries in a price list.
+         *
+         * @param priceListId - The ID of the price list whose entries to list.
+         * @param options - Optional pagination and request-level overrides.
+         * @returns A promise that resolves to an array of {@link CatalogPriceListEntry} records.
+         *
+         * @example
+         * ```typescript
+         * const entries = await client.catalog.priceListEntries.listByPriceList('pl_abc');
+         * ```
+         */
+        listByPriceList: (priceListId: string, options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<CatalogPriceListEntry[]>;
+        /**
+         * Create a new entry in a price list.
+         *
+         * @param attributes - Entry attributes. Must include `price_list_id` and `price`.
+         *   Include either `product_id` or `variant_id` to target pricing.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the newly created {@link CatalogPriceListEntry}.
+         *
+         * @example
+         * ```typescript
+         * const entry = await client.catalog.priceListEntries.create({
+         *   price_list_id: 'pl_abc',
+         *   product_id: 'prod_xyz',
+         *   price: '24.99',
+         *   strategy: 'fixed',
+         * });
+         * ```
+         */
+        create: (attributes: CreateCatalogPriceListEntryAttributes, options?: RequestOptions) => Promise<CatalogPriceListEntry>;
+        /**
+         * Update an existing price list entry (PATCH semantics).
+         *
+         * @param id - The unique identifier of the entry to update.
+         * @param attributes - Key/value map of attributes to change.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to the updated {@link CatalogPriceListEntry}.
+         *
+         * @example
+         * ```typescript
+         * const entry = await client.catalog.priceListEntries.update('ple_abc', {
+         *   price: '19.99',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: UpdateCatalogPriceListEntryAttributes, options?: RequestOptions) => Promise<CatalogPriceListEntry>;
+        /**
+         * Permanently delete a price list entry.
+         *
+         * @param id - The unique identifier of the entry to delete.
+         * @param options - Optional request-level overrides.
+         * @returns A promise that resolves to `true` on successful deletion.
+         *
+         * @example
+         * ```typescript
+         * await client.catalog.priceListEntries.delete('ple_abc');
+         * ```
+         */
+        delete: (id: string, options?: RequestOptions) => Promise<true>;
+    };
+};
+//# sourceMappingURL=catalog.d.ts.map