@teemill/product-catalog 1.38.1 → 1.40.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog API
  * 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 warehouse product, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.38.1
+ * The version of the OpenAPI document: 1.40.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -424,188 +424,276 @@ export type CreateApplicationSetRequestRecordsInnerAttributesInnerThumbnailTypeE
 /**
  *
  * @export
- * @interface CreateProductRequest
+ * @interface CreateBundleProduct
  */
-export interface CreateProductRequest {
+export interface CreateBundleProduct {
+    /**
+     * Product title
+     * @type {string}
+     * @memberof CreateBundleProduct
+     */
+    'title'?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof CreateBundleProduct
+     */
+    'description'?: string;
+    /**
+     * Whether the product is enabled upon creation.
+     * @type {boolean}
+     * @memberof CreateBundleProduct
+     */
+    'enabled'?: boolean;
+    /**
+     * A custom URL slug for the product. This must be unique for each product on the project.
+     * @type {string}
+     * @memberof CreateBundleProduct
+     */
+    'slug'?: string;
+    /**
+     *
+     * @type {UpdateProductsRequestProductsInnerSeoMetadata}
+     * @memberof CreateBundleProduct
+     */
+    'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
+    /**
+     * The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration
+     * @type {string}
+     * @memberof CreateBundleProduct
+     */
+    'targetSearchPhrase'?: string;
+    /**
+     * Synonyms for the target search phrase. **Note:** This field requires the website integration
+     * @type {Array<string>}
+     * @memberof CreateBundleProduct
+     */
+    'targetSearchPhraseSynonyms'?: Array<string>;
+    /**
+     * Additional product tags used for searching and filtering.
+     * @type {Array<string>}
+     * @memberof CreateBundleProduct
+     */
+    'tags'?: Array<string>;
+    /**
+     * Internal tags used for internal searching and filtering.
+     * @type {Array<string>}
+     * @memberof CreateBundleProduct
+     */
+    'internalTags'?: Array<string>;
+    /**
+     * Images to attach to the product. For example, photos of models using/wearing the product.
+     * @type {Array<CreateProductImagesInner>}
+     * @memberof CreateBundleProduct
+     */
+    'images'?: Array<CreateProductImagesInner>;
+    /**
+     * Videos to attach to the product.
+     * @type {Array<CreateProductVideosInner>}
+     * @memberof CreateBundleProduct
+     */
+    'videos'?: Array<CreateProductVideosInner>;
+    /**
+     * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
+     * @type {Array<CreateProductAdditionalFilesInner>}
+     * @memberof CreateBundleProduct
+     */
+    'additionalFiles'?: Array<CreateProductAdditionalFilesInner>;
+    /**
+     * For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
+     * @type {number}
+     * @memberof CreateBundleProduct
+     */
+    'shopifyId'?: number;
+    /**
+     * Key/value pairs that can be used to store additional information about the product
+     * @type {Array<MetaField>}
+     * @memberof CreateBundleProduct
+     */
+    'metafields'?: Array<MetaField>;
+    /**
+     * A list of product uuids to include in this bundle
+     * @type {Array<string>}
+     * @memberof CreateBundleProduct
+     */
+    'bundleItems': Array<string>;
+    /**
+     *
+     * @type {Price}
+     * @memberof CreateBundleProduct
+     */
+    'retailPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof CreateBundleProduct
+     */
+    'salePrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof CreateBundleProduct
+     */
+    'price'?: Price;
+}
+/**
+ *
+ * @export
+ * @interface CreateProduct
+ */
+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.
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'gfnProductRef': string;
     /**
      * Product title
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'title'?: string;
     /**
      * Product description
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'description'?: string;
     /**
      * Whether the product is enabled upon creation.
      * @type {boolean}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'enabled'?: boolean;
     /**
      * A custom URL slug for the product. This must be unique for each product on the project.
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'slug'?: string;
     /**
      *
-     * @type {CreateProductRequestSeoMetadata}
-     * @memberof CreateProductRequest
+     * @type {UpdateProductsRequestProductsInnerSeoMetadata}
+     * @memberof CreateProduct
      */
-    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
     /**
      * The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'targetSearchPhrase'?: string;
     /**
      * Synonyms for the target search phrase. **Note:** This field requires the website integration
      * @type {Array<string>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'targetSearchPhraseSynonyms'?: Array<string>;
     /**
      * Additional product tags used for searching and filtering.
      * @type {Array<string>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'tags'?: Array<string>;
     /**
      * Internal tags used for internal searching and filtering.
      * @type {Array<string>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'internalTags'?: Array<string>;
     /**
      * Variants
      * @type {Array<CreateProductVariant>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'variants': Array<CreateProductVariant>;
     /**
      * Images to attach to the product. For example, photos of models using/wearing the product.
-     * @type {Array<CreateProductRequestImagesInner>}
-     * @memberof CreateProductRequest
+     * @type {Array<CreateProductImagesInner>}
+     * @memberof CreateProduct
      */
-    'images'?: Array<CreateProductRequestImagesInner>;
+    'images'?: Array<CreateProductImagesInner>;
     /**
      * Videos to attach to the product.
-     * @type {Array<CreateProductRequestVideosInner>}
-     * @memberof CreateProductRequest
+     * @type {Array<CreateProductVideosInner>}
+     * @memberof CreateProduct
      */
-    'videos'?: Array<CreateProductRequestVideosInner>;
+    'videos'?: Array<CreateProductVideosInner>;
     /**
      * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
-     * @type {Array<CreateProductRequestAdditionalFilesInner>}
-     * @memberof CreateProductRequest
+     * @type {Array<CreateProductAdditionalFilesInner>}
+     * @memberof CreateProduct
      */
-    'additionalFiles'?: Array<CreateProductRequestAdditionalFilesInner>;
+    'additionalFiles'?: Array<CreateProductAdditionalFilesInner>;
     /**
      * List of application set UUIDs to associate with this product
      * @type {Array<string>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'applicationSets'?: Array<string>;
     /**
      * Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
      * @type {boolean}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'includeInDataFeeds'?: boolean;
     /**
      * For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
      * @type {number}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'shopifyId'?: number;
     /**
      * Key/value pairs that can be used to store additional information about the product
      * @type {Array<MetaField>}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'metafields'?: Array<MetaField>;
     /**
      * A JSON object that defines the personalization template for the product.
      * @type {string}
-     * @memberof CreateProductRequest
+     * @memberof CreateProduct
      */
     'personalizationTemplate'?: string;
 }
 /**
  *
  * @export
- * @interface CreateProductRequestAdditionalFilesInner
+ * @interface CreateProductAdditionalFilesInner
  */
