@teemill/product-catalog 1.97.1 → 1.99.0

package/docs/CreateApplicationProperties.md

@@ -14,9 +14,9 @@ Name | Type | Description | Notes
 **fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
 **color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
 **rotation** | **number** | The rotation of the text in degrees. | [optional] [default to undefined]
+**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) |  | [optional] [default to undefined]
 **width** | **number** | Width of the application in pixels | [optional] [default to undefined]
 **height** | **number** | Height of the application in pixels | [optional] [default to undefined]
-**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -33,9 +33,9 @@ const instance: CreateApplicationProperties = {
     fontStyle,
     color,
     rotation,
+    metadata,
     width,
     height,
-    metadata,
 };
 ```
 

package/docs/PersonalizationOptional.md

@@ -0,0 +1,23 @@
+# PersonalizationOptional
+
+When present, this personalisation field is optional — the customer can leave it blank or fill it in for an additional charge.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hidePlaceholder** | **boolean** | Hides the placeholder design on the product preview image until the customer fills the field. | [optional] [default to false]
+**optionalPrice** | **number** | Additional price (in the project currency major unit) attributed to the product when the customer fills this optional field. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { PersonalizationOptional } from '@teemill/product-catalog';
+
+const instance: PersonalizationOptional = {
+    hidePlaceholder,
+    optionalPrice,
+};
+```
+
+[[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

@@ -42,7 +42,7 @@ Name | Type | Description | Notes
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
-**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **marketplaceListings** | [**Array<MarketplaceListing>**](MarketplaceListing.md) | Marketplace-specific listing data that can override product fields during integration syncs. | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
 **license** | [**License**](License.md) |  | [optional] [default to undefined]

package/docs/ProductAttribute.md

@@ -6,7 +6,7 @@
 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]
+**values** | [**Array<ProductAttributeValue>**](ProductAttributeValue.md) | Attribute values | [default to undefined]
 
 ## Example
 

package/docs/ProductBundleItemsInner.md

@@ -39,7 +39,7 @@ Name | Type | Description | Notes
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
-**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
 **license** | [**License**](License.md) |  | [optional] [default to undefined]
 **config** | [**UpdateProductRequestBundleItemsInnerConfig**](UpdateProductRequestBundleItemsInnerConfig.md) |  | [optional] [default to undefined]

package/docs/ProductsApi.md

@@ -18,7 +18,7 @@ All URIs are relative to *https://api.podos.io*
 |[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
 
 # **autoMerchProducts**
-> AutoMerchProducts202Response autoMerchProducts()
+> ExportProducts202Response autoMerchProducts()
 
 AI auto merchandises products by a set of given IDs. Runs AI SEO optimisation alongside updates to mockups, colours and other merchandising properties.
 
@@ -53,7 +53,7 @@ const { status, data } = await apiInstance.autoMerchProducts(
 
 ### Return type
 
-**AutoMerchProducts202Response**
+**ExportProducts202Response**
 
 ### Authorization
 
@@ -257,7 +257,7 @@ void (empty response body)
 [[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)
 
 # **duplicateProducts**
-> DuplicateProducts202Response duplicateProducts()
+> ExportProducts202Response duplicateProducts()
 
 Duplicate products by a set of given IDs to a set of given project IDs.
 
@@ -292,7 +292,7 @@ const { status, data } = await apiInstance.duplicateProducts(
 
 ### Return type
 
-**DuplicateProducts202Response**
+**ExportProducts202Response**
 
 ### Authorization
 
@@ -643,7 +643,7 @@ const { status, data } = await apiInstance.listProducts(
 [[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)
 
 # **seoOptimiseProducts**
-> SeoOptimiseProducts202Response seoOptimiseProducts()
+> ExportProducts202Response seoOptimiseProducts()
 
 AI SEO optimises products by a set of given IDs.
 
@@ -678,7 +678,7 @@ const { status, data } = await apiInstance.seoOptimiseProducts(
 
 ### Return type
 
-**SeoOptimiseProducts202Response**
+**ExportProducts202Response**
 
 ### Authorization
 

package/docs/TextApplicationProperties.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
 **color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
 **rotation** | **number** | The rotation of the text in degrees. | [optional] [default to undefined]
+**metadata** | [**TextApplicationPropertiesMetadata**](TextApplicationPropertiesMetadata.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -31,6 +32,7 @@ const instance: TextApplicationProperties = {
     fontStyle,
     color,
     rotation,
+    metadata,
 };
 ```
 

package/docs/TextApplicationPropertiesMetadata.md

@@ -0,0 +1,20 @@
+# TextApplicationPropertiesMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**personalization** | [**TextApplicationPropertiesPersonalization**](TextApplicationPropertiesPersonalization.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TextApplicationPropertiesMetadata } from '@teemill/product-catalog';
+
+const instance: TextApplicationPropertiesMetadata = {
+    personalization,
+};
+```
+
+[[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/TextApplicationPropertiesPersonalizationRules.md

@@ -5,12 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**maxLength** | **number** | The maximum length of the text, in characters. | [optional] [default to 100]
-**profanityFilter** | **boolean** | If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" | [optional] [default to false]
+**optional** | [**PersonalizationOptional**](PersonalizationOptional.md) |  | [optional] [default to undefined]
+**maxLength** | **number** | The maximum length of the text, in characters. Only valid when metadata.personalization.type is \"text\" | [optional] [default to 100]
+**profanityFilter** | **boolean** | If true, suspected profanities will be replaced by asterisks. Only valid when metadata.personalization.type is \"text\" or \"textarea\" | [optional] [default to false]
 **scaleToFit** | **boolean** | If true, and the inputted text is longer than the original text, the font size will be reduced to keep the text within the application\'s original bounds. | [optional] [default to false]
+**forceCapitalisation** | **boolean** | If true, all text on this element will be formatted to uppercase. Only valid when metadata.personalization.type is \"text\" or \"textarea\" | [optional] [default to false]
+**enableColourPicker** | **boolean** | If true, customers can choose the colour of this element. | [optional] [default to false]
+**enums** | **Array<string>** | Pre-defined text options a customer can choose from. Only valid when metadata.personalization.type is \"dropdown\" | [optional] [default to undefined]
 **maxValue** | **number** | The maximum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 100]
 **minValue** | **number** | The minimum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 0]
-**pad** | **number** | If the entered number is below the specified digits it will be padded with 0s. E.g. 7 will become 007 when pad is 3. Only valid when metadata.personalization.type is number | [optional] [default to 0]
+**pad** | **number** | If the entered number is below the specified digits it will be padded with 0s. E.g. 7 will become 007 when pad is 3. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 0]
 
 ## Example
 
@@ -18,9 +22,13 @@ Name | Type | Description | Notes
 import { TextApplicationPropertiesPersonalizationRules } from '@teemill/product-catalog';
 
 const instance: TextApplicationPropertiesPersonalizationRules = {
+    optional,
     maxLength,
     profanityFilter,
     scaleToFit,
+    forceCapitalisation,
+    enableColourPicker,
+    enums,
     maxValue,
     minValue,
     pad,

package/docs/UpdateProductRequest.md

@@ -30,7 +30,7 @@ Name | Type | Description | Notes
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]
-**integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
 **collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 

package/docs/UpdateProductsRequestProductsInner.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **variants** | [**Array<UpdateProductsRequestProductsInnerVariantsInner>**](UpdateProductsRequestProductsInnerVariantsInner.md) | List of variants to update. | [optional] [default to undefined]
 **includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
 **shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
-**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
 **collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]

package/docs/Variant.md

@@ -25,7 +25,7 @@ Name | Type | Description | Notes
 **gtin** | **string** | Deprecated. Please use `barcode` instead. | [optional] [default to undefined]
 **shopifyId** | **number** | For use with the Shopify integration. The Shopify variant ID that this variant is linked to. | [optional] [default to undefined]
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the variant | [optional] [default to undefined]
-**integrationConnections** | [**Array<VariantIntegrationConnectionsInner>**](VariantIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **wholesaleCost** | [**VariantWholesaleCost**](VariantWholesaleCost.md) |  | [optional] [default to undefined]
 **warehouseVariant** | [**VariantWarehouseVariant**](VariantWarehouseVariant.md) |  | [optional] [default to undefined]
 **gfnVariant** | [**VariantGfnVariant**](VariantGfnVariant.md) |  | [optional] [default to undefined]

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.97.1
+ * The version of the OpenAPI document: 1.99.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.97.1",
+  "version": "1.99.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {