@commercetools/importapi-sdk 6.4.0 → 6.6.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/CHANGELOG.md +68 -0
- package/dist/commercetools-importapi-sdk.browser.cjs.js +248 -61
- package/dist/commercetools-importapi-sdk.browser.esm.js +243 -62
- package/dist/commercetools-importapi-sdk.cjs.dev.js +248 -61
- package/dist/commercetools-importapi-sdk.cjs.prod.js +248 -61
- package/dist/commercetools-importapi-sdk.esm.js +243 -62
- package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +2 -0
- package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts.map +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-discount-codes-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +3 -3
- package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +2 -2
- package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-by-import-container-key-request-builder.d.ts +38 -0
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-by-import-container-key-request-builder.d.ts.map +1 -0
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-request-builder.d.ts +29 -0
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-request-builder.d.ts.map +1 -0
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-standalone-prices-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-containers/by-project-key-types-import-containers-by-import-container-key-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-operations/by-project-key-import-containers-by-import-container-key-import-operations-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-containers-by-import-container-key-import-summaries-request-builder.d.ts +1 -1
- package/dist/declarations/src/generated/client/product-selections/by-project-key-product-selections-request-builder.d.ts +27 -0
- package/dist/declarations/src/generated/client/product-selections/by-project-key-product-selections-request-builder.d.ts.map +1 -0
- package/dist/declarations/src/generated/index.d.ts +4 -0
- package/dist/declarations/src/generated/index.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/categories.d.ts +5 -8
- package/dist/declarations/src/generated/models/categories.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/common.d.ts +160 -59
- package/dist/declarations/src/generated/models/common.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/customers.d.ts +12 -13
- package/dist/declarations/src/generated/models/customers.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/customfields.d.ts +149 -91
- package/dist/declarations/src/generated/models/customfields.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/discount-codes.d.ts +12 -14
- package/dist/declarations/src/generated/models/discount-codes.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/errors.d.ts +6 -0
- package/dist/declarations/src/generated/models/errors.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/importcontainers.d.ts +68 -23
- package/dist/declarations/src/generated/models/importcontainers.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/importoperations.d.ts +19 -17
- package/dist/declarations/src/generated/models/importoperations.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/importrequests.d.ts +31 -17
- package/dist/declarations/src/generated/models/importrequests.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/importsummaries.d.ts +11 -12
- package/dist/declarations/src/generated/models/importsummaries.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/inventories.d.ts +8 -8
- package/dist/declarations/src/generated/models/order-patches.d.ts +57 -7
- package/dist/declarations/src/generated/models/order-patches.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/orders.d.ts +136 -45
- package/dist/declarations/src/generated/models/orders.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/prices.d.ts +10 -14
- package/dist/declarations/src/generated/models/prices.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/product-selections.d.ts +109 -0
- package/dist/declarations/src/generated/models/product-selections.d.ts.map +1 -0
- package/dist/declarations/src/generated/models/productdrafts.d.ts +37 -64
- package/dist/declarations/src/generated/models/productdrafts.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/products.d.ts +15 -58
- package/dist/declarations/src/generated/models/products.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/producttypes.d.ts +14 -19
- package/dist/declarations/src/generated/models/producttypes.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/productvariants.d.ts +162 -89
- package/dist/declarations/src/generated/models/productvariants.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/standalone-prices.d.ts +14 -15
- package/dist/declarations/src/generated/models/standalone-prices.d.ts.map +1 -1
- package/dist/declarations/src/generated/models/types.d.ts +11 -4
- package/dist/declarations/src/generated/models/types.d.ts.map +1 -1
- package/dist/declarations/src/generated/shared/utils/common-types.d.ts +29 -1
- package/dist/declarations/src/generated/shared/utils/common-types.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -116,7 +116,7 @@ class ByProjectKeyCategoriesImportContainersByImportContainerKeyRequestBuilder {
|
|
|
116
116
|
this.args = args;
|
|
117
117
|
}
|
|
118
118
|
/**
|
|
119
|
-
* Creates
|
|
119
|
+
* Creates an Import Request for Categories.
|
|
120
120
|
*/
|
|
121
121
|
post(methodArgs) {
|
|
122
122
|
return new ApiRequest({
|
|
@@ -190,7 +190,7 @@ class ByProjectKeyCustomersImportContainersByImportContainerKeyRequestBuilder {
|
|
|
190
190
|
this.args = args;
|
|
191
191
|
}
|
|
192
192
|
/**
|
|
193
|
-
* Creates
|
|
193
|
+
* Creates an Import Request for Customers.
|
|
194
194
|
*/
|
|
195
195
|
post(methodArgs) {
|
|
196
196
|
return new ApiRequest({
|
|
@@ -264,7 +264,7 @@ class ByProjectKeyDiscountCodesImportContainersByImportContainerKeyRequestBuilde
|
|
|
264
264
|
this.args = args;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
|
-
* Creates
|
|
267
|
+
* Creates an Import Request for Discount Codes.
|
|
268
268
|
*/
|
|
269
269
|
post(methodArgs) {
|
|
270
270
|
return new ApiRequest({
|
|
@@ -338,7 +338,7 @@ class ByProjectKeyImportContainersByImportContainerKeyImportOperationsRequestBui
|
|
|
338
338
|
this.args = args;
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
|
-
* Retrieves all [
|
|
341
|
+
* Retrieves all ImportOperations within an [ImportContainer](ctp:import:type:ImportContainer).
|
|
342
342
|
*
|
|
343
343
|
*/
|
|
344
344
|
get(methodArgs) {
|
|
@@ -367,7 +367,7 @@ class ByProjectKeyImportContainersByImportContainerKeyImportSummariesRequestBuil
|
|
|
367
367
|
this.args = args;
|
|
368
368
|
}
|
|
369
369
|
/**
|
|
370
|
-
* Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the
|
|
370
|
+
* Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the [ImportContainer](ctp:import:type:ImportContainer) with the provided `importContainerKey`.
|
|
371
371
|
*
|
|
372
372
|
*/
|
|
373
373
|
get(methodArgs) {
|
|
@@ -414,7 +414,7 @@ class ByProjectKeyImportContainersByImportContainerKeyRequestBuilder {
|
|
|
414
414
|
}
|
|
415
415
|
|
|
416
416
|
/**
|
|
417
|
-
* Updates
|
|
417
|
+
* Updates an [ImportContainer](ctp:import:type:ImportContainer) in the Project.
|
|
418
418
|
*/
|
|
419
419
|
put(methodArgs) {
|
|
420
420
|
return new ApiRequest({
|
|
@@ -430,7 +430,7 @@ class ByProjectKeyImportContainersByImportContainerKeyRequestBuilder {
|
|
|
430
430
|
}, this.args.executeRequest);
|
|
431
431
|
}
|
|
432
432
|
/**
|
|
433
|
-
* Retrieves
|
|
433
|
+
* Retrieves an [ImportContainer](ctp:import:type:ImportContainer) with the provided `importContainerKey`.
|
|
434
434
|
*/
|
|
435
435
|
get(methodArgs) {
|
|
436
436
|
return new ApiRequest({
|
|
@@ -444,7 +444,7 @@ class ByProjectKeyImportContainersByImportContainerKeyRequestBuilder {
|
|
|
444
444
|
}, this.args.executeRequest);
|
|
445
445
|
}
|
|
446
446
|
/**
|
|
447
|
-
* Deletes
|
|
447
|
+
* Deletes an Import Container in the Project.
|
|
448
448
|
*
|
|
449
449
|
* Generates the [ImportContainerDeleted](/projects/events#import-container-deleted-event) Event.
|
|
450
450
|
*
|
|
@@ -485,7 +485,7 @@ class ByProjectKeyImportContainersRequestBuilder {
|
|
|
485
485
|
}
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
|
-
* Creates
|
|
488
|
+
* Creates an Import Container in the Project.
|
|
489
489
|
*
|
|
490
490
|
* Generates the [ImportContainerCreated](/projects/events#import-container-created-event) Event.
|
|
491
491
|
*
|
|
@@ -504,7 +504,7 @@ class ByProjectKeyImportContainersRequestBuilder {
|
|
|
504
504
|
}, this.args.executeRequest);
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
|
-
* Retrieves all
|
|
507
|
+
* Retrieves all ImportContainers in the Project.
|
|
508
508
|
*/
|
|
509
509
|
get(methodArgs) {
|
|
510
510
|
return new ApiRequest({
|
|
@@ -532,7 +532,7 @@ class ByProjectKeyImportOperationsByIdRequestBuilder {
|
|
|
532
532
|
this.args = args;
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
535
|
-
* Retrieves
|
|
535
|
+
* Retrieves an ImportOperation with the provided `id`.
|
|
536
536
|
*
|
|
537
537
|
*/
|
|
538
538
|
get(methodArgs) {
|
|
@@ -583,7 +583,7 @@ class ByProjectKeyInventoriesImportContainersByImportContainerKeyRequestBuilder
|
|
|
583
583
|
this.args = args;
|
|
584
584
|
}
|
|
585
585
|
/**
|
|
586
|
-
* Creates
|
|
586
|
+
* Creates an Import Request for InventoryEntries.
|
|
587
587
|
*/
|
|
588
588
|
post(methodArgs) {
|
|
589
589
|
return new ApiRequest({
|
|
@@ -657,7 +657,7 @@ class ByProjectKeyOrderPatchesImportContainersByImportContainerKeyRequestBuilder
|
|
|
657
657
|
this.args = args;
|
|
658
658
|
}
|
|
659
659
|
/**
|
|
660
|
-
* Creates
|
|
660
|
+
* Creates an Import Request for updating Orders.
|
|
661
661
|
*/
|
|
662
662
|
post(methodArgs) {
|
|
663
663
|
return new ApiRequest({
|
|
@@ -731,7 +731,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
|
|
|
731
731
|
this.args = args;
|
|
732
732
|
}
|
|
733
733
|
/**
|
|
734
|
-
* Creates
|
|
734
|
+
* Creates an Import Request for creating Orders.
|
|
735
735
|
*/
|
|
736
736
|
post(methodArgs) {
|
|
737
737
|
return new ApiRequest({
|
|
@@ -805,7 +805,7 @@ class ByProjectKeyPricesImportContainersByImportContainerKeyRequestBuilder {
|
|
|
805
805
|
this.args = args;
|
|
806
806
|
}
|
|
807
807
|
/**
|
|
808
|
-
* Creates
|
|
808
|
+
* Creates an Import Request for Prices.
|
|
809
809
|
*/
|
|
810
810
|
post(methodArgs) {
|
|
811
811
|
return new ApiRequest({
|
|
@@ -879,7 +879,7 @@ class ByProjectKeyProductDraftsImportContainersByImportContainerKeyRequestBuilde
|
|
|
879
879
|
this.args = args;
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
|
-
* Creates
|
|
882
|
+
* Creates an Import Request for Products.
|
|
883
883
|
*
|
|
884
884
|
*/
|
|
885
885
|
post(methodArgs) {
|
|
@@ -942,6 +942,80 @@ class ByProjectKeyProductDraftsRequestBuilder {
|
|
|
942
942
|
}
|
|
943
943
|
}
|
|
944
944
|
|
|
945
|
+
/**
|
|
946
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
947
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
948
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
949
|
+
*/
|
|
950
|
+
/**
|
|
951
|
+
**/
|
|
952
|
+
class ByProjectKeyProductSelectionsImportContainersByImportContainerKeyRequestBuilder {
|
|
953
|
+
constructor(args) {
|
|
954
|
+
this.args = args;
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* Creates an Import Request for Product Selections.
|
|
958
|
+
*/
|
|
959
|
+
post(methodArgs) {
|
|
960
|
+
return new ApiRequest({
|
|
961
|
+
baseUri: this.args.baseUri,
|
|
962
|
+
method: 'POST',
|
|
963
|
+
uriTemplate: '/{projectKey}/product-selections/import-containers/{importContainerKey}',
|
|
964
|
+
pathVariables: this.args.pathArgs,
|
|
965
|
+
headers: {
|
|
966
|
+
'Content-Type': 'application/json',
|
|
967
|
+
...methodArgs?.headers
|
|
968
|
+
},
|
|
969
|
+
body: methodArgs?.body
|
|
970
|
+
}, this.args.executeRequest);
|
|
971
|
+
}
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
976
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
977
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
978
|
+
*/
|
|
979
|
+
/**
|
|
980
|
+
**/
|
|
981
|
+
class ByProjectKeyProductSelectionsImportContainersRequestBuilder {
|
|
982
|
+
constructor(args) {
|
|
983
|
+
this.args = args;
|
|
984
|
+
}
|
|
985
|
+
withImportContainerKeyValue(childPathArgs) {
|
|
986
|
+
return new ByProjectKeyProductSelectionsImportContainersByImportContainerKeyRequestBuilder({
|
|
987
|
+
pathArgs: {
|
|
988
|
+
...this.args.pathArgs,
|
|
989
|
+
...childPathArgs
|
|
990
|
+
},
|
|
991
|
+
executeRequest: this.args.executeRequest,
|
|
992
|
+
baseUri: this.args.baseUri
|
|
993
|
+
});
|
|
994
|
+
}
|
|
995
|
+
}
|
|
996
|
+
|
|
997
|
+
/**
|
|
998
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
999
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
1000
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
1001
|
+
*/
|
|
1002
|
+
/**
|
|
1003
|
+
**/
|
|
1004
|
+
class ByProjectKeyProductSelectionsRequestBuilder {
|
|
1005
|
+
constructor(args) {
|
|
1006
|
+
this.args = args;
|
|
1007
|
+
}
|
|
1008
|
+
importContainers() {
|
|
1009
|
+
return new ByProjectKeyProductSelectionsImportContainersRequestBuilder({
|
|
1010
|
+
pathArgs: {
|
|
1011
|
+
...this.args.pathArgs
|
|
1012
|
+
},
|
|
1013
|
+
executeRequest: this.args.executeRequest,
|
|
1014
|
+
baseUri: this.args.baseUri
|
|
1015
|
+
});
|
|
1016
|
+
}
|
|
1017
|
+
}
|
|
1018
|
+
|
|
945
1019
|
/**
|
|
946
1020
|
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
947
1021
|
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
@@ -954,7 +1028,7 @@ class ByProjectKeyProductTypesImportContainersByImportContainerKeyRequestBuilder
|
|
|
954
1028
|
this.args = args;
|
|
955
1029
|
}
|
|
956
1030
|
/**
|
|
957
|
-
* Creates
|
|
1031
|
+
* Creates an Import Request for ProductTypes.
|
|
958
1032
|
*/
|
|
959
1033
|
post(methodArgs) {
|
|
960
1034
|
return new ApiRequest({
|
|
@@ -1028,7 +1102,7 @@ class ByProjectKeyProductVariantPatchesImportContainersByImportContainerKeyReque
|
|
|
1028
1102
|
this.args = args;
|
|
1029
1103
|
}
|
|
1030
1104
|
/**
|
|
1031
|
-
* Creates
|
|
1105
|
+
* Creates an Import Request for updating Product Variants.
|
|
1032
1106
|
* Returns an [InvalidField](ctp:import:type:InvalidFieldError) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
|
|
1033
1107
|
*
|
|
1034
1108
|
*/
|
|
@@ -1104,7 +1178,7 @@ class ByProjectKeyProductVariantsImportContainersByImportContainerKeyRequestBuil
|
|
|
1104
1178
|
this.args = args;
|
|
1105
1179
|
}
|
|
1106
1180
|
/**
|
|
1107
|
-
* Creates
|
|
1181
|
+
* Creates an Import Request for ProductVariants.
|
|
1108
1182
|
*/
|
|
1109
1183
|
post(methodArgs) {
|
|
1110
1184
|
return new ApiRequest({
|
|
@@ -1178,7 +1252,7 @@ class ByProjectKeyProductsImportContainersByImportContainerKeyRequestBuilder {
|
|
|
1178
1252
|
this.args = args;
|
|
1179
1253
|
}
|
|
1180
1254
|
/**
|
|
1181
|
-
* Creates
|
|
1255
|
+
* Creates an Import Request for Products.
|
|
1182
1256
|
*/
|
|
1183
1257
|
post(methodArgs) {
|
|
1184
1258
|
return new ApiRequest({
|
|
@@ -1252,7 +1326,7 @@ class ByProjectKeyStandalonePricesImportContainersByImportContainerKeyRequestBui
|
|
|
1252
1326
|
this.args = args;
|
|
1253
1327
|
}
|
|
1254
1328
|
/**
|
|
1255
|
-
* Creates
|
|
1329
|
+
* Creates an Import Request for Standalone Prices.
|
|
1256
1330
|
*/
|
|
1257
1331
|
post(methodArgs) {
|
|
1258
1332
|
return new ApiRequest({
|
|
@@ -1326,7 +1400,7 @@ class ByProjectKeyTypesImportContainersByImportContainerKeyRequestBuilder {
|
|
|
1326
1400
|
this.args = args;
|
|
1327
1401
|
}
|
|
1328
1402
|
/**
|
|
1329
|
-
* Creates
|
|
1403
|
+
* Creates an Import Request for Types.
|
|
1330
1404
|
*/
|
|
1331
1405
|
post(methodArgs) {
|
|
1332
1406
|
return new ApiRequest({
|
|
@@ -1543,6 +1617,15 @@ class ByProjectKeyRequestBuilder {
|
|
|
1543
1617
|
baseUri: this.args.baseUri
|
|
1544
1618
|
});
|
|
1545
1619
|
}
|
|
1620
|
+
productSelections() {
|
|
1621
|
+
return new ByProjectKeyProductSelectionsRequestBuilder({
|
|
1622
|
+
pathArgs: {
|
|
1623
|
+
...this.args.pathArgs
|
|
1624
|
+
},
|
|
1625
|
+
executeRequest: this.args.executeRequest,
|
|
1626
|
+
baseUri: this.args.baseUri
|
|
1627
|
+
});
|
|
1628
|
+
}
|
|
1546
1629
|
}
|
|
1547
1630
|
|
|
1548
1631
|
class ApiRoot {
|
|
@@ -1605,89 +1688,95 @@ class ApiRoot {
|
|
|
1605
1688
|
*/
|
|
1606
1689
|
|
|
1607
1690
|
/**
|
|
1608
|
-
*
|
|
1691
|
+
* Used by the [Import API](/import-export/overview) to identify a Cart
|
|
1609
1692
|
*/
|
|
1610
1693
|
|
|
1611
1694
|
/**
|
|
1612
|
-
*
|
|
1695
|
+
* Used by the [Import API](/import-export/overview) to identify a CartDiscount.
|
|
1613
1696
|
*/
|
|
1614
1697
|
|
|
1615
1698
|
/**
|
|
1616
|
-
*
|
|
1699
|
+
* Used by the [Import API](/import-export/overview) to identify a Category.
|
|
1617
1700
|
*/
|
|
1618
1701
|
|
|
1619
1702
|
/**
|
|
1620
|
-
*
|
|
1703
|
+
* Used by the [Import API](/import-export/overview) to identify a Channel.
|
|
1621
1704
|
*/
|
|
1622
1705
|
|
|
1623
1706
|
/**
|
|
1624
|
-
*
|
|
1707
|
+
* Used by the [Import API](/import-export/overview) to identify a Customer.
|
|
1625
1708
|
*/
|
|
1626
1709
|
|
|
1627
1710
|
/**
|
|
1628
|
-
*
|
|
1711
|
+
* Used by the [Import API](/import-export/overview) to identify a CustomerGroup.
|
|
1629
1712
|
*/
|
|
1630
1713
|
|
|
1631
1714
|
/**
|
|
1632
|
-
*
|
|
1715
|
+
* Used by the [Import API](/import-export/overview) to identify a CustomObject.
|
|
1633
1716
|
*/
|
|
1634
1717
|
|
|
1635
1718
|
/**
|
|
1636
|
-
*
|
|
1719
|
+
* Used by the [Import API](/import-export/overview) to identify a DiscountCode.
|
|
1637
1720
|
*/
|
|
1638
1721
|
|
|
1639
1722
|
/**
|
|
1640
|
-
* References
|
|
1723
|
+
* References an order by key.
|
|
1641
1724
|
*/
|
|
1642
1725
|
|
|
1643
1726
|
/**
|
|
1644
|
-
*
|
|
1727
|
+
* Used by the [Import API](/import-export/overview) to identify a Payment.
|
|
1645
1728
|
*/
|
|
1646
1729
|
|
|
1647
1730
|
/**
|
|
1648
|
-
*
|
|
1731
|
+
* Used by the [Import API](/import-export/overview) to identify an Embedded Price.
|
|
1649
1732
|
*/
|
|
1650
1733
|
|
|
1651
1734
|
/**
|
|
1652
|
-
*
|
|
1735
|
+
* Used by the [Import API](/import-export/overview) to identify a Product.
|
|
1653
1736
|
*/
|
|
1654
1737
|
|
|
1655
1738
|
/**
|
|
1656
|
-
*
|
|
1739
|
+
* Used by the [Import API](/import-export/overview) to identify a ProductDiscount.
|
|
1657
1740
|
*/
|
|
1658
1741
|
|
|
1659
1742
|
/**
|
|
1660
|
-
*
|
|
1743
|
+
* Used by the [Import API](/import-export/overview) to identify a ProductType.
|
|
1661
1744
|
*/
|
|
1662
1745
|
|
|
1663
1746
|
/**
|
|
1664
|
-
*
|
|
1747
|
+
* Used by the [Import API](/import-export/overview) to identify a ProductVariant.
|
|
1665
1748
|
*/
|
|
1666
1749
|
|
|
1667
1750
|
/**
|
|
1668
|
-
*
|
|
1751
|
+
* Used by the [Import API](/import-export/overview) to identify a ShippingMethod.
|
|
1669
1752
|
*/
|
|
1670
1753
|
|
|
1671
1754
|
/**
|
|
1672
|
-
*
|
|
1755
|
+
* Used by the [Import API](/import-export/overview) to identify a State.
|
|
1673
1756
|
*/
|
|
1674
1757
|
|
|
1675
1758
|
/**
|
|
1676
|
-
*
|
|
1759
|
+
* Used by the [Import API](/import-export/overview) to identify a Store.
|
|
1677
1760
|
*/
|
|
1678
1761
|
|
|
1679
1762
|
/**
|
|
1680
|
-
*
|
|
1763
|
+
* Used by the [Import API](/import-export/overview) to identify a TaxCategory.
|
|
1681
1764
|
*/
|
|
1682
1765
|
|
|
1683
1766
|
/**
|
|
1684
|
-
*
|
|
1767
|
+
* Used by the [Import API](/import-export/overview) to identify a Type.
|
|
1685
1768
|
*/
|
|
1686
1769
|
|
|
1687
1770
|
/**
|
|
1688
|
-
*
|
|
1771
|
+
* Contains a reference to a resource which does not exist. For example, if a Category is imported with a parent Category that does not exist, the reference to the parent Category is an unresolved reference.
|
|
1689
1772
|
*/
|
|
1690
1773
|
|
|
1774
|
+
/**
|
|
1775
|
+
* The type of money.
|
|
1776
|
+
* The `centPrecision` type is used for currencies with minor units, such as EUR and USD.
|
|
1777
|
+
* The `highPrecision` type is used for currencies without minor units, such as JPY.
|
|
1778
|
+
*
|
|
1779
|
+
*/
|
|
1691
1780
|
let MoneyTypeValues = /*#__PURE__*/function (MoneyTypeValues) {
|
|
1692
1781
|
MoneyTypeValues["CentPrecision"] = "centPrecision";
|
|
1693
1782
|
MoneyTypeValues["HighPrecision"] = "highPrecision";
|
|
@@ -1713,6 +1802,7 @@ let ImportResourceTypeValues = /*#__PURE__*/function (ImportResourceTypeValues)
|
|
|
1713
1802
|
ImportResourceTypeValues["Price"] = "price";
|
|
1714
1803
|
ImportResourceTypeValues["Product"] = "product";
|
|
1715
1804
|
ImportResourceTypeValues["ProductDraft"] = "product-draft";
|
|
1805
|
+
ImportResourceTypeValues["ProductSelection"] = "product-selection";
|
|
1716
1806
|
ImportResourceTypeValues["ProductType"] = "product-type";
|
|
1717
1807
|
ImportResourceTypeValues["ProductVariant"] = "product-variant";
|
|
1718
1808
|
ImportResourceTypeValues["ProductVariantPatch"] = "product-variant-patch";
|
|
@@ -1721,7 +1811,7 @@ let ImportResourceTypeValues = /*#__PURE__*/function (ImportResourceTypeValues)
|
|
|
1721
1811
|
return ImportResourceTypeValues;
|
|
1722
1812
|
}({});
|
|
1723
1813
|
/**
|
|
1724
|
-
*
|
|
1814
|
+
* Type of referenced resource.
|
|
1725
1815
|
*
|
|
1726
1816
|
*/
|
|
1727
1817
|
let ReferenceTypeValues = /*#__PURE__*/function (ReferenceTypeValues) {
|
|
@@ -1780,12 +1870,12 @@ let AuthenticationModeValues = /*#__PURE__*/function (AuthenticationModeValues)
|
|
|
1780
1870
|
}({});
|
|
1781
1871
|
|
|
1782
1872
|
/**
|
|
1783
|
-
* Different from [Address](
|
|
1873
|
+
* Different from [Address](ctp:api:type:Address) in that `key` is required and `id` is not supported.
|
|
1784
1874
|
*
|
|
1785
1875
|
*/
|
|
1786
1876
|
|
|
1787
1877
|
/**
|
|
1788
|
-
*
|
|
1878
|
+
* Represents the data used to import a Customer. Once imported, this data is persisted as a [Customer](ctp:api:type:Customer) in the Project.
|
|
1789
1879
|
*
|
|
1790
1880
|
*/
|
|
1791
1881
|
|
|
@@ -1796,7 +1886,49 @@ let AuthenticationModeValues = /*#__PURE__*/function (AuthenticationModeValues)
|
|
|
1796
1886
|
*/
|
|
1797
1887
|
|
|
1798
1888
|
/**
|
|
1799
|
-
*
|
|
1889
|
+
* The strategy of the retention policy. Used to determine how the ImportContainer should be retained.
|
|
1890
|
+
*/
|
|
1891
|
+
let StrategyEnumValues = /*#__PURE__*/function (StrategyEnumValues) {
|
|
1892
|
+
StrategyEnumValues["Ttl"] = "ttl";
|
|
1893
|
+
return StrategyEnumValues;
|
|
1894
|
+
}({});
|
|
1895
|
+
|
|
1896
|
+
/**
|
|
1897
|
+
* The retention policy of the ImportContainer. If not set, the ImportContainer does not expire.
|
|
1898
|
+
*/
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* Set a time to live retention policy for the ImportContainer.
|
|
1902
|
+
*/
|
|
1903
|
+
|
|
1904
|
+
/**
|
|
1905
|
+
* Contains the resources to be imported. Unless `resourceType` is specified, the ImportContainer can import all of the supported [ImportResourceTypes](ctp:import:type:ImportResourceType).
|
|
1906
|
+
*
|
|
1907
|
+
*/
|
|
1908
|
+
|
|
1909
|
+
/**
|
|
1910
|
+
* The representation sent to the server to create an [ImportContainer](#importcontainer).
|
|
1911
|
+
*
|
|
1912
|
+
*/
|
|
1913
|
+
|
|
1914
|
+
/**
|
|
1915
|
+
* The representation sent to the server when updating an ImportContainer.
|
|
1916
|
+
*
|
|
1917
|
+
*/
|
|
1918
|
+
|
|
1919
|
+
/**
|
|
1920
|
+
* [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ImportContainer](ctp:import:type:ImportContainer).
|
|
1921
|
+
*
|
|
1922
|
+
*/
|
|
1923
|
+
|
|
1924
|
+
/**
|
|
1925
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
1926
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
1927
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
1928
|
+
*/
|
|
1929
|
+
|
|
1930
|
+
/**
|
|
1931
|
+
* Represents the import status of a resource.
|
|
1800
1932
|
*
|
|
1801
1933
|
*/
|
|
1802
1934
|
|
|
@@ -1816,7 +1948,7 @@ let ImportOperationStateValues = /*#__PURE__*/function (ImportOperationStateValu
|
|
|
1816
1948
|
}({});
|
|
1817
1949
|
|
|
1818
1950
|
/**
|
|
1819
|
-
* The
|
|
1951
|
+
* The status of a new [ImportOperation](#importoperation).
|
|
1820
1952
|
*/
|
|
1821
1953
|
|
|
1822
1954
|
/**
|
|
@@ -1842,8 +1974,7 @@ let ReturnShipmentStateValues = /*#__PURE__*/function (ReturnShipmentStateValues
|
|
|
1842
1974
|
*/
|
|
1843
1975
|
|
|
1844
1976
|
/**
|
|
1845
|
-
*
|
|
1846
|
-
* [Orders](ctp:api:type:Order) in a Project.
|
|
1977
|
+
* Represents the data used to update an [Order](ctp:api:type:Order) in a Project.
|
|
1847
1978
|
*
|
|
1848
1979
|
*/
|
|
1849
1980
|
|
|
@@ -1854,13 +1985,12 @@ let ReturnShipmentStateValues = /*#__PURE__*/function (ReturnShipmentStateValues
|
|
|
1854
1985
|
*/
|
|
1855
1986
|
|
|
1856
1987
|
/**
|
|
1857
|
-
*
|
|
1988
|
+
* Determines the address (as a reference to an address in `itemShippingAddresses`) and the quantity shipped to the address.
|
|
1858
1989
|
*
|
|
1859
1990
|
*/
|
|
1860
1991
|
|
|
1861
1992
|
/**
|
|
1862
|
-
* The
|
|
1863
|
-
*
|
|
1993
|
+
* The sum of the `targets` must match the quantity of the Line Items or Custom Line Items
|
|
1864
1994
|
*/
|
|
1865
1995
|
|
|
1866
1996
|
/**
|
|
@@ -1885,8 +2015,7 @@ let ShippingMethodStateValues = /*#__PURE__*/function (ShippingMethodStateValues
|
|
|
1885
2015
|
}({});
|
|
1886
2016
|
|
|
1887
2017
|
/**
|
|
1888
|
-
* Maps to an
|
|
1889
|
-
* the order, but when importing orders you must provide a draft representation as a part of the OrderImport.
|
|
2018
|
+
* Maps to an Order's `shippingInfo` property. This field is usually populated by the Cart associated with the Order, but when importing Orders you must provide a draft representation as a part of the OrderImport.
|
|
1890
2019
|
*
|
|
1891
2020
|
*/
|
|
1892
2021
|
|
|
@@ -1985,9 +2114,7 @@ let ShippingRateInputTypeValues = /*#__PURE__*/function (ShippingRateInputTypeVa
|
|
|
1985
2114
|
}({});
|
|
1986
2115
|
|
|
1987
2116
|
/**
|
|
1988
|
-
*
|
|
1989
|
-
*
|
|
1990
|
-
* In commercetools, you can import an Order using the [Create Order by Import](/projects/orders-import#create-order-by-import) endpoint method instead of creating it from a Cart.
|
|
2117
|
+
* Represents the data used to import an Order. Once imported, this data is persisted as an [Order](ctp:api:type:Order) in the Project.
|
|
1991
2118
|
*
|
|
1992
2119
|
* An OrderImport is a snapshot of an order at the time it was imported.
|
|
1993
2120
|
*
|
|
@@ -1999,6 +2126,54 @@ let ShippingRateInputTypeValues = /*#__PURE__*/function (ShippingRateInputTypeVa
|
|
|
1999
2126
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
2000
2127
|
*/
|
|
2001
2128
|
|
|
2129
|
+
/**
|
|
2130
|
+
* Defines how variants are selected for the product.
|
|
2131
|
+
*
|
|
2132
|
+
*/
|
|
2133
|
+
let VariantSelectionTypeValues = /*#__PURE__*/function (VariantSelectionTypeValues) {
|
|
2134
|
+
VariantSelectionTypeValues["IncludeAllExcept"] = "includeAllExcept";
|
|
2135
|
+
VariantSelectionTypeValues["IncludeOnly"] = "includeOnly";
|
|
2136
|
+
return VariantSelectionTypeValues;
|
|
2137
|
+
}({});
|
|
2138
|
+
|
|
2139
|
+
/**
|
|
2140
|
+
* Variant selection specifying how variants are included or excluded.
|
|
2141
|
+
*
|
|
2142
|
+
*/
|
|
2143
|
+
|
|
2144
|
+
/**
|
|
2145
|
+
* Defines which Variants of the Product will be excluded from the Product Selection. If not supplied all Variants are deemed to be excluded.
|
|
2146
|
+
*
|
|
2147
|
+
*/
|
|
2148
|
+
|
|
2149
|
+
/**
|
|
2150
|
+
* An assignment of a product and either variantSelection or variantExclusion (not both).
|
|
2151
|
+
*
|
|
2152
|
+
*/
|
|
2153
|
+
|
|
2154
|
+
/**
|
|
2155
|
+
* Product Selections can have the following modes:
|
|
2156
|
+
* - `Individual`: Products must be explicitly assigned.
|
|
2157
|
+
* - `IndividualExclusion`: Products are included unless explicitly excluded.
|
|
2158
|
+
*
|
|
2159
|
+
*/
|
|
2160
|
+
let ProductSelectionModeValues = /*#__PURE__*/function (ProductSelectionModeValues) {
|
|
2161
|
+
ProductSelectionModeValues["Individual"] = "Individual";
|
|
2162
|
+
ProductSelectionModeValues["IndividualExclusion"] = "IndividualExclusion";
|
|
2163
|
+
return ProductSelectionModeValues;
|
|
2164
|
+
}({});
|
|
2165
|
+
|
|
2166
|
+
/**
|
|
2167
|
+
* Represents the data used to import a ProductSelection. Once imported, this data is persisted as a [ProductSelection](ctp:api:type:ProductSelection) in the Project.
|
|
2168
|
+
*
|
|
2169
|
+
*/
|
|
2170
|
+
|
|
2171
|
+
/**
|
|
2172
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
2173
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
2174
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
2175
|
+
*/
|
|
2176
|
+
|
|
2002
2177
|
let AttributeLevelValues = /*#__PURE__*/function (AttributeLevelValues) {
|
|
2003
2178
|
AttributeLevelValues["Product"] = "Product";
|
|
2004
2179
|
AttributeLevelValues["Variant"] = "Variant";
|
|
@@ -2018,7 +2193,7 @@ let TextInputHintValues = /*#__PURE__*/function (TextInputHintValues) {
|
|
|
2018
2193
|
}({});
|
|
2019
2194
|
|
|
2020
2195
|
/**
|
|
2021
|
-
*
|
|
2196
|
+
* Represents the data used to import a ProductType. Once imported, this data is persisted as a [ProductType](ctp:api:type:ProductType) in the Project.
|
|
2022
2197
|
*
|
|
2023
2198
|
*/
|
|
2024
2199
|
|
|
@@ -2029,7 +2204,7 @@ let TextInputHintValues = /*#__PURE__*/function (TextInputHintValues) {
|
|
|
2029
2204
|
*/
|
|
2030
2205
|
|
|
2031
2206
|
/**
|
|
2032
|
-
* Provides a visual representation type for this field. It is only relevant for string-based field types like [CustomFieldStringType](ctp:
|
|
2207
|
+
* Provides a visual representation type for this field. It is only relevant for string-based field types like [CustomFieldStringType](ctp:api:type:CustomFieldStringType) and [CustomFieldLocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType).
|
|
2033
2208
|
*
|
|
2034
2209
|
*/
|
|
2035
2210
|
let TypeTextInputHintValues = /*#__PURE__*/function (TypeTextInputHintValues) {
|
|
@@ -2075,6 +2250,12 @@ let ResourceTypeIdValues = /*#__PURE__*/function (ResourceTypeIdValues) {
|
|
|
2075
2250
|
return ResourceTypeIdValues;
|
|
2076
2251
|
}({});
|
|
2077
2252
|
|
|
2253
|
+
/**
|
|
2254
|
+
* Defines the data type of a Custom Field. Maps to `Type.FieldDefinition.type`.
|
|
2255
|
+
* The `discriminator` is used to determine the type of the field.
|
|
2256
|
+
*
|
|
2257
|
+
*/
|
|
2258
|
+
|
|
2078
2259
|
/**
|
|
2079
2260
|
* Field type for Boolean values.
|
|
2080
2261
|
*/
|
|
@@ -2159,7 +2340,7 @@ let CustomFieldReferenceValueValues = /*#__PURE__*/function (CustomFieldReferenc
|
|
|
2159
2340
|
*/
|
|
2160
2341
|
|
|
2161
2342
|
/**
|
|
2162
|
-
*
|
|
2343
|
+
* Represents the data used to import a Type. Once imported, this data is persisted as a [Type](ctp:api:type:Type) in the Project.
|
|
2163
2344
|
*
|
|
2164
2345
|
*/
|
|
2165
2346
|
|
|
@@ -2225,6 +2406,9 @@ exports.ByProjectKeyPricesRequestBuilder = ByProjectKeyPricesRequestBuilder;
|
|
|
2225
2406
|
exports.ByProjectKeyProductDraftsImportContainersByImportContainerKeyRequestBuilder = ByProjectKeyProductDraftsImportContainersByImportContainerKeyRequestBuilder;
|
|
2226
2407
|
exports.ByProjectKeyProductDraftsImportContainersRequestBuilder = ByProjectKeyProductDraftsImportContainersRequestBuilder;
|
|
2227
2408
|
exports.ByProjectKeyProductDraftsRequestBuilder = ByProjectKeyProductDraftsRequestBuilder;
|
|
2409
|
+
exports.ByProjectKeyProductSelectionsImportContainersByImportContainerKeyRequestBuilder = ByProjectKeyProductSelectionsImportContainersByImportContainerKeyRequestBuilder;
|
|
2410
|
+
exports.ByProjectKeyProductSelectionsImportContainersRequestBuilder = ByProjectKeyProductSelectionsImportContainersRequestBuilder;
|
|
2411
|
+
exports.ByProjectKeyProductSelectionsRequestBuilder = ByProjectKeyProductSelectionsRequestBuilder;
|
|
2228
2412
|
exports.ByProjectKeyProductTypesImportContainersByImportContainerKeyRequestBuilder = ByProjectKeyProductTypesImportContainersByImportContainerKeyRequestBuilder;
|
|
2229
2413
|
exports.ByProjectKeyProductTypesImportContainersRequestBuilder = ByProjectKeyProductTypesImportContainersRequestBuilder;
|
|
2230
2414
|
exports.ByProjectKeyProductTypesRequestBuilder = ByProjectKeyProductTypesRequestBuilder;
|
|
@@ -2255,6 +2439,7 @@ exports.OrderStateValues = OrderStateValues;
|
|
|
2255
2439
|
exports.PaymentStateValues = PaymentStateValues;
|
|
2256
2440
|
exports.ProcessingStateValues = ProcessingStateValues;
|
|
2257
2441
|
exports.ProductPriceModeEnumValues = ProductPriceModeEnumValues;
|
|
2442
|
+
exports.ProductSelectionModeValues = ProductSelectionModeValues;
|
|
2258
2443
|
exports.ReferenceTypeValues = ReferenceTypeValues;
|
|
2259
2444
|
exports.ResourceTypeIdValues = ResourceTypeIdValues;
|
|
2260
2445
|
exports.ReturnShipmentStateValues = ReturnShipmentStateValues;
|
|
@@ -2263,10 +2448,12 @@ exports.ShipmentStateValues = ShipmentStateValues;
|
|
|
2263
2448
|
exports.ShippingMethodStateValues = ShippingMethodStateValues;
|
|
2264
2449
|
exports.ShippingRateInputTypeValues = ShippingRateInputTypeValues;
|
|
2265
2450
|
exports.ShippingRateTierTypeValues = ShippingRateTierTypeValues;
|
|
2451
|
+
exports.StrategyEnumValues = StrategyEnumValues;
|
|
2266
2452
|
exports.TaxCalculationModeValues = TaxCalculationModeValues;
|
|
2267
2453
|
exports.TaxModeValues = TaxModeValues;
|
|
2268
2454
|
exports.TextInputHintValues = TextInputHintValues;
|
|
2269
2455
|
exports.TypeTextInputHintValues = TypeTextInputHintValues;
|
|
2456
|
+
exports.VariantSelectionTypeValues = VariantSelectionTypeValues;
|
|
2270
2457
|
exports.buildRelativeUri = buildRelativeUri;
|
|
2271
2458
|
exports.createApiBuilderFromCtpClient = createApiBuilderFromCtpClient;
|
|
2272
2459
|
exports.createExecutorFromMiddlewares = createExecutorFromMiddlewares;
|