@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.
- package/.openapi-generator/FILES +2 -9
- package/.openapi-generator/VERSION +1 -1
- package/README.md +4 -11
- package/api.ts +55 -80
- package/base.ts +1 -1
- package/common.ts +15 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +58 -82
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +6 -1
- package/dist/common.js +15 -4
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +58 -82
- package/dist/esm/api.js +2 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +6 -1
- package/dist/esm/common.js +13 -3
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- 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/ApplicationPropertiesMetadata.md +1 -1
- package/docs/ApplicationPropertiesPersonalizationRules.md +4 -0
- package/docs/ApplicationPropertiesProperties.md +2 -2
- package/docs/ApplicationSetRecord.md +1 -1
- package/docs/BundleProduct.md +1 -1
- package/docs/CreateApplicationProperties.md +2 -2
- package/docs/MarketplaceListing.md +2 -0
- package/docs/PersonalizationOptional.md +23 -0
- package/docs/Product.md +1 -1
- package/docs/ProductAttribute.md +1 -1
- package/docs/ProductBundleItemsInner.md +1 -1
- package/docs/ProductsApi.md +6 -6
- package/docs/TextApplicationProperties.md +2 -0
- package/docs/TextApplicationPropertiesMetadata.md +20 -0
- package/docs/TextApplicationPropertiesPersonalizationRules.md +7 -1
- package/docs/UpdateProductRequest.md +1 -1
- package/docs/UpdateProductsRequestProductsInner.md +1 -1
- package/docs/Variant.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -17,7 +17,6 @@ docs/ApplicationGroupsResponse.md
|
|
|
17
17
|
docs/ApplicationMockup.md
|
|
18
18
|
docs/ApplicationProperties.md
|
|
19
19
|
docs/ApplicationPropertiesMetadata.md
|
|
20
|
-
docs/ApplicationPropertiesMetadataPersonalization.md
|
|
21
20
|
docs/ApplicationPropertiesPersonalization.md
|
|
22
21
|
docs/ApplicationPropertiesPersonalizationRules.md
|
|
23
22
|
docs/ApplicationPropertiesPosition.md
|
|
@@ -34,8 +33,6 @@ docs/ApplicationTechnology.md
|
|
|
34
33
|
docs/ApplicationTechnologyIntegrationProduct.md
|
|
35
34
|
docs/Attribute.md
|
|
36
35
|
docs/AttributeThumbnail.md
|
|
37
|
-
docs/Attributes1Inner.md
|
|
38
|
-
docs/AutoMerchProducts202Response.md
|
|
39
36
|
docs/AutoMerchProductsRequest.md
|
|
40
37
|
docs/BundleProduct.md
|
|
41
38
|
docs/CreateApplication.md
|
|
@@ -59,7 +56,6 @@ docs/CreateProductVariantAttributesInner.md
|
|
|
59
56
|
docs/CreateProductVariantImagesInner.md
|
|
60
57
|
docs/CreateProductVideosInner.md
|
|
61
58
|
docs/DeleteProductsRequest.md
|
|
62
|
-
docs/DuplicateProducts202Response.md
|
|
63
59
|
docs/DuplicateProductsRequest.md
|
|
64
60
|
docs/ExportProducts202Response.md
|
|
65
61
|
docs/Image.md
|
|
@@ -72,6 +68,7 @@ docs/MarketplaceListing.md
|
|
|
72
68
|
docs/MetaField.md
|
|
73
69
|
docs/NamedPrice.md
|
|
74
70
|
docs/OptimisationHistoryItem.md
|
|
71
|
+
docs/PersonalizationOptional.md
|
|
75
72
|
docs/Price.md
|
|
76
73
|
docs/Product.md
|
|
77
74
|
docs/ProductAdditionalFilesInner.md
|
|
@@ -81,7 +78,6 @@ docs/ProductAnalyticsResponse.md
|
|
|
81
78
|
docs/ProductApplicationSetsInner.md
|
|
82
79
|
docs/ProductAttribute.md
|
|
83
80
|
docs/ProductAttributeValue.md
|
|
84
|
-
docs/ProductAttributeValue1.md
|
|
85
81
|
docs/ProductBundleItemsInner.md
|
|
86
82
|
docs/ProductCreatorsApi.md
|
|
87
83
|
docs/ProductGfnProduct.md
|
|
@@ -97,11 +93,11 @@ docs/RequiredPrice.md
|
|
|
97
93
|
docs/SEOMetadata.md
|
|
98
94
|
docs/SEOMetadata1.md
|
|
99
95
|
docs/SalePrice.md
|
|
100
|
-
docs/SeoOptimiseProducts202Response.md
|
|
101
96
|
docs/SeoOptimiseProductsRequest.md
|
|
102
97
|
docs/Stock.md
|
|
103
98
|
docs/TargetSearchPhraseData.md
|
|
104
99
|
docs/TextApplicationProperties.md
|
|
100
|
+
docs/TextApplicationPropertiesMetadata.md
|
|
105
101
|
docs/TextApplicationPropertiesPersonalization.md
|
|
106
102
|
docs/TextApplicationPropertiesPersonalizationRules.md
|
|
107
103
|
docs/TextApplicationPropertiesPosition.md
|
|
@@ -114,11 +110,9 @@ docs/UpdateProductRequestAttributesInner.md
|
|
|
114
110
|
docs/UpdateProductRequestBundleItemsInner.md
|
|
115
111
|
docs/UpdateProductRequestBundleItemsInnerConfig.md
|
|
116
112
|
docs/UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md
|
|
117
|
-
docs/UpdateProductRequestIntegrationConnectionsInner.md
|
|
118
113
|
docs/UpdateProductsRequest.md
|
|
119
114
|
docs/UpdateProductsRequestProductsInner.md
|
|
120
115
|
docs/UpdateProductsRequestProductsInnerCollectionsInner.md
|
|
121
|
-
docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md
|
|
122
116
|
docs/UpdateProductsRequestProductsInnerLicense.md
|
|
123
117
|
docs/UpdateProductsRequestProductsInnerSeoMetadata.md
|
|
124
118
|
docs/UpdateProductsRequestProductsInnerVariantsInner.md
|
|
@@ -131,7 +125,6 @@ docs/UserListCreatorsInner.md
|
|
|
131
125
|
docs/UserListCreatorsInnerAvatar.md
|
|
132
126
|
docs/Variant.md
|
|
133
127
|
docs/VariantGfnVariant.md
|
|
134
|
-
docs/VariantIntegrationConnectionsInner.md
|
|
135
128
|
docs/VariantProduct.md
|
|
136
129
|
docs/VariantWarehouseVariant.md
|
|
137
130
|
docs/VariantWholesaleCost.md
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.23.0
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.98.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.98.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -96,7 +96,6 @@ Class | Method | HTTP request | Description
|
|
|
96
96
|
- [ApplicationMockup](docs/ApplicationMockup.md)
|
|
97
97
|
- [ApplicationProperties](docs/ApplicationProperties.md)
|
|
98
98
|
- [ApplicationPropertiesMetadata](docs/ApplicationPropertiesMetadata.md)
|
|
99
|
-
- [ApplicationPropertiesMetadataPersonalization](docs/ApplicationPropertiesMetadataPersonalization.md)
|
|
100
99
|
- [ApplicationPropertiesPersonalization](docs/ApplicationPropertiesPersonalization.md)
|
|
101
100
|
- [ApplicationPropertiesPersonalizationRules](docs/ApplicationPropertiesPersonalizationRules.md)
|
|
102
101
|
- [ApplicationPropertiesPosition](docs/ApplicationPropertiesPosition.md)
|
|
@@ -111,8 +110,6 @@ Class | Method | HTTP request | Description
|
|
|
111
110
|
- [ApplicationTechnologyIntegrationProduct](docs/ApplicationTechnologyIntegrationProduct.md)
|
|
112
111
|
- [Attribute](docs/Attribute.md)
|
|
113
112
|
- [AttributeThumbnail](docs/AttributeThumbnail.md)
|
|
114
|
-
- [Attributes1Inner](docs/Attributes1Inner.md)
|
|
115
|
-
- [AutoMerchProducts202Response](docs/AutoMerchProducts202Response.md)
|
|
116
113
|
- [AutoMerchProductsRequest](docs/AutoMerchProductsRequest.md)
|
|
117
114
|
- [BundleProduct](docs/BundleProduct.md)
|
|
118
115
|
- [CreateApplication](docs/CreateApplication.md)
|
|
@@ -136,7 +133,6 @@ Class | Method | HTTP request | Description
|
|
|
136
133
|
- [CreateProductVariantImagesInner](docs/CreateProductVariantImagesInner.md)
|
|
137
134
|
- [CreateProductVideosInner](docs/CreateProductVideosInner.md)
|
|
138
135
|
- [DeleteProductsRequest](docs/DeleteProductsRequest.md)
|
|
139
|
-
- [DuplicateProducts202Response](docs/DuplicateProducts202Response.md)
|
|
140
136
|
- [DuplicateProductsRequest](docs/DuplicateProductsRequest.md)
|
|
141
137
|
- [ExportProducts202Response](docs/ExportProducts202Response.md)
|
|
142
138
|
- [Image](docs/Image.md)
|
|
@@ -149,6 +145,7 @@ Class | Method | HTTP request | Description
|
|
|
149
145
|
- [MetaField](docs/MetaField.md)
|
|
150
146
|
- [NamedPrice](docs/NamedPrice.md)
|
|
151
147
|
- [OptimisationHistoryItem](docs/OptimisationHistoryItem.md)
|
|
148
|
+
- [PersonalizationOptional](docs/PersonalizationOptional.md)
|
|
152
149
|
- [Price](docs/Price.md)
|
|
153
150
|
- [Product](docs/Product.md)
|
|
154
151
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
@@ -157,7 +154,6 @@ Class | Method | HTTP request | Description
|
|
|
157
154
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
158
155
|
- [ProductAttribute](docs/ProductAttribute.md)
|
|
159
156
|
- [ProductAttributeValue](docs/ProductAttributeValue.md)
|
|
160
|
-
- [ProductAttributeValue1](docs/ProductAttributeValue1.md)
|
|
161
157
|
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
162
158
|
- [ProductGfnProduct](docs/ProductGfnProduct.md)
|
|
163
159
|
- [ProductStaticCollectionsInner](docs/ProductStaticCollectionsInner.md)
|
|
@@ -170,11 +166,11 @@ Class | Method | HTTP request | Description
|
|
|
170
166
|
- [SEOMetadata](docs/SEOMetadata.md)
|
|
171
167
|
- [SEOMetadata1](docs/SEOMetadata1.md)
|
|
172
168
|
- [SalePrice](docs/SalePrice.md)
|
|
173
|
-
- [SeoOptimiseProducts202Response](docs/SeoOptimiseProducts202Response.md)
|
|
174
169
|
- [SeoOptimiseProductsRequest](docs/SeoOptimiseProductsRequest.md)
|
|
175
170
|
- [Stock](docs/Stock.md)
|
|
176
171
|
- [TargetSearchPhraseData](docs/TargetSearchPhraseData.md)
|
|
177
172
|
- [TextApplicationProperties](docs/TextApplicationProperties.md)
|
|
173
|
+
- [TextApplicationPropertiesMetadata](docs/TextApplicationPropertiesMetadata.md)
|
|
178
174
|
- [TextApplicationPropertiesPersonalization](docs/TextApplicationPropertiesPersonalization.md)
|
|
179
175
|
- [TextApplicationPropertiesPersonalizationRules](docs/TextApplicationPropertiesPersonalizationRules.md)
|
|
180
176
|
- [TextApplicationPropertiesPosition](docs/TextApplicationPropertiesPosition.md)
|
|
@@ -187,11 +183,9 @@ Class | Method | HTTP request | Description
|
|
|
187
183
|
- [UpdateProductRequestBundleItemsInner](docs/UpdateProductRequestBundleItemsInner.md)
|
|
188
184
|
- [UpdateProductRequestBundleItemsInnerConfig](docs/UpdateProductRequestBundleItemsInnerConfig.md)
|
|
189
185
|
- [UpdateProductRequestBundleItemsInnerConfigValidOptionsInner](docs/UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md)
|
|
190
|
-
- [UpdateProductRequestIntegrationConnectionsInner](docs/UpdateProductRequestIntegrationConnectionsInner.md)
|
|
191
186
|
- [UpdateProductsRequest](docs/UpdateProductsRequest.md)
|
|
192
187
|
- [UpdateProductsRequestProductsInner](docs/UpdateProductsRequestProductsInner.md)
|
|
193
188
|
- [UpdateProductsRequestProductsInnerCollectionsInner](docs/UpdateProductsRequestProductsInnerCollectionsInner.md)
|
|
194
|
-
- [UpdateProductsRequestProductsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md)
|
|
195
189
|
- [UpdateProductsRequestProductsInnerLicense](docs/UpdateProductsRequestProductsInnerLicense.md)
|
|
196
190
|
- [UpdateProductsRequestProductsInnerSeoMetadata](docs/UpdateProductsRequestProductsInnerSeoMetadata.md)
|
|
197
191
|
- [UpdateProductsRequestProductsInnerVariantsInner](docs/UpdateProductsRequestProductsInnerVariantsInner.md)
|
|
@@ -204,7 +198,6 @@ Class | Method | HTTP request | Description
|
|
|
204
198
|
- [UserListCreatorsInnerAvatar](docs/UserListCreatorsInnerAvatar.md)
|
|
205
199
|
- [Variant](docs/Variant.md)
|
|
206
200
|
- [VariantGfnVariant](docs/VariantGfnVariant.md)
|
|
207
|
-
- [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
|
|
208
201
|
- [VariantProduct](docs/VariantProduct.md)
|
|
209
202
|
- [VariantWarehouseVariant](docs/VariantWarehouseVariant.md)
|
|
210
203
|
- [VariantWholesaleCost](docs/VariantWholesaleCost.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.
|
|
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).
|
|
@@ -237,13 +237,8 @@ export interface ApplicationProperties {
|
|
|
237
237
|
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
238
238
|
}
|
|
239
239
|
export interface ApplicationPropertiesMetadata {
|
|
240
|
-
'personalization'?:
|
|
240
|
+
'personalization'?: ApplicationPropertiesPersonalization;
|
|
241
241
|
}
|
|
242
|
-
/**
|
|
243
|
-
* @type ApplicationPropertiesMetadataPersonalization
|
|
244
|
-
*/
|
|
245
|
-
export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
|
|
246
|
-
|
|
247
242
|
/**
|
|
248
243
|
* Personalisation configuration for a design application, allowing end-users to customise the design.
|
|
249
244
|
*/
|
|
@@ -255,10 +250,15 @@ export interface ApplicationPropertiesPersonalization {
|
|
|
255
250
|
'rules'?: ApplicationPropertiesPersonalizationRules;
|
|
256
251
|
}
|
|
257
252
|
export interface ApplicationPropertiesPersonalizationRules {
|
|
253
|
+
'optional'?: PersonalizationOptional;
|
|
258
254
|
/**
|
|
259
255
|
* The fit of the image. This determines how an uploaded image will be resized to fit the application.
|
|
260
256
|
*/
|
|
261
257
|
'fit'?: ApplicationPropertiesPersonalizationRulesFitEnum;
|
|
258
|
+
/**
|
|
259
|
+
* If true, customers can use AI artwork tools (redraw, upscale, remove background) on their uploaded image. The platform will be billed for this usage.
|
|
260
|
+
*/
|
|
261
|
+
'showAiArtworkTools'?: boolean;
|
|
262
262
|
}
|
|
263
263
|
|
|
264
264
|
export const ApplicationPropertiesPersonalizationRulesFitEnum = {
|
|
@@ -331,6 +331,7 @@ export interface ApplicationPropertiesProperties {
|
|
|
331
331
|
* The rotation of the text in degrees.
|
|
332
332
|
*/
|
|
333
333
|
'rotation'?: number;
|
|
334
|
+
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
334
335
|
/**
|
|
335
336
|
* Width of the application in pixels
|
|
336
337
|
*/
|
|
@@ -339,7 +340,6 @@ export interface ApplicationPropertiesProperties {
|
|
|
339
340
|
* Height of the application in pixels
|
|
340
341
|
*/
|
|
341
342
|
'height'?: number | null;
|
|
342
|
-
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
343
343
|
}
|
|
344
344
|
|
|
345
345
|
export const ApplicationPropertiesPropertiesFontWeightEnum = {
|
|
@@ -419,7 +419,7 @@ export interface ApplicationSetRecord {
|
|
|
419
419
|
/**
|
|
420
420
|
* Attributes associated to a variant such as Colour and Size.
|
|
421
421
|
*/
|
|
422
|
-
'attributes'?: Array<
|
|
422
|
+
'attributes'?: Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>;
|
|
423
423
|
/**
|
|
424
424
|
* List of applications for this record
|
|
425
425
|
*/
|
|
@@ -497,16 +497,6 @@ export const AttributeThumbnailTypeEnum = {
|
|
|
497
497
|
|
|
498
498
|
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
499
499
|
|
|
500
|
-
export interface Attributes1Inner {
|
|
501
|
-
'name'?: string;
|
|
502
|
-
'value'?: string;
|
|
503
|
-
}
|
|
504
|
-
export interface AutoMerchProducts202Response {
|
|
505
|
-
/**
|
|
506
|
-
* A message describing the auto merchandising status
|
|
507
|
-
*/
|
|
508
|
-
'message'?: string;
|
|
509
|
-
}
|
|
510
500
|
export interface AutoMerchProductsRequest {
|
|
511
501
|
/**
|
|
512
502
|
* A set of product IDs to AI auto merchandise.
|
|
@@ -636,7 +626,7 @@ export interface BundleProduct {
|
|
|
636
626
|
* History of AI optimisations performed on the product
|
|
637
627
|
*/
|
|
638
628
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
639
|
-
'integrationConnections'?: Array<
|
|
629
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
640
630
|
/**
|
|
641
631
|
* Whether to show a sale badge on the product
|
|
642
632
|
*/
|
|
@@ -740,6 +730,7 @@ export interface CreateApplicationProperties {
|
|
|
740
730
|
* The rotation of the text in degrees.
|
|
741
731
|
*/
|
|
742
732
|
'rotation'?: number;
|
|
733
|
+
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
743
734
|
/**
|
|
744
735
|
* Width of the application in pixels
|
|
745
736
|
*/
|
|
@@ -748,7 +739,6 @@ export interface CreateApplicationProperties {
|
|
|
748
739
|
* Height of the application in pixels
|
|
749
740
|
*/
|
|
750
741
|
'height'?: number | null;
|
|
751
|
-
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
752
742
|
}
|
|
753
743
|
|
|
754
744
|
export const CreateApplicationPropertiesFontWeightEnum = {
|
|
@@ -1113,12 +1103,6 @@ export interface CreateProductVideosInner {
|
|
|
1113
1103
|
export interface DeleteProductsRequest {
|
|
1114
1104
|
'products'?: Array<string>;
|
|
1115
1105
|
}
|
|
1116
|
-
export interface DuplicateProducts202Response {
|
|
1117
|
-
/**
|
|
1118
|
-
* A message describing the duplication status
|
|
1119
|
-
*/
|
|
1120
|
-
'message'?: string;
|
|
1121
|
-
}
|
|
1122
1106
|
export interface DuplicateProductsRequest {
|
|
1123
1107
|
/**
|
|
1124
1108
|
* A set of product IDs to duplicate.
|
|
@@ -1242,6 +1226,10 @@ export interface MarketplaceListing {
|
|
|
1242
1226
|
'metaTitle'?: string | null;
|
|
1243
1227
|
'metaDescription'?: string | null;
|
|
1244
1228
|
'price'?: number | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* Listing-specific tags for this marketplace.
|
|
1231
|
+
*/
|
|
1232
|
+
'tags'?: Array<string> | null;
|
|
1245
1233
|
'images'?: Array<Image>;
|
|
1246
1234
|
}
|
|
1247
1235
|
/**
|
|
@@ -1283,6 +1271,19 @@ export interface OptimisationHistoryItem {
|
|
|
1283
1271
|
*/
|
|
1284
1272
|
'createdAt'?: string;
|
|
1285
1273
|
}
|
|
1274
|
+
/**
|
|
1275
|
+
* When present, this personalisation field is optional — the customer can leave it blank or fill it in for an additional charge.
|
|
1276
|
+
*/
|
|
1277
|
+
export interface PersonalizationOptional {
|
|
1278
|
+
/**
|
|
1279
|
+
* Hides the placeholder design on the product preview image until the customer fills the field.
|
|
1280
|
+
*/
|
|
1281
|
+
'hidePlaceholder'?: boolean;
|
|
1282
|
+
/**
|
|
1283
|
+
* Additional price (in the project currency major unit) attributed to the product when the customer fills this optional field.
|
|
1284
|
+
*/
|
|
1285
|
+
'optionalPrice'?: number;
|
|
1286
|
+
}
|
|
1286
1287
|
/**
|
|
1287
1288
|
* Standard price definition that defines the amount and currency.
|
|
1288
1289
|
*/
|
|
@@ -1412,7 +1413,7 @@ export interface Product {
|
|
|
1412
1413
|
* History of AI optimisations performed on the product
|
|
1413
1414
|
*/
|
|
1414
1415
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1415
|
-
'integrationConnections'?: Array<
|
|
1416
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1416
1417
|
/**
|
|
1417
1418
|
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1418
1419
|
*/
|
|
@@ -1496,7 +1497,7 @@ export interface ProductAttribute {
|
|
|
1496
1497
|
/**
|
|
1497
1498
|
* Attribute values
|
|
1498
1499
|
*/
|
|
1499
|
-
'values': Array<
|
|
1500
|
+
'values': Array<ProductAttributeValue>;
|
|
1500
1501
|
}
|
|
1501
1502
|
export interface ProductAttributeValue {
|
|
1502
1503
|
/**
|
|
@@ -1508,16 +1509,6 @@ export interface ProductAttributeValue {
|
|
|
1508
1509
|
*/
|
|
1509
1510
|
'value': string;
|
|
1510
1511
|
}
|
|
1511
|
-
export interface ProductAttributeValue1 {
|
|
1512
|
-
/**
|
|
1513
|
-
* Position of the value when ordered
|
|
1514
|
-
*/
|
|
1515
|
-
'sortOrder': number;
|
|
1516
|
-
/**
|
|
1517
|
-
* Product attribute value
|
|
1518
|
-
*/
|
|
1519
|
-
'value': string;
|
|
1520
|
-
}
|
|
1521
1512
|
export interface ProductBundleItemsInner {
|
|
1522
1513
|
/**
|
|
1523
1514
|
* The unique identifier of the bundle product.
|
|
@@ -1616,7 +1607,7 @@ export interface ProductBundleItemsInner {
|
|
|
1616
1607
|
* History of AI optimisations performed on the product
|
|
1617
1608
|
*/
|
|
1618
1609
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1619
|
-
'integrationConnections'?: Array<
|
|
1610
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1620
1611
|
/**
|
|
1621
1612
|
* Whether to show a sale badge on the product
|
|
1622
1613
|
*/
|
|
@@ -1793,12 +1784,6 @@ export const SalePriceCurrencyCodeEnum = {
|
|
|
1793
1784
|
|
|
1794
1785
|
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1795
1786
|
|
|
1796
|
-
export interface SeoOptimiseProducts202Response {
|
|
1797
|
-
/**
|
|
1798
|
-
* A message describing the optimisation status
|
|
1799
|
-
*/
|
|
1800
|
-
'message'?: string;
|
|
1801
|
-
}
|
|
1802
1787
|
export interface SeoOptimiseProductsRequest {
|
|
1803
1788
|
/**
|
|
1804
1789
|
* A set of product IDs to AI SEO optimise.
|
|
@@ -1869,6 +1854,7 @@ export interface TextApplicationProperties {
|
|
|
1869
1854
|
* The rotation of the text in degrees.
|
|
1870
1855
|
*/
|
|
1871
1856
|
'rotation'?: number;
|
|
1857
|
+
'metadata'?: TextApplicationPropertiesMetadata | null;
|
|
1872
1858
|
}
|
|
1873
1859
|
|
|
1874
1860
|
export const TextApplicationPropertiesFontWeightEnum = {
|
|
@@ -1887,6 +1873,9 @@ export const TextApplicationPropertiesFontStyleEnum = {
|
|
|
1887
1873
|
|
|
1888
1874
|
export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
|
|
1889
1875
|
|
|
1876
|
+
export interface TextApplicationPropertiesMetadata {
|
|
1877
|
+
'personalization'?: TextApplicationPropertiesPersonalization;
|
|
1878
|
+
}
|
|
1890
1879
|
/**
|
|
1891
1880
|
* Personalisation configuration for a text application, allowing end-users to customise the text content.
|
|
1892
1881
|
*/
|
|
@@ -1905,23 +1894,33 @@ export interface TextApplicationPropertiesPersonalization {
|
|
|
1905
1894
|
export const TextApplicationPropertiesPersonalizationTypeEnum = {
|
|
1906
1895
|
Text: 'text',
|
|
1907
1896
|
Number: 'number',
|
|
1897
|
+
Textarea: 'textarea',
|
|
1908
1898
|
} as const;
|
|
1909
1899
|
|
|
1910
1900
|
export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
|
|
1911
1901
|
|
|
1912
1902
|
export interface TextApplicationPropertiesPersonalizationRules {
|
|
1903
|
+
'optional'?: PersonalizationOptional;
|
|
1913
1904
|
/**
|
|
1914
1905
|
* The maximum length of the text, in characters.
|
|
1915
1906
|
*/
|
|
1916
1907
|
'maxLength'?: number;
|
|
1917
1908
|
/**
|
|
1918
|
-
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\"
|
|
1909
|
+
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" or \"textarea\"
|
|
1919
1910
|
*/
|
|
1920
1911
|
'profanityFilter'?: boolean;
|
|
1921
1912
|
/**
|
|
1922
1913
|
* 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.
|
|
1923
1914
|
*/
|
|
1924
1915
|
'scaleToFit'?: boolean;
|
|
1916
|
+
/**
|
|
1917
|
+
* If true, all text on this element will be formatted to uppercase.
|
|
1918
|
+
*/
|
|
1919
|
+
'forceCapitalisation'?: boolean;
|
|
1920
|
+
/**
|
|
1921
|
+
* If true, customers can choose the colour of this element.
|
|
1922
|
+
*/
|
|
1923
|
+
'enableColourPicker'?: boolean;
|
|
1925
1924
|
/**
|
|
1926
1925
|
* The maximum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
1927
1926
|
*/
|
|
@@ -2099,7 +2098,7 @@ export interface UpdateProductRequest {
|
|
|
2099
2098
|
/**
|
|
2100
2099
|
* Integration connections for the product
|
|
2101
2100
|
*/
|
|
2102
|
-
'integrationConnections'?: Array<
|
|
2101
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2103
2102
|
/**
|
|
2104
2103
|
* Whether to show a sale badge on the product
|
|
2105
2104
|
*/
|
|
@@ -2136,16 +2135,6 @@ export interface UpdateProductRequestBundleItemsInnerConfigValidOptionsInner {
|
|
|
2136
2135
|
'name': string;
|
|
2137
2136
|
'values': Array<string>;
|
|
2138
2137
|
}
|
|
2139
|
-
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
2140
|
-
/**
|
|
2141
|
-
* Code identifying the integration
|
|
2142
|
-
*/
|
|
2143
|
-
'integrationCode': string;
|
|
2144
|
-
/**
|
|
2145
|
-
* The value of the identifying property on the foreign product
|
|
2146
|
-
*/
|
|
2147
|
-
'foreignKey': string;
|
|
2148
|
-
}
|
|
2149
2138
|
export interface UpdateProductsRequest {
|
|
2150
2139
|
'products'?: Array<UpdateProductsRequestProductsInner>;
|
|
2151
2140
|
}
|
|
@@ -2195,7 +2184,7 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
2195
2184
|
* 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.
|
|
2196
2185
|
*/
|
|
2197
2186
|
'shopifyId'?: number | null;
|
|
2198
|
-
'integrationConnections'?: Array<
|
|
2187
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2199
2188
|
/**
|
|
2200
2189
|
* Whether to show a sale badge on the product
|
|
2201
2190
|
*/
|
|
@@ -2209,13 +2198,6 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
2209
2198
|
export interface UpdateProductsRequestProductsInnerCollectionsInner {
|
|
2210
2199
|
'id': string;
|
|
2211
2200
|
}
|
|
2212
|
-
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
2213
|
-
'integrationCode': string;
|
|
2214
|
-
/**
|
|
2215
|
-
* The value of the identifying property on the foreign product
|
|
2216
|
-
*/
|
|
2217
|
-
'foreignKey': string;
|
|
2218
|
-
}
|
|
2219
2201
|
/**
|
|
2220
2202
|
* 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.
|
|
2221
2203
|
*/
|
|
@@ -2409,7 +2391,7 @@ export interface Variant {
|
|
|
2409
2391
|
* Key/value pairs that can be used to store additional information about the variant
|
|
2410
2392
|
*/
|
|
2411
2393
|
'metafields'?: Array<MetaField>;
|
|
2412
|
-
'integrationConnections'?: Array<
|
|
2394
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2413
2395
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2414
2396
|
/**
|
|
2415
2397
|
* @deprecated
|
|
@@ -2434,13 +2416,6 @@ export interface VariantGfnVariant {
|
|
|
2434
2416
|
*/
|
|
2435
2417
|
'metafields'?: Array<MetaField>;
|
|
2436
2418
|
}
|
|
2437
|
-
export interface VariantIntegrationConnectionsInner {
|
|
2438
|
-
'integrationCode': string;
|
|
2439
|
-
/**
|
|
2440
|
-
* The value of the identifying property on the foreign variant
|
|
2441
|
-
*/
|
|
2442
|
-
'foreignKey': string;
|
|
2443
|
-
}
|
|
2444
2419
|
export interface VariantProduct {
|
|
2445
2420
|
/**
|
|
2446
2421
|
* Unique object identifier
|
|
@@ -5519,7 +5494,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5519
5494
|
* @param {*} [options] Override http request option.
|
|
5520
5495
|
* @throws {RequiredError}
|
|
5521
5496
|
*/
|
|
5522
|
-
async autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5497
|
+
async autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>> {
|
|
5523
5498
|
const localVarAxiosArgs = await localVarAxiosParamCreator.autoMerchProducts(project, autoMerchProductsRequest, options);
|
|
5524
5499
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5525
5500
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.autoMerchProducts']?.[localVarOperationServerIndex]?.url;
|
|
@@ -5575,7 +5550,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5575
5550
|
* @param {*} [options] Override http request option.
|
|
5576
5551
|
* @throws {RequiredError}
|
|
5577
5552
|
*/
|
|
5578
|
-
async duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5553
|
+
async duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>> {
|
|
5579
5554
|
const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateProducts(project, duplicateProductsRequest, options);
|
|
5580
5555
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5581
5556
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.duplicateProducts']?.[localVarOperationServerIndex]?.url;
|
|
@@ -5675,7 +5650,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5675
5650
|
* @param {*} [options] Override http request option.
|
|
5676
5651
|
* @throws {RequiredError}
|
|
5677
5652
|
*/
|
|
5678
|
-
async seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5653
|
+
async seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>> {
|
|
5679
5654
|
const localVarAxiosArgs = await localVarAxiosParamCreator.seoOptimiseProducts(project, seoOptimiseProductsRequest, options);
|
|
5680
5655
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5681
5656
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.seoOptimiseProducts']?.[localVarOperationServerIndex]?.url;
|
|
@@ -5726,7 +5701,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5726
5701
|
* @param {*} [options] Override http request option.
|
|
5727
5702
|
* @throws {RequiredError}
|
|
5728
5703
|
*/
|
|
5729
|
-
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5704
|
+
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response> {
|
|
5730
5705
|
return localVarFp.autoMerchProducts(requestParameters.project, requestParameters.autoMerchProductsRequest, options).then((request) => request(axios, basePath));
|
|
5731
5706
|
},
|
|
5732
5707
|
/**
|
|
@@ -5766,7 +5741,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5766
5741
|
* @param {*} [options] Override http request option.
|
|
5767
5742
|
* @throws {RequiredError}
|
|
5768
5743
|
*/
|
|
5769
|
-
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5744
|
+
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response> {
|
|
5770
5745
|
return localVarFp.duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(axios, basePath));
|
|
5771
5746
|
},
|
|
5772
5747
|
/**
|
|
@@ -5816,7 +5791,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5816
5791
|
* @param {*} [options] Override http request option.
|
|
5817
5792
|
* @throws {RequiredError}
|
|
5818
5793
|
*/
|
|
5819
|
-
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5794
|
+
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response> {
|
|
5820
5795
|
return localVarFp.seoOptimiseProducts(requestParameters.project, requestParameters.seoOptimiseProductsRequest, options).then((request) => request(axios, basePath));
|
|
5821
5796
|
},
|
|
5822
5797
|
/**
|
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.
|
|
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/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.
|
|
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).
|
|
@@ -86,7 +86,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
|
|
|
86
86
|
function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
|
|
87
87
|
if (parameter == null) return;
|
|
88
88
|
if (typeof parameter === "object") {
|
|
89
|
-
if (Array.isArray(parameter)) {
|
|
89
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
90
90
|
(parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
91
91
|
}
|
|
92
92
|
else {
|
|
@@ -115,6 +115,18 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
|
|
|
115
115
|
url.search = searchParams.toString();
|
|
116
116
|
}
|
|
117
117
|
|
|
118
|
+
/**
|
|
119
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
120
|
+
* @export
|
|
121
|
+
*/
|
|
122
|
+
export const replaceWithSerializableTypeIfNeeded = function (_key: string, value: unknown) {
|
|
123
|
+
if (value instanceof Set) {
|
|
124
|
+
return Array.from(value);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return value;
|
|
128
|
+
}
|
|
129
|
+
|
|
118
130
|
/**
|
|
119
131
|
*
|
|
120
132
|
* @export
|
|
@@ -125,7 +137,7 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
|
|
|
125
137
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
126
138
|
: nonString;
|
|
127
139
|
return needsSerialization
|
|
128
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
140
|
+
? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
|
|
129
141
|
: (value || "");
|
|
130
142
|
}
|
|
131
143
|
|
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.
|
|
6
|
+
* The version of the OpenAPI document: 1.98.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|