@teemill/product-catalog 1.35.0 → 1.36.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/product-catalog@1.35.0
+## @teemill/product-catalog@1.36.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.35.0 --save
+npm install @teemill/product-catalog@1.36.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.35.0
+ * The version of the OpenAPI document: 1.36.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -629,22 +629,22 @@ export interface CreateProductRequestVideosInner {
 export interface CreateProductVariant {
     /**
      * Attributes associated to a variant such as Colour and Size.
-     * @type {Array<CreateProductVariantAttributesInner>}
+     * @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
      * @memberof CreateProductVariant
      */
-    'attributes': Array<CreateProductVariantAttributesInner>;
+    'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
     /**
      * 
-     * @type {CreateProductVariantRetailPrice}
+     * @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
      * @memberof CreateProductVariant
      */
-    'retailPrice': CreateProductVariantRetailPrice;
+    'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
     /**
      * 
-     * @type {CreateProductVariantSalePrice}
+     * @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
      * @memberof CreateProductVariant
      */
-    'salePrice'?: CreateProductVariantSalePrice;
+    'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice;
     /**
      * A custom stock keeping unit for the variant.
      * @type {string}
@@ -669,6 +669,12 @@ export interface CreateProductVariant {
      * @memberof 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.
+     * @type {string}
+     * @memberof CreateProductVariant
+     */
+    'gtin'?: string | null;
     /**
      * For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one.
      * @type {number}
@@ -676,33 +682,6 @@ export interface CreateProductVariant {
      */
     'shopifyId'?: number;
 }
-/**
- * 
- * @export
- * @interface CreateProductVariantAttributesInner
- */
-export interface CreateProductVariantAttributesInner {
-    /**
-     * Attribute name
-     * @type {string}
-     * @memberof CreateProductVariantAttributesInner
-     */
-    'name': CreateProductVariantAttributesInnerNameEnum;
-    /**
-     * Attribute value
-     * @type {string}
-     * @memberof CreateProductVariantAttributesInner
-     */
-    'value': string;
-}
-
-export const CreateProductVariantAttributesInnerNameEnum = {
-    Size: 'Size',
-    Colour: 'Colour'
-} as const;
-
-export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
-
 /**
  * 
  * @export
@@ -716,58 +695,6 @@ export interface CreateProductVariantImagesInner {
      */
     'src'?: string;
 }
-/**
- * Variant retail price including tax.
- * @export
- * @interface CreateProductVariantRetailPrice
- */
-export interface CreateProductVariantRetailPrice {
-    /**
-     * Price including tax in the specified currency.
-     * @type {number}
-     * @memberof CreateProductVariantRetailPrice
-     */
-    'amount': number;
-    /**
-     * Currency code for the currency the price is valued in.
-     * @type {string}
-     * @memberof CreateProductVariantRetailPrice
-     */
-    'currencyCode': CreateProductVariantRetailPriceCurrencyCodeEnum;
-}
-
-export const CreateProductVariantRetailPriceCurrencyCodeEnum = {
-    Gbp: 'GBP'
-} as const;
-
-export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
-
-/**
- * Variant discounted price including tax.
- * @export
- * @interface CreateProductVariantSalePrice
- */
-export interface CreateProductVariantSalePrice {
-    /**
-     * Sale price including tax in the specified currency.
-     * @type {number}
-     * @memberof CreateProductVariantSalePrice
-     */
-    'amount': number;
-    /**
-     * Currency code for the currency the sale price is valued in.
-     * @type {string}
-     * @memberof CreateProductVariantSalePrice
-     */
-    'currencyCode': CreateProductVariantSalePriceCurrencyCodeEnum;
-}
-
-export const CreateProductVariantSalePriceCurrencyCodeEnum = {
-    Gbp: 'GBP'
-} as const;
-
-export type CreateProductVariantSalePriceCurrencyCodeEnum = typeof CreateProductVariantSalePriceCurrencyCodeEnum[keyof typeof CreateProductVariantSalePriceCurrencyCodeEnum];
-
 /**
  * Image description
  * @export
@@ -1410,6 +1337,208 @@ export interface UpdateProductRequest {
      */
     'metafields'?: Array<MetaField>;
 }
