@teemill/product-catalog 1.48.0 → 1.50.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -818,6 +818,19 @@ export interface CreateProductVideosInner {
      */
     'src'?: string;
 }
+/**
+ *
+ * @export
+ * @interface DeleteProductsRequest
+ */
+export interface DeleteProductsRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DeleteProductsRequest
+     */
+    'products'?: Array<string>;
+}
 /**
  *
  * @export
@@ -1367,6 +1380,12 @@ export interface SeoOptimiseProductsRequest {
      * @memberof SeoOptimiseProductsRequest
      */
     'ids'?: Array<string>;
+    /**
+     * If provided, only the specified fields will be updated.
+     * @type {Array<string>}
+     * @memberof SeoOptimiseProductsRequest
+     */
+    'fields'?: Array<string>;
 }
 /**
  *
@@ -2497,6 +2516,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteProduct: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes catalog products for the given project.
+     * @summary Delete products
+     * @param {string} project What project it is
+     * @param {DeleteProductsRequest} deleteProductsRequest Delete products in bulk.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProducts: (project: string, deleteProductsRequest: DeleteProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Duplicate products by a set of given IDs to a set of given project IDs.
      * @summary Duplicate products.
@@ -2598,6 +2626,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProduct(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Deletes catalog products for the given project.
+     * @summary Delete products
+     * @param {string} project What project it is
+     * @param {DeleteProductsRequest} deleteProductsRequest Delete products in bulk.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProducts(project: string, deleteProductsRequest: DeleteProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Duplicate products by a set of given IDs to a set of given project IDs.
      * @summary Duplicate products.
@@ -2697,6 +2734,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Deletes catalog products for the given project.
+     * @summary Delete products
+     * @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProducts(requestParameters: ProductsApiDeleteProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Duplicate products by a set of given IDs to a set of given project IDs.
      * @summary Duplicate products.
@@ -2800,6 +2845,25 @@ export interface ProductsApiDeleteProductRequest {
      */
     readonly productId: string;
 }
