@teemill/product-catalog 1.33.1 → 1.34.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/product-catalog@1.33.1
+## @teemill/product-catalog@1.34.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.33.1 --save
+npm install @teemill/product-catalog@1.34.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.33.1
+ * The version of the OpenAPI document: 1.34.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2349,21 +2349,17 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Lists all enabled store listing products attached to the given project.
-         * @summary List products
+         * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+         * @summary Import products
          * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
-         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [fields] Filter response fields to only include a subset of the resource.
+         * @param {string} [body] A data URL of a CSV file containing data for one or more products.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        importProducts: async (project: string, body?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'project' is not null or undefined
-            assertParamExists('getProducts', 'project', project)
-            const localVarPath = `/v1/catalog/products`;
+            assertParamExists('importProducts', 'project', project)
+            const localVarPath = `/v1/catalog/products/import`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -2371,7 +2367,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -2386,31 +2382,14 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
                 localVarQueryParameter['project'] = project;
             }
 
-            if (pageToken !== undefined) {
-                localVarQueryParameter['pageToken'] = pageToken;
-            }
-
-            if (search !== undefined) {
-                localVarQueryParameter['search'] = search;
-            }
-
-            if (sortBy) {
-                localVarQueryParameter['sortBy'] = sortBy;
-            }
-
-            if (pageSize !== undefined) {
-                localVarQueryParameter['pageSize'] = pageSize;
-            }
-
-            if (fields !== undefined) {
-                localVarQueryParameter['fields'] = fields;
-            }
-
 
     
+            localVarHeaderParameter['Content-Type'] = 'text/csv';
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -2418,17 +2397,21 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
-         * @summary Import products
+         * Lists all store listing products attached to the given project.
+         * @summary List products
          * @param {string} project What project it is
-         * @param {string} [body] A data URL of a CSV file containing data for one or more products.
+         * @param {number} [pageToken] Page reference token
+         * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
+         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [fields] Filter response fields to only include a subset of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        importProducts: async (project: string, body?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'project' is not null or undefined
-            assertParamExists('importProducts', 'project', project)
-            const localVarPath = `/v1/catalog/products/import`;
+            assertParamExists('listProducts', 'project', project)
+            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;
@@ -2436,7 +2419,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -2451,14 +2434,31 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
                 localVarQueryParameter['project'] = project;
             }
 
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
 
-    
-            localVarHeaderParameter['Content-Type'] = 'text/csv';
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
 
+            if (sortBy) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (fields !== undefined) {
+                localVarQueryParameter['fields'] = fields;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -2571,35 +2571,35 @@ export const ProductsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Lists all enabled store listing products attached to the given project.
-         * @summary List products
+         * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+         * @summary Import products
          * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
-         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [fields] Filter response fields to only include a subset of the resource.
+         * @param {string} [body] A data URL of a CSV file containing data for one or more products.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
+        async importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.importProducts(project, body, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProducts']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['ProductsApi.importProducts']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
-         * @summary Import products
+         * Lists all store listing products attached to the given project.
+         * @summary List products
          * @param {string} project What project it is
-         * @param {string} [body] A data URL of a CSV file containing data for one or more products.
+         * @param {number} [pageToken] Page reference token
+         * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
+         * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+         * @param {string} [fields] Filter response fields to only include a subset of the resource.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.importProducts(project, body, options);
+        async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['ProductsApi.importProducts']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
@@ -2657,16 +2657,6 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
         getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
             return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
         },
-        /**
-         * Lists all enabled store listing products attached to the given project.
-         * @summary List products
-         * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
-            return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
-        },
         /**
          * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
          * @summary Import products
@@ -2677,6 +2667,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
         importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response> {
             return localVarFp.importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists all store listing products attached to the given project.
+         * @summary List products
+         * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
+            return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
+        },
         /**
          * Updates a product by a given ID.
          * @summary Update product
@@ -2761,75 +2761,75 @@ export interface ProductsApiGetProductRequest {
 }
 
 /**
- * Request parameters for getProducts operation in ProductsApi.
+ * Request parameters for importProducts operation in ProductsApi.
  * @export
- * @interface ProductsApiGetProductsRequest
+ * @interface ProductsApiImportProductsRequest
  */
-export interface ProductsApiGetProductsRequest {
+export interface ProductsApiImportProductsRequest {
     /**
      * What project it is
      * @type {string}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiImportProducts
+     */
+    readonly project: string
+
+    /**
+     * A data URL of a CSV file containing data for one or more products.
+     * @type {string}
+     * @memberof ProductsApiImportProducts
+     */
+    readonly body?: string
+}
+
+/**
+ * Request parameters for listProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiListProductsRequest
+ */
+export interface ProductsApiListProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiListProducts
      */
     readonly project: string
 
     /**
      * Page reference token
      * @type {number}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiListProducts
      */
     readonly pageToken?: number
 
     /**
      * Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
      * @type {string}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiListProducts
      */
     readonly search?: string
 
     /**
      * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
      * @type {Array<string>}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiListProducts
      */
     readonly sortBy?: Array<string>
 
     /**
      * Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @type {number}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiListProducts
      */
     readonly pageSize?: number
 
     /**
      * Filter response fields to only include a subset of the resource.
      * @type {string}
-     * @memberof ProductsApiGetProducts
+     * @memberof ProductsApiListProducts
      */
     readonly fields?: string
 }
 
-/**
- * Request parameters for importProducts operation in ProductsApi.
- * @export
- * @interface ProductsApiImportProductsRequest
- */
-export interface ProductsApiImportProductsRequest {
-    /**
-     * What project it is
-     * @type {string}
-     * @memberof ProductsApiImportProducts
-     */
-    readonly project: string
-
-    /**
-     * A data URL of a CSV file containing data for one or more products.
-     * @type {string}
-     * @memberof ProductsApiImportProducts
-     */
-    readonly body?: string
-}
-
 /**
  * Request parameters for updateProduct operation in ProductsApi.
  * @export
@@ -2902,27 +2902,27 @@ export class ProductsApi extends BaseAPI {
     }
 
     /**
-     * Lists all enabled store listing products attached to the given project.
-     * @summary List products
-     * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
+     * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
+     * @summary Import products
+     * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    public getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig) {
-        return ProductsApiFp(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
+    public importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
-     * @summary Import products
-     * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
+     * Lists all store listing products attached to the given project.
+     * @summary List products
+     * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    public importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig) {
-        return ProductsApiFp(this.configuration).importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, 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.33.1
+ * The version of the OpenAPI document: 1.34.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.33.1
+ * The version of the OpenAPI document: 1.34.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.33.1
+ * The version of the OpenAPI document: 1.34.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).