@teemill/product-catalog 1.47.0 → 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -850,6 +850,19 @@ export interface DuplicateProductsRequest {
      */
     'projects': Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface ExportProducts202Response
+ */
+export interface ExportProducts202Response {
+    /**
+     * A message describing the export status
+     * @type {string}
+     * @memberof ExportProducts202Response
+     */
+    'message'?: string;
+}
 /**
  * Image description
  * @export
@@ -1354,6 +1367,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>;
 }
 /**
  *
@@ -2493,6 +2512,14 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     duplicateProducts: (project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Export the project\'s products and variants as a CSV file.
+     * @summary Export products
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportProducts: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -2586,6 +2613,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateProducts202Response>>;
+    /**
+     * Export the project\'s products and variants as a CSV file.
+     * @summary Export products
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportProducts(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -2676,6 +2711,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateProducts202Response>;
+    /**
+     * Export the project\'s products and variants as a CSV file.
+     * @summary Export products
+     * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -2782,6 +2825,19 @@ export interface ProductsApiDuplicateProductsRequest {
      */
     readonly duplicateProductsRequest?: DuplicateProductsRequest;
 }
+/**
+ * Request parameters for exportProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiExportProductsRequest
+ */
+export interface ProductsApiExportProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiExportProducts
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for getProduct operation in ProductsApi.
  * @export
@@ -2966,6 +3022,15 @@ export declare class ProductsApi extends BaseAPI {
      * @memberof ProductsApi
      */
     duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateProducts202Response, any>>;
+    /**
+     * Export the project\'s products and variants as a CSV file.
+     * @summary Export products
+     * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      * Gets a product by a given ID.
      * @summary Get product

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.47.0
+ * The version of the OpenAPI document: 1.49.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -641,6 +641,42 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Export the project\'s products and variants as a CSV file.
+         * @summary Export products
+         * @param {string} project What project it is
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportProducts: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('exportProducts', 'project', project);
+            const localVarPath = `/v1/catalog/products/export`;
+            // 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: 'GET' }, 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;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Gets a product by a given ID.
          * @summary Get product
@@ -963,6 +999,22 @@ export const ProductsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Export the project\'s products and variants as a CSV file.
+         * @summary Export products
+         * @param {string} project What project it is
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportProducts(project, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, 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.exportProducts']) === 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);
+            });
+        },
         /**
          * Gets a product by a given ID.
          * @summary Get product
@@ -1110,6 +1162,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
         duplicateProducts(requestParameters, options) {
             return localVarFp.duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Export the project\'s products and variants as a CSV file.
+         * @summary Export products
+         * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        exportProducts(requestParameters, options) {
+            return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
+        },
         /**
          * Gets a product by a given ID.
          * @summary Get product
@@ -1212,6 +1274,17 @@ export class ProductsApi extends BaseAPI {
     duplicateProducts(requestParameters, options) {
         return ProductsApiFp(this.configuration).duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Export the project\'s products and variants as a CSV file.
+     * @summary Export products
+     * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    exportProducts(requestParameters, options) {
+        return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Gets a product by a given ID.
      * @summary Get product

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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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.47.0
+ * The version of the OpenAPI document: 1.49.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)