@teemill/product-catalog 1.94.0 → 1.95.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.
@@ -78,6 +78,9 @@ docs/ProductAnalytics.md
78
78
  docs/ProductAnalyticsApi.md
79
79
  docs/ProductAnalyticsResponse.md
80
80
  docs/ProductApplicationSetsInner.md
81
+ docs/ProductAttribute.md
82
+ docs/ProductAttributeValue.md
83
+ docs/ProductAttributeValue1.md
81
84
  docs/ProductBundleItemsInner.md
82
85
  docs/ProductCreatorsApi.md
83
86
  docs/ProductGfnProduct.md
@@ -106,6 +109,7 @@ docs/UpdateApplicationSetRequest.md
106
109
  docs/UpdateApplicationSetRequestRecordsInner.md
107
110
  docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md
108
111
  docs/UpdateProductRequest.md
112
+ docs/UpdateProductRequestAttributesInner.md
109
113
  docs/UpdateProductRequestBundleItemsInner.md
110
114
  docs/UpdateProductRequestBundleItemsInnerConfig.md
111
115
  docs/UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/product-catalog@1.94.0
1
+ ## @teemill/product-catalog@1.95.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.94.0 --save
39
+ npm install @teemill/product-catalog@1.95.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -154,6 +154,9 @@ Class | Method | HTTP request | Description
154
154
  - [ProductAnalytics](docs/ProductAnalytics.md)