+/**
+ * Request parameters for deleteProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiDeleteProductsRequest
+ */
+export interface ProductsApiDeleteProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiDeleteProducts
+     */
+    readonly project: string;
+    /**
+     * Delete products in bulk.
+     * @type {DeleteProductsRequest}
+     * @memberof ProductsApiDeleteProducts
+     */
+    readonly deleteProductsRequest: DeleteProductsRequest;
+}
 /**
  * Request parameters for duplicateProducts operation in ProductsApi.
  * @export
@@ -3007,6 +3071,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Deletes catalog products for the given project.
+     * @summary Delete products
+     * @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProducts(requestParameters: ProductsApiDeleteProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Duplicate products by a set of given IDs to a set of given project IDs.
      * @summary Duplicate products.

package/dist/esm/api.js

@@ -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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -602,6 +602,47 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes catalog products for the given project.
+         * @summary Delete products
+         * @param {string} project What project it is
+         * @param {DeleteProductsRequest} deleteProductsRequest Delete products in bulk.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteProducts: (project_1, deleteProductsRequest_1, ...args_1) => __awaiter(this, [project_1, deleteProductsRequest_1, ...args_1], void 0, function* (project, deleteProductsRequest, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('deleteProducts', 'project', project);
+            // verify required parameter 'deleteProductsRequest' is not null or undefined
+            assertParamExists('deleteProducts', 'deleteProductsRequest', deleteProductsRequest);
+            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 = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield 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 = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(deleteProductsRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Duplicate products by a set of given IDs to a set of given project IDs.
          * @summary Duplicate products.
@@ -982,6 +1023,23 @@ export const ProductsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Deletes catalog products for the given project.
+         * @summary Delete products
+         * @param {string} project What project it is
+         * @param {DeleteProductsRequest} deleteProductsRequest Delete products in bulk.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteProducts(project, deleteProductsRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProducts(project, deleteProductsRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.deleteProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Duplicate products by a set of given IDs to a set of given project IDs.
          * @summary Duplicate products.
@@ -1152,6 +1210,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
         deleteProduct(requestParameters, options) {
             return localVarFp.deleteProduct(requestParameters.project, requestParameters.productId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes catalog products for the given project.
+         * @summary Delete products
+         * @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteProducts(requestParameters, options) {
+            return localVarFp.deleteProducts(requestParameters.project, requestParameters.deleteProductsRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Duplicate products by a set of given IDs to a set of given project IDs.
          * @summary Duplicate products.
@@ -1263,6 +1331,17 @@ export class ProductsApi extends BaseAPI {
     deleteProduct(requestParameters, options) {
         return ProductsApiFp(this.configuration).deleteProduct(requestParameters.project, requestParameters.productId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes catalog products for the given project.
+     * @summary Delete products
+     * @param {ProductsApiDeleteProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProducts(requestParameters, options) {
+        return ProductsApiFp(this.configuration).deleteProducts(requestParameters.project, requestParameters.deleteProductsRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Duplicate products by a set of given IDs to a set of given project IDs.
      * @summary Duplicate products.

package/dist/esm/base.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

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

package/dist/esm/common.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

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

package/dist/esm/configuration.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

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

package/dist/esm/index.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

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

package/dist/index.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.48.0
+ * The version of the OpenAPI document: 1.50.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

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

package/docs/AdditionalFile.md

@@ -0,0 +1,20 @@
+# AdditionalFile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | Publicly available file URL. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdditionalFile } from '@teemill/product-catalog';
+
+const instance: AdditionalFile = {
+    src,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/product-catalog';
+
+const instance: ApiError = {
+    code,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Application.md

@@ -0,0 +1,28 @@
+# Application
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**technology** | **string** | Technology to use for the application. | [default to undefined]
+**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
+**src** | **string** | Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files. | [default to undefined]
+**mockup** | [**ApplicationMockup**](ApplicationMockup.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Application } from '@teemill/product-catalog';
+
+const instance: Application = {
+    id,
+    technology,
+    placement,
+    src,
+    mockup,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApplicationMockup.md

@@ -0,0 +1,22 @@
+# ApplicationMockup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **string** | Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one. | [default to undefined]
+**preview** | **string** | Publicly available mockup image URL. This is a preview of the mockup image for the given application. | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationMockup } from '@teemill/product-catalog';
+
+const instance: ApplicationMockup = {
+    file,
+    preview,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApplicationSet.md

@@ -0,0 +1,38 @@
+# ApplicationSet
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the resource location | [default to undefined]
+**name** | **string** | Name of the application set | [default to undefined]
+**description** | **string** | Description of the application set | [optional] [default to undefined]
+**width** | **number** | The width, in pixels of the images in the set | [default to undefined]
+**height** | **number** | The height, in pixels of the images in the set | [default to undefined]
+**dpi** | **number** | The DPI used when printing the images in the set | [default to undefined]
+**records** | [**Array<ApplicationSetRecord>**](ApplicationSetRecord.md) | List of application set records | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationSet } from '@teemill/product-catalog';
+
+const instance: ApplicationSet = {
+    id,
+    ref,
+    name,
+    description,
+    width,
+    height,
+    dpi,
+    records,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApplicationSet1.md

@@ -0,0 +1,22 @@
+# ApplicationSet1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationSet1 } from '@teemill/product-catalog';
+
+const instance: ApplicationSet1 = {
+    id,
+    ref,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApplicationSetRecord.md

@@ -0,0 +1,26 @@
+# ApplicationSetRecord
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**set** | [**ApplicationSet1**](ApplicationSet1.md) |  | [optional] [default to undefined]
+**attributes** | [**Array<Attributes1Inner>**](Attributes1Inner.md) | Attributes associated to a variant such as Colour and Size. | [optional] [default to undefined]
+**applications** | [**Array<Application>**](Application.md) | List of applications for this record | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationSetRecord } from '@teemill/product-catalog';
+
+const instance: ApplicationSetRecord = {
+    id,
+    set,
+    attributes,
+    applications,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)