@teemill/product-catalog 1.92.0 → 1.92.1

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.92.0
+ * The version of the OpenAPI document: 1.92.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,9 +13,12 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
+/**
+ * A specific action that can be taken to implement a recommendation.
+ */
 export interface Action {
     /**
-     * Unique object identifier
+     * The unique identifier of this action.
      */
     'id': string;
     /**
@@ -40,12 +43,18 @@ export declare const ActionImpactEnum: {
     readonly Low: "low";
 };
 export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
+/**
+ * An additional file to attach to a product (e.g. size guide, care instructions).
+ */
 export interface AdditionalFile {
     /**
      * Publicly available file URL.
      */
     'src'?: string;
 }
+/**
+ * Analytics data for a product including revenue, sales, traffic, and conversion metrics.
+ */
 export interface AnalyticsItem {
     /**
      * Unique object identifier
@@ -72,6 +81,9 @@ export interface AnalyticsItem {
      */
     'revenue': number;
 }
+/**
+ * An AI-generated summary of product analytics with actionable recommendations.
+ */
 export interface AnalyticsSummary {
     /**
      * A summary of the recommendations
@@ -81,13 +93,25 @@ export interface AnalyticsSummary {
     'createdAt': string;
     'updatedAt': string;
 }
+/**
+ * Represents an error returned by the API.
+ */
 export interface ApiError {
+    /**
+     * A machine-readable error code identifying the type of error.
+     */
     'code'?: string;
+    /**
+     * A human-readable message providing more details about the error.
+     */
     'message': string;
 }
+/**
+ * A design application on a product variant, specifying the technology, placement, design file, and optional personalisation.
+ */
 export interface Application {
     /**
-     * Unique object identifier
+     * The unique identifier of this application.
      */
     'id'?: string;
     /**
@@ -139,13 +163,16 @@ export declare const ApplicationPlacementEnum: {
     readonly Neck: "neck";
 };
 export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
+/**
+ * A named group of design applications that can be reused across multiple products.
+ */
 export interface ApplicationGroup {
     /**
-     * Unique object identifier
+     * The unique identifier of the application group.
      */
     'id': string;
     /**
-     * A reference to the application group resource location
+     * A URI reference to this application group resource.
      */
     'ref': string;
     /**
@@ -172,6 +199,9 @@ export interface ApplicationMockup {
      */
     'preview'?: string;
 }
+/**
+ * Properties of a design application including dimensions, position, and optional personalisation rules. Null when the application has no configurable properties.
+ */
 export interface ApplicationProperties {
     /**
      * Width of the application in pixels
@@ -192,6 +222,9 @@ export interface ApplicationPropertiesMetadata {
  * @type ApplicationPropertiesMetadataPersonalization
  */
 export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
+/**
+ * Personalisation configuration for a design application, allowing end-users to customise the design.
+ */
 export interface ApplicationPropertiesPersonalization {
     /**
      * The label to be displayed on the personalization field.
@@ -296,13 +329,16 @@ export declare const ApplicationPropertiesPropertiesFontStyleEnum: {
     readonly Oblique: "oblique";
 };
 export type ApplicationPropertiesPropertiesFontStyleEnum = typeof ApplicationPropertiesPropertiesFontStyleEnum[keyof typeof ApplicationPropertiesPropertiesFontStyleEnum];
+/**
+ * A set of application records that defines which design applications are applied to which variants.
+ */
 export interface ApplicationSet {
     /**
-     * Unique object identifier
+     * The unique identifier of the application set.
      */
     'id': string;
     /**
-     * A reference to the application set resource location
+     * A URI reference to this application set resource.
      */
     'ref': string;
     /**
@@ -342,9 +378,12 @@ export interface ApplicationSet1 {
      */
     'ref'?: string;
 }
+/**
+ * A record within an application set, linking a specific application to a set.
+ */
 export interface ApplicationSetRecord {
     /**
-     * Unique object identifier
+     * The unique identifier of this record.
      */
     'id'?: string;
     'set'?: ApplicationSet1;
@@ -367,9 +406,12 @@ export interface ApplicationSetsResponse {
 export interface ApplicationTechnologiesResponse {
     'applicationTechnologies'?: Array<ApplicationTechnology>;
 }
+/**
+ * A print or application technology available for use on catalog products.
+ */
 export interface ApplicationTechnology {
     /**
-     * Unique object identifier
+     * The unique identifier of the technology.
      */
     'id'?: string;
     /**
@@ -424,15 +466,21 @@ export interface Attributes1Inner {
     'name'?: string;
     'value'?: string;
 }
+/**
+ * A bundle product that groups multiple items together at a combined price.
+ */
 export interface BundleProduct {
     /**
-     * Unique object identifier
+     * The unique identifier of the bundle product.
      */
     'id'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this bundle product resource.
      */
     'ref'?: string;
+    /**
+     * The display title of the bundle product.
+     */
     'title': string;
     'description': string;
     'slug'?: string;
@@ -457,7 +505,13 @@ export interface BundleProduct {
      * Variants
      */
     'variants'?: Array<Variant>;
+    /**
+     * The retail price of the product, including tax. Only provided if the product is a bundle.
+     */
     'retailPrice'?: Price;
+    /**
+     * The sale price of the product, including tax. Only provided if the product is a bundle.
+     */
     'salePrice'?: SalePrice | null;
     /**
      * Additional files attached to the product.
@@ -475,12 +529,21 @@ export interface BundleProduct {
      * A count of reviews. This field is only present if included in the fields query parameter
      */
     'reviewCount'?: number;
+    /**
+     * A unique identifier for a specific variant (product + colour + size).
+     */
     'sku'?: string;
     /**
      * A count of sales. This field is only present if included in the fields query parameter
      */
     'sales'?: number;
+    /**
+     * The start of the window in which sales are counted
+     */
     'salesStart'?: string;
+    /**
+     * The end of the window in which sales are counted
+     */
     'salesEnd'?: string;
     'includeInDataFeeds'?: boolean;
     /**
@@ -511,6 +574,9 @@ export interface BundleProduct {
     'showSaleBadge'?: boolean;
     'license'?: License;
 }
+/**
+ * The payload for creating a new design application on a product variant.
+ */
 export interface CreateApplication {
     /**
      * The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
@@ -666,6 +732,9 @@ export interface CreateApplicationSetRequestRecordsInnerAttributesInner {
      */
     'value': string;
 }
+/**
+ * The payload for creating a new bundle product that groups multiple items together.
+ */
 export interface CreateBundleProduct {
     /**
      * Product title
@@ -723,17 +792,11 @@ export interface CreateBundleProduct {
     /**
      * A list of product uuids to include in this bundle
      */
-    'bundleItems': Array<CreateBundleProductBundleItemsInner>;
+    'bundleItems': Array<UpdateProductRequestBundleItemsInner>;
     'retailPrice'?: Price;
     'salePrice'?: SalePrice | null;
     'price'?: Price;
 }
-export interface CreateBundleProductBundleItemsInner {
-    /**
-     * Unique object identifier
-     */
-    'id'?: string;
-}
 export interface CreateBundleProductSeoMetadata {
     /**
      * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
@@ -788,6 +851,9 @@ export interface CreateDigitalProductVariantsInnerImagesInner {
      */
     'src': string;
 }
+/**
+ * The payload for creating a new catalog product from a GFN base product.
+ */
 export interface CreateProduct {
     /**
      * Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
@@ -892,6 +958,9 @@ export interface CreateProductImagesInner {
  * @type CreateProductRequest
  */
 export type CreateProductRequest = CreateBundleProduct | CreateDigitalProduct | CreateProduct;
+/**
+ * The payload for creating a new variant on a catalog product.
+ */
 export interface CreateProductVariant {
     /**
      * One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match).
@@ -978,11 +1047,11 @@ export interface ExportProducts202Response {
     'message'?: string;
 }
 /**
- * Image description
+ * An image associated with a product or variant.
  */
 export interface Image {
     /**
-     * Unique object identifier
+     * The unique identifier of the image.
      */
     'id'?: string;
     'src': string;
@@ -996,6 +1065,9 @@ export interface Image {
     'createdAt'?: string;
     'updatedAt'?: string;
 }
+/**
+ * An image file to attach to a product, specified by a publicly available URL.
+ */
 export interface ImageFile {
     /**
      * Publicly available file URL.
@@ -1051,6 +1123,9 @@ export interface License {
      */
     'expiresAt'?: string;
 }
+/**
+ * A stock location showing the number of units available at a specific warehouse location.
+ */
 export interface Location {
     /**
      * The total number of units available at the location
@@ -1074,18 +1149,30 @@ export interface MetaField {
      */
     'value': string;
 }
+/**
+ * A named price component (e.g. Fulfillment, Application) with its amount and currency.
+ */
 export interface NamedPrice {
     /**
      * The name of the price
      */
     'name': string;
+    /**
+     * The price amount and currency.
+     */
     'price': RequiredPrice;
 }
+/**
+ * A record of an AI SEO optimisation performed on a product.
+ */
 export interface OptimisationHistoryItem {
     /**
-     * Unique object identifier
+     * The unique identifier of this optimisation.
      */
     'id'?: string;
+    /**
+     * The timestamp when this optimisation was performed.
+     */
     'createdAt'?: string;
 }
 /**
@@ -1105,15 +1192,21 @@ export declare const PriceCurrencyCodeEnum: {
     readonly Gbp: "GBP";
 };
 export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
+/**
+ * A catalog product listing that can be purchased, containing design applications, pricing, variants, and SEO metadata.
+ */
 export interface Product {
     /**
-     * Unique object identifier
+     * The unique identifier of the product.
      */
     'id'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this product resource.
      */
     'ref'?: string;
+    /**
+     * The display title of the product.
+     */
     'title': string;
     'description': string;
     'slug'?: string;
@@ -1142,7 +1235,13 @@ export interface Product {
      * Products in the bundle.
      */
     'bundleItems'?: Array<ProductBundleItemsInner>;
+    /**
+     * The retail price of the product, including tax. Only provided if the product is a bundle.
+     */
     'retailPrice'?: Price;
+    /**
+     * The sale price of the product, including tax. Only provided if the product is a bundle.
+     */
     'salePrice'?: SalePrice | null;
     /**
      * Additional files attached to the product.
@@ -1160,12 +1259,21 @@ export interface Product {
      * A count of reviews. This field is only present if included in the fields query parameter
      */
     'reviewCount'?: number;
+    /**
+     * A unique identifier for a specific variant (product + colour + size).
+     */
     'sku'?: string;
     /**
      * A count of sales. This field is only present if included in the fields query parameter
      */
     'sales'?: number;
+    /**
+     * The start of the window in which sales are counted
+     */
     'salesStart'?: string;
+    /**
+     * The end of the window in which sales are counted
+     */
     'salesEnd'?: string;
     'includeInDataFeeds'?: boolean;
     /**
@@ -1263,13 +1371,16 @@ export interface ProductApplicationSetsInner {
 }
 export interface ProductBundleItemsInner {
     /**
-     * Unique object identifier
+     * The unique identifier of the bundle product.
      */
     'id'?: string;
     /**
-     * A reference to the resource location
+     * A URI reference to this bundle product resource.
      */
     'ref'?: string;
+    /**
+     * The display title of the bundle product.
+     */
     'title': string;
     'description': string;
     'slug'?: string;
@@ -1294,7 +1405,13 @@ export interface ProductBundleItemsInner {
      * Variants
      */
     'variants'?: Array<Variant>;
+    /**
+     * The retail price of the product, including tax. Only provided if the product is a bundle.
+     */
     'retailPrice'?: Price;
+    /**
+     * The sale price of the product, including tax. Only provided if the product is a bundle.
+     */
     'salePrice'?: SalePrice | null;
     /**
      * Additional files attached to the product.
@@ -1312,12 +1429,21 @@ export interface ProductBundleItemsInner {
      * A count of reviews. This field is only present if included in the fields query parameter
      */
     'reviewCount'?: number;
+    /**
+     * A unique identifier for a specific variant (product + colour + size).
+     */
     'sku'?: string;
     /**
      * A count of sales. This field is only present if included in the fields query parameter
      */
     'sales'?: number;
+    /**
+     * The start of the window in which sales are counted
+     */
     'salesStart'?: string;
+    /**
+     * The end of the window in which sales are counted
+     */
     'salesEnd'?: string;
     'includeInDataFeeds'?: boolean;
     /**
@@ -1370,9 +1496,12 @@ export interface ProductStaticCollectionsInner {
     'id'?: string;
     'title'?: string;
 }
+/**
+ * A type of product available in the catalog (e.g. Printed T-Shirt, Embroidered Hoodie).
+ */
 export interface ProductType {
     /**
-     * Unique object identifier
+     * The unique identifier of the product type.
      */
     'id': string;
     /**
@@ -1411,9 +1540,12 @@ export interface ProductsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ * An AI-generated recommendation for improving product performance.
+ */
 export interface Recommendation {
     /**
-     * Unique object identifier
+     * The unique identifier of this recommendation.
      */
     'id': string;
     /**
@@ -1519,10 +1651,22 @@ export interface SeoOptimiseProductsRequest {
      */
     'fields'?: Array<string>;
 }
+/**
+ * Stock availability information including total level and per-location breakdown.
+ */
 export interface Stock {
+    /**
+     * The current total stock level available for purchase.
+     */
     'level'?: number;
+    /**
+     * Stock levels broken down by warehouse location.
+     */
     'locations'?: Array<Location>;
 }
+/**
+ * Target search phrase configuration for SEO optimisation of a product.
+ */
 export interface TargetSearchPhraseData {
     /**
      * The primary target search phrase for the product that you wish to rank for in search engine results.
@@ -1533,6 +1677,9 @@ export interface TargetSearchPhraseData {
      */
     'targetSearchPhraseSynonyms'?: Array<string>;
 }
+/**
+ * Properties for a text-based application including font, colour, position, and optional personalisation. Null when the application has no configurable properties.
+ */
 export interface TextApplicationProperties {
     'position'?: TextApplicationPropertiesPosition;
     'positionInference'?: ApplicationPropertiesPositionInference | null;
@@ -1578,6 +1725,9 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
     readonly Oblique: "oblique";
 };
 export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
+/**
+ * Personalisation configuration for a text application, allowing end-users to customise the text content.
+ */
 export interface TextApplicationPropertiesPersonalization {
     /**
      * The label to be displayed on the personalization field.
@@ -1736,7 +1886,13 @@ export interface UpdateProductRequest {
      * A list of products to be in this bundle. Only valid if the product is already a bundle.
      */
     'bundleItems'?: Array<UpdateProductRequestBundleItemsInner>;
+    /**
+     * The retail price of the product, including tax. Only provided if the product is a bundle.
+     */
     'retailPrice'?: Price;
+    /**
+     * The sale price of the product, including tax. Only provided if the product is a bundle.
+     */
     'salePrice'?: SalePrice | null;
     /**
      * Images to attach to the product. For example, photos of models using/wearing the product.
@@ -1786,7 +1942,7 @@ export interface UpdateProductRequest {
 }
 export interface UpdateProductRequestBundleItemsInner {
     /**
-     * Unique object identifier
+     * The product UUID to include in the bundle
      */
     'id'?: string;
     'config'?: UpdateProductRequestBundleItemsInnerConfig;
@@ -1981,7 +2137,13 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
     readonly Gbp: "GBP";
 };
 export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
+/**
+ * A list of users who have created products for the project.
+ */
 export interface UserList {
+    /**
+     * The list of product creators.
+     */
     'creators': Array<UserListCreatorsInner>;
 }
 export interface UserListCreatorsInner {
@@ -2005,18 +2167,24 @@ export interface UserListCreatorsInnerAvatar {
      */
     'original': string | null;
 }
+/**
+ * A specific colour/size combination of a catalog product with its own SKU, pricing, stock, and design applications.
+ */
 export interface Variant {
     /**
-     * Unique object identifier
+     * The unique identifier of the variant.
      */
     'id'?: string;
     /**
-     * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
+     * The attributes (e.g. Colour, Size) that define this variant.
      */
     'attributes': Array<Attribute>;
+    /**
+     * The stock keeping unit code for this variant.
+     */
     'sku': string;
     /**
-     * A reference to the variant resource location
+     * A URI reference to this variant resource.
      */
     'ref'?: string;
     'product'?: VariantProduct;
@@ -2113,6 +2281,9 @@ export interface VariantWarehouseVariant {
     'metafields'?: Array<MetaField>;
 }
 export interface VariantWholesaleCost {
+    /**
+     * The cost of the variant alone
+     */
     'item': RequiredPrice;
     /**
      * A breakdown of the cost per application
@@ -2122,6 +2293,9 @@ export interface VariantWholesaleCost {
      * a breakdown of the cost per handling fee
      */
     'handling': Array<NamedPrice>;
+    /**
+     * The total cost of fulfillment for the variant. This includes the cost of the variant, the cost of the applications, and the cost of the handling fees.
+     */
     'fulfillment': RequiredPrice;
 }
 export interface VariantsResponse {
@@ -2132,11 +2306,11 @@ export interface VariantsResponse {
     'nextPageToken'?: number | null;
 }
 /**
- * Video object
+ * A video associated with a product.
  */
 export interface Video {
     /**
-     * Unique object identifier
+     * The unique identifier of the video.
      */
     'id'?: string;
     'src'?: string;
@@ -2145,6 +2319,9 @@ export interface Video {
     'createdAt'?: string;
     'updatedAt'?: string;
 }
+/**
+ * A video file to attach to a product, specified by a publicly available URL.
+ */
 export interface VideoFile {
     /**
      * Publicly available file URL.
@@ -2705,10 +2882,12 @@ export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration
      * Lists all technologies available to this project.
      * @summary List technologies available to this project
      * @param {string} project What project it is
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTechnologies: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listTechnologies: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ApplicationTechnologiesApi - functional programming interface
@@ -2718,10 +2897,12 @@ export declare const ApplicationTechnologiesApiFp: (configuration?: Configuratio
      * Lists all technologies available to this project.
      * @summary List technologies available to this project
      * @param {string} project What project it is
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTechnologies(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
+    listTechnologies(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
 };
 /**
  * ApplicationTechnologiesApi - factory interface
@@ -2744,6 +2925,14 @@ export interface ApplicationTechnologiesApiListTechnologiesRequest {
      * What project it is
      */
     readonly project: string;
+    /**
+     * Page reference token
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
 }
 /**
  * ApplicationTechnologiesApi - object-oriented interface
@@ -3113,10 +3302,12 @@ export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Confi
      * Lists all the unique users that have created products for the given project.
      * @summary List product creators
      * @param {string} project What project it is
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listProductCreators: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProductCreatorsApi - functional programming interface
@@ -3126,10 +3317,12 @@ export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
      * Lists all the unique users that have created products for the given project.
      * @summary List product creators
      * @param {string} project What project it is
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
+    listProductCreators(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
 };
 /**
  * ProductCreatorsApi - factory interface
@@ -3152,6 +3345,14 @@ export interface ProductCreatorsApiListProductCreatorsRequest {
      * What project it is
      */
     readonly project: string;
+    /**
+     * Page reference token
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
 }
 /**
  * ProductCreatorsApi - object-oriented interface
@@ -3247,7 +3448,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
      * @summary Create product
      * @param {string} project What project it is
-     * @param {CreateProductRequest} [createProductRequest]
+     * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3358,7 +3559,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Update product
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
-     * @param {UpdateProductRequest} [updateProductRequest]
+     * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3381,7 +3582,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
      * @summary Create product
      * @param {string} project What project it is
-     * @param {CreateProductRequest} [createProductRequest]
+     * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3492,7 +3693,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @summary Update product
      * @param {string} project What project it is
      * @param {string} productId Product\&#39;s unique identifier
-     * @param {UpdateProductRequest} [updateProductRequest]
+     * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -3608,6 +3809,9 @@ export interface ProductsApiCreateProductRequest {
      * What project it is
      */
     readonly project: string;
+    /**
+     * The product to create, including title, variants, design applications, and pricing.
+     */
     readonly createProductRequest?: CreateProductRequest;
 }
 /**
@@ -3842,6 +4046,9 @@ export interface ProductsApiUpdateProductRequest {
      * Product\&#39;s unique identifier
      */
     readonly productId: string;
+    /**
+     * The product fields to update. Only the fields provided will be modified.
+     */
     readonly updateProductRequest?: UpdateProductRequest;
 }
 /**