-export interface CreateProductRequestAdditionalFilesInner {
+export interface CreateProductAdditionalFilesInner {
     /**
      * Publicly available file URL.
      * @type {string}
-     * @memberof CreateProductRequestAdditionalFilesInner
+     * @memberof CreateProductAdditionalFilesInner
      */
     'src'?: string;
 }
 /**
  *
  * @export
- * @interface CreateProductRequestImagesInner
+ * @interface CreateProductImagesInner
  */
-export interface CreateProductRequestImagesInner {
+export interface CreateProductImagesInner {
     /**
      * Publicly available file URL.
      * @type {string}
-     * @memberof CreateProductRequestImagesInner
+     * @memberof CreateProductImagesInner
      */
     'src'?: string;
     /**
      * Image type.
      * @type {string}
-     * @memberof CreateProductRequestImagesInner
+     * @memberof CreateProductImagesInner
      */
     'type'?: string | null;
 }
 /**
- *
- * @export
- * @interface CreateProductRequestSeoMetadata
- */
-export interface CreateProductRequestSeoMetadata {
-    /**
-     * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
-     * @type {string}
-     * @memberof CreateProductRequestSeoMetadata
-     */
-    'title'?: string;
-    /**
-     * Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
-     * @type {string}
-     * @memberof CreateProductRequestSeoMetadata
-     */
-    'description'?: string | null;
-}
-/**
- *
+ * @type CreateProductRequest
  * @export
- * @interface CreateProductRequestVideosInner
  */
-export interface CreateProductRequestVideosInner {
-    /**
-     * Publicly available file URL.
-     * @type {string}
-     * @memberof CreateProductRequestVideosInner
-     */
-    'src'?: string;
-}
+export type CreateProductRequest = CreateBundleProduct | CreateProduct;
 /**
  *
  * @export
@@ -655,7 +743,7 @@ export interface CreateProductVariant {
      */
     'applicationSets'?: Array<string>;
     /**
-     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
+     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
      * @type {string}
      * @memberof CreateProductVariant
      */
@@ -680,6 +768,19 @@ export interface CreateProductVariantImagesInner {
      */
     'src'?: string;
 }
+/**
+ *
+ * @export
+ * @interface CreateProductVideosInner
+ */
+export interface CreateProductVideosInner {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof CreateProductVideosInner
+     */
+    'src'?: string;
+}
 /**
  * Image description
  * @export
@@ -872,10 +973,10 @@ export interface Product {
     'enabled'?: boolean;
     /**
      *
-     * @type {SeoMetadata}
+     * @type {SEOMetadata}
      * @memberof Product
      */
-    'seoMetadata'?: SeoMetadata;
+    'seoMetadata'?: SEOMetadata;
     /**
      *
      * @type {TargetSearchPhraseData}
@@ -930,6 +1031,12 @@ export interface Product {
      * @memberof Product
      */
     'variants'?: Array<Variant>;
+    /**
+     * Products in the bundle.
+     * @type {Array<Product>}
+     * @memberof Product
+     */
+    'bundleItems'?: Array<Product>;
     /**
      * Additional files attached to the product.
      * @type {Array<ProductAdditionalFilesInner>}
@@ -1094,22 +1201,48 @@ export interface ProductsResponse {
 /**
  * SEO metadata for the product
  * @export
- * @interface SeoMetadata
+ * @interface SEOMetadata
  */
-export interface SeoMetadata {
+export interface SEOMetadata {
     /**
      * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
      * @type {string}
-     * @memberof SeoMetadata
+     * @memberof SEOMetadata
      */
     'title'?: string;
     /**
      * Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
      * @type {string}
-     * @memberof SeoMetadata
+     * @memberof SEOMetadata
      */
     'description'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface SeoOptimiseProducts202Response
+ */
+export interface SeoOptimiseProducts202Response {
+    /**
+     * A message describing the optimisation status
+     * @type {string}
+     * @memberof SeoOptimiseProducts202Response
+     */
+    'message'?: string;
+}
+/**
+ *
+ * @export
+ * @interface SeoOptimiseProductsRequest
+ */
+export interface SeoOptimiseProductsRequest {
+    /**
+     * A set of product IDs to AI SEO optimise.
+     * @type {Array<string>}
+     * @memberof SeoOptimiseProductsRequest
+     */
+    'ids'?: Array<string>;
+}
 /**
  *
  * @export
@@ -1273,10 +1406,10 @@ export interface UpdateProductRequest {
     'slug'?: string;
     /**
      *
-     * @type {CreateProductRequestSeoMetadata}
+     * @type {UpdateProductsRequestProductsInnerSeoMetadata}
      * @memberof UpdateProductRequest
      */
-    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
     /**
      * The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration
      * @type {string}
@@ -1307,6 +1440,12 @@ export interface UpdateProductRequest {
      * @memberof UpdateProductRequest
      */
     'variants'?: Array<CreateProductVariant>;
+    /**
+     * A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
+     * @type {Array<string>}
+     * @memberof UpdateProductRequest
+     */
+    'bundleItems'?: Array<string>;
     /**
      * Images to attach to the product. For example, photos of models using/wearing the product.
      * @type {Array<ImageFile>}
@@ -1401,10 +1540,10 @@ export interface UpdateProductsRequestProductsInner {
     'enabled'?: boolean;
     /**
      *
-     * @type {CreateProductRequestSeoMetadata}
+     * @type {UpdateProductsRequestProductsInnerSeoMetadata}
      * @memberof UpdateProductsRequestProductsInner
      */
-    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
     /**
      * The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration
      * @type {string}
@@ -1442,6 +1581,25 @@ export interface UpdateProductsRequestProductsInner {
      */
     'shopifyId'?: number;
 }
+/**
+ *
+ * @export
+ * @interface UpdateProductsRequestProductsInnerSeoMetadata
+ */
+export interface UpdateProductsRequestProductsInnerSeoMetadata {
+    /**
+     * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerSeoMetadata
+     */
+    'title'?: string;
+    /**
+     * Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerSeoMetadata
+     */
+    'description'?: string | null;
+}
 /**
  *
  * @export
@@ -1467,7 +1625,7 @@ export interface UpdateProductsRequestProductsInnerVariantsInner {
      */
     'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice;
     /**
-     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
+     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
      * @type {string}
      * @memberof UpdateProductsRequestProductsInnerVariantsInner
      */
@@ -1646,7 +1804,7 @@ export interface Variant {
      */
     'applications'?: Array<Application>;
     /**
-     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
+     * The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed.
      * @type {string}
      * @memberof Variant
      */
@@ -2140,6 +2298,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * AI SEO optimises products by a set of given IDs.
+     * @summary AI SEO optimise products.
+     * @param {string} project What project it is
+     * @param {SeoOptimiseProductsRequest} [seoOptimiseProductsRequest] A set of product IDs to AI SEO optimise.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    seoOptimiseProducts: (project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -2215,6 +2382,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
+    /**
+     * AI SEO optimises products by a set of given IDs.
+     * @summary AI SEO optimise products.
+     * @param {string} project What project it is
+     * @param {SeoOptimiseProductsRequest} [seoOptimiseProductsRequest] A set of product IDs to AI SEO optimise.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimiseProducts202Response>>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -2280,6 +2456,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
+    /**
+     * AI SEO optimises products by a set of given IDs.
+     * @summary AI SEO optimise products.
+     * @param {ProductsApiSeoOptimiseProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimiseProducts202Response>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -2422,6 +2606,25 @@ export interface ProductsApiListProductsRequest {
      */
     readonly fields?: string;
 }
+/**
+ * Request parameters for seoOptimiseProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiSeoOptimiseProductsRequest
+ */
+export interface ProductsApiSeoOptimiseProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiSeoOptimiseProducts
+     */
+    readonly project: string;
+    /**
+     * A set of product IDs to AI SEO optimise.
+     * @type {SeoOptimiseProductsRequest}
+     * @memberof ProductsApiSeoOptimiseProducts
+     */
+    readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest;
+}
 /**
  * Request parameters for updateProduct operation in ProductsApi.
  * @export
@@ -2518,6 +2721,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
+    /**
+     * AI SEO optimises products by a set of given IDs.
+     * @summary AI SEO optimise products.
+     * @param {ProductsApiSeoOptimiseProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimiseProducts202Response, any>>;
     /**
      * Updates a product by a given ID.
      * @summary Update product