+/**
+ * 
+ * @export
+ * @interface UpdateProductsRequest
+ */
+export interface UpdateProductsRequest {
+    /**
+     * 
+     * @type {Array<UpdateProductsRequestProductsInner>}
+     * @memberof UpdateProductsRequest
+     */
+    'products'?: Array<UpdateProductsRequestProductsInner>;
+}
+/**
+ * 
+ * @export
+ * @interface UpdateProductsRequestProductsInner
+ */
+export interface UpdateProductsRequestProductsInner {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'id': string;
+    /**
+     * Product title
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'title'?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'description'?: string;
+    /**
+     * Whether the product is enabled.
+     * @type {boolean}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'enabled'?: boolean;
+    /**
+     * 
+     * @type {CreateProductRequestSeoMetadata}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    /**
+     * 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 UpdateProductsRequestProductsInner
+     */
+    'targetSearchPhrase'?: string;
+    /**
+     * Synonyms for the target search phrase. **Note:** This field requires the website integration
+     * @type {Array<string>}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'targetSearchPhraseSynonyms'?: Array<string>;
+    /**
+     * Additional product tags used for searching and filtering.
+     * @type {Array<string>}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'tags'?: Array<string>;
+    /**
+     * List of variants to update.
+     * @type {Array<UpdateProductsRequestProductsInnerVariantsInner>}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    'variants'?: Array<UpdateProductsRequestProductsInnerVariantsInner>;
+    /**
+     * Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
+     * @type {boolean}
+     * @memberof UpdateProductsRequestProductsInner
+     */
+    '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 UpdateProductsRequestProductsInner
+     */
+    'shopifyId'?: number;
+}
+/**
+ * 
+ * @export
+ * @interface UpdateProductsRequestProductsInnerVariantsInner
+ */
+export interface UpdateProductsRequestProductsInnerVariantsInner {
+    /**
+     * Attributes associated to a variant such as Colour and Size.
+     * @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInner
+     */
+    'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
+    /**
+     * 
+     * @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInner
+     */
+    'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
+    /**
+     * 
+     * @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
+     * @memberof 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.
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInner
+     */
+    'gtin'?: string | null;
+    /**
+     * For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one.
+     * @type {number}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInner
+     */
+    'shopifyId'?: number;
+}
+/**
+ * 
+ * @export
+ * @interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
+ */
+export interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
+     */
+    'name': UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
+     */
+    'value': string;
+}
+
+export const UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
+    Size: 'Size',
+    Colour: 'Colour'
+} as const;
+
+export type UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum];
+
+/**
+ * Variant retail price including tax.
+ * @export
+ * @interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
+ */
+export interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice {
+    /**
+     * Price including tax in the specified currency.
+     * @type {number}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
+     */
+    'amount': number;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
+     */
+    'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum;
+}
+
+export const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = {
+    Gbp: 'GBP'
+} as const;
+
+export type UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum];
+
+/**
+ * Variant discounted price including tax.
+ * @export
+ * @interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice
+ */
+export interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice {
+    /**
+     * Sale price including tax in the specified currency.
+     * @type {number}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
+     */
+    'amount': number;
+    /**
+     * Currency code for the currency the sale price is valued in.
+     * @type {string}
+     * @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
+     */
+    'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum;
+}
+
+export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = {
+    Gbp: 'GBP'
+} as const;
+
+export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
+
 /**
  * 
  * @export
@@ -1507,7 +1636,7 @@ export interface Variant {
      */
     'applications'?: Array<Application>;
     /**
-     * Global Trade Item Number
+     * 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.
      * @type {string}
      * @memberof Variant
      */
@@ -2542,6 +2671,56 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
             localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates catalog products for the given project.
+         * @summary Update products
+         * @param {string} project What project it is
+         * @param {UpdateProductsRequest} updateProductsRequest Update products in bulk.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateProducts: async (project: string, updateProductsRequest: UpdateProductsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('updateProducts', 'project', project)
+            // verify required parameter 'updateProductsRequest' is not null or undefined
+            assertParamExists('updateProducts', 'updateProductsRequest', updateProductsRequest)
+            const localVarPath = `/v1/catalog/products`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(updateProductsRequest, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -2647,6 +2826,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Updates catalog products for the given project.
+         * @summary Update products
+         * @param {string} project What project it is
+         * @param {UpdateProductsRequest} updateProductsRequest Update products in bulk.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateProducts(project: string, updateProductsRequest: UpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateProducts(project, updateProductsRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProducts']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -2717,6 +2910,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
         updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
             return localVarFp.updateProduct(requestParameters.project, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Updates catalog products for the given project.
+         * @summary Update products
+         * @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
+            return localVarFp.updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -2888,6 +3091,27 @@ export interface ProductsApiUpdateProductRequest {
     readonly updateProductRequest?: UpdateProductRequest
 }
 
+/**
+ * Request parameters for updateProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiUpdateProductsRequest
+ */
+export interface ProductsApiUpdateProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiUpdateProducts
+     */
+    readonly project: string
+
+    /**
+     * Update products in bulk.
+     * @type {UpdateProductsRequest}
+     * @memberof ProductsApiUpdateProducts
+     */
+    readonly updateProductsRequest: UpdateProductsRequest
+}
+
 /**
  * ProductsApi - object-oriented interface
  * @export
@@ -2966,6 +3190,18 @@ export class ProductsApi extends BaseAPI {
     public updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
         return ProductsApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Updates catalog products for the given project.
+     * @summary Update products
+     * @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    public updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 

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.35.0
+ * The version of the OpenAPI document: 1.36.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.35.0
+ * The version of the OpenAPI document: 1.36.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.35.0
+ * The version of the OpenAPI document: 1.36.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -92,7 +92,7 @@ export class Configuration {
         this.baseOptions = {
             headers: {
                 ...param.baseOptions?.headers,
-                'User-Agent': "OpenAPI-Generator/1.35.0/typescript-axios"
+                'User-Agent': "OpenAPI-Generator/1.36.0/typescript-axios"
             },
             ...param.baseOptions
         };