@teemill/product-catalog 1.75.0 → 1.77.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.
- package/README.md +8 -2
- package/api.ts +131 -5
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +25 -2
- package/dist/api.d.ts +131 -5
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +25 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +131 -5
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +25 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CreateBundleProduct.md +1 -1
- package/docs/{InlineObject.md → CreateBundleProductBundleItemsInner.md} +5 -5
- package/docs/CreateProduct.md +2 -0
- package/docs/CreateProductRequest.md +3 -1
- package/docs/Product.md +1 -1
- package/docs/UpdateProductRequest.md +3 -1
- package/docs/UpdateProductRequestBundleItemsInnerConfig.md +1 -1
- package/docs/{UpdateProductRequestBundleItemsInnerConfigValidOptions.md → UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md} +3 -4
- package/docs/UpdateProductsRequestProductsInner.md +2 -0
- package/docs/UpdateProductsRequestProductsInnerLicense.md +23 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/.openapi-generator/FILES +0 -13
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -23
- package/docs/CreateApplicationPropertiesPosition.md +0 -23
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.77.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.
|
|
39
|
+
npm install @teemill/product-catalog@1.77.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -110,6 +110,7 @@ Class | Method | HTTP request | Description
|
|
|
110
110
|
- [CreateApplicationSetRequestRecordsInner](docs/CreateApplicationSetRequestRecordsInner.md)
|
|
111
111
|
- [CreateApplicationSetRequestRecordsInnerAttributesInner](docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md)
|
|
112
112
|
- [CreateBundleProduct](docs/CreateBundleProduct.md)
|
|
113
|
+
- [CreateBundleProductBundleItemsInner](docs/CreateBundleProductBundleItemsInner.md)
|
|
113
114
|
- [CreateProduct](docs/CreateProduct.md)
|
|
114
115
|
- [CreateProductAdditionalFilesInner](docs/CreateProductAdditionalFilesInner.md)
|
|
115
116
|
- [CreateProductImagesInner](docs/CreateProductImagesInner.md)
|
|
@@ -133,6 +134,7 @@ Class | Method | HTTP request | Description
|
|
|
133
134
|
- [Product](docs/Product.md)
|
|
134
135
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
135
136
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
137
|
+
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
136
138
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
137
139
|
- [ProductsResponse](docs/ProductsResponse.md)
|
|
138
140
|
- [RequiredPrice](docs/RequiredPrice.md)
|
|
@@ -151,10 +153,14 @@ Class | Method | HTTP request | Description
|
|
|
151
153
|
- [UpdateApplicationSetRequestRecordsInner](docs/UpdateApplicationSetRequestRecordsInner.md)
|
|
152
154
|
- [UpdateApplicationSetRequestRecordsInnerAttributesInner](docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md)
|
|
153
155
|
- [UpdateProductRequest](docs/UpdateProductRequest.md)
|
|
156
|
+
- [UpdateProductRequestBundleItemsInner](docs/UpdateProductRequestBundleItemsInner.md)
|
|
157
|
+
- [UpdateProductRequestBundleItemsInnerConfig](docs/UpdateProductRequestBundleItemsInnerConfig.md)
|
|
158
|
+
- [UpdateProductRequestBundleItemsInnerConfigValidOptionsInner](docs/UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md)
|
|
154
159
|
- [UpdateProductRequestIntegrationConnectionsInner](docs/UpdateProductRequestIntegrationConnectionsInner.md)
|
|
155
160
|
- [UpdateProductsRequest](docs/UpdateProductsRequest.md)
|
|
156
161
|
- [UpdateProductsRequestProductsInner](docs/UpdateProductsRequestProductsInner.md)
|
|
157
162
|
- [UpdateProductsRequestProductsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md)
|
|
163
|
+
- [UpdateProductsRequestProductsInnerLicense](docs/UpdateProductsRequestProductsInnerLicense.md)
|
|
158
164
|
- [UpdateProductsRequestProductsInnerSeoMetadata](docs/UpdateProductsRequestProductsInnerSeoMetadata.md)
|
|
159
165
|
- [UpdateProductsRequestProductsInnerVariantsInner](docs/UpdateProductsRequestProductsInnerVariantsInner.md)
|
|
160
166
|
- [UpdateProductsRequestProductsInnerVariantsInnerAttributesInner](docs/UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.77.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -605,11 +605,17 @@ export interface CreateBundleProduct {
|
|
|
605
605
|
/**
|
|
606
606
|
* A list of product uuids to include in this bundle
|
|
607
607
|
*/
|
|
608
|
-
'bundleItems': Array<
|
|
608
|
+
'bundleItems': Array<CreateBundleProductBundleItemsInner>;
|
|
609
609
|
'retailPrice'?: Price;
|
|
610
610
|
'salePrice'?: SalePrice | null;
|
|
611
611
|
'price'?: Price;
|
|
612
612
|
}
|
|
613
|
+
export interface CreateBundleProductBundleItemsInner {
|
|
614
|
+
/**
|
|
615
|
+
* Unique object identifier
|
|
616
|
+
*/
|
|
617
|
+
'id'?: string;
|
|
618
|
+
}
|
|
613
619
|
export interface CreateProduct {
|
|
614
620
|
/**
|
|
615
621
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
@@ -688,6 +694,7 @@ export interface CreateProduct {
|
|
|
688
694
|
* A JSON object that defines the personalization template for the product.
|
|
689
695
|
*/
|
|
690
696
|
'personalizationTemplate'?: string;
|
|
697
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
691
698
|
}
|
|
692
699
|
export interface CreateProductAdditionalFilesInner {
|
|
693
700
|
/**
|
|
@@ -934,7 +941,7 @@ export interface Product {
|
|
|
934
941
|
/**
|
|
935
942
|
* Products in the bundle.
|
|
936
943
|
*/
|
|
937
|
-
'bundleItems'?: Array<
|
|
944
|
+
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
938
945
|
'retailPrice'?: Price;
|
|
939
946
|
'salePrice'?: SalePrice | null;
|
|
940
947
|
/**
|
|
@@ -1008,6 +1015,93 @@ export interface ProductApplicationSetsInner {
|
|
|
1008
1015
|
*/
|
|
1009
1016
|
'name'?: string;
|
|
1010
1017
|
}
|
|
1018
|
+
export interface ProductBundleItemsInner {
|
|
1019
|
+
/**
|
|
1020
|
+
* Unique object identifier
|
|
1021
|
+
*/
|
|
1022
|
+
'id'?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* A reference to the resource location
|
|
1025
|
+
*/
|
|
1026
|
+
'ref'?: string;
|
|
1027
|
+
'title': string;
|
|
1028
|
+
'description': string;
|
|
1029
|
+
'slug'?: string;
|
|
1030
|
+
'brand'?: string;
|
|
1031
|
+
'enabled'?: boolean;
|
|
1032
|
+
'seoMetadata'?: SEOMetadata;
|
|
1033
|
+
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1034
|
+
'tags'?: Array<string>;
|
|
1035
|
+
'internalTags'?: Array<string>;
|
|
1036
|
+
'createdAt'?: string;
|
|
1037
|
+
'updatedAt'?: string;
|
|
1038
|
+
'publishedAt'?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* Images
|
|
1041
|
+
*/
|
|
1042
|
+
'images'?: Array<Image>;
|
|
1043
|
+
/**
|
|
1044
|
+
* Videos
|
|
1045
|
+
*/
|
|
1046
|
+
'videos'?: Array<Video>;
|
|
1047
|
+
/**
|
|
1048
|
+
* Variants
|
|
1049
|
+
*/
|
|
1050
|
+
'variants'?: Array<Variant>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Products in the bundle.
|
|
1053
|
+
*/
|
|
1054
|
+
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
1055
|
+
'retailPrice'?: Price;
|
|
1056
|
+
'salePrice'?: SalePrice | null;
|
|
1057
|
+
/**
|
|
1058
|
+
* Additional files attached to the product.
|
|
1059
|
+
*/
|
|
1060
|
+
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1061
|
+
/**
|
|
1062
|
+
* List of application sets associated with this product
|
|
1063
|
+
*/
|
|
1064
|
+
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1065
|
+
/**
|
|
1066
|
+
* The average review rating. This field is only present if included in the fields query parameter
|
|
1067
|
+
*/
|
|
1068
|
+
'reviewScore'?: number | null;
|
|
1069
|
+
/**
|
|
1070
|
+
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1071
|
+
*/
|
|
1072
|
+
'reviewCount'?: number;
|
|
1073
|
+
'sku'?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* A count of sales. This field is only present if included in the fields query parameter
|
|
1076
|
+
*/
|
|
1077
|
+
'sales'?: number;
|
|
1078
|
+
'salesStart'?: string;
|
|
1079
|
+
'salesEnd'?: string;
|
|
1080
|
+
'includeInDataFeeds'?: boolean;
|
|
1081
|
+
/**
|
|
1082
|
+
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1083
|
+
*/
|
|
1084
|
+
'shopifyId'?: number | null;
|
|
1085
|
+
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1086
|
+
/**
|
|
1087
|
+
* Key/value pairs that can be used to store additional information about the product
|
|
1088
|
+
*/
|
|
1089
|
+
'metafields'?: Array<MetaField>;
|
|
1090
|
+
/**
|
|
1091
|
+
* a JSON string representing the personalization template for the product
|
|
1092
|
+
*/
|
|
1093
|
+
'personalizationTemplate'?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* History of AI optimisations performed on the product
|
|
1096
|
+
*/
|
|
1097
|
+
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1098
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Whether to show a sale badge on the product
|
|
1101
|
+
*/
|
|
1102
|
+
'showSaleBadge'?: boolean;
|
|
1103
|
+
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1104
|
+
}
|
|
1011
1105
|
export interface ProductWarehouseProduct {
|
|
1012
1106
|
/**
|
|
1013
1107
|
* Unique object identifier
|
|
@@ -1315,9 +1409,9 @@ export interface UpdateProductRequest {
|
|
|
1315
1409
|
*/
|
|
1316
1410
|
'variants'?: Array<CreateProductVariant>;
|
|
1317
1411
|
/**
|
|
1318
|
-
* A list of
|
|
1412
|
+
* A list of products to be in this bundle. Only valid if the product is already a bundle.
|
|
1319
1413
|
*/
|
|
1320
|
-
'bundleItems'?: Array<
|
|
1414
|
+
'bundleItems'?: Array<UpdateProductRequestBundleItemsInner>;
|
|
1321
1415
|
'retailPrice'?: Price;
|
|
1322
1416
|
'salePrice'?: SalePrice | null;
|
|
1323
1417
|
/**
|
|
@@ -1352,6 +1446,7 @@ export interface UpdateProductRequest {
|
|
|
1352
1446
|
* A JSON object that defines the personalization template for the product.
|
|
1353
1447
|
*/
|
|
1354
1448
|
'personalizationTemplate'?: string;
|
|
1449
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
1355
1450
|
/**
|
|
1356
1451
|
* Integration connections for the product
|
|
1357
1452
|
*/
|
|
@@ -1361,6 +1456,23 @@ export interface UpdateProductRequest {
|
|
|
1361
1456
|
*/
|
|
1362
1457
|
'showSaleBadge'?: boolean;
|
|
1363
1458
|
}
|
|
1459
|
+
export interface UpdateProductRequestBundleItemsInner {
|
|
1460
|
+
/**
|
|
1461
|
+
* Unique object identifier
|
|
1462
|
+
*/
|
|
1463
|
+
'id'?: string;
|
|
1464
|
+
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1465
|
+
}
|
|
1466
|
+
export interface UpdateProductRequestBundleItemsInnerConfig {
|
|
1467
|
+
/**
|
|
1468
|
+
* The valid options for the product in the bundle. This can be used to filter options that are available on the product but shouldn\'t be available when sold as part of a bundle. If none are provided, all options are considered to be valid.
|
|
1469
|
+
*/
|
|
1470
|
+
'validOptions'?: Array<UpdateProductRequestBundleItemsInnerConfigValidOptionsInner>;
|
|
1471
|
+
}
|
|
1472
|
+
export interface UpdateProductRequestBundleItemsInnerConfigValidOptionsInner {
|
|
1473
|
+
'name': string;
|
|
1474
|
+
'values': Array<string>;
|
|
1475
|
+
}
|
|
1364
1476
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
1365
1477
|
/**
|
|
1366
1478
|
* Code identifying the integration
|
|
@@ -1425,6 +1537,7 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
1425
1537
|
* Whether to show a sale badge on the product
|
|
1426
1538
|
*/
|
|
1427
1539
|
'showSaleBadge'?: boolean;
|
|
1540
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
1428
1541
|
}
|
|
1429
1542
|
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
1430
1543
|
'integrationCode': string;
|
|
@@ -1433,6 +1546,19 @@ export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
|
1433
1546
|
*/
|
|
1434
1547
|
'foreignKey': string;
|
|
1435
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* This field should be used when a product requires a valid license to manufacture, sell, or distribute — for example, officially licensed characters, brands, or artwork.
|
|
1551
|
+
*/
|
|
1552
|
+
export interface UpdateProductsRequestProductsInnerLicense {
|
|
1553
|
+
/**
|
|
1554
|
+
* The ID of the license
|
|
1555
|
+
*/
|
|
1556
|
+
'id': string;
|
|
1557
|
+
/**
|
|
1558
|
+
* The date and time the license will expire
|
|
1559
|
+
*/
|
|
1560
|
+
'expiresAt': string;
|
|
1561
|
+
}
|
|
1436
1562
|
export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
1437
1563
|
/**
|
|
1438
1564
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.77.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 API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.77.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
2
|
/**
|
|
4
3
|
* Product Catalog API
|
|
5
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 warehouse product, plus listing information such as title, description and tags.
|
|
6
5
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.77.0
|
|
8
7
|
*
|
|
9
8
|
*
|
|
10
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,12 +11,24 @@
|
|
|
12
11
|
* Do not edit the class manually.
|
|
13
12
|
*/
|
|
14
13
|
|
|
14
|
+
interface AWSv4Configuration {
|
|
15
|
+
options?: {
|
|
16
|
+
region?: string
|
|
17
|
+
service?: string
|
|
18
|
+
}
|
|
19
|
+
credentials?: {
|
|
20
|
+
accessKeyId?: string
|
|
21
|
+
secretAccessKey?: string,
|
|
22
|
+
sessionToken?: string
|
|
23
|
+
}
|
|
24
|
+
}
|
|
15
25
|
|
|
16
26
|
export interface ConfigurationParameters {
|
|
17
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
18
28
|
username?: string;
|
|
19
29
|
password?: string;
|
|
20
30
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
21
32
|
basePath?: string;
|
|
22
33
|
serverIndex?: number;
|
|
23
34
|
baseOptions?: any;
|
|
@@ -44,6 +55,17 @@ export class Configuration {
|
|
|
44
55
|
* @param scopes oauth2 scope
|
|
45
56
|
*/
|
|
46
57
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
+
/**
|
|
59
|
+
* parameter for aws4 signature security
|
|
60
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
+
* @param {string} options.region - aws region
|
|
62
|
+
* @param {string} options.service - name of the service.
|
|
63
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
+
* @memberof Configuration
|
|
67
|
+
*/
|
|
68
|
+
awsv4?: AWSv4Configuration;
|
|
47
69
|
/**
|
|
48
70
|
* override base path
|
|
49
71
|
*/
|
|
@@ -70,6 +92,7 @@ export class Configuration {
|
|
|
70
92
|
this.username = param.username;
|
|
71
93
|
this.password = param.password;
|
|
72
94
|
this.accessToken = param.accessToken;
|
|
95
|
+
this.awsv4 = param.awsv4;
|
|
73
96
|
this.basePath = param.basePath;
|
|
74
97
|
this.serverIndex = param.serverIndex;
|
|
75
98
|
this.baseOptions = {
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.77.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -572,11 +572,17 @@ export interface CreateBundleProduct {
|
|
|
572
572
|
/**
|
|
573
573
|
* A list of product uuids to include in this bundle
|
|
574
574
|
*/
|
|
575
|
-
'bundleItems': Array<
|
|
575
|
+
'bundleItems': Array<CreateBundleProductBundleItemsInner>;
|
|
576
576
|
'retailPrice'?: Price;
|
|
577
577
|
'salePrice'?: SalePrice | null;
|
|
578
578
|
'price'?: Price;
|
|
579
579
|
}
|
|
580
|
+
export interface CreateBundleProductBundleItemsInner {
|
|
581
|
+
/**
|
|
582
|
+
* Unique object identifier
|
|
583
|
+
*/
|
|
584
|
+
'id'?: string;
|
|
585
|
+
}
|
|
580
586
|
export interface CreateProduct {
|
|
581
587
|
/**
|
|
582
588
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
@@ -655,6 +661,7 @@ export interface CreateProduct {
|
|
|
655
661
|
* A JSON object that defines the personalization template for the product.
|
|
656
662
|
*/
|
|
657
663
|
'personalizationTemplate'?: string;
|
|
664
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
658
665
|
}
|
|
659
666
|
export interface CreateProductAdditionalFilesInner {
|
|
660
667
|
/**
|
|
@@ -897,7 +904,7 @@ export interface Product {
|
|
|
897
904
|
/**
|
|
898
905
|
* Products in the bundle.
|
|
899
906
|
*/
|
|
900
|
-
'bundleItems'?: Array<
|
|
907
|
+
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
901
908
|
'retailPrice'?: Price;
|
|
902
909
|
'salePrice'?: SalePrice | null;
|
|
903
910
|
/**
|
|
@@ -971,6 +978,93 @@ export interface ProductApplicationSetsInner {
|
|
|
971
978
|
*/
|
|
972
979
|
'name'?: string;
|
|
973
980
|
}
|
|
981
|
+
export interface ProductBundleItemsInner {
|
|
982
|
+
/**
|
|
983
|
+
* Unique object identifier
|
|
984
|
+
*/
|
|
985
|
+
'id'?: string;
|
|
986
|
+
/**
|
|
987
|
+
* A reference to the resource location
|
|
988
|
+
*/
|
|
989
|
+
'ref'?: string;
|
|
990
|
+
'title': string;
|
|
991
|
+
'description': string;
|
|
992
|
+
'slug'?: string;
|
|
993
|
+
'brand'?: string;
|
|
994
|
+
'enabled'?: boolean;
|
|
995
|
+
'seoMetadata'?: SEOMetadata;
|
|
996
|
+
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
997
|
+
'tags'?: Array<string>;
|
|
998
|
+
'internalTags'?: Array<string>;
|
|
999
|
+
'createdAt'?: string;
|
|
1000
|
+
'updatedAt'?: string;
|
|
1001
|
+
'publishedAt'?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* Images
|
|
1004
|
+
*/
|
|
1005
|
+
'images'?: Array<Image>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Videos
|
|
1008
|
+
*/
|
|
1009
|
+
'videos'?: Array<Video>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Variants
|
|
1012
|
+
*/
|
|
1013
|
+
'variants'?: Array<Variant>;
|
|
1014
|
+
/**
|
|
1015
|
+
* Products in the bundle.
|
|
1016
|
+
*/
|
|
1017
|
+
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
1018
|
+
'retailPrice'?: Price;
|
|
1019
|
+
'salePrice'?: SalePrice | null;
|
|
1020
|
+
/**
|
|
1021
|
+
* Additional files attached to the product.
|
|
1022
|
+
*/
|
|
1023
|
+
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1024
|
+
/**
|
|
1025
|
+
* List of application sets associated with this product
|
|
1026
|
+
*/
|
|
1027
|
+
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1028
|
+
/**
|
|
1029
|
+
* The average review rating. This field is only present if included in the fields query parameter
|
|
1030
|
+
*/
|
|
1031
|
+
'reviewScore'?: number | null;
|
|
1032
|
+
/**
|
|
1033
|
+
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1034
|
+
*/
|
|
1035
|
+
'reviewCount'?: number;
|
|
1036
|
+
'sku'?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* A count of sales. This field is only present if included in the fields query parameter
|
|
1039
|
+
*/
|
|
1040
|
+
'sales'?: number;
|
|
1041
|
+
'salesStart'?: string;
|
|
1042
|
+
'salesEnd'?: string;
|
|
1043
|
+
'includeInDataFeeds'?: boolean;
|
|
1044
|
+
/**
|
|
1045
|
+
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1046
|
+
*/
|
|
1047
|
+
'shopifyId'?: number | null;
|
|
1048
|
+
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1049
|
+
/**
|
|
1050
|
+
* Key/value pairs that can be used to store additional information about the product
|
|
1051
|
+
*/
|
|
1052
|
+
'metafields'?: Array<MetaField>;
|
|
1053
|
+
/**
|
|
1054
|
+
* a JSON string representing the personalization template for the product
|
|
1055
|
+
*/
|
|
1056
|
+
'personalizationTemplate'?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* History of AI optimisations performed on the product
|
|
1059
|
+
*/
|
|
1060
|
+
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1061
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1062
|
+
/**
|
|
1063
|
+
* Whether to show a sale badge on the product
|
|
1064
|
+
*/
|
|
1065
|
+
'showSaleBadge'?: boolean;
|
|
1066
|
+
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1067
|
+
}
|
|
974
1068
|
export interface ProductWarehouseProduct {
|
|
975
1069
|
/**
|
|
976
1070
|
* Unique object identifier
|
|
@@ -1265,9 +1359,9 @@ export interface UpdateProductRequest {
|
|
|
1265
1359
|
*/
|
|
1266
1360
|
'variants'?: Array<CreateProductVariant>;
|
|
1267
1361
|
/**
|
|
1268
|
-
* A list of
|
|
1362
|
+
* A list of products to be in this bundle. Only valid if the product is already a bundle.
|
|
1269
1363
|
*/
|
|
1270
|
-
'bundleItems'?: Array<
|
|
1364
|
+
'bundleItems'?: Array<UpdateProductRequestBundleItemsInner>;
|
|
1271
1365
|
'retailPrice'?: Price;
|
|
1272
1366
|
'salePrice'?: SalePrice | null;
|
|
1273
1367
|
/**
|
|
@@ -1302,6 +1396,7 @@ export interface UpdateProductRequest {
|
|
|
1302
1396
|
* A JSON object that defines the personalization template for the product.
|
|
1303
1397
|
*/
|
|
1304
1398
|
'personalizationTemplate'?: string;
|
|
1399
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
1305
1400
|
/**
|
|
1306
1401
|
* Integration connections for the product
|
|
1307
1402
|
*/
|
|
@@ -1311,6 +1406,23 @@ export interface UpdateProductRequest {
|
|
|
1311
1406
|
*/
|
|
1312
1407
|
'showSaleBadge'?: boolean;
|
|
1313
1408
|
}
|
|
1409
|
+
export interface UpdateProductRequestBundleItemsInner {
|
|
1410
|
+
/**
|
|
1411
|
+
* Unique object identifier
|
|
1412
|
+
*/
|
|
1413
|
+
'id'?: string;
|
|
1414
|
+
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1415
|
+
}
|
|
1416
|
+
export interface UpdateProductRequestBundleItemsInnerConfig {
|
|
1417
|
+
/**
|
|
1418
|
+
* The valid options for the product in the bundle. This can be used to filter options that are available on the product but shouldn\'t be available when sold as part of a bundle. If none are provided, all options are considered to be valid.
|
|
1419
|
+
*/
|
|
1420
|
+
'validOptions'?: Array<UpdateProductRequestBundleItemsInnerConfigValidOptionsInner>;
|
|
1421
|
+
}
|
|
1422
|
+
export interface UpdateProductRequestBundleItemsInnerConfigValidOptionsInner {
|
|
1423
|
+
'name': string;
|
|
1424
|
+
'values': Array<string>;
|
|
1425
|
+
}
|
|
1314
1426
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
1315
1427
|
/**
|
|
1316
1428
|
* Code identifying the integration
|
|
@@ -1375,6 +1487,7 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
1375
1487
|
* Whether to show a sale badge on the product
|
|
1376
1488
|
*/
|
|
1377
1489
|
'showSaleBadge'?: boolean;
|
|
1490
|
+
'license'?: UpdateProductsRequestProductsInnerLicense;
|
|
1378
1491
|
}
|
|
1379
1492
|
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
1380
1493
|
'integrationCode': string;
|
|
@@ -1383,6 +1496,19 @@ export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
|
1383
1496
|
*/
|
|
1384
1497
|
'foreignKey': string;
|
|
1385
1498
|
}
|
|
1499
|
+
/**
|
|
1500
|
+
* This field should be used when a product requires a valid license to manufacture, sell, or distribute — for example, officially licensed characters, brands, or artwork.
|
|
1501
|
+
*/
|
|
1502
|
+
export interface UpdateProductsRequestProductsInnerLicense {
|
|
1503
|
+
/**
|
|
1504
|
+
* The ID of the license
|
|
1505
|
+
*/
|
|
1506
|
+
'id': string;
|
|
1507
|
+
/**
|
|
1508
|
+
* The date and time the license will expire
|
|
1509
|
+
*/
|
|
1510
|
+
'expiresAt': string;
|
|
1511
|
+
}
|
|
1386
1512
|
export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
1387
1513
|
/**
|
|
1388
1514
|
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.77.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 API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.77.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 API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.77.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 API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.77.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 API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.77.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,18 +2,30 @@
|
|
|
2
2
|
* Product Catalog API
|
|
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 warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.77.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
interface AWSv4Configuration {
|
|
13
|
+
options?: {
|
|
14
|
+
region?: string;
|
|
15
|
+
service?: string;
|
|
16
|
+
};
|
|
17
|
+
credentials?: {
|
|
18
|
+
accessKeyId?: string;
|
|
19
|
+
secretAccessKey?: string;
|
|
20
|
+
sessionToken?: string;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
12
23
|
export interface ConfigurationParameters {
|
|
13
24
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
25
|
username?: string;
|
|
15
26
|
password?: string;
|
|
16
27
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
28
|
+
awsv4?: AWSv4Configuration;
|
|
17
29
|
basePath?: string;
|
|
18
30
|
serverIndex?: number;
|
|
19
31
|
baseOptions?: any;
|
|
@@ -39,6 +51,17 @@ export declare class Configuration {
|
|
|
39
51
|
* @param scopes oauth2 scope
|
|
40
52
|
*/
|
|
41
53
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
54
|
+
/**
|
|
55
|
+
* parameter for aws4 signature security
|
|
56
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
57
|
+
* @param {string} options.region - aws region
|
|
58
|
+
* @param {string} options.service - name of the service.
|
|
59
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
60
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
61
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
62
|
+
* @memberof Configuration
|
|
63
|
+
*/
|
|
64
|
+
awsv4?: AWSv4Configuration;
|
|
42
65
|
/**
|
|
43
66
|
* override base path
|
|
44
67
|
*/
|
|
@@ -72,3 +95,4 @@ export declare class Configuration {
|
|
|
72
95
|
*/
|
|
73
96
|
isJsonMime(mime: string): boolean;
|
|
74
97
|
}
|
|
98
|
+
export {};
|
package/dist/configuration.js
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/* tslint:disable */
|
|
3
|
-
/* eslint-disable */
|
|
4
3
|
/**
|
|
5
4
|
* Product Catalog API
|
|
6
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 warehouse product, plus listing information such as title, description and tags.
|
|
7
6
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.77.0
|
|
9
8
|
*
|
|
10
9
|
*
|
|
11
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -21,6 +20,7 @@ class Configuration {
|
|
|
21
20
|
this.username = param.username;
|
|
22
21
|
this.password = param.password;
|
|
23
22
|
this.accessToken = param.accessToken;
|
|
23
|
+
this.awsv4 = param.awsv4;
|
|
24
24
|
this.basePath = param.basePath;
|
|
25
25
|
this.serverIndex = param.serverIndex;
|
|
26
26
|
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|