155
155
  - [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
156
156
  - [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
157
+ - [ProductAttribute](docs/ProductAttribute.md)
158
+ - [ProductAttributeValue](docs/ProductAttributeValue.md)
159
+ - [ProductAttributeValue1](docs/ProductAttributeValue1.md)
157
160
  - [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
158
161
  - [ProductGfnProduct](docs/ProductGfnProduct.md)
159
162
  - [ProductStaticCollectionsInner](docs/ProductStaticCollectionsInner.md)
@@ -179,6 +182,7 @@ Class | Method | HTTP request | Description
179
182
  - [UpdateApplicationSetRequestRecordsInner](docs/UpdateApplicationSetRequestRecordsInner.md)
180
183
  - [UpdateApplicationSetRequestRecordsInnerAttributesInner](docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md)
181
184
  - [UpdateProductRequest](docs/UpdateProductRequest.md)
185
+ - [UpdateProductRequestAttributesInner](docs/UpdateProductRequestAttributesInner.md)
182
186
  - [UpdateProductRequestBundleItemsInner](docs/UpdateProductRequestBundleItemsInner.md)
183
187
  - [UpdateProductRequestBundleItemsInnerConfig](docs/UpdateProductRequestBundleItemsInnerConfig.md)
184
188
  - [UpdateProductRequestBundleItemsInnerConfigValidOptionsInner](docs/UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.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.94.0
7
+ * The version of the OpenAPI document: 1.95.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -463,18 +463,21 @@ export interface ApplicationTechnologyIntegrationProduct {
463
463
  */
464
464
  'ref'?: string;
465
465
  }
466
+ /**
467
+ * An attribute associated to a variant such as Colour and Size.
468
+ */
466
469
  export interface Attribute {
467
470
  /**
468
- * Attribute name
471
+ * Variant attribute name
469
472
  */
470
473
  'name': string;
471
474
  /**
472
- * Attribute value
475
+ * Variant attribute value
473
476
  */
474
477
  'value': string;
475
478
  'thumbnail'?: AttributeThumbnail;
476
479
  /**
477
- * Attribute tags
480
+ * Variant attribute tags
478
481
  */
479
482
  'tags'?: Array<string>;
480
483
  }
@@ -1305,6 +1308,10 @@ export interface Product {
1305
1308
  'targetSearchPhraseData'?: TargetSearchPhraseData;
1306
1309
  'tags'?: Array<string>;
1307
1310
  'internalTags'?: Array<string>;
1311
+ /**
1312
+ * Attributes associated to a product such as product colours and sizes
1313
+ */
1314
+ 'attributes'?: Array<ProductAttribute>;
1308
1315
  'createdAt'?: string;
1309
1316
  'updatedAt'?: string;
1310
1317
  'publishedAt'?: string;
@@ -1458,6 +1465,36 @@ export interface ProductApplicationSetsInner {
1458
1465
  */
1459
1466
  'name'?: string;
1460
1467
  }
1468
+ export interface ProductAttribute {
1469
+ /**
1470
+ * Attribute name, this can only be \'Colour\' or \'Size\' for now
1471
+ */
1472
+ 'name': string;
1473
+ /**
1474
+ * Attribute values
1475
+ */
1476
+ 'values': Array<ProductAttributeValue1>;
1477
+ }
1478
+ export interface ProductAttributeValue {
1479
+ /**
1480
+ * Position of the value when ordered
1481
+ */
1482
+ 'sortOrder': number;
1483
+ /**
1484
+ * The specific size or colour value. This must match the GFN Catalog API exactly.
1485
+ */
1486
+ 'value': string;
1487
+ }
1488
+ export interface ProductAttributeValue1 {
1489
+ /**
1490
+ * Position of the value when ordered
1491
+ */
1492
+ 'sortOrder': number;
1493
+ /**
1494
+ * Product attribute value
1495
+ */
1496
+ 'value': string;
1497
+ }
1461
1498
  export interface ProductBundleItemsInner {
1462
1499
  /**
1463
1500
  * The unique identifier of the bundle product.
@@ -1966,6 +2003,10 @@ export interface UpdateProductRequest {
1966
2003
  * The brand of the product.
1967
2004
  */
1968
2005
  'brand'?: string | null;
2006
+ /**
2007
+ * 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.
2008
+ */
2009
+ 'attributes'?: Array<UpdateProductRequestAttributesInner>;
1969
2010
  'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
1970
2011
  /**
1971
2012
  * 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
@@ -2045,6 +2086,16 @@ export interface UpdateProductRequest {
2045
2086
  */
2046
2087
  'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
2047
2088
  }
2089
+ export interface UpdateProductRequestAttributesInner {
2090
+ /**
2091
+ * Product attribute name, this can only be \'Colour\' or \'Size\' for now
2092
+ */
2093
+ 'name': string;
2094
+ /**
2095
+ * 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.
2096
+ */
2097
+ 'values': Array<ProductAttributeValue>;
2098
+ }
2048
2099
  export interface UpdateProductRequestBundleItemsInner {
2049
2100
  /**
2050
2101
  * The product UUID to include in the bundle
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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
6
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -438,18 +438,21 @@ export interface ApplicationTechnologyIntegrationProduct {
438
438
  */
439
439
  'ref'?: string;
440
440
  }
441
+ /**
442
+ * An attribute associated to a variant such as Colour and Size.
443
+ */
441
444
  export interface Attribute {
442
445
  /**
443
- * Attribute name
446
+ * Variant attribute name
444
447
  */
445
448
  'name': string;
446
449
  /**
447
- * Attribute value
450
+ * Variant attribute value
448
451
  */
449
452
  'value': string;
450
453
  'thumbnail'?: AttributeThumbnail;
451
454
  /**
452
- * Attribute tags
455
+ * Variant attribute tags
453
456
  */
454
457
  'tags'?: Array<string>;
455
458
  }
@@ -1259,6 +1262,10 @@ export interface Product {
1259
1262
  'targetSearchPhraseData'?: TargetSearchPhraseData;
1260
1263
  'tags'?: Array<string>;
1261
1264
  'internalTags'?: Array<string>;
1265
+ /**
1266
+ * Attributes associated to a product such as product colours and sizes
1267
+ */
1268
+ 'attributes'?: Array<ProductAttribute>;
1262
1269
  'createdAt'?: string;
1263
1270
  'updatedAt'?: string;
1264
1271
  'publishedAt'?: string;
@@ -1412,6 +1419,36 @@ export interface ProductApplicationSetsInner {
1412
1419
  */
1413
1420
  'name'?: string;
1414
1421
  }
1422
+ export interface ProductAttribute {
1423
+ /**
1424
+ * Attribute name, this can only be \'Colour\' or \'Size\' for now
1425
+ */
1426
+ 'name': string;
1427
+ /**
1428
+ * Attribute values
1429
+ */
1430
+ 'values': Array<ProductAttributeValue1>;
1431
+ }
1432
+ export interface ProductAttributeValue {
1433
+ /**
1434
+ * Position of the value when ordered
1435
+ */
1436
+ 'sortOrder': number;
1437
+ /**
1438
+ * The specific size or colour value. This must match the GFN Catalog API exactly.
1439
+ */
1440
+ 'value': string;
1441
+ }
1442
+ export interface ProductAttributeValue1 {
1443
+ /**
1444
+ * Position of the value when ordered
1445
+ */
1446
+ 'sortOrder': number;
1447
+ /**
1448
+ * Product attribute value
1449
+ */
1450
+ 'value': string;
1451
+ }
1415
1452
  export interface ProductBundleItemsInner {
1416
1453
  /**
1417
1454
  * The unique identifier of the bundle product.
@@ -1904,6 +1941,10 @@ export interface UpdateProductRequest {
1904
1941
  * The brand of the product.
1905
1942
  */
1906
1943
  'brand'?: string | null;
1944
+ /**
1945
+ * 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.
1946
+ */
1947
+ 'attributes'?: Array<UpdateProductRequestAttributesInner>;
1907
1948
  'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
1908
1949
  /**
1909
1950
  * 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
@@ -1983,6 +2024,16 @@ export interface UpdateProductRequest {
1983
2024
  */
1984
2025
  'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
1985
2026
  }
2027
+ export interface UpdateProductRequestAttributesInner {
2028
+ /**
2029
+ * Product attribute name, this can only be \'Colour\' or \'Size\' for now
2030
+ */
2031
+ 'name': string;
2032
+ /**
2033
+ * 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.
2034
+ */
2035
+ 'values': Array<ProductAttributeValue>;
2036
+ }
1986
2037
  export interface UpdateProductRequestBundleItemsInner {
1987
2038
  /**
1988
2039
  * The product UUID to include in the bundle
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.94.0
8
+ * The version of the OpenAPI document: 1.95.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
8
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
8
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -438,18 +438,21 @@ export interface ApplicationTechnologyIntegrationProduct {
438
438
  */
439
439
  'ref'?: string;
440
440
  }
441
+ /**
442
+ * An attribute associated to a variant such as Colour and Size.
443
+ */
441
444
  export interface Attribute {
442
445
  /**
443
- * Attribute name
446
+ * Variant attribute name
444
447
  */
445
448
  'name': string;
446
449
  /**
447
- * Attribute value
450
+ * Variant attribute value
448
451
  */
449
452
  'value': string;
450
453
  'thumbnail'?: AttributeThumbnail;
451
454
  /**
452
- * Attribute tags
455
+ * Variant attribute tags
453
456
  */
454
457
  'tags'?: Array<string>;
455
458
  }
@@ -1259,6 +1262,10 @@ export interface Product {
1259
1262
  'targetSearchPhraseData'?: TargetSearchPhraseData;
1260
1263
  'tags'?: Array<string>;
1261
1264
  'internalTags'?: Array<string>;
1265
+ /**
1266
+ * Attributes associated to a product such as product colours and sizes
1267
+ */
1268
+ 'attributes'?: Array<ProductAttribute>;
1262
1269
  'createdAt'?: string;
1263
1270
  'updatedAt'?: string;
1264
1271
  'publishedAt'?: string;
@@ -1412,6 +1419,36 @@ export interface ProductApplicationSetsInner {
1412
1419
  */
1413
1420
  'name'?: string;
1414
1421
  }
1422
+ export interface ProductAttribute {
1423
+ /**
1424
+ * Attribute name, this can only be \'Colour\' or \'Size\' for now
1425
+ */
1426
+ 'name': string;
1427
+ /**
1428
+ * Attribute values
1429
+ */
1430
+ 'values': Array<ProductAttributeValue1>;
1431
+ }
1432
+ export interface ProductAttributeValue {
1433
+ /**
1434
+ * Position of the value when ordered
1435
+ */
1436
+ 'sortOrder': number;
1437
+ /**
1438
+ * The specific size or colour value. This must match the GFN Catalog API exactly.
1439
+ */
1440
+ 'value': string;
1441
+ }
1442
+ export interface ProductAttributeValue1 {
1443
+ /**
1444
+ * Position of the value when ordered
1445
+ */
1446
+ 'sortOrder': number;
1447
+ /**
1448
+ * Product attribute value
1449
+ */
1450
+ 'value': string;
1451
+ }
1415
1452
  export interface ProductBundleItemsInner {
1416
1453
  /**
1417
1454
  * The unique identifier of the bundle product.
@@ -1904,6 +1941,10 @@ export interface UpdateProductRequest {
1904
1941
  * The brand of the product.
1905
1942
  */
1906
1943
  'brand'?: string | null;
1944
+ /**
1945
+ * 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.
1946
+ */
1947
+ 'attributes'?: Array<UpdateProductRequestAttributesInner>;
1907
1948
  'seoMetadata'?: UpdateProductsRequestProductsInnerSeoMetadata;
1908
1949
  /**
1909
1950
  * 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
@@ -1983,6 +2024,16 @@ export interface UpdateProductRequest {
1983
2024
  */
1984
2025
  'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
1985
2026
  }
2027
+ export interface UpdateProductRequestAttributesInner {
2028
+ /**
2029
+ * Product attribute name, this can only be \'Colour\' or \'Size\' for now
2030
+ */
2031
+ 'name': string;
2032
+ /**
2033
+ * 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.
2034
+ */
2035
+ 'values': Array<ProductAttributeValue>;
2036
+ }
1986
2037
  export interface UpdateProductRequestBundleItemsInner {
1987
2038
  /**
1988
2039
  * The product UUID to include in the bundle
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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
6
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0
5
+ * The version of the OpenAPI document: 1.95.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.94.0
8
+ * The version of the OpenAPI document: 1.95.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/Attribute.md CHANGED
@@ -1,14 +1,15 @@
1
1
  # Attribute
2
2
 
3
+ An attribute associated to a variant such as Colour and Size.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **name** | **string** | Attribute name | [default to undefined]
9
- **value** | **string** | Attribute value | [default to undefined]
9
+ **name** | **string** | Variant attribute name | [default to undefined]
10
+ **value** | **string** | Variant attribute value | [default to undefined]
10
11
  **thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) | | [optional] [default to undefined]
11
- **tags** | **Array&lt;string&gt;** | Attribute tags | [optional] [default to undefined]
12
+ **tags** | **Array&lt;string&gt;** | Variant attribute tags | [optional] [default to undefined]
12
13
 
13
14
  ## Example
14
15
 
package/docs/Product.md CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) | | [optional] [default to undefined]
18
18
  **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
19
19
  **internalTags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
20
+ **attributes** | [**Array&lt;ProductAttribute&gt;**](ProductAttribute.md) | Attributes associated to a product such as product colours and sizes | [optional] [default to undefined]
20
21
  **createdAt** | **string** | | [optional] [default to undefined]
21
22
  **updatedAt** | **string** | | [optional] [default to undefined]
22
23
  **publishedAt** | **string** | | [optional] [default to undefined]
@@ -66,6 +67,7 @@ const instance: Product = {
66
67
  targetSearchPhraseData,
67
68
  tags,
68
69
  internalTags,
70
+ attributes,
69
71
  createdAt,
70
72
  updatedAt,
71
73
  publishedAt,
@@ -0,0 +1,22 @@
1
+ # ProductAttribute
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | Attribute name, this can only be \&#39;Colour\&#39; or \&#39;Size\&#39; for now | [default to undefined]
9
+ **values** | [**Array&lt;ProductAttributeValue1&gt;**](ProductAttributeValue1.md) | Attribute values | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ProductAttribute } from '@teemill/product-catalog';
15
+
16
+ const instance: ProductAttribute = {
17
+ name,
18
+ values,
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)
@@ -0,0 +1,22 @@
1
+ # ProductAttributeValue
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **sortOrder** | **number** | Position of the value when ordered | [default to undefined]
9
+ **value** | **string** | The specific size or colour value. This must match the GFN Catalog API exactly. | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ProductAttributeValue } from '@teemill/product-catalog';
15
+
16
+ const instance: ProductAttributeValue = {
17
+ sortOrder,
18
+ value,
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)
@@ -0,0 +1,22 @@
1
+ # ProductAttributeValue1
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **sortOrder** | **number** | Position of the value when ordered | [default to undefined]
9
+ **value** | **string** | Product attribute value | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ProductAttributeValue1 } from '@teemill/product-catalog';
15
+
16
+ const instance: ProductAttributeValue1 = {
17
+ sortOrder,
18
+ value,
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)
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
12
12
  **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
13
13
  **brand** | **string** | The brand of the product. | [optional] [default to undefined]
14
+ **attributes** | [**Array&lt;UpdateProductRequestAttributesInner&gt;**](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]
14
15
  **seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) | | [optional] [default to undefined]
15
16
  **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]
16
17
  **targetSearchPhraseSynonyms** | **Array&lt;string&gt;** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
@@ -45,6 +46,7 @@ const instance: UpdateProductRequest = {
45
46
  enabled,
46
47
  slug,
47
48
  brand,
49
+ attributes,
48
50
  seoMetadata,
49
51
  targetSearchPhrase,
50
52
  targetSearchPhraseSynonyms,
@@ -0,0 +1,22 @@
1
+ # UpdateProductRequestAttributesInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | Product attribute name, this can only be \&#39;Colour\&#39; or \&#39;Size\&#39; for now | [default to undefined]
9
+ **values** | [**Array&lt;ProductAttributeValue&gt;**](ProductAttributeValue.md) | List of product attribute values, each including a sort order and an option value (e.g., \&#39;Black\&#39;, \&#39;Blue\&#39;, \&#39;XL\&#39;, \&#39;XXL\&#39;). 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]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UpdateProductRequestAttributesInner } from '@teemill/product-catalog';
15
+
16
+ const instance: UpdateProductRequestAttributesInner = {
17
+ name,
18
+ values,
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)
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.94.0
7
+ * The version of the OpenAPI document: 1.95.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.94.0",
3
+ "version": "1.95.0",
4
4
  "description": "OpenAPI client for @teemill/product-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {