@teemill/product-catalog 1.39.0 → 1.40.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/product-catalog@1.39.0
+## @teemill/product-catalog@1.40.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/product-catalog@1.39.0 --save
+npm install @teemill/product-catalog@1.40.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,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.39.0
+ * The version of the OpenAPI document: 1.40.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -445,188 +445,277 @@ 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;
 }
 /**
- * 
+ * @type CreateProductRequest
  * @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;
-}
-/**
- * 
- * @export
- * @interface CreateProductRequestVideosInner
- */
-export interface CreateProductRequestVideosInner {
-    /**
-     * Publicly available file URL.
-     * @type {string}
-     * @memberof CreateProductRequestVideosInner
-     */
-    'src'?: string;
-}
+export type CreateProductRequest = CreateBundleProduct | CreateProduct;
+
 /**
  * 
  * @export
@@ -676,7 +765,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
      */
@@ -701,6 +790,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
@@ -954,6 +1056,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>}
@@ -1323,10 +1431,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}
@@ -1357,6 +1465,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>}
@@ -1451,10 +1565,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}
@@ -1492,6 +1606,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
@@ -1517,7 +1650,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
      */
@@ -1705,7 +1838,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
      */

package/base.ts

@@ -4,7 +4,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.39.0
+ * The version of the OpenAPI document: 1.40.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,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.39.0
+ * The version of the OpenAPI document: 1.40.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,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.39.0
+ * The version of the OpenAPI document: 1.40.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -90,11 +90,10 @@ export class Configuration {
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = {
+            ...param.baseOptions,
             headers: {
                 ...param.baseOptions?.headers,
-                'User-Agent': "OpenAPI-Generator/1.39.0/typescript-axios"
             },
-            ...param.baseOptions
         };
         this.formDataCtor = param.formDataCtor;
     }