@teemill/product-catalog 1.93.1 → 1.94.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -35,6 +35,8 @@ docs/ApplicationTechnologyIntegrationProduct.md
35
35
  docs/Attribute.md
36
36
  docs/AttributeThumbnail.md
37
37
  docs/Attributes1Inner.md
38
+ docs/AutoMerchProducts202Response.md
39
+ docs/AutoMerchProductsRequest.md
38
40
  docs/BundleProduct.md
39
41
  docs/CreateApplication.md
40
42
  docs/CreateApplicationGroupRequest.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/product-catalog@1.93.1
1
+ ## @teemill/product-catalog@1.94.0
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/product-catalog@1.93.1 --save
39
+ npm install @teemill/product-catalog@1.94.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -67,6 +67,7 @@ Class | Method | HTTP request | Description
67
67
  *ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
68
68
  *ProductCreatorsApi* | [**listProductCreators**](docs/ProductCreatorsApi.md#listproductcreators) | **GET** /v1/catalog/creators | List product creators
69
69
  *ProductTypesApi* | [**listProductTypes**](docs/ProductTypesApi.md#listproducttypes) | **GET** /v1/catalog/product-types | List product types
70
+ *ProductsApi* | [**autoMerchProducts**](docs/ProductsApi.md#automerchproducts) | **POST** /v1/catalog/products/auto-merch | AI auto merchandise products.
70
71
  *ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
71
72
  *ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
72
73
  *ProductsApi* | [**deleteProducts**](docs/ProductsApi.md#deleteproducts) | **DELETE** /v1/catalog/products | Delete products
@@ -111,6 +112,8 @@ Class | Method | HTTP request | Description
111
112
  - [Attribute](docs/Attribute.md)
112
113
  - [AttributeThumbnail](docs/AttributeThumbnail.md)
113
114
  - [Attributes1Inner](docs/Attributes1Inner.md)
115
+ - [AutoMerchProducts202Response](docs/AutoMerchProducts202Response.md)
116
+ - [AutoMerchProductsRequest](docs/AutoMerchProductsRequest.md)
114
117
  - [BundleProduct](docs/BundleProduct.md)
115
118
  - [CreateApplication](docs/CreateApplication.md)
116
119
  - [CreateApplicationGroupRequest](docs/CreateApplicationGroupRequest.md)
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -498,6 +498,40 @@ export interface Attributes1Inner {
498
498
  'name'?: string;
499
499
  'value'?: string;
500
500
  }
501
+ export interface AutoMerchProducts202Response {
502
+ /**
503
+ * A message describing the auto merchandising status
504
+ */
505
+ 'message'?: string;
506
+ }
507
+ export interface AutoMerchProductsRequest {
508
+ /**
509
+ * A set of product IDs to AI auto merchandise.
510
+ */
511
+ 'ids': Array<string>;
512
+ /**
513
+ * If provided, only the specified fields will be updated. Supports AI SEO field keys (e.g. \"title\", \"targetSearchPhraseData\") and merchandising field keys with an \"append\" or \"remove\" suffix (e.g. \"lifestyleImages.append\", \"colours.remove\").
514
+ */
515
+ 'fields'?: Array<AutoMerchProductsRequestFieldsEnum>;
516
+ }
517
+
518
+ export const AutoMerchProductsRequestFieldsEnum = {
519
+ LifestyleImagesAppend: 'lifestyleImages.append',
520
+ LifestyleImagesRemove: 'lifestyleImages.remove',
521
+ ColoursAppend: 'colours.append',
522
+ ColoursRemove: 'colours.remove',
523
+ Title: 'title',
524
+ Description: 'description',
525
+ SeoMetadataTitle: 'seoMetadata.title',
526
+ SeoMetadataDescription: 'seoMetadata.description',
527
+ Tags: 'tags',
528
+ Slug: 'slug',
529
+ Images: 'images',
530
+ TargetSearchPhraseData: 'targetSearchPhraseData',
531
+ } as const;
532
+
533
+ export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
534
+
501
535
  /**
502
536
  * A bundle product that groups multiple items together at a combined price.
503
537
  */
@@ -4646,6 +4680,53 @@ export class ProductTypesApi extends BaseAPI {
4646
4680
  */
4647
4681
  export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
4648
4682
  return {
4683
+ /**
4684
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
4685
+ * @summary AI auto merchandise products.
4686
+ * @param {string} project What project it is
4687
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
4688
+ * @param {*} [options] Override http request option.
4689
+ * @throws {RequiredError}
4690
+ */
4691
+ autoMerchProducts: async (project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4692
+ // verify required parameter 'project' is not null or undefined
4693
+ assertParamExists('autoMerchProducts', 'project', project)
4694
+ const localVarPath = `/v1/catalog/products/auto-merch`;
4695
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4696
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4697
+ let baseOptions;
4698
+ if (configuration) {
4699
+ baseOptions = configuration.baseOptions;
4700
+ }
4701
+
4702
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
4703
+ const localVarHeaderParameter = {} as any;
4704
+ const localVarQueryParameter = {} as any;
4705
+
4706
+ // authentication session-oauth required
4707
+ // oauth required
4708
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4709
+
4710
+ // authentication api-key required
4711
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4712
+
4713
+ if (project !== undefined) {
4714
+ localVarQueryParameter['project'] = project;
4715
+ }
4716
+
4717
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4718
+ localVarHeaderParameter['Accept'] = 'application/json';
4719
+
4720
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4721
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4722
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4723
+ localVarRequestOptions.data = serializeDataIfNeeded(autoMerchProductsRequest, localVarRequestOptions, configuration)
4724
+
4725
+ return {
4726
+ url: toPathString(localVarUrlObj),
4727
+ options: localVarRequestOptions,
4728
+ };
4729
+ },
4649
4730
  /**
4650
4731
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
4651
4732
  * @summary Create product
@@ -5351,6 +5432,20 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
5351
5432
  export const ProductsApiFp = function(configuration?: Configuration) {
5352
5433
  const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
5353
5434
  return {
5435
+ /**
5436
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
5437
+ * @summary AI auto merchandise products.
5438
+ * @param {string} project What project it is
5439
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
5440
+ * @param {*} [options] Override http request option.
5441
+ * @throws {RequiredError}
5442
+ */
5443
+ async autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoMerchProducts202Response>> {
5444
+ const localVarAxiosArgs = await localVarAxiosParamCreator.autoMerchProducts(project, autoMerchProductsRequest, options);
5445
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5446
+ const localVarOperationServerBasePath = operationServerMap['ProductsApi.autoMerchProducts']?.[localVarOperationServerIndex]?.url;
5447
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5448
+ },
5354
5449
  /**
5355
5450
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
5356
5451
  * @summary Create product
@@ -5544,6 +5639,16 @@ export const ProductsApiFp = function(configuration?: Configuration) {
5544
5639
  export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
5545
5640
  const localVarFp = ProductsApiFp(configuration)
5546
5641
  return {
5642
+ /**
5643
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
5644
+ * @summary AI auto merchandise products.
5645
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
5646
+ * @param {*} [options] Override http request option.
5647
+ * @throws {RequiredError}
5648
+ */
5649
+ autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response> {
5650
+ return localVarFp.autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(axios, basePath));
5651
+ },
5547
5652
  /**
5548
5653
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
5549
5654
  * @summary Create product
@@ -5657,6 +5762,21 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
5657
5762
  };
5658
5763
  };
5659
5764
 
5765
+ /**
5766
+ * Request parameters for autoMerchProducts operation in ProductsApi.
5767
+ */
5768
+ export interface ProductsApiAutoMerchProductsRequest {
5769
+ /**
5770
+ * What project it is
5771
+ */
5772
+ readonly project: string
5773
+
5774
+ /**
5775
+ * A set of product IDs to AI auto merchandise.
5776
+ */
5777
+ readonly autoMerchProductsRequest?: AutoMerchProductsRequest
5778
+ }
5779
+
5660
5780
  /**
5661
5781
  * Request parameters for createProduct operation in ProductsApi.
5662
5782
  */
@@ -5976,6 +6096,17 @@ export interface ProductsApiUpdateProductsRequest {
5976
6096
  * ProductsApi - object-oriented interface
5977
6097
  */
5978
6098
  export class ProductsApi extends BaseAPI {
6099
+ /**
6100
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
6101
+ * @summary AI auto merchandise products.
6102
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
6103
+ * @param {*} [options] Override http request option.
6104
+ * @throws {RequiredError}
6105
+ */
6106
+ public autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig) {
6107
+ return ProductsApiFp(this.configuration).autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(this.axios, this.basePath));
6108
+ }
6109
+
5979
6110
  /**
5980
6111
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
5981
6112
  * @summary Create product
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Product Catalog
4
4
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
5
5
  *
6
- * The version of the OpenAPI document: 1.93.1
6
+ * The version of the OpenAPI document: 1.94.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -470,6 +470,37 @@ export interface Attributes1Inner {
470
470
  'name'?: string;
471
471
  'value'?: string;
472
472
  }
473
+ export interface AutoMerchProducts202Response {
474
+ /**
475
+ * A message describing the auto merchandising status
476
+ */
477
+ 'message'?: string;
478
+ }
479
+ export interface AutoMerchProductsRequest {
480
+ /**
481
+ * A set of product IDs to AI auto merchandise.
482
+ */
483
+ 'ids': Array<string>;
484
+ /**
485
+ * If provided, only the specified fields will be updated. Supports AI SEO field keys (e.g. \"title\", \"targetSearchPhraseData\") and merchandising field keys with an \"append\" or \"remove\" suffix (e.g. \"lifestyleImages.append\", \"colours.remove\").
486
+ */
487
+ 'fields'?: Array<AutoMerchProductsRequestFieldsEnum>;
488
+ }
489
+ export declare const AutoMerchProductsRequestFieldsEnum: {
490
+ readonly LifestyleImagesAppend: "lifestyleImages.append";
491
+ readonly LifestyleImagesRemove: "lifestyleImages.remove";
492
+ readonly ColoursAppend: "colours.append";
493
+ readonly ColoursRemove: "colours.remove";
494
+ readonly Title: "title";
495
+ readonly Description: "description";
496
+ readonly SeoMetadataTitle: "seoMetadata.title";
497
+ readonly SeoMetadataDescription: "seoMetadata.description";
498
+ readonly Tags: "tags";
499
+ readonly Slug: "slug";
500
+ readonly Images: "images";
501
+ readonly TargetSearchPhraseData: "targetSearchPhraseData";
502
+ };
503
+ export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
473
504
  /**
474
505
  * A bundle product that groups multiple items together at a combined price.
475
506
  */
@@ -3456,6 +3487,15 @@ export declare class ProductTypesApi extends BaseAPI {
3456
3487
  * ProductsApi - axios parameter creator
3457
3488
  */
3458
3489
  export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
3490
+ /**
3491
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3492
+ * @summary AI auto merchandise products.
3493
+ * @param {string} project What project it is
3494
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
3495
+ * @param {*} [options] Override http request option.
3496
+ * @throws {RequiredError}
3497
+ */
3498
+ autoMerchProducts: (project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3459
3499
  /**
3460
3500
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3461
3501
  * @summary Create product
@@ -3590,6 +3630,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3590
3630
  * ProductsApi - functional programming interface
3591
3631
  */
3592
3632
  export declare const ProductsApiFp: (configuration?: Configuration) => {
3633
+ /**
3634
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3635
+ * @summary AI auto merchandise products.
3636
+ * @param {string} project What project it is
3637
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
3638
+ * @param {*} [options] Override http request option.
3639
+ * @throws {RequiredError}
3640
+ */
3641
+ autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoMerchProducts202Response>>;
3593
3642
  /**
3594
3643
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3595
3644
  * @summary Create product
@@ -3724,6 +3773,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3724
3773
  * ProductsApi - factory interface
3725
3774
  */
3726
3775
  export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3776
+ /**
3777
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3778
+ * @summary AI auto merchandise products.
3779
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
3780
+ * @param {*} [options] Override http request option.
3781
+ * @throws {RequiredError}
3782
+ */
3783
+ autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response>;
3727
3784
  /**
3728
3785
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3729
3786
  * @summary Create product
@@ -3813,6 +3870,19 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
3813
3870
  */
3814
3871
  updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
3815
3872
  };
3873
+ /**
3874
+ * Request parameters for autoMerchProducts operation in ProductsApi.
3875
+ */
3876
+ export interface ProductsApiAutoMerchProductsRequest {
3877
+ /**
3878
+ * What project it is
3879
+ */
3880
+ readonly project: string;
3881
+ /**
3882
+ * A set of product IDs to AI auto merchandise.
3883
+ */
3884
+ readonly autoMerchProductsRequest?: AutoMerchProductsRequest;
3885
+ }
3816
3886
  /**
3817
3887
  * Request parameters for createProduct operation in ProductsApi.
3818
3888
  */
@@ -4080,6 +4150,14 @@ export interface ProductsApiUpdateProductsRequest {
4080
4150
  * ProductsApi - object-oriented interface
4081
4151
  */
4082
4152
  export declare class ProductsApi extends BaseAPI {
4153
+ /**
4154
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
4155
+ * @summary AI auto merchandise products.
4156
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
4157
+ * @param {*} [options] Override http request option.
4158
+ * @throws {RequiredError}
4159
+ */
4160
+ autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoMerchProducts202Response, any, {}>>;
4083
4161
  /**
4084
4162
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
4085
4163
  * @summary Create product
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog
6
6
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.93.1
8
+ * The version of the OpenAPI document: 1.94.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductCreatorsApi = exports.ProductCreatorsApiFactory = exports.ProductCreatorsApiFp = exports.ProductCreatorsApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.RecommendationPriorityEnum = exports.PriceCurrencyCodeEnum = exports.CreateProductVariantAttributesInnerNameEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = exports.ActionImpactEnum = void 0;
26
- exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = void 0;
25
+ exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductCreatorsApi = exports.ProductCreatorsApiFactory = exports.ProductCreatorsApiFp = exports.ProductCreatorsApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.RecommendationPriorityEnum = exports.PriceCurrencyCodeEnum = exports.CreateProductVariantAttributesInnerNameEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AutoMerchProductsRequestFieldsEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = exports.ActionImpactEnum = void 0;
26
+ exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = exports.ProductsApi = void 0;
27
27
  const axios_1 = require("axios");
28
28
  // Some imports not used depending on template conditions
29
29
  // @ts-ignore
@@ -77,6 +77,20 @@ exports.AttributeThumbnailTypeEnum = {
77
77
  Color: 'color',
78
78
  Image: 'image',
79
79
  };
80
+ exports.AutoMerchProductsRequestFieldsEnum = {
81
+ LifestyleImagesAppend: 'lifestyleImages.append',
82
+ LifestyleImagesRemove: 'lifestyleImages.remove',
83
+ ColoursAppend: 'colours.append',
84
+ ColoursRemove: 'colours.remove',
85
+ Title: 'title',
86
+ Description: 'description',
87
+ SeoMetadataTitle: 'seoMetadata.title',
88
+ SeoMetadataDescription: 'seoMetadata.description',
89
+ Tags: 'tags',
90
+ Slug: 'slug',
91
+ Images: 'images',
92
+ TargetSearchPhraseData: 'targetSearchPhraseData',
93
+ };
80
94
  exports.CreateApplicationTechnologyEnum = {
81
95
  Dtg: 'dtg',
82
96
  Embroidery: 'embroidery',
@@ -1816,6 +1830,46 @@ exports.ProductTypesApi = ProductTypesApi;
1816
1830
  */
1817
1831
  const ProductsApiAxiosParamCreator = function (configuration) {
1818
1832
  return {
1833
+ /**
1834
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
1835
+ * @summary AI auto merchandise products.
1836
+ * @param {string} project What project it is
1837
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
1838
+ * @param {*} [options] Override http request option.
1839
+ * @throws {RequiredError}
1840
+ */
1841
+ autoMerchProducts: (project_1, autoMerchProductsRequest_1, ...args_1) => __awaiter(this, [project_1, autoMerchProductsRequest_1, ...args_1], void 0, function* (project, autoMerchProductsRequest, options = {}) {
1842
+ // verify required parameter 'project' is not null or undefined
1843
+ (0, common_1.assertParamExists)('autoMerchProducts', 'project', project);
1844
+ const localVarPath = `/v1/catalog/products/auto-merch`;
1845
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1846
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1847
+ let baseOptions;
1848
+ if (configuration) {
1849
+ baseOptions = configuration.baseOptions;
1850
+ }
1851
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1852
+ const localVarHeaderParameter = {};
1853
+ const localVarQueryParameter = {};
1854
+ // authentication session-oauth required
1855
+ // oauth required
1856
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
1857
+ // authentication api-key required
1858
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
1859
+ if (project !== undefined) {
1860
+ localVarQueryParameter['project'] = project;
1861
+ }
1862
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1863
+ localVarHeaderParameter['Accept'] = 'application/json';
1864
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1865
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1866
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1867
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(autoMerchProductsRequest, localVarRequestOptions, configuration);
1868
+ return {
1869
+ url: (0, common_1.toPathString)(localVarUrlObj),
1870
+ options: localVarRequestOptions,
1871
+ };
1872
+ }),
1819
1873
  /**
1820
1874
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
1821
1875
  * @summary Create product
@@ -2413,6 +2467,23 @@ exports.ProductsApiAxiosParamCreator = ProductsApiAxiosParamCreator;
2413
2467
  const ProductsApiFp = function (configuration) {
2414
2468
  const localVarAxiosParamCreator = (0, exports.ProductsApiAxiosParamCreator)(configuration);
2415
2469
  return {
2470
+ /**
2471
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2472
+ * @summary AI auto merchandise products.
2473
+ * @param {string} project What project it is
2474
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
2475
+ * @param {*} [options] Override http request option.
2476
+ * @throws {RequiredError}
2477
+ */
2478
+ autoMerchProducts(project, autoMerchProductsRequest, options) {
2479
+ return __awaiter(this, void 0, void 0, function* () {
2480
+ var _a, _b, _c;
2481
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.autoMerchProducts(project, autoMerchProductsRequest, options);
2482
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2483
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.autoMerchProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2484
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2485
+ });
2486
+ },
2416
2487
  /**
2417
2488
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2418
2489
  * @summary Create product
@@ -2639,6 +2710,16 @@ exports.ProductsApiFp = ProductsApiFp;
2639
2710
  const ProductsApiFactory = function (configuration, basePath, axios) {
2640
2711
  const localVarFp = (0, exports.ProductsApiFp)(configuration);
2641
2712
  return {
2713
+ /**
2714
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2715
+ * @summary AI auto merchandise products.
2716
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
2717
+ * @param {*} [options] Override http request option.
2718
+ * @throws {RequiredError}
2719
+ */
2720
+ autoMerchProducts(requestParameters, options) {
2721
+ return localVarFp.autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(axios, basePath));
2722
+ },
2642
2723
  /**
2643
2724
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2644
2725
  * @summary Create product
@@ -2756,6 +2837,16 @@ exports.ProductsApiFactory = ProductsApiFactory;
2756
2837
  * ProductsApi - object-oriented interface
2757
2838
  */
2758
2839
  class ProductsApi extends base_1.BaseAPI {
2840
+ /**
2841
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2842
+ * @summary AI auto merchandise products.
2843
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
2844
+ * @param {*} [options] Override http request option.
2845
+ * @throws {RequiredError}
2846
+ */
2847
+ autoMerchProducts(requestParameters, options) {
2848
+ return (0, exports.ProductsApiFp)(this.configuration).autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(this.axios, this.basePath));
2849
+ }
2759
2850
  /**
2760
2851
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2761
2852
  * @summary Create product
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog
6
6
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.93.1
8
+ * The version of the OpenAPI document: 1.94.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog
6
6
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.93.1
8
+ * The version of the OpenAPI document: 1.94.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -470,6 +470,37 @@ export interface Attributes1Inner {
470
470
  'name'?: string;
471
471
  'value'?: string;
472
472
  }
473
+ export interface AutoMerchProducts202Response {
474
+ /**
475
+ * A message describing the auto merchandising status
476
+ */
477
+ 'message'?: string;
478
+ }
479
+ export interface AutoMerchProductsRequest {
480
+ /**
481
+ * A set of product IDs to AI auto merchandise.
482
+ */
483
+ 'ids': Array<string>;
484
+ /**
485
+ * If provided, only the specified fields will be updated. Supports AI SEO field keys (e.g. \"title\", \"targetSearchPhraseData\") and merchandising field keys with an \"append\" or \"remove\" suffix (e.g. \"lifestyleImages.append\", \"colours.remove\").
486
+ */
487
+ 'fields'?: Array<AutoMerchProductsRequestFieldsEnum>;
488
+ }
489
+ export declare const AutoMerchProductsRequestFieldsEnum: {
490
+ readonly LifestyleImagesAppend: "lifestyleImages.append";
491
+ readonly LifestyleImagesRemove: "lifestyleImages.remove";
492
+ readonly ColoursAppend: "colours.append";
493
+ readonly ColoursRemove: "colours.remove";
494
+ readonly Title: "title";
495
+ readonly Description: "description";
496
+ readonly SeoMetadataTitle: "seoMetadata.title";
497
+ readonly SeoMetadataDescription: "seoMetadata.description";
498
+ readonly Tags: "tags";
499
+ readonly Slug: "slug";
500
+ readonly Images: "images";
501
+ readonly TargetSearchPhraseData: "targetSearchPhraseData";
502
+ };
503
+ export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
473
504
  /**
474
505
  * A bundle product that groups multiple items together at a combined price.
475
506
  */
@@ -3456,6 +3487,15 @@ export declare class ProductTypesApi extends BaseAPI {
3456
3487
  * ProductsApi - axios parameter creator
3457
3488
  */
3458
3489
  export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
3490
+ /**
3491
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3492
+ * @summary AI auto merchandise products.
3493
+ * @param {string} project What project it is
3494
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
3495
+ * @param {*} [options] Override http request option.
3496
+ * @throws {RequiredError}
3497
+ */
3498
+ autoMerchProducts: (project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3459
3499
  /**
3460
3500
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3461
3501
  * @summary Create product
@@ -3590,6 +3630,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3590
3630
  * ProductsApi - functional programming interface
3591
3631
  */
3592
3632
  export declare const ProductsApiFp: (configuration?: Configuration) => {
3633
+ /**
3634
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3635
+ * @summary AI auto merchandise products.
3636
+ * @param {string} project What project it is
3637
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
3638
+ * @param {*} [options] Override http request option.
3639
+ * @throws {RequiredError}
3640
+ */
3641
+ autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoMerchProducts202Response>>;
3593
3642
  /**
3594
3643
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3595
3644
  * @summary Create product
@@ -3724,6 +3773,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3724
3773
  * ProductsApi - factory interface
3725
3774
  */
3726
3775
  export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3776
+ /**
3777
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
3778
+ * @summary AI auto merchandise products.
3779
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
3780
+ * @param {*} [options] Override http request option.
3781
+ * @throws {RequiredError}
3782
+ */
3783
+ autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response>;
3727
3784
  /**
3728
3785
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3729
3786
  * @summary Create product
@@ -3813,6 +3870,19 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
3813
3870
  */
3814
3871
  updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
3815
3872
  };
3873
+ /**
3874
+ * Request parameters for autoMerchProducts operation in ProductsApi.
3875
+ */
3876
+ export interface ProductsApiAutoMerchProductsRequest {
3877
+ /**
3878
+ * What project it is
3879
+ */
3880
+ readonly project: string;
3881
+ /**
3882
+ * A set of product IDs to AI auto merchandise.
3883
+ */
3884
+ readonly autoMerchProductsRequest?: AutoMerchProductsRequest;
3885
+ }
3816
3886
  /**
3817
3887
  * Request parameters for createProduct operation in ProductsApi.
3818
3888
  */
@@ -4080,6 +4150,14 @@ export interface ProductsApiUpdateProductsRequest {
4080
4150
  * ProductsApi - object-oriented interface
4081
4151
  */
4082
4152
  export declare class ProductsApi extends BaseAPI {
4153
+ /**
4154
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
4155
+ * @summary AI auto merchandise products.
4156
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
4157
+ * @param {*} [options] Override http request option.
4158
+ * @throws {RequiredError}
4159
+ */
4160
+ autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoMerchProducts202Response, any, {}>>;
4083
4161
  /**
4084
4162
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
4085
4163
  * @summary Create product
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -73,6 +73,20 @@ export const AttributeThumbnailTypeEnum = {
73
73
  Color: 'color',
74
74
  Image: 'image',
75
75
  };
76
+ export const AutoMerchProductsRequestFieldsEnum = {
77
+ LifestyleImagesAppend: 'lifestyleImages.append',
78
+ LifestyleImagesRemove: 'lifestyleImages.remove',
79
+ ColoursAppend: 'colours.append',
80
+ ColoursRemove: 'colours.remove',
81
+ Title: 'title',
82
+ Description: 'description',
83
+ SeoMetadataTitle: 'seoMetadata.title',
84
+ SeoMetadataDescription: 'seoMetadata.description',
85
+ Tags: 'tags',
86
+ Slug: 'slug',
87
+ Images: 'images',
88
+ TargetSearchPhraseData: 'targetSearchPhraseData',
89
+ };
76
90
  export const CreateApplicationTechnologyEnum = {
77
91
  Dtg: 'dtg',
78
92
  Embroidery: 'embroidery',
@@ -1788,6 +1802,46 @@ export class ProductTypesApi extends BaseAPI {
1788
1802
  */
1789
1803
  export const ProductsApiAxiosParamCreator = function (configuration) {
1790
1804
  return {
1805
+ /**
1806
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
1807
+ * @summary AI auto merchandise products.
1808
+ * @param {string} project What project it is
1809
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
1810
+ * @param {*} [options] Override http request option.
1811
+ * @throws {RequiredError}
1812
+ */
1813
+ autoMerchProducts: (project_1, autoMerchProductsRequest_1, ...args_1) => __awaiter(this, [project_1, autoMerchProductsRequest_1, ...args_1], void 0, function* (project, autoMerchProductsRequest, options = {}) {
1814
+ // verify required parameter 'project' is not null or undefined
1815
+ assertParamExists('autoMerchProducts', 'project', project);
1816
+ const localVarPath = `/v1/catalog/products/auto-merch`;
1817
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1818
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1819
+ let baseOptions;
1820
+ if (configuration) {
1821
+ baseOptions = configuration.baseOptions;
1822
+ }
1823
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1824
+ const localVarHeaderParameter = {};
1825
+ const localVarQueryParameter = {};
1826
+ // authentication session-oauth required
1827
+ // oauth required
1828
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1829
+ // authentication api-key required
1830
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1831
+ if (project !== undefined) {
1832
+ localVarQueryParameter['project'] = project;
1833
+ }
1834
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1835
+ localVarHeaderParameter['Accept'] = 'application/json';
1836
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1837
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1838
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1839
+ localVarRequestOptions.data = serializeDataIfNeeded(autoMerchProductsRequest, localVarRequestOptions, configuration);
1840
+ return {
1841
+ url: toPathString(localVarUrlObj),
1842
+ options: localVarRequestOptions,
1843
+ };
1844
+ }),
1791
1845
  /**
1792
1846
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
1793
1847
  * @summary Create product
@@ -2384,6 +2438,23 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
2384
2438
  export const ProductsApiFp = function (configuration) {
2385
2439
  const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration);
2386
2440
  return {
2441
+ /**
2442
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2443
+ * @summary AI auto merchandise products.
2444
+ * @param {string} project What project it is
2445
+ * @param {AutoMerchProductsRequest} [autoMerchProductsRequest] A set of product IDs to AI auto merchandise.
2446
+ * @param {*} [options] Override http request option.
2447
+ * @throws {RequiredError}
2448
+ */
2449
+ autoMerchProducts(project, autoMerchProductsRequest, options) {
2450
+ return __awaiter(this, void 0, void 0, function* () {
2451
+ var _a, _b, _c;
2452
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.autoMerchProducts(project, autoMerchProductsRequest, options);
2453
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2454
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.autoMerchProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2455
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2456
+ });
2457
+ },
2387
2458
  /**
2388
2459
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2389
2460
  * @summary Create product
@@ -2609,6 +2680,16 @@ export const ProductsApiFp = function (configuration) {
2609
2680
  export const ProductsApiFactory = function (configuration, basePath, axios) {
2610
2681
  const localVarFp = ProductsApiFp(configuration);
2611
2682
  return {
2683
+ /**
2684
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2685
+ * @summary AI auto merchandise products.
2686
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
2687
+ * @param {*} [options] Override http request option.
2688
+ * @throws {RequiredError}
2689
+ */
2690
+ autoMerchProducts(requestParameters, options) {
2691
+ return localVarFp.autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(axios, basePath));
2692
+ },
2612
2693
  /**
2613
2694
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2614
2695
  * @summary Create product
@@ -2725,6 +2806,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
2725
2806
  * ProductsApi - object-oriented interface
2726
2807
  */
2727
2808
  export class ProductsApi extends BaseAPI {
2809
+ /**
2810
+ * AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
2811
+ * @summary AI auto merchandise products.
2812
+ * @param {ProductsApiAutoMerchProductsRequest} requestParameters Request parameters.
2813
+ * @param {*} [options] Override http request option.
2814
+ * @throws {RequiredError}
2815
+ */
2816
+ autoMerchProducts(requestParameters, options) {
2817
+ return ProductsApiFp(this.configuration).autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(this.axios, this.basePath));
2818
+ }
2728
2819
  /**
2729
2820
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
2730
2821
  * @summary Create product
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Product Catalog
4
4
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
5
5
  *
6
- * The version of the OpenAPI document: 1.93.1
6
+ * The version of the OpenAPI document: 1.94.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.93.1
5
+ * The version of the OpenAPI document: 1.94.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog
6
6
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.93.1
8
+ * The version of the OpenAPI document: 1.94.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,20 @@
1
+ # AutoMerchProducts202Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | A message describing the auto merchandising status | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { AutoMerchProducts202Response } from '@teemill/product-catalog';
14
+
15
+ const instance: AutoMerchProducts202Response = {
16
+ message,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # AutoMerchProductsRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **ids** | **Array&lt;string&gt;** | A set of product IDs to AI auto merchandise. | [default to undefined]
9
+ **fields** | **Array&lt;string&gt;** | If provided, only the specified fields will be updated. Supports AI SEO field keys (e.g. \&quot;title\&quot;, \&quot;targetSearchPhraseData\&quot;) and merchandising field keys with an \&quot;append\&quot; or \&quot;remove\&quot; suffix (e.g. \&quot;lifestyleImages.append\&quot;, \&quot;colours.remove\&quot;). | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AutoMerchProductsRequest } from '@teemill/product-catalog';
15
+
16
+ const instance: AutoMerchProductsRequest = {
17
+ ids,
18
+ fields,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.podos.io*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**autoMerchProducts**](#automerchproducts) | **POST** /v1/catalog/products/auto-merch | AI auto merchandise products.|
7
8
  |[**createProduct**](#createproduct) | **POST** /v1/catalog/products | Create product|
8
9
  |[**deleteProduct**](#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product|
9
10
  |[**deleteProducts**](#deleteproducts) | **DELETE** /v1/catalog/products | Delete products|
@@ -16,6 +17,66 @@ All URIs are relative to *https://api.podos.io*
16
17
  |[**updateProduct**](#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product|
17
18
  |[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
18
19
 
20
+ # **autoMerchProducts**
21
+ > AutoMerchProducts202Response autoMerchProducts()
22
+
23
+ AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
24
+
25
+ ### Example
26
+
27
+ ```typescript
28
+ import {
29
+ ProductsApi,
30
+ Configuration,
31
+ AutoMerchProductsRequest
32
+ } from '@teemill/product-catalog';
33
+
34
+ const configuration = new Configuration();
35
+ const apiInstance = new ProductsApi(configuration);
36
+
37
+ let project: string; //What project it is (default to undefined)
38
+ let autoMerchProductsRequest: AutoMerchProductsRequest; //A set of product IDs to AI auto merchandise. (optional)
39
+
40
+ const { status, data } = await apiInstance.autoMerchProducts(
41
+ project,
42
+ autoMerchProductsRequest
43
+ );
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ |Name | Type | Description | Notes|
49
+ |------------- | ------------- | ------------- | -------------|
50
+ | **autoMerchProductsRequest** | **AutoMerchProductsRequest**| A set of product IDs to AI auto merchandise. | |
51
+ | **project** | [**string**] | What project it is | defaults to undefined|
52
+
53
+
54
+ ### Return type
55
+
56
+ **AutoMerchProducts202Response**
57
+
58
+ ### Authorization
59
+
60
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json
65
+ - **Accept**: application/json
66
+
67
+
68
+ ### HTTP response details
69
+ | Status code | Description | Response headers |
70
+ |-------------|-------------|------------------|
71
+ |**202** | Products queued for auto merchandising. | - |
72
+ |**400** | Failed validation. | - |
73
+ |**401** | Not authorised to access this resource. | - |
74
+ |**403** | Refuse to authorize. | - |
75
+ |**404** | Resource not found. | - |
76
+ |**500** | Unknown server error. | - |
77
+
78
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
79
+
19
80
  # **createProduct**
20
81
  > Product createProduct()
21
82
 
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.93.1
7
+ * The version of the OpenAPI document: 1.94.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/product-catalog",
3
- "version": "1.93.1",
3
+ "version": "1.94.0",
4
4
  "description": "OpenAPI client for @teemill/product-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {