@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/dist/esm/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/esm/api.js
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/dist/esm/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/esm/base.js
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/dist/esm/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/esm/common.js
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).
|
|
@@ -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 {};
|
|
@@ -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).
|
|
@@ -18,6 +17,7 @@ export class Configuration {
|
|
|
18
17
|
this.username = param.username;
|
|
19
18
|
this.password = param.password;
|
|
20
19
|
this.accessToken = param.accessToken;
|
|
20
|
+
this.awsv4 = param.awsv4;
|
|
21
21
|
this.basePath = param.basePath;
|
|
22
22
|
this.serverIndex = param.serverIndex;
|
|
23
23
|
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
package/dist/esm/index.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/esm/index.js
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/dist/index.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/index.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).
|
|
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
|
|
20
20
|
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
21
21
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
22
|
-
**bundleItems** | **Array<
|
|
22
|
+
**bundleItems** | [**Array<CreateBundleProductBundleItemsInner>**](CreateBundleProductBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
|
|
23
23
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
24
24
|
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
25
25
|
**price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateBundleProductBundleItemsInner
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { CreateBundleProductBundleItemsInner } from '@teemill/product-catalog';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: CreateBundleProductBundleItemsInner = {
|
|
16
|
+
id,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
package/docs/CreateProduct.md
CHANGED
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
26
26
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
27
27
|
**personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
|
|
28
|
+
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
28
29
|
|
|
29
30
|
## Example
|
|
30
31
|
|
|
@@ -52,6 +53,7 @@ const instance: CreateProduct = {
|
|
|
52
53
|
shopifyId,
|
|
53
54
|
metafields,
|
|
54
55
|
personalizationTemplate,
|
|
56
|
+
license,
|
|
55
57
|
};
|
|
56
58
|
```
|
|
57
59
|
|
|
@@ -25,7 +25,8 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
26
26
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
27
27
|
**personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
|
|
28
|
-
**
|
|
28
|
+
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
29
|
+
**bundleItems** | [**Array<CreateBundleProductBundleItemsInner>**](CreateBundleProductBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
|
|
29
30
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
30
31
|
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
31
32
|
**price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
|
|
@@ -56,6 +57,7 @@ const instance: CreateProductRequest = {
|
|
|
56
57
|
shopifyId,
|
|
57
58
|
metafields,
|
|
58
59
|
personalizationTemplate,
|
|
60
|
+
license,
|
|
59
61
|
bundleItems,
|
|
60
62
|
retailPrice,
|
|
61
63
|
salePrice,
|
package/docs/Product.md
CHANGED
|
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
|
|
23
23
|
**videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
|
|
24
24
|
**variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
|
|
25
|
-
**bundleItems** | [**Array<
|
|
25
|
+
**bundleItems** | [**Array<ProductBundleItemsInner>**](ProductBundleItemsInner.md) | Products in the bundle. | [optional] [default to undefined]
|
|
26
26
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
27
27
|
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
28
28
|
**additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
|
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
|
|
18
18
|
**internalTags** | **Array<string>** | Additional product tags used for internal searching and filtering. | [optional] [default to undefined]
|
|
19
19
|
**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [optional] [default to undefined]
|
|
20
|
-
**bundleItems** | **Array<
|
|
20
|
+
**bundleItems** | [**Array<UpdateProductRequestBundleItemsInner>**](UpdateProductRequestBundleItemsInner.md) | A list of products to be in this bundle. Only valid if the product is already a bundle. | [optional] [default to undefined]
|
|
21
21
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
22
22
|
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
23
23
|
**images** | [**Array<ImageFile>**](ImageFile.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
|
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
29
29
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
30
30
|
**personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
|
|
31
|
+
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
31
32
|
**integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
|
|
32
33
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
|
|
33
34
|
|
|
@@ -60,6 +61,7 @@ const instance: UpdateProductRequest = {
|
|
|
60
61
|
shopifyId,
|
|
61
62
|
metafields,
|
|
62
63
|
personalizationTemplate,
|
|
64
|
+
license,
|
|
63
65
|
integrationConnections,
|
|
64
66
|
showSaleBadge,
|
|
65
67
|
};
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**validOptions** | [**
|
|
8
|
+
**validOptions** | [**Array<UpdateProductRequestBundleItemsInnerConfigValidOptionsInner>**](UpdateProductRequestBundleItemsInnerConfigValidOptionsInner.md) | 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. | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UpdateProductRequestBundleItemsInnerConfigValidOptionsInner
|
|
2
2
|
|
|
3
|
-
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.
|
|
4
3
|
|
|
5
4
|
## Properties
|
|
6
5
|
|
|
@@ -12,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
14
13
|
```typescript
|
|
15
|
-
import {
|
|
14
|
+
import { UpdateProductRequestBundleItemsInnerConfigValidOptionsInner } from '@teemill/product-catalog';
|
|
16
15
|
|
|
17
|
-
const instance:
|
|
16
|
+
const instance: UpdateProductRequestBundleItemsInnerConfigValidOptionsInner = {
|
|
18
17
|
name,
|
|
19
18
|
values,
|
|
20
19
|
};
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
|
|
20
20
|
**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
|
|
21
21
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
|
|
22
|
+
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -40,6 +41,7 @@ const instance: UpdateProductsRequestProductsInner = {
|
|
|
40
41
|
shopifyId,
|
|
41
42
|
integrationConnections,
|
|
42
43
|
showSaleBadge,
|
|
44
|
+
license,
|
|
43
45
|
};
|
|
44
46
|
```
|
|
45
47
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# UpdateProductsRequestProductsInnerLicense
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The ID of the license | [default to undefined]
|
|
10
|
+
**expiresAt** | **string** | The date and time the license will expire | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateProductsRequestProductsInnerLicense } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateProductsRequestProductsInnerLicense = {
|
|
18
|
+
id,
|
|
19
|
+
expiresAt,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.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/package.json
CHANGED
package/.openapi-generator/FILES
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
7.11.0
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# OpenAPI Generator Ignore
|
|
2
|
-
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
-
|
|
4
|
-
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
-
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
-
|
|
7
|
-
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
-
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
-
#ApiClient.cs
|
|
10
|
-
|
|
11
|
-
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
-
#foo/*/qux
|
|
13
|
-
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
-
|
|
15
|
-
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
-
#foo/**/qux
|
|
17
|
-
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
-
|
|
19
|
-
# You can also negate patterns with an exclamation (!).
|
|
20
|
-
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
-
#docs/*.md
|
|
22
|
-
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
-
#!docs/README.md
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# CreateApplicationPropertiesPosition
|
|
2
|
-
|
|
3
|
-
Position of the application
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**x** | **number** | X coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
10
|
-
**y** | **number** | Y coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { CreateApplicationPropertiesPosition } from '@teemill/product-catalog';
|
|
16
|
-
|
|
17
|
-
const instance: CreateApplicationPropertiesPosition = {
|
|
18
|
-
x,
|
|
19
|
-
y,
|
|
20
|
-
};
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|