@teemill/product-catalog 1.93.1 → 1.95.0

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Product Catalog
  * 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.
  *
- * The version of the OpenAPI document: 1.93.1
+ * The version of the OpenAPI document: 1.95.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
  * 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.
  *
- * The version of the OpenAPI document: 1.93.1
+ * The version of the OpenAPI document: 1.95.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

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

package/docs/Attribute.md

@@ -1,14 +1,15 @@
 # Attribute
 
+An attribute associated to a variant such as Colour and Size.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Attribute name | [default to undefined]
-**value** | **string** | Attribute value | [default to undefined]
+**name** | **string** | Variant attribute name | [default to undefined]
+**value** | **string** | Variant attribute value | [default to undefined]
 **thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) |  | [optional] [default to undefined]
-**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
+**tags** | **Array<string>** | Variant attribute tags | [optional] [default to undefined]
 
 ## Example
 

package/docs/AutoMerchProducts202Response.md

@@ -0,0 +1,20 @@
+# AutoMerchProducts202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the auto merchandising status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoMerchProducts202Response } from '@teemill/product-catalog';
+
+const instance: AutoMerchProducts202Response = {
+    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/AutoMerchProductsRequest.md

@@ -0,0 +1,22 @@
+# AutoMerchProductsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | A set of product IDs to AI auto merchandise. | [default to undefined]
+**fields** | **Array<string>** | 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\"). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoMerchProductsRequest } from '@teemill/product-catalog';
+
+const instance: AutoMerchProductsRequest = {
+    ids,
+    fields,
+};
+```
+
+[[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/Product.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
 **tags** | **Array<string>** |  | [optional] [default to undefined]
 **internalTags** | **Array<string>** |  | [optional] [default to undefined]
+**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | Attributes associated to a product such as product colours and sizes | [optional] [default to undefined]
 **createdAt** | **string** |  | [optional] [default to undefined]
 **updatedAt** | **string** |  | [optional] [default to undefined]
 **publishedAt** | **string** |  | [optional] [default to undefined]
@@ -66,6 +67,7 @@ const instance: Product = {
     targetSearchPhraseData,
     tags,
     internalTags,
+    attributes,
     createdAt,
     updatedAt,
     publishedAt,

package/docs/ProductAttribute.md

@@ -0,0 +1,22 @@
+# ProductAttribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name, this can only be \'Colour\' or \'Size\' for now | [default to undefined]
+**values** | [**Array<ProductAttributeValue1>**](ProductAttributeValue1.md) | Attribute values | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAttribute } from '@teemill/product-catalog';
+
+const instance: ProductAttribute = {
+    name,
+    values,
+};
+```
+
+[[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/ProductAttributeValue.md

@@ -0,0 +1,22 @@
+# ProductAttributeValue
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sortOrder** | **number** | Position of the value when ordered | [default to undefined]
+**value** | **string** | The specific size or colour value. This must match the GFN Catalog API exactly. | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAttributeValue } from '@teemill/product-catalog';
+
+const instance: ProductAttributeValue = {
+    sortOrder,
+    value,
+};
+```
+
+[[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/ProductAttributeValue1.md

@@ -0,0 +1,22 @@
+# ProductAttributeValue1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sortOrder** | **number** | Position of the value when ordered | [default to undefined]
+**value** | **string** | Product attribute value | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAttributeValue1 } from '@teemill/product-catalog';
+
+const instance: ProductAttributeValue1 = {
+    sortOrder,
+    value,
+};
+```
+
+[[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/ProductsApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.podos.io*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**autoMerchProducts**](#automerchproducts) | **POST** /v1/catalog/products/auto-merch | AI auto merchandise products.|
 |[**createProduct**](#createproduct) | **POST** /v1/catalog/products | Create product|
 |[**deleteProduct**](#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product|
 |[**deleteProducts**](#deleteproducts) | **DELETE** /v1/catalog/products | Delete products|
@@ -16,6 +17,66 @@ All URIs are relative to *https://api.podos.io*
 |[**updateProduct**](#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product|
 |[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
 
+# **autoMerchProducts**
+> AutoMerchProducts202Response autoMerchProducts()
+
+AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
+
+### Example
+
+```typescript
+import {
+    ProductsApi,
+    Configuration,
+    AutoMerchProductsRequest
+} from '@teemill/product-catalog';
+
+const configuration = new Configuration();
+const apiInstance = new ProductsApi(configuration);
+
+let project: string; //What project it is (default to undefined)
+let autoMerchProductsRequest: AutoMerchProductsRequest; //A set of product IDs to AI auto merchandise. (optional)
+
+const { status, data } = await apiInstance.autoMerchProducts(
+    project,
+    autoMerchProductsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **autoMerchProductsRequest** | **AutoMerchProductsRequest**| A set of product IDs to AI auto merchandise. | |
+| **project** | [**string**] | What project it is | defaults to undefined|
+
+
+### Return type
+
+**AutoMerchProducts202Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Products queued for auto merchandising. |  -  |
+|**400** | Failed validation. |  -  |
+|**401** | Not authorised to access this resource. |  -  |
+|**403** | Refuse to authorize. |  -  |
+|**404** | Resource not found. |  -  |
+|**500** | Unknown server error. |  -  |
+
+[[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)
+
 # **createProduct**
 > Product createProduct()
 

package/docs/UpdateProductRequest.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
 **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
 **brand** | **string** | The brand of the product. | [optional] [default to undefined]
+**attributes** | [**Array<UpdateProductRequestAttributesInner>**](UpdateProductRequestAttributesInner.md) | Attributes associated to a product such as product colours and sizes.  The name and values must match the GFN Catalog API exactly — use the GFN Catalog API to list the product to get the exact strings (casing and spelling must match). If present, any new variant attributes and values must be included in this list.  | [optional] [default to undefined]
 **seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
 **targetSearchPhrase** | **string** | The primary target search phrase for the product that you wish to rank for in search engine results.  **Note:** This field requires the website integration | [optional] [default to undefined]
 **targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
@@ -45,6 +46,7 @@ const instance: UpdateProductRequest = {
     enabled,
     slug,
     brand,
+    attributes,
     seoMetadata,
     targetSearchPhrase,
     targetSearchPhraseSynonyms,

package/docs/UpdateProductRequestAttributesInner.md

@@ -0,0 +1,22 @@
+# UpdateProductRequestAttributesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Product attribute name, this can only be \'Colour\' or \'Size\' for now | [default to undefined]
+**values** | [**Array<ProductAttributeValue>**](ProductAttributeValue.md) | List of product attribute values, each including a sort order and an option value (e.g., \'Black\', \'Blue\', \'XL\', \'XXL\'). Any existing values not included here will be removed, along with any variants that use them. Any new values listed will be added to the product.  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductRequestAttributesInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductRequestAttributesInner = {
+    name,
+    values,
+};
+```
+
+[[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/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/product-catalog",
-  "version": "1.93.1",
+  "version": "1.95.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {