@teemill/product-catalog 1.97.0 → 1.98.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.
Files changed (47) hide show
  1. package/.openapi-generator/FILES +2 -9
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +4 -11
  4. package/api.ts +55 -80
  5. package/base.ts +1 -1
  6. package/common.ts +15 -3
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +58 -82
  9. package/dist/api.js +2 -1
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +1 -1
  12. package/dist/common.d.ts +6 -1
  13. package/dist/common.js +15 -4
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/esm/api.d.ts +58 -82
  17. package/dist/esm/api.js +2 -1
  18. package/dist/esm/base.d.ts +1 -1
  19. package/dist/esm/base.js +1 -1
  20. package/dist/esm/common.d.ts +6 -1
  21. package/dist/esm/common.js +13 -3
  22. package/dist/esm/configuration.d.ts +1 -1
  23. package/dist/esm/configuration.js +1 -1
  24. package/dist/esm/index.d.ts +1 -1
  25. package/dist/esm/index.js +1 -1
  26. package/dist/index.d.ts +1 -1
  27. package/dist/index.js +1 -1
  28. package/docs/ApplicationPropertiesMetadata.md +1 -1
  29. package/docs/ApplicationPropertiesPersonalizationRules.md +4 -0
  30. package/docs/ApplicationPropertiesProperties.md +2 -2
  31. package/docs/ApplicationSetRecord.md +1 -1
  32. package/docs/BundleProduct.md +1 -1
  33. package/docs/CreateApplicationProperties.md +2 -2
  34. package/docs/MarketplaceListing.md +2 -0
  35. package/docs/PersonalizationOptional.md +23 -0
  36. package/docs/Product.md +1 -1
  37. package/docs/ProductAttribute.md +1 -1
  38. package/docs/ProductBundleItemsInner.md +1 -1
  39. package/docs/ProductsApi.md +6 -6
  40. package/docs/TextApplicationProperties.md +2 -0
  41. package/docs/TextApplicationPropertiesMetadata.md +20 -0
  42. package/docs/TextApplicationPropertiesPersonalizationRules.md +7 -1
  43. package/docs/UpdateProductRequest.md +1 -1
  44. package/docs/UpdateProductsRequestProductsInner.md +1 -1
  45. package/docs/Variant.md +1 -1
  46. package/index.ts +1 -1
  47. package/package.json +1 -1
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
14
14
  **fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
15
15
  **color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
16
16
  **rotation** | **number** | The rotation of the text in degrees. | [optional] [default to undefined]
17
+ **metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) | | [optional] [default to undefined]
17
18
  **width** | **number** | Width of the application in pixels | [optional] [default to undefined]
18
19
  **height** | **number** | Height of the application in pixels | [optional] [default to undefined]
19
- **metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) | | [optional] [default to undefined]
20
20
 
21
21
  ## Example
22
22
 
@@ -33,9 +33,9 @@ const instance: CreateApplicationProperties = {
33
33
  fontStyle,
34
34
  color,
35
35
  rotation,
36
+ metadata,
36
37
  width,
37
38
  height,
38
- metadata,
39
39
  };
40
40
  ```
41
41
 
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **metaTitle** | **string** | | [optional] [default to undefined]
14
14
  **metaDescription** | **string** | | [optional] [default to undefined]
15
15
  **price** | **number** | | [optional] [default to undefined]
16
+ **tags** | **Array<string>** | Listing-specific tags for this marketplace. | [optional] [default to undefined]
16
17
  **images** | [**Array<Image>**](Image.md) | | [optional] [default to undefined]
17
18
 
18
19
  ## Example
@@ -28,6 +29,7 @@ const instance: MarketplaceListing = {
28
29
  metaTitle,
29
30
  metaDescription,
30
31
  price,
32
+ tags,
31
33
  images,
32
34
  };
33
35
  ```
