@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/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -220,12 +220,8 @@ export interface ApplicationProperties {
|
|
|
220
220
|
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
221
221
|
}
|
|
222
222
|
export interface ApplicationPropertiesMetadata {
|
|
223
|
-
'personalization'?:
|
|
223
|
+
'personalization'?: ApplicationPropertiesPersonalization;
|
|
224
224
|
}
|
|
225
|
-
/**
|
|
226
|
-
* @type ApplicationPropertiesMetadataPersonalization
|
|
227
|
-
*/
|
|
228
|
-
export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
|
|
229
225
|
/**
|
|
230
226
|
* Personalisation configuration for a design application, allowing end-users to customise the design.
|
|
231
227
|
*/
|
|
@@ -237,10 +233,15 @@ export interface ApplicationPropertiesPersonalization {
|
|
|
237
233
|
'rules'?: ApplicationPropertiesPersonalizationRules;
|
|
238
234
|
}
|
|
239
235
|
export interface ApplicationPropertiesPersonalizationRules {
|
|
236
|
+
'optional'?: PersonalizationOptional;
|
|
240
237
|
/**
|
|
241
238
|
* The fit of the image. This determines how an uploaded image will be resized to fit the application.
|
|
242
239
|
*/
|
|
243
240
|
'fit'?: ApplicationPropertiesPersonalizationRulesFitEnum;
|
|
241
|
+
/**
|
|
242
|
+
* If true, customers can use AI artwork tools (redraw, upscale, remove background) on their uploaded image. The platform will be billed for this usage.
|
|
243
|
+
*/
|
|
244
|
+
'showAiArtworkTools'?: boolean;
|
|
244
245
|
}
|
|
245
246
|
export declare const ApplicationPropertiesPersonalizationRulesFitEnum: {
|
|
246
247
|
readonly Contain: "contain";
|
|
@@ -310,6 +311,7 @@ export interface ApplicationPropertiesProperties {
|
|
|
310
311
|
* The rotation of the text in degrees.
|
|
311
312
|
*/
|
|
312
313
|
'rotation'?: number;
|
|
314
|
+
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
313
315
|
/**
|
|
314
316
|
* Width of the application in pixels
|
|
315
317
|
*/
|
|
@@ -318,7 +320,6 @@ export interface ApplicationPropertiesProperties {
|
|
|
318
320
|
* Height of the application in pixels
|
|
319
321
|
*/
|
|
320
322
|
'height'?: number | null;
|
|
321
|
-
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
322
323
|
}
|
|
323
324
|
export declare const ApplicationPropertiesPropertiesFontWeightEnum: {
|
|
324
325
|
readonly Lighter: "lighter";
|
|
@@ -394,7 +395,7 @@ export interface ApplicationSetRecord {
|
|
|
394
395
|
/**
|
|
395
396
|
* Attributes associated to a variant such as Colour and Size.
|
|
396
397
|
*/
|
|
397
|
-
'attributes'?: Array<
|
|
398
|
+
'attributes'?: Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>;
|
|
398
399
|
/**
|
|
399
400
|
* List of applications for this record
|
|
400
401
|
*/
|
|
@@ -469,16 +470,6 @@ export declare const AttributeThumbnailTypeEnum: {
|
|
|
469
470
|
readonly Image: "image";
|
|
470
471
|
};
|
|
471
472
|
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
472
|
-
export interface Attributes1Inner {
|
|
473
|
-
'name'?: string;
|
|
474
|
-
'value'?: string;
|
|
475
|
-
}
|
|
476
|
-
export interface AutoMerchProducts202Response {
|
|
477
|
-
/**
|
|
478
|
-
* A message describing the auto merchandising status
|
|
479
|
-
*/
|
|
480
|
-
'message'?: string;
|
|
481
|
-
}
|
|
482
473
|
export interface AutoMerchProductsRequest {
|
|
483
474
|
/**
|
|
484
475
|
* A set of product IDs to AI auto merchandise.
|
|
@@ -605,7 +596,7 @@ export interface BundleProduct {
|
|
|
605
596
|
* History of AI optimisations performed on the product
|
|
606
597
|
*/
|
|
607
598
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
608
|
-
'integrationConnections'?: Array<
|
|
599
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
609
600
|
/**
|
|
610
601
|
* Whether to show a sale badge on the product
|
|
611
602
|
*/
|
|
@@ -705,6 +696,7 @@ export interface CreateApplicationProperties {
|
|
|
705
696
|
* The rotation of the text in degrees.
|
|
706
697
|
*/
|
|
707
698
|
'rotation'?: number;
|
|
699
|
+
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
708
700
|
/**
|
|
709
701
|
* Width of the application in pixels
|
|
710
702
|
*/
|
|
@@ -713,7 +705,6 @@ export interface CreateApplicationProperties {
|
|
|
713
705
|
* Height of the application in pixels
|
|
714
706
|
*/
|
|
715
707
|
'height'?: number | null;
|
|
716
|
-
'metadata'?: ApplicationPropertiesMetadata | null;
|
|
717
708
|
}
|
|
718
709
|
export declare const CreateApplicationPropertiesFontWeightEnum: {
|
|
719
710
|
readonly Lighter: "lighter";
|
|
@@ -1070,12 +1061,6 @@ export interface CreateProductVideosInner {
|
|
|
1070
1061
|
export interface DeleteProductsRequest {
|
|
1071
1062
|
'products'?: Array<string>;
|
|
1072
1063
|
}
|
|
1073
|
-
export interface DuplicateProducts202Response {
|
|
1074
|
-
/**
|
|
1075
|
-
* A message describing the duplication status
|
|
1076
|
-
*/
|
|
1077
|
-
'message'?: string;
|
|
1078
|
-
}
|
|
1079
1064
|
export interface DuplicateProductsRequest {
|
|
1080
1065
|
/**
|
|
1081
1066
|
* A set of product IDs to duplicate.
|
|
@@ -1199,6 +1184,10 @@ export interface MarketplaceListing {
|
|
|
1199
1184
|
'metaTitle'?: string | null;
|
|
1200
1185
|
'metaDescription'?: string | null;
|
|
1201
1186
|
'price'?: number | null;
|
|
1187
|
+
/**
|
|
1188
|
+
* Listing-specific tags for this marketplace.
|
|
1189
|
+
*/
|
|
1190
|
+
'tags'?: Array<string> | null;
|
|
1202
1191
|
'images'?: Array<Image>;
|
|
1203
1192
|
}
|
|
1204
1193
|
/**
|
|
@@ -1240,6 +1229,19 @@ export interface OptimisationHistoryItem {
|
|
|
1240
1229
|
*/
|
|
1241
1230
|
'createdAt'?: string;
|
|
1242
1231
|
}
|
|
1232
|
+
/**
|
|
1233
|
+
* When present, this personalisation field is optional — the customer can leave it blank or fill it in for an additional charge.
|
|
1234
|
+
*/
|
|
1235
|
+
export interface PersonalizationOptional {
|
|
1236
|
+
/**
|
|
1237
|
+
* Hides the placeholder design on the product preview image until the customer fills the field.
|
|
1238
|
+
*/
|
|
1239
|
+
'hidePlaceholder'?: boolean;
|
|
1240
|
+
/**
|
|
1241
|
+
* Additional price (in the project currency major unit) attributed to the product when the customer fills this optional field.
|
|
1242
|
+
*/
|
|
1243
|
+
'optionalPrice'?: number;
|
|
1244
|
+
}
|
|
1243
1245
|
/**
|
|
1244
1246
|
* Standard price definition that defines the amount and currency.
|
|
1245
1247
|
*/
|
|
@@ -1366,7 +1368,7 @@ export interface Product {
|
|
|
1366
1368
|
* History of AI optimisations performed on the product
|
|
1367
1369
|
*/
|
|
1368
1370
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1369
|
-
'integrationConnections'?: Array<
|
|
1371
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1370
1372
|
/**
|
|
1371
1373
|
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1372
1374
|
*/
|
|
@@ -1450,7 +1452,7 @@ export interface ProductAttribute {
|
|
|
1450
1452
|
/**
|
|
1451
1453
|
* Attribute values
|
|
1452
1454
|
*/
|
|
1453
|
-
'values': Array<
|
|
1455
|
+
'values': Array<ProductAttributeValue>;
|
|
1454
1456
|
}
|
|
1455
1457
|
export interface ProductAttributeValue {
|
|
1456
1458
|
/**
|
|
@@ -1462,16 +1464,6 @@ export interface ProductAttributeValue {
|
|
|
1462
1464
|
*/
|
|
1463
1465
|
'value': string;
|
|
1464
1466
|
}
|
|
1465
|
-
export interface ProductAttributeValue1 {
|
|
1466
|
-
/**
|
|
1467
|
-
* Position of the value when ordered
|
|
1468
|
-
*/
|
|
1469
|
-
'sortOrder': number;
|
|
1470
|
-
/**
|
|
1471
|
-
* Product attribute value
|
|
1472
|
-
*/
|
|
1473
|
-
'value': string;
|
|
1474
|
-
}
|
|
1475
1467
|
export interface ProductBundleItemsInner {
|
|
1476
1468
|
/**
|
|
1477
1469
|
* The unique identifier of the bundle product.
|
|
@@ -1570,7 +1562,7 @@ export interface ProductBundleItemsInner {
|
|
|
1570
1562
|
* History of AI optimisations performed on the product
|
|
1571
1563
|
*/
|
|
1572
1564
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1573
|
-
'integrationConnections'?: Array<
|
|
1565
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
1574
1566
|
/**
|
|
1575
1567
|
* Whether to show a sale badge on the product
|
|
1576
1568
|
*/
|
|
@@ -1738,12 +1730,6 @@ export declare const SalePriceCurrencyCodeEnum: {
|
|
|
1738
1730
|
readonly Gbp: "GBP";
|
|
1739
1731
|
};
|
|
1740
1732
|
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
1741
|
-
export interface SeoOptimiseProducts202Response {
|
|
1742
|
-
/**
|
|
1743
|
-
* A message describing the optimisation status
|
|
1744
|
-
*/
|
|
1745
|
-
'message'?: string;
|
|
1746
|
-
}
|
|
1747
1733
|
export interface SeoOptimiseProductsRequest {
|
|
1748
1734
|
/**
|
|
1749
1735
|
* A set of product IDs to AI SEO optimise.
|
|
@@ -1814,6 +1800,7 @@ export interface TextApplicationProperties {
|
|
|
1814
1800
|
* The rotation of the text in degrees.
|
|
1815
1801
|
*/
|
|
1816
1802
|
'rotation'?: number;
|
|
1803
|
+
'metadata'?: TextApplicationPropertiesMetadata | null;
|
|
1817
1804
|
}
|
|
1818
1805
|
export declare const TextApplicationPropertiesFontWeightEnum: {
|
|
1819
1806
|
readonly Lighter: "lighter";
|
|
@@ -1828,6 +1815,9 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
|
|
|
1828
1815
|
readonly Oblique: "oblique";
|
|
1829
1816
|
};
|
|
1830
1817
|
export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
|
|
1818
|
+
export interface TextApplicationPropertiesMetadata {
|
|
1819
|
+
'personalization'?: TextApplicationPropertiesPersonalization;
|
|
1820
|
+
}
|
|
1831
1821
|
/**
|
|
1832
1822
|
* Personalisation configuration for a text application, allowing end-users to customise the text content.
|
|
1833
1823
|
*/
|
|
@@ -1845,21 +1835,31 @@ export interface TextApplicationPropertiesPersonalization {
|
|
|
1845
1835
|
export declare const TextApplicationPropertiesPersonalizationTypeEnum: {
|
|
1846
1836
|
readonly Text: "text";
|
|
1847
1837
|
readonly Number: "number";
|
|
1838
|
+
readonly Textarea: "textarea";
|
|
1848
1839
|
};
|
|
1849
1840
|
export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
|
|
1850
1841
|
export interface TextApplicationPropertiesPersonalizationRules {
|
|
1842
|
+
'optional'?: PersonalizationOptional;
|
|
1851
1843
|
/**
|
|
1852
1844
|
* The maximum length of the text, in characters.
|
|
1853
1845
|
*/
|
|
1854
1846
|
'maxLength'?: number;
|
|
1855
1847
|
/**
|
|
1856
|
-
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\"
|
|
1848
|
+
* If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" or \"textarea\"
|
|
1857
1849
|
*/
|
|
1858
1850
|
'profanityFilter'?: boolean;
|
|
1859
1851
|
/**
|
|
1860
1852
|
* 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.
|
|
1861
1853
|
*/
|
|
1862
1854
|
'scaleToFit'?: boolean;
|
|
1855
|
+
/**
|
|
1856
|
+
* If true, all text on this element will be formatted to uppercase.
|
|
1857
|
+
*/
|
|
1858
|
+
'forceCapitalisation'?: boolean;
|
|
1859
|
+
/**
|
|
1860
|
+
* If true, customers can choose the colour of this element.
|
|
1861
|
+
*/
|
|
1862
|
+
'enableColourPicker'?: boolean;
|
|
1863
1863
|
/**
|
|
1864
1864
|
* The maximum value of the number. Only valid when metadata.personalization.type is \"number\"
|
|
1865
1865
|
*/
|
|
@@ -2037,7 +2037,7 @@ export interface UpdateProductRequest {
|
|
|
2037
2037
|
/**
|
|
2038
2038
|
* Integration connections for the product
|
|
2039
2039
|
*/
|
|
2040
|
-
'integrationConnections'?: Array<
|
|
2040
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2041
2041
|
/**
|
|
2042
2042
|
* Whether to show a sale badge on the product
|
|
2043
2043
|
*/
|
|
@@ -2074,16 +2074,6 @@ export interface UpdateProductRequestBundleItemsInnerConfigValidOptionsInner {
|
|
|
2074
2074
|
'name': string;
|
|
2075
2075
|
'values': Array<string>;
|
|
2076
2076
|
}
|
|
2077
|
-
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
2078
|
-
/**
|
|
2079
|
-
* Code identifying the integration
|
|
2080
|
-
*/
|
|
2081
|
-
'integrationCode': string;
|
|
2082
|
-
/**
|
|
2083
|
-
* The value of the identifying property on the foreign product
|
|
2084
|
-
*/
|
|
2085
|
-
'foreignKey': string;
|
|
2086
|
-
}
|
|
2087
2077
|
export interface UpdateProductsRequest {
|
|
2088
2078
|
'products'?: Array<UpdateProductsRequestProductsInner>;
|
|
2089
2079
|
}
|
|
@@ -2133,7 +2123,7 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
2133
2123
|
* 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.
|
|
2134
2124
|
*/
|
|
2135
2125
|
'shopifyId'?: number | null;
|
|
2136
|
-
'integrationConnections'?: Array<
|
|
2126
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2137
2127
|
/**
|
|
2138
2128
|
* Whether to show a sale badge on the product
|
|
2139
2129
|
*/
|
|
@@ -2147,13 +2137,6 @@ export interface UpdateProductsRequestProductsInner {
|
|
|
2147
2137
|
export interface UpdateProductsRequestProductsInnerCollectionsInner {
|
|
2148
2138
|
'id': string;
|
|
2149
2139
|
}
|
|
2150
|
-
export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
|
|
2151
|
-
'integrationCode': string;
|
|
2152
|
-
/**
|
|
2153
|
-
* The value of the identifying property on the foreign product
|
|
2154
|
-
*/
|
|
2155
|
-
'foreignKey': string;
|
|
2156
|
-
}
|
|
2157
2140
|
/**
|
|
2158
2141
|
* 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.
|
|
2159
2142
|
*/
|
|
@@ -2338,7 +2321,7 @@ export interface Variant {
|
|
|
2338
2321
|
* Key/value pairs that can be used to store additional information about the variant
|
|
2339
2322
|
*/
|
|
2340
2323
|
'metafields'?: Array<MetaField>;
|
|
2341
|
-
'integrationConnections'?: Array<
|
|
2324
|
+
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
2342
2325
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2343
2326
|
/**
|
|
2344
2327
|
* @deprecated
|
|
@@ -2363,13 +2346,6 @@ export interface VariantGfnVariant {
|
|
|
2363
2346
|
*/
|
|
2364
2347
|
'metafields'?: Array<MetaField>;
|
|
2365
2348
|
}
|
|
2366
|
-
export interface VariantIntegrationConnectionsInner {
|
|
2367
|
-
'integrationCode': string;
|
|
2368
|
-
/**
|
|
2369
|
-
* The value of the identifying property on the foreign variant
|
|
2370
|
-
*/
|
|
2371
|
-
'foreignKey': string;
|
|
2372
|
-
}
|
|
2373
2349
|
export interface VariantProduct {
|
|
2374
2350
|
/**
|
|
2375
2351
|
* Unique object identifier
|
|
@@ -3713,7 +3689,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3713
3689
|
* @param {*} [options] Override http request option.
|
|
3714
3690
|
* @throws {RequiredError}
|
|
3715
3691
|
*/
|
|
3716
|
-
autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3692
|
+
autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>>;
|
|
3717
3693
|
/**
|
|
3718
3694
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3719
3695
|
* @summary Create product
|
|
@@ -3749,7 +3725,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3749
3725
|
* @param {*} [options] Override http request option.
|
|
3750
3726
|
* @throws {RequiredError}
|
|
3751
3727
|
*/
|
|
3752
|
-
duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3728
|
+
duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>>;
|
|
3753
3729
|
/**
|
|
3754
3730
|
* Export the project\'s products and variants as a CSV file.
|
|
3755
3731
|
* @summary Export products
|
|
@@ -3824,7 +3800,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3824
3800
|
* @param {*} [options] Override http request option.
|
|
3825
3801
|
* @throws {RequiredError}
|
|
3826
3802
|
*/
|
|
3827
|
-
seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3803
|
+
seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportProducts202Response>>;
|
|
3828
3804
|
/**
|
|
3829
3805
|
* Updates a product by a given ID.
|
|
3830
3806
|
* @summary Update product
|
|
@@ -3856,7 +3832,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3856
3832
|
* @param {*} [options] Override http request option.
|
|
3857
3833
|
* @throws {RequiredError}
|
|
3858
3834
|
*/
|
|
3859
|
-
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3835
|
+
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response>;
|
|
3860
3836
|
/**
|
|
3861
3837
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3862
3838
|
* @summary Create product
|
|
@@ -3888,7 +3864,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3888
3864
|
* @param {*} [options] Override http request option.
|
|
3889
3865
|
* @throws {RequiredError}
|
|
3890
3866
|
*/
|
|
3891
|
-
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3867
|
+
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response>;
|
|
3892
3868
|
/**
|
|
3893
3869
|
* Export the project\'s products and variants as a CSV file.
|
|
3894
3870
|
* @summary Export products
|
|
@@ -3928,7 +3904,7 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
3928
3904
|
* @param {*} [options] Override http request option.
|
|
3929
3905
|
* @throws {RequiredError}
|
|
3930
3906
|
*/
|
|
3931
|
-
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3907
|
+
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportProducts202Response>;
|
|
3932
3908
|
/**
|
|
3933
3909
|
* Updates a product by a given ID.
|
|
3934
3910
|
* @summary Update product
|
|
@@ -4237,7 +4213,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4237
4213
|
* @param {*} [options] Override http request option.
|
|
4238
4214
|
* @throws {RequiredError}
|
|
4239
4215
|
*/
|
|
4240
|
-
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
4216
|
+
autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportProducts202Response, any, {}>>;
|
|
4241
4217
|
/**
|
|
4242
4218
|
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
4243
4219
|
* @summary Create product
|
|
@@ -4269,7 +4245,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4269
4245
|
* @param {*} [options] Override http request option.
|
|
4270
4246
|
* @throws {RequiredError}
|
|
4271
4247
|
*/
|
|
4272
|
-
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
4248
|
+
duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportProducts202Response, any, {}>>;
|
|
4273
4249
|
/**
|
|
4274
4250
|
* Export the project\'s products and variants as a CSV file.
|
|
4275
4251
|
* @summary Export products
|
|
@@ -4309,7 +4285,7 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
4309
4285
|
* @param {*} [options] Override http request option.
|
|
4310
4286
|
* @throws {RequiredError}
|
|
4311
4287
|
*/
|
|
4312
|
-
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
4288
|
+
seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportProducts202Response, any, {}>>;
|
|
4313
4289
|
/**
|
|
4314
4290
|
* Updates a product by a given ID.
|
|
4315
4291
|
* @summary Update product
|
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.
|
|
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).
|
|
@@ -150,6 +150,7 @@ export const TextApplicationPropertiesFontStyleEnum = {
|
|
|
150
150
|
export const TextApplicationPropertiesPersonalizationTypeEnum = {
|
|
151
151
|
Text: 'text',
|
|
152
152
|
Number: 'number',
|
|
153
|
+
Textarea: 'textarea',
|
|
153
154
|
};
|
|
154
155
|
export const UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
|
|
155
156
|
Size: 'Size',
|
package/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.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.
|
|
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/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -48,6 +48,11 @@ export declare const setOAuthToObject: (object: any, name: string, scopes: strin
|
|
|
48
48
|
* @export
|
|
49
49
|
*/
|
|
50
50
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const replaceWithSerializableTypeIfNeeded: (_key: string, value: unknown) => unknown;
|
|
51
56
|
/**
|
|
52
57
|
*
|
|
53
58
|
* @export
|
package/dist/esm/common.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.
|
|
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).
|
|
@@ -91,7 +91,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
91
91
|
if (parameter == null)
|
|
92
92
|
return;
|
|
93
93
|
if (typeof parameter === "object") {
|
|
94
|
-
if (Array.isArray(parameter)) {
|
|
94
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
95
95
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
96
96
|
}
|
|
97
97
|
else {
|
|
@@ -116,6 +116,16 @@ export const setSearchParams = function (url, ...objects) {
|
|
|
116
116
|
setFlattenedQueryParams(searchParams, objects);
|
|
117
117
|
url.search = searchParams.toString();
|
|
118
118
|
};
|
|
119
|
+
/**
|
|
120
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
121
|
+
* @export
|
|
122
|
+
*/
|
|
123
|
+
export const replaceWithSerializableTypeIfNeeded = function (_key, value) {
|
|
124
|
+
if (value instanceof Set) {
|
|
125
|
+
return Array.from(value);
|
|
126
|
+
}
|
|
127
|
+
return value;
|
|
128
|
+
};
|
|
119
129
|
/**
|
|
120
130
|
*
|
|
121
131
|
* @export
|
|
@@ -126,7 +136,7 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
|
|
|
126
136
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
127
137
|
: nonString;
|
|
128
138
|
return needsSerialization
|
|
129
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
139
|
+
? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
|
|
130
140
|
: (value || "");
|
|
131
141
|
};
|
|
132
142
|
/**
|
|
@@ -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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.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.
|
|
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).
|
package/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.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.
|
|
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/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.98.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.98.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**personalization** | [**
|
|
8
|
+
**personalization** | [**ApplicationPropertiesPersonalization**](ApplicationPropertiesPersonalization.md) | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**optional** | [**PersonalizationOptional**](PersonalizationOptional.md) | | [optional] [default to undefined]
|
|
8
9
|
**fit** | **string** | The fit of the image. This determines how an uploaded image will be resized to fit the application. | [optional] [default to FitEnum_Contain]
|
|
10
|
+
**showAiArtworkTools** | **boolean** | If true, customers can use AI artwork tools (redraw, upscale, remove background) on their uploaded image. The platform will be billed for this usage. | [optional] [default to false]
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -13,7 +15,9 @@ Name | Type | Description | Notes
|
|
|
13
15
|
import { ApplicationPropertiesPersonalizationRules } from '@teemill/product-catalog';
|
|
14
16
|
|
|
15
17
|
const instance: ApplicationPropertiesPersonalizationRules = {
|
|
18
|
+
optional,
|
|
16
19
|
fit,
|
|
20
|
+
showAiArtworkTools,
|
|
17
21
|
};
|
|
18
22
|
```
|
|
19
23
|
|
|
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
|
|
15
15
|
**color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
|
|
16
16
|
**rotation** | **number** | The rotation of the text in degrees. | [optional] [default to undefined]
|
|
17
|
+
**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) | | [optional] [default to undefined]
|
|
17
18
|
**width** | **number** | Width of the application in pixels | [optional] [default to undefined]
|
|
18
19
|
**height** | **number** | Height of the application in pixels | [optional] [default to undefined]
|
|
19
|
-
**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) | | [optional] [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -33,9 +33,9 @@ const instance: ApplicationPropertiesProperties = {
|
|
|
33
33
|
fontStyle,
|
|
34
34
|
color,
|
|
35
35
|
rotation,
|
|
36
|
+
metadata,
|
|
36
37
|
width,
|
|
37
38
|
height,
|
|
38
|
-
metadata,
|
|
39
39
|
};
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **string** | The unique identifier of this record. | [optional] [default to undefined]
|
|
10
10
|
**set** | [**ApplicationSet1**](ApplicationSet1.md) | | [optional] [default to undefined]
|
|
11
|
-
**attributes** | [**Array<
|
|
11
|
+
**attributes** | [**Array<UpdateApplicationSetRequestRecordsInnerAttributesInner>**](UpdateApplicationSetRequestRecordsInnerAttributesInner.md) | Attributes associated to a variant such as Colour and Size. | [optional] [default to undefined]
|
|
12
12
|
**applications** | [**Array<Application>**](Application.md) | List of applications for this record | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
package/docs/BundleProduct.md
CHANGED
|
@@ -40,7 +40,7 @@ Name | Type | Description | Notes
|
|
|
40
40
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
41
41
|
**personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
|
|
42
42
|
**optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
|
|
43
|
-
**integrationConnections** | [**Array<
|
|
43
|
+
**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
|
|
44
44
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
|
|
45
45
|
**license** | [**License**](License.md) | | [optional] [default to undefined]
|
|
46
46
|
|