@teemill/product-catalog 1.73.0 → 1.75.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 +4 -6
- package/api.ts +43 -112
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +40 -112
- package/dist/api.js +5 -2
- 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 +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +40 -112
- package/dist/esm/api.js +4 -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 +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/CreateBundleProduct.md +1 -1
- package/docs/CreateProductRequest.md +1 -1
- package/docs/NamedPrice.md +22 -0
- package/docs/Price.md +1 -1
- package/docs/Product.md +1 -1
- package/docs/RequiredPrice.md +23 -0
- package/docs/UpdateProductRequest.md +1 -1
- package/docs/VariantWholesaleCost.md +6 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.75.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.75.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -127,14 +127,15 @@ Class | Method | HTTP request | Description
|
|
|
127
127
|
- [ImportProducts200Response](docs/ImportProducts200Response.md)
|
|
128
128
|
- [Location](docs/Location.md)
|
|
129
129
|
- [MetaField](docs/MetaField.md)
|
|
130
|
+
- [NamedPrice](docs/NamedPrice.md)
|
|
130
131
|
- [OptimisationHistoryItem](docs/OptimisationHistoryItem.md)
|
|
131
132
|
- [Price](docs/Price.md)
|
|
132
133
|
- [Product](docs/Product.md)
|
|
133
134
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
134
135
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
135
|
-
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
136
136
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
137
137
|
- [ProductsResponse](docs/ProductsResponse.md)
|
|
138
|
+
- [RequiredPrice](docs/RequiredPrice.md)
|
|
138
139
|
- [SEOMetadata](docs/SEOMetadata.md)
|
|
139
140
|
- [SalePrice](docs/SalePrice.md)
|
|
140
141
|
- [SeoOptimiseProducts202Response](docs/SeoOptimiseProducts202Response.md)
|
|
@@ -150,9 +151,6 @@ Class | Method | HTTP request | Description
|
|
|
150
151
|
- [UpdateApplicationSetRequestRecordsInner](docs/UpdateApplicationSetRequestRecordsInner.md)
|
|
151
152
|
- [UpdateApplicationSetRequestRecordsInnerAttributesInner](docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md)
|
|
152
153
|
- [UpdateProductRequest](docs/UpdateProductRequest.md)
|
|
153
|
-
- [UpdateProductRequestBundleItemsInner](docs/UpdateProductRequestBundleItemsInner.md)
|
|
154
|
-
- [UpdateProductRequestBundleItemsInnerConfig](docs/UpdateProductRequestBundleItemsInnerConfig.md)
|
|
155
|
-
- [UpdateProductRequestBundleItemsInnerConfigValidOptions](docs/UpdateProductRequestBundleItemsInnerConfigValidOptions.md)
|
|
156
154
|
- [UpdateProductRequestIntegrationConnectionsInner](docs/UpdateProductRequestIntegrationConnectionsInner.md)
|
|
157
155
|
- [UpdateProductsRequest](docs/UpdateProductsRequest.md)
|
|
158
156
|
- [UpdateProductsRequestProductsInner](docs/UpdateProductsRequestProductsInner.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -605,7 +605,7 @@ export interface CreateBundleProduct {
|
|
|
605
605
|
/**
|
|
606
606
|
* A list of product uuids to include in this bundle
|
|
607
607
|
*/
|
|
608
|
-
'bundleItems': Array<
|
|
608
|
+
'bundleItems': Array<string>;
|
|
609
609
|
'retailPrice'?: Price;
|
|
610
610
|
'salePrice'?: SalePrice | null;
|
|
611
611
|
'price'?: Price;
|
|
@@ -864,6 +864,13 @@ export interface MetaField {
|
|
|
864
864
|
*/
|
|
865
865
|
'value': string;
|
|
866
866
|
}
|
|
867
|
+
export interface NamedPrice {
|
|
868
|
+
/**
|
|
869
|
+
* The name of the price
|
|
870
|
+
*/
|
|
871
|
+
'name': string;
|
|
872
|
+
'price': RequiredPrice;
|
|
873
|
+
}
|
|
867
874
|
export interface OptimisationHistoryItem {
|
|
868
875
|
/**
|
|
869
876
|
* Unique object identifier
|
|
@@ -872,7 +879,7 @@ export interface OptimisationHistoryItem {
|
|
|
872
879
|
'createdAt'?: string;
|
|
873
880
|
}
|
|
874
881
|
/**
|
|
875
|
-
* Standard price definition that defines the amount
|
|
882
|
+
* Standard price definition that defines the amount and currency.
|
|
876
883
|
*/
|
|
877
884
|
export interface Price {
|
|
878
885
|
/**
|
|
@@ -927,7 +934,7 @@ export interface Product {
|
|
|
927
934
|
/**
|
|
928
935
|
* Products in the bundle.
|
|
929
936
|
*/
|
|
930
|
-
'bundleItems'?: Array<
|
|
937
|
+
'bundleItems'?: Array<Product>;
|
|
931
938
|
'retailPrice'?: Price;
|
|
932
939
|
'salePrice'?: SalePrice | null;
|
|
933
940
|
/**
|
|
@@ -1001,93 +1008,6 @@ export interface ProductApplicationSetsInner {
|
|
|
1001
1008
|
*/
|
|
1002
1009
|
'name'?: string;
|
|
1003
1010
|
}
|
|
1004
|
-
export interface ProductBundleItemsInner {
|
|
1005
|
-
/**
|
|
1006
|
-
* Unique object identifier
|
|
1007
|
-
*/
|
|
1008
|
-
'id'?: string;
|
|
1009
|
-
/**
|
|
1010
|
-
* A reference to the resource location
|
|
1011
|
-
*/
|
|
1012
|
-
'ref'?: string;
|
|
1013
|
-
'title': string;
|
|
1014
|
-
'description': string;
|
|
1015
|
-
'slug'?: string;
|
|
1016
|
-
'brand'?: string;
|
|
1017
|
-
'enabled'?: boolean;
|
|
1018
|
-
'seoMetadata'?: SEOMetadata;
|
|
1019
|
-
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1020
|
-
'tags'?: Array<string>;
|
|
1021
|
-
'internalTags'?: Array<string>;
|
|
1022
|
-
'createdAt'?: string;
|
|
1023
|
-
'updatedAt'?: string;
|
|
1024
|
-
'publishedAt'?: string;
|
|
1025
|
-
/**
|
|
1026
|
-
* Images
|
|
1027
|
-
*/
|
|
1028
|
-
'images'?: Array<Image>;
|
|
1029
|
-
/**
|
|
1030
|
-
* Videos
|
|
1031
|
-
*/
|
|
1032
|
-
'videos'?: Array<Video>;
|
|
1033
|
-
/**
|
|
1034
|
-
* Variants
|
|
1035
|
-
*/
|
|
1036
|
-
'variants'?: Array<Variant>;
|
|
1037
|
-
/**
|
|
1038
|
-
* Products in the bundle.
|
|
1039
|
-
*/
|
|
1040
|
-
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
1041
|
-
'retailPrice'?: Price;
|
|
1042
|
-
'salePrice'?: SalePrice | null;
|
|
1043
|
-
/**
|
|
1044
|
-
* Additional files attached to the product.
|
|
1045
|
-
*/
|
|
1046
|
-
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1047
|
-
/**
|
|
1048
|
-
* List of application sets associated with this product
|
|
1049
|
-
*/
|
|
1050
|
-
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1051
|
-
/**
|
|
1052
|
-
* The average review rating. This field is only present if included in the fields query parameter
|
|
1053
|
-
*/
|
|
1054
|
-
'reviewScore'?: number | null;
|
|
1055
|
-
/**
|
|
1056
|
-
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1057
|
-
*/
|
|
1058
|
-
'reviewCount'?: number;
|
|
1059
|
-
'sku'?: string;
|
|
1060
|
-
/**
|
|
1061
|
-
* A count of sales. This field is only present if included in the fields query parameter
|
|
1062
|
-
*/
|
|
1063
|
-
'sales'?: number;
|
|
1064
|
-
'salesStart'?: string;
|
|
1065
|
-
'salesEnd'?: string;
|
|
1066
|
-
'includeInDataFeeds'?: boolean;
|
|
1067
|
-
/**
|
|
1068
|
-
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1069
|
-
*/
|
|
1070
|
-
'shopifyId'?: number | null;
|
|
1071
|
-
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1072
|
-
/**
|
|
1073
|
-
* Key/value pairs that can be used to store additional information about the product
|
|
1074
|
-
*/
|
|
1075
|
-
'metafields'?: Array<MetaField>;
|
|
1076
|
-
/**
|
|
1077
|
-
* a JSON string representing the personalization template for the product
|
|
1078
|
-
*/
|
|
1079
|
-
'personalizationTemplate'?: string;
|
|
1080
|
-
/**
|
|
1081
|
-
* History of AI optimisations performed on the product
|
|
1082
|
-
*/
|
|
1083
|
-
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1084
|
-
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1085
|
-
/**
|
|
1086
|
-
* Whether to show a sale badge on the product
|
|
1087
|
-
*/
|
|
1088
|
-
'showSaleBadge'?: boolean;
|
|
1089
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1090
|
-
}
|
|
1091
1011
|
export interface ProductWarehouseProduct {
|
|
1092
1012
|
/**
|
|
1093
1013
|
* Unique object identifier
|
|
@@ -1105,6 +1025,26 @@ export interface ProductsResponse {
|
|
|
1105
1025
|
*/
|
|
1106
1026
|
'nextPageToken'?: number | null;
|
|
1107
1027
|
}
|
|
1028
|
+
/**
|
|
1029
|
+
* Required price definition that defines the amount and currency.
|
|
1030
|
+
*/
|
|
1031
|
+
export interface RequiredPrice {
|
|
1032
|
+
/**
|
|
1033
|
+
* Price including tax in the specified currency.
|
|
1034
|
+
*/
|
|
1035
|
+
'amount': number;
|
|
1036
|
+
/**
|
|
1037
|
+
* Currency code for the currency the price is valued in.
|
|
1038
|
+
*/
|
|
1039
|
+
'currencyCode': RequiredPriceCurrencyCodeEnum;
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
export const RequiredPriceCurrencyCodeEnum = {
|
|
1043
|
+
Gbp: 'GBP'
|
|
1044
|
+
} as const;
|
|
1045
|
+
|
|
1046
|
+
export type RequiredPriceCurrencyCodeEnum = typeof RequiredPriceCurrencyCodeEnum[keyof typeof RequiredPriceCurrencyCodeEnum];
|
|
1047
|
+
|
|
1108
1048
|
/**
|
|
1109
1049
|
* SEO metadata for the product
|
|
1110
1050
|
*/
|
|
@@ -1375,9 +1315,9 @@ export interface UpdateProductRequest {
|
|
|
1375
1315
|
*/
|
|
1376
1316
|
'variants'?: Array<CreateProductVariant>;
|
|
1377
1317
|
/**
|
|
1378
|
-
* A list of
|
|
1318
|
+
* A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
|
|
1379
1319
|
*/
|
|
1380
|
-
'bundleItems'?: Array<
|
|
1320
|
+
'bundleItems'?: Array<string>;
|
|
1381
1321
|
'retailPrice'?: Price;
|
|
1382
1322
|
'salePrice'?: SalePrice | null;
|
|
1383
1323
|
/**
|
|
@@ -1421,23 +1361,6 @@ export interface UpdateProductRequest {
|
|
|
1421
1361
|
*/
|
|
1422
1362
|
'showSaleBadge'?: boolean;
|
|
1423
1363
|
}
|
|
1424
|
-
export interface UpdateProductRequestBundleItemsInner {
|
|
1425
|
-
/**
|
|
1426
|
-
* Unique object identifier
|
|
1427
|
-
*/
|
|
1428
|
-
'id'?: string;
|
|
1429
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1430
|
-
}
|
|
1431
|
-
export interface UpdateProductRequestBundleItemsInnerConfig {
|
|
1432
|
-
'validOptions'?: UpdateProductRequestBundleItemsInnerConfigValidOptions;
|
|
1433
|
-
}
|
|
1434
|
-
/**
|
|
1435
|
-
* 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.
|
|
1436
|
-
*/
|
|
1437
|
-
export interface UpdateProductRequestBundleItemsInnerConfigValidOptions {
|
|
1438
|
-
'name': string;
|
|
1439
|
-
'values': Array<string>;
|
|
1440
|
-
}
|
|
1441
1364
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
1442
1365
|
/**
|
|
1443
1366
|
* Code identifying the integration
|
|
@@ -1671,8 +1594,16 @@ export interface VariantProduct {
|
|
|
1671
1594
|
'ref'?: string;
|
|
1672
1595
|
}
|
|
1673
1596
|
export interface VariantWholesaleCost {
|
|
1674
|
-
'item'
|
|
1675
|
-
|
|
1597
|
+
'item': RequiredPrice;
|
|
1598
|
+
/**
|
|
1599
|
+
* A breakdown of the cost per application
|
|
1600
|
+
*/
|
|
1601
|
+
'applications': Array<NamedPrice>;
|
|
1602
|
+
/**
|
|
1603
|
+
* a breakdown of the cost per handling fee
|
|
1604
|
+
*/
|
|
1605
|
+
'handling': Array<NamedPrice>;
|
|
1606
|
+
'fulfillment': RequiredPrice;
|
|
1676
1607
|
}
|
|
1677
1608
|
export interface VariantsResponse {
|
|
1678
1609
|
'variants'?: Array<Variant>;
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.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.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog 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.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -572,7 +572,7 @@ 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<string>;
|
|
576
576
|
'retailPrice'?: Price;
|
|
577
577
|
'salePrice'?: SalePrice | null;
|
|
578
578
|
'price'?: Price;
|
|
@@ -830,6 +830,13 @@ export interface MetaField {
|
|
|
830
830
|
*/
|
|
831
831
|
'value': string;
|
|
832
832
|
}
|
|
833
|
+
export interface NamedPrice {
|
|
834
|
+
/**
|
|
835
|
+
* The name of the price
|
|
836
|
+
*/
|
|
837
|
+
'name': string;
|
|
838
|
+
'price': RequiredPrice;
|
|
839
|
+
}
|
|
833
840
|
export interface OptimisationHistoryItem {
|
|
834
841
|
/**
|
|
835
842
|
* Unique object identifier
|
|
@@ -838,7 +845,7 @@ export interface OptimisationHistoryItem {
|
|
|
838
845
|
'createdAt'?: string;
|
|
839
846
|
}
|
|
840
847
|
/**
|
|
841
|
-
* Standard price definition that defines the amount
|
|
848
|
+
* Standard price definition that defines the amount and currency.
|
|
842
849
|
*/
|
|
843
850
|
export interface Price {
|
|
844
851
|
/**
|
|
@@ -890,7 +897,7 @@ export interface Product {
|
|
|
890
897
|
/**
|
|
891
898
|
* Products in the bundle.
|
|
892
899
|
*/
|
|
893
|
-
'bundleItems'?: Array<
|
|
900
|
+
'bundleItems'?: Array<Product>;
|
|
894
901
|
'retailPrice'?: Price;
|
|
895
902
|
'salePrice'?: SalePrice | null;
|
|
896
903
|
/**
|
|
@@ -964,93 +971,6 @@ export interface ProductApplicationSetsInner {
|
|
|
964
971
|
*/
|
|
965
972
|
'name'?: string;
|
|
966
973
|
}
|
|
967
|
-
export interface ProductBundleItemsInner {
|
|
968
|
-
/**
|
|
969
|
-
* Unique object identifier
|
|
970
|
-
*/
|
|
971
|
-
'id'?: string;
|
|
972
|
-
/**
|
|
973
|
-
* A reference to the resource location
|
|
974
|
-
*/
|
|
975
|
-
'ref'?: string;
|
|
976
|
-
'title': string;
|
|
977
|
-
'description': string;
|
|
978
|
-
'slug'?: string;
|
|
979
|
-
'brand'?: string;
|
|
980
|
-
'enabled'?: boolean;
|
|
981
|
-
'seoMetadata'?: SEOMetadata;
|
|
982
|
-
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
983
|
-
'tags'?: Array<string>;
|
|
984
|
-
'internalTags'?: Array<string>;
|
|
985
|
-
'createdAt'?: string;
|
|
986
|
-
'updatedAt'?: string;
|
|
987
|
-
'publishedAt'?: string;
|
|
988
|
-
/**
|
|
989
|
-
* Images
|
|
990
|
-
*/
|
|
991
|
-
'images'?: Array<Image>;
|
|
992
|
-
/**
|
|
993
|
-
* Videos
|
|
994
|
-
*/
|
|
995
|
-
'videos'?: Array<Video>;
|
|
996
|
-
/**
|
|
997
|
-
* Variants
|
|
998
|
-
*/
|
|
999
|
-
'variants'?: Array<Variant>;
|
|
1000
|
-
/**
|
|
1001
|
-
* Products in the bundle.
|
|
1002
|
-
*/
|
|
1003
|
-
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
1004
|
-
'retailPrice'?: Price;
|
|
1005
|
-
'salePrice'?: SalePrice | null;
|
|
1006
|
-
/**
|
|
1007
|
-
* Additional files attached to the product.
|
|
1008
|
-
*/
|
|
1009
|
-
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1010
|
-
/**
|
|
1011
|
-
* List of application sets associated with this product
|
|
1012
|
-
*/
|
|
1013
|
-
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1014
|
-
/**
|
|
1015
|
-
* The average review rating. This field is only present if included in the fields query parameter
|
|
1016
|
-
*/
|
|
1017
|
-
'reviewScore'?: number | null;
|
|
1018
|
-
/**
|
|
1019
|
-
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1020
|
-
*/
|
|
1021
|
-
'reviewCount'?: number;
|
|
1022
|
-
'sku'?: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* A count of sales. This field is only present if included in the fields query parameter
|
|
1025
|
-
*/
|
|
1026
|
-
'sales'?: number;
|
|
1027
|
-
'salesStart'?: string;
|
|
1028
|
-
'salesEnd'?: string;
|
|
1029
|
-
'includeInDataFeeds'?: boolean;
|
|
1030
|
-
/**
|
|
1031
|
-
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1032
|
-
*/
|
|
1033
|
-
'shopifyId'?: number | null;
|
|
1034
|
-
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1035
|
-
/**
|
|
1036
|
-
* Key/value pairs that can be used to store additional information about the product
|
|
1037
|
-
*/
|
|
1038
|
-
'metafields'?: Array<MetaField>;
|
|
1039
|
-
/**
|
|
1040
|
-
* a JSON string representing the personalization template for the product
|
|
1041
|
-
*/
|
|
1042
|
-
'personalizationTemplate'?: string;
|
|
1043
|
-
/**
|
|
1044
|
-
* History of AI optimisations performed on the product
|
|
1045
|
-
*/
|
|
1046
|
-
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1047
|
-
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1048
|
-
/**
|
|
1049
|
-
* Whether to show a sale badge on the product
|
|
1050
|
-
*/
|
|
1051
|
-
'showSaleBadge'?: boolean;
|
|
1052
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1053
|
-
}
|
|
1054
974
|
export interface ProductWarehouseProduct {
|
|
1055
975
|
/**
|
|
1056
976
|
* Unique object identifier
|
|
@@ -1068,6 +988,23 @@ export interface ProductsResponse {
|
|
|
1068
988
|
*/
|
|
1069
989
|
'nextPageToken'?: number | null;
|
|
1070
990
|
}
|
|
991
|
+
/**
|
|
992
|
+
* Required price definition that defines the amount and currency.
|
|
993
|
+
*/
|
|
994
|
+
export interface RequiredPrice {
|
|
995
|
+
/**
|
|
996
|
+
* Price including tax in the specified currency.
|
|
997
|
+
*/
|
|
998
|
+
'amount': number;
|
|
999
|
+
/**
|
|
1000
|
+
* Currency code for the currency the price is valued in.
|
|
1001
|
+
*/
|
|
1002
|
+
'currencyCode': RequiredPriceCurrencyCodeEnum;
|
|
1003
|
+
}
|
|
1004
|
+
export declare const RequiredPriceCurrencyCodeEnum: {
|
|
1005
|
+
readonly Gbp: "GBP";
|
|
1006
|
+
};
|
|
1007
|
+
export type RequiredPriceCurrencyCodeEnum = typeof RequiredPriceCurrencyCodeEnum[keyof typeof RequiredPriceCurrencyCodeEnum];
|
|
1071
1008
|
/**
|
|
1072
1009
|
* SEO metadata for the product
|
|
1073
1010
|
*/
|
|
@@ -1328,9 +1265,9 @@ export interface UpdateProductRequest {
|
|
|
1328
1265
|
*/
|
|
1329
1266
|
'variants'?: Array<CreateProductVariant>;
|
|
1330
1267
|
/**
|
|
1331
|
-
* A list of
|
|
1268
|
+
* A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
|
|
1332
1269
|
*/
|
|
1333
|
-
'bundleItems'?: Array<
|
|
1270
|
+
'bundleItems'?: Array<string>;
|
|
1334
1271
|
'retailPrice'?: Price;
|
|
1335
1272
|
'salePrice'?: SalePrice | null;
|
|
1336
1273
|
/**
|
|
@@ -1374,23 +1311,6 @@ export interface UpdateProductRequest {
|
|
|
1374
1311
|
*/
|
|
1375
1312
|
'showSaleBadge'?: boolean;
|
|
1376
1313
|
}
|
|
1377
|
-
export interface UpdateProductRequestBundleItemsInner {
|
|
1378
|
-
/**
|
|
1379
|
-
* Unique object identifier
|
|
1380
|
-
*/
|
|
1381
|
-
'id'?: string;
|
|
1382
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1383
|
-
}
|
|
1384
|
-
export interface UpdateProductRequestBundleItemsInnerConfig {
|
|
1385
|
-
'validOptions'?: UpdateProductRequestBundleItemsInnerConfigValidOptions;
|
|
1386
|
-
}
|
|
1387
|
-
/**
|
|
1388
|
-
* 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.
|
|
1389
|
-
*/
|
|
1390
|
-
export interface UpdateProductRequestBundleItemsInnerConfigValidOptions {
|
|
1391
|
-
'name': string;
|
|
1392
|
-
'values': Array<string>;
|
|
1393
|
-
}
|
|
1394
1314
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
1395
1315
|
/**
|
|
1396
1316
|
* Code identifying the integration
|
|
@@ -1615,8 +1535,16 @@ export interface VariantProduct {
|
|
|
1615
1535
|
'ref'?: string;
|
|
1616
1536
|
}
|
|
1617
1537
|
export interface VariantWholesaleCost {
|
|
1618
|
-
'item'
|
|
1619
|
-
|
|
1538
|
+
'item': RequiredPrice;
|
|
1539
|
+
/**
|
|
1540
|
+
* A breakdown of the cost per application
|
|
1541
|
+
*/
|
|
1542
|
+
'applications': Array<NamedPrice>;
|
|
1543
|
+
/**
|
|
1544
|
+
* a breakdown of the cost per handling fee
|
|
1545
|
+
*/
|
|
1546
|
+
'handling': Array<NamedPrice>;
|
|
1547
|
+
'fulfillment': RequiredPrice;
|
|
1620
1548
|
}
|
|
1621
1549
|
export interface VariantsResponse {
|
|
1622
1550
|
'variants'?: Array<Variant>;
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.75.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
25
|
+
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -103,6 +103,9 @@ exports.CreateApplicationPropertiesFontStyleEnum = {
|
|
|
103
103
|
exports.PriceCurrencyCodeEnum = {
|
|
104
104
|
Gbp: 'GBP'
|
|
105
105
|
};
|
|
106
|
+
exports.RequiredPriceCurrencyCodeEnum = {
|
|
107
|
+
Gbp: 'GBP'
|
|
108
|
+
};
|
|
106
109
|
exports.SalePriceCurrencyCodeEnum = {
|
|
107
110
|
Gbp: 'GBP'
|
|
108
111
|
};
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.75.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.75.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,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.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.75.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog 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.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -572,7 +572,7 @@ 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<string>;
|
|
576
576
|
'retailPrice'?: Price;
|
|
577
577
|
'salePrice'?: SalePrice | null;
|
|
578
578
|
'price'?: Price;
|
|
@@ -830,6 +830,13 @@ export interface MetaField {
|
|
|
830
830
|
*/
|
|
831
831
|
'value': string;
|
|
832
832
|
}
|
|
833
|
+
export interface NamedPrice {
|
|
834
|
+
/**
|
|
835
|
+
* The name of the price
|
|
836
|
+
*/
|
|
837
|
+
'name': string;
|
|
838
|
+
'price': RequiredPrice;
|
|
839
|
+
}
|
|
833
840
|
export interface OptimisationHistoryItem {
|
|
834
841
|
/**
|
|
835
842
|
* Unique object identifier
|
|
@@ -838,7 +845,7 @@ export interface OptimisationHistoryItem {
|
|
|
838
845
|
'createdAt'?: string;
|
|
839
846
|
}
|
|
840
847
|
/**
|
|
841
|
-
* Standard price definition that defines the amount
|
|
848
|
+
* Standard price definition that defines the amount and currency.
|
|
842
849
|
*/
|
|
843
850
|
export interface Price {
|
|
844
851
|
/**
|
|
@@ -890,7 +897,7 @@ export interface Product {
|
|
|
890
897
|
/**
|
|
891
898
|
* Products in the bundle.
|
|
892
899
|
*/
|
|
893
|
-
'bundleItems'?: Array<
|
|
900
|
+
'bundleItems'?: Array<Product>;
|
|
894
901
|
'retailPrice'?: Price;
|
|
895
902
|
'salePrice'?: SalePrice | null;
|
|
896
903
|
/**
|
|
@@ -964,93 +971,6 @@ export interface ProductApplicationSetsInner {
|
|
|
964
971
|
*/
|
|
965
972
|
'name'?: string;
|
|
966
973
|
}
|
|
967
|
-
export interface ProductBundleItemsInner {
|
|
968
|
-
/**
|
|
969
|
-
* Unique object identifier
|
|
970
|
-
*/
|
|
971
|
-
'id'?: string;
|
|
972
|
-
/**
|
|
973
|
-
* A reference to the resource location
|
|
974
|
-
*/
|
|
975
|
-
'ref'?: string;
|
|
976
|
-
'title': string;
|
|
977
|
-
'description': string;
|
|
978
|
-
'slug'?: string;
|
|
979
|
-
'brand'?: string;
|
|
980
|
-
'enabled'?: boolean;
|
|
981
|
-
'seoMetadata'?: SEOMetadata;
|
|
982
|
-
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
983
|
-
'tags'?: Array<string>;
|
|
984
|
-
'internalTags'?: Array<string>;
|
|
985
|
-
'createdAt'?: string;
|
|
986
|
-
'updatedAt'?: string;
|
|
987
|
-
'publishedAt'?: string;
|
|
988
|
-
/**
|
|
989
|
-
* Images
|
|
990
|
-
*/
|
|
991
|
-
'images'?: Array<Image>;
|
|
992
|
-
/**
|
|
993
|
-
* Videos
|
|
994
|
-
*/
|
|
995
|
-
'videos'?: Array<Video>;
|
|
996
|
-
/**
|
|
997
|
-
* Variants
|
|
998
|
-
*/
|
|
999
|
-
'variants'?: Array<Variant>;
|
|
1000
|
-
/**
|
|
1001
|
-
* Products in the bundle.
|
|
1002
|
-
*/
|
|
1003
|
-
'bundleItems'?: Array<ProductBundleItemsInner>;
|
|
1004
|
-
'retailPrice'?: Price;
|
|
1005
|
-
'salePrice'?: SalePrice | null;
|
|
1006
|
-
/**
|
|
1007
|
-
* Additional files attached to the product.
|
|
1008
|
-
*/
|
|
1009
|
-
'additionalFiles'?: Array<ProductAdditionalFilesInner>;
|
|
1010
|
-
/**
|
|
1011
|
-
* List of application sets associated with this product
|
|
1012
|
-
*/
|
|
1013
|
-
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
1014
|
-
/**
|
|
1015
|
-
* The average review rating. This field is only present if included in the fields query parameter
|
|
1016
|
-
*/
|
|
1017
|
-
'reviewScore'?: number | null;
|
|
1018
|
-
/**
|
|
1019
|
-
* A count of reviews. This field is only present if included in the fields query parameter
|
|
1020
|
-
*/
|
|
1021
|
-
'reviewCount'?: number;
|
|
1022
|
-
'sku'?: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* A count of sales. This field is only present if included in the fields query parameter
|
|
1025
|
-
*/
|
|
1026
|
-
'sales'?: number;
|
|
1027
|
-
'salesStart'?: string;
|
|
1028
|
-
'salesEnd'?: string;
|
|
1029
|
-
'includeInDataFeeds'?: boolean;
|
|
1030
|
-
/**
|
|
1031
|
-
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1032
|
-
*/
|
|
1033
|
-
'shopifyId'?: number | null;
|
|
1034
|
-
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1035
|
-
/**
|
|
1036
|
-
* Key/value pairs that can be used to store additional information about the product
|
|
1037
|
-
*/
|
|
1038
|
-
'metafields'?: Array<MetaField>;
|
|
1039
|
-
/**
|
|
1040
|
-
* a JSON string representing the personalization template for the product
|
|
1041
|
-
*/
|
|
1042
|
-
'personalizationTemplate'?: string;
|
|
1043
|
-
/**
|
|
1044
|
-
* History of AI optimisations performed on the product
|
|
1045
|
-
*/
|
|
1046
|
-
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1047
|
-
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1048
|
-
/**
|
|
1049
|
-
* Whether to show a sale badge on the product
|
|
1050
|
-
*/
|
|
1051
|
-
'showSaleBadge'?: boolean;
|
|
1052
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1053
|
-
}
|
|
1054
974
|
export interface ProductWarehouseProduct {
|
|
1055
975
|
/**
|
|
1056
976
|
* Unique object identifier
|
|
@@ -1068,6 +988,23 @@ export interface ProductsResponse {
|
|
|
1068
988
|
*/
|
|
1069
989
|
'nextPageToken'?: number | null;
|
|
1070
990
|
}
|
|
991
|
+
/**
|
|
992
|
+
* Required price definition that defines the amount and currency.
|
|
993
|
+
*/
|
|
994
|
+
export interface RequiredPrice {
|
|
995
|
+
/**
|
|
996
|
+
* Price including tax in the specified currency.
|
|
997
|
+
*/
|
|
998
|
+
'amount': number;
|
|
999
|
+
/**
|
|
1000
|
+
* Currency code for the currency the price is valued in.
|
|
1001
|
+
*/
|
|
1002
|
+
'currencyCode': RequiredPriceCurrencyCodeEnum;
|
|
1003
|
+
}
|
|
1004
|
+
export declare const RequiredPriceCurrencyCodeEnum: {
|
|
1005
|
+
readonly Gbp: "GBP";
|
|
1006
|
+
};
|
|
1007
|
+
export type RequiredPriceCurrencyCodeEnum = typeof RequiredPriceCurrencyCodeEnum[keyof typeof RequiredPriceCurrencyCodeEnum];
|
|
1071
1008
|
/**
|
|
1072
1009
|
* SEO metadata for the product
|
|
1073
1010
|
*/
|
|
@@ -1328,9 +1265,9 @@ export interface UpdateProductRequest {
|
|
|
1328
1265
|
*/
|
|
1329
1266
|
'variants'?: Array<CreateProductVariant>;
|
|
1330
1267
|
/**
|
|
1331
|
-
* A list of
|
|
1268
|
+
* A list of product uuids to be in this bundle. Only valid if the product is already a bundle.
|
|
1332
1269
|
*/
|
|
1333
|
-
'bundleItems'?: Array<
|
|
1270
|
+
'bundleItems'?: Array<string>;
|
|
1334
1271
|
'retailPrice'?: Price;
|
|
1335
1272
|
'salePrice'?: SalePrice | null;
|
|
1336
1273
|
/**
|
|
@@ -1374,23 +1311,6 @@ export interface UpdateProductRequest {
|
|
|
1374
1311
|
*/
|
|
1375
1312
|
'showSaleBadge'?: boolean;
|
|
1376
1313
|
}
|
|
1377
|
-
export interface UpdateProductRequestBundleItemsInner {
|
|
1378
|
-
/**
|
|
1379
|
-
* Unique object identifier
|
|
1380
|
-
*/
|
|
1381
|
-
'id'?: string;
|
|
1382
|
-
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1383
|
-
}
|
|
1384
|
-
export interface UpdateProductRequestBundleItemsInnerConfig {
|
|
1385
|
-
'validOptions'?: UpdateProductRequestBundleItemsInnerConfigValidOptions;
|
|
1386
|
-
}
|
|
1387
|
-
/**
|
|
1388
|
-
* 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.
|
|
1389
|
-
*/
|
|
1390
|
-
export interface UpdateProductRequestBundleItemsInnerConfigValidOptions {
|
|
1391
|
-
'name': string;
|
|
1392
|
-
'values': Array<string>;
|
|
1393
|
-
}
|
|
1394
1314
|
export interface UpdateProductRequestIntegrationConnectionsInner {
|
|
1395
1315
|
/**
|
|
1396
1316
|
* Code identifying the integration
|
|
@@ -1615,8 +1535,16 @@ export interface VariantProduct {
|
|
|
1615
1535
|
'ref'?: string;
|
|
1616
1536
|
}
|
|
1617
1537
|
export interface VariantWholesaleCost {
|
|
1618
|
-
'item'
|
|
1619
|
-
|
|
1538
|
+
'item': RequiredPrice;
|
|
1539
|
+
/**
|
|
1540
|
+
* A breakdown of the cost per application
|
|
1541
|
+
*/
|
|
1542
|
+
'applications': Array<NamedPrice>;
|
|
1543
|
+
/**
|
|
1544
|
+
* a breakdown of the cost per handling fee
|
|
1545
|
+
*/
|
|
1546
|
+
'handling': Array<NamedPrice>;
|
|
1547
|
+
'fulfillment': RequiredPrice;
|
|
1620
1548
|
}
|
|
1621
1549
|
export interface VariantsResponse {
|
|
1622
1550
|
'variants'?: Array<Variant>;
|
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.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -100,6 +100,9 @@ export const CreateApplicationPropertiesFontStyleEnum = {
|
|
|
100
100
|
export const PriceCurrencyCodeEnum = {
|
|
101
101
|
Gbp: 'GBP'
|
|
102
102
|
};
|
|
103
|
+
export const RequiredPriceCurrencyCodeEnum = {
|
|
104
|
+
Gbp: 'GBP'
|
|
105
|
+
};
|
|
103
106
|
export const SalePriceCurrencyCodeEnum = {
|
|
104
107
|
Gbp: 'GBP'
|
|
105
108
|
};
|
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.75.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.75.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.75.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.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog 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.75.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog 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.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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 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.75.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.75.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.75.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.75.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** |
|
|
22
|
+
**bundleItems** | **Array<string>** | 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]
|
|
@@ -25,7 +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
|
-
**bundleItems** |
|
|
28
|
+
**bundleItems** | **Array<string>** | A list of product uuids to include in this bundle | [default to undefined]
|
|
29
29
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
30
30
|
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
31
31
|
**price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# NamedPrice
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | The name of the price | [default to undefined]
|
|
9
|
+
**price** | [**RequiredPrice**](RequiredPrice.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { NamedPrice } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: NamedPrice = {
|
|
17
|
+
name,
|
|
18
|
+
price,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Price.md
CHANGED
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<Product>**](Product.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]
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RequiredPrice
|
|
2
|
+
|
|
3
|
+
Required price definition that defines the amount and currency.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**amount** | **number** | Price including tax in the specified currency. | [default to undefined]
|
|
10
|
+
**currencyCode** | **string** | Currency code for the currency the price is valued in. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RequiredPrice } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: RequiredPrice = {
|
|
18
|
+
amount,
|
|
19
|
+
currencyCode,
|
|
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)
|
|
@@ -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** |
|
|
20
|
+
**bundleItems** | **Array<string>** | A list of product uuids 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]
|
|
@@ -5,8 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**item** | [**
|
|
9
|
-
**
|
|
8
|
+
**item** | [**RequiredPrice**](RequiredPrice.md) | | [default to undefined]
|
|
9
|
+
**applications** | [**Array<NamedPrice>**](NamedPrice.md) | A breakdown of the cost per application | [default to undefined]
|
|
10
|
+
**handling** | [**Array<NamedPrice>**](NamedPrice.md) | a breakdown of the cost per handling fee | [default to undefined]
|
|
11
|
+
**fulfillment** | [**RequiredPrice**](RequiredPrice.md) | | [default to undefined]
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -15,6 +17,8 @@ import { VariantWholesaleCost } from '@teemill/product-catalog';
|
|
|
15
17
|
|
|
16
18
|
const instance: VariantWholesaleCost = {
|
|
17
19
|
item,
|
|
20
|
+
applications,
|
|
21
|
+
handling,
|
|
18
22
|
fulfillment,
|
|
19
23
|
};
|
|
20
24
|
```
|
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.75.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|