@@ -0,0 +1,23 @@
1
+ # PersonalizationOptional
2
+
3
+ When present, this personalisation field is optional — the customer can leave it blank or fill it in for an additional charge.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **hidePlaceholder** | **boolean** | Hides the placeholder design on the product preview image until the customer fills the field. | [optional] [default to false]
10
+ **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]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { PersonalizationOptional } from '@teemill/product-catalog';
16
+
17
+ const instance: PersonalizationOptional = {
18
+ hidePlaceholder,
19
+ optionalPrice,
20
+ };
21
+ ```
22
+
23
+ [[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 CHANGED
@@ -42,7 +42,7 @@ Name | Type | Description | Notes
42
42
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
43
43
  **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
44
44
  **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
45
- **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
45
+ **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
46
46
  **marketplaceListings** | [**Array<MarketplaceListing>**](MarketplaceListing.md) | Marketplace-specific listing data that can override product fields during integration syncs. | [optional] [default to undefined]
47
47
  **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
48
48
  **license** | [**License**](License.md) | | [optional] [default to undefined]
@@ -6,7 +6,7 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **name** | **string** | Attribute name, this can only be \'Colour\' or \'Size\' for now | [default to undefined]
9
- **values** | [**Array<ProductAttributeValue1>**](ProductAttributeValue1.md) | Attribute values | [default to undefined]
9
+ **values** | [**Array<ProductAttributeValue>**](ProductAttributeValue.md) | Attribute values | [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
@@ -39,7 +39,7 @@ Name | Type | Description | Notes
39
39
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
40
40
  **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
41
41
  **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
42
- **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
42
+ **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
43
43
  **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
44
44
  **license** | [**License**](License.md) | | [optional] [default to undefined]
45
45
  **config** | [**UpdateProductRequestBundleItemsInnerConfig**](UpdateProductRequestBundleItemsInnerConfig.md) | | [optional] [default to undefined]
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.podos.io*
18
18
  |[**updateProducts**](#updateproducts) | **PATCH** /v1/catalog/products | Update products|
19
19
 
20
20
  # **autoMerchProducts**
21
- > AutoMerchProducts202Response autoMerchProducts()
21
+ > ExportProducts202Response autoMerchProducts()
22
22
 
23
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
24
 
@@ -53,7 +53,7 @@ const { status, data } = await apiInstance.autoMerchProducts(
53
53
 
54
54
  ### Return type
55
55
 
56
- **AutoMerchProducts202Response**
56
+ **ExportProducts202Response**
57
57
 
58
58
  ### Authorization
59
59
 
@@ -257,7 +257,7 @@ void (empty response body)
257
257
  [[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)
258
258
 
259
259
  # **duplicateProducts**
260
- > DuplicateProducts202Response duplicateProducts()
260
+ > ExportProducts202Response duplicateProducts()
261
261
 
262
262
  Duplicate products by a set of given IDs to a set of given project IDs.
263
263
 
@@ -292,7 +292,7 @@ const { status, data } = await apiInstance.duplicateProducts(
292
292
 
293
293
  ### Return type
294
294
 
295
- **DuplicateProducts202Response**
295
+ **ExportProducts202Response**
296
296
 
297
297
  ### Authorization
298
298
 
@@ -643,7 +643,7 @@ const { status, data } = await apiInstance.listProducts(
643
643
  [[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)
644
644
 
645
645
  # **seoOptimiseProducts**
646
- > SeoOptimiseProducts202Response seoOptimiseProducts()
646
+ > ExportProducts202Response seoOptimiseProducts()
647
647
 
648
648
  AI SEO optimises products by a set of given IDs.
649
649
 
@@ -678,7 +678,7 @@ const { status, data } = await apiInstance.seoOptimiseProducts(
678
678
 
679
679
  ### Return type
680
680
 
681
- **SeoOptimiseProducts202Response**
681
+ **ExportProducts202Response**
682
682
 
683
683
  ### Authorization
684
684
 
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
  **fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
16
16
  **color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
17
17
  **rotation** | **number** | The rotation of the text in degrees. | [optional] [default to undefined]
18
+ **metadata** | [**TextApplicationPropertiesMetadata**](TextApplicationPropertiesMetadata.md) | | [optional] [default to undefined]
18
19
 
19
20
  ## Example
20
21
 
@@ -31,6 +32,7 @@ const instance: TextApplicationProperties = {
31
32
  fontStyle,
32
33
  color,
33
34
  rotation,
35
+ metadata,
34
36
  };
35
37
  ```
36
38
 
@@ -0,0 +1,20 @@
1
+ # TextApplicationPropertiesMetadata
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **personalization** | [**TextApplicationPropertiesPersonalization**](TextApplicationPropertiesPersonalization.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { TextApplicationPropertiesMetadata } from '@teemill/product-catalog';
14
+
15
+ const instance: TextApplicationPropertiesMetadata = {
16
+ personalization,
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)
@@ -5,9 +5,12 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **optional** | [**PersonalizationOptional**](PersonalizationOptional.md) | | [optional] [default to undefined]
8
9
  **maxLength** | **number** | The maximum length of the text, in characters. | [optional] [default to 100]
9
- **profanityFilter** | **boolean** | If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" | [optional] [default to false]
10
+ **profanityFilter** | **boolean** | If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" or \"textarea\" | [optional] [default to false]
10
11
  **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]
12
+ **forceCapitalisation** | **boolean** | If true, all text on this element will be formatted to uppercase. | [optional] [default to false]
13
+ **enableColourPicker** | **boolean** | If true, customers can choose the colour of this element. | [optional] [default to false]
11
14
  **maxValue** | **number** | The maximum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 100]
12
15
  **minValue** | **number** | The minimum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 0]
13
16
  **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]
@@ -18,9 +21,12 @@ Name | Type | Description | Notes
18
21
  import { TextApplicationPropertiesPersonalizationRules } from '@teemill/product-catalog';
19
22
 
20
23
  const instance: TextApplicationPropertiesPersonalizationRules = {
24
+ optional,
21
25
  maxLength,
22
26
  profanityFilter,
23
27
  scaleToFit,
28
+ forceCapitalisation,
29
+ enableColourPicker,
24
30
  maxValue,
25
31
  minValue,
26
32
  pad,
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
30
30
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
31
31
  **personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
32
32
  **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
33
- **integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
33
+ **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
34
34
  **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
35
35
  **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]
36
36
 
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
17
17
  **variants** | [**Array<UpdateProductsRequestProductsInnerVariantsInner>**](UpdateProductsRequestProductsInnerVariantsInner.md) | List of variants to update. | [optional] [default to undefined]
18
18
  **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]
19
19
  **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]
20
- **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
20
+ **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
21
21
  **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
22
22
  **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]
23
23
  **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
package/docs/Variant.md CHANGED
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
25
25
  **gtin** | **string** | Deprecated. Please use `barcode` instead. | [optional] [default to undefined]
26
26
  **shopifyId** | **number** | For use with the Shopify integration. The Shopify variant ID that this variant is linked to. | [optional] [default to undefined]
27
27
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the variant | [optional] [default to undefined]
28
- **integrationConnections** | [**Array<VariantIntegrationConnectionsInner>**](VariantIntegrationConnectionsInner.md) | | [optional] [default to undefined]
28
+ **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
29
29
  **wholesaleCost** | [**VariantWholesaleCost**](VariantWholesaleCost.md) | | [optional] [default to undefined]
30
30
  **warehouseVariant** | [**VariantWarehouseVariant**](VariantWarehouseVariant.md) | | [optional] [default to undefined]
31
31
  **gfnVariant** | [**VariantGfnVariant**](VariantGfnVariant.md) | | [optional] [default to undefined]
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.97.0
7
+ * The version of the OpenAPI document: 1.98.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.97.0",
3
+ "version": "1.98.0",
4
4
  "description": "OpenAPI client for @teemill/product-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {