@commercetools/importapi-sdk 1.18.0 → 2.0.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.
Files changed (111) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/README.md +100 -18
  3. package/dist/commercetools-importapi-sdk.browser.cjs.js +2390 -1516
  4. package/dist/commercetools-importapi-sdk.browser.esm.js +2390 -1516
  5. package/dist/commercetools-importapi-sdk.cjs.dev.js +2390 -1516
  6. package/dist/commercetools-importapi-sdk.cjs.prod.js +2390 -1516
  7. package/dist/commercetools-importapi-sdk.esm.js +2390 -1516
  8. package/dist/declarations/src/ctp/ctp-client.d.ts +2 -2
  9. package/dist/declarations/src/generated/client/api-root.d.ts +18 -25
  10. package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +52 -55
  11. package/dist/declarations/src/generated/client/categories/by-project-key-categories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  12. package/dist/declarations/src/generated/client/categories/by-project-key-categories-request-builder.d.ts +28 -33
  13. package/dist/declarations/src/generated/client/customers/by-project-key-customers-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  14. package/dist/declarations/src/generated/client/customers/by-project-key-customers-request-builder.d.ts +28 -33
  15. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  16. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-request-builder.d.ts +26 -0
  17. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  18. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-request-builder.d.ts +26 -0
  19. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +55 -0
  20. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +51 -0
  21. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  22. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-request-builder.d.ts +26 -0
  23. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  24. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-request-builder.d.ts +26 -0
  25. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  26. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-request-builder.d.ts +26 -0
  27. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  28. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-request-builder.d.ts +26 -0
  29. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-by-import-container-key-request-builder.d.ts +36 -0
  30. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-request-builder.d.ts +26 -0
  31. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  32. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-request-builder.d.ts +26 -0
  33. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  34. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-request-builder.d.ts +26 -0
  35. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  36. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-request-builder.d.ts +26 -0
  37. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  38. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-request-builder.d.ts +26 -0
  39. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  40. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +49 -56
  41. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  42. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  43. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-containers-by-import-container-key-import-operations-request-builder.d.ts +45 -0
  44. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +35 -0
  45. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-request-builder.d.ts +26 -0
  46. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  47. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  48. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  49. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  50. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  51. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  52. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  53. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  54. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  55. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  56. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  57. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  58. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  59. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -55
  60. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  61. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -55
  62. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -44
  63. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -56
  64. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-by-import-sink-key-request-builder.d.ts +51 -58
  65. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-request-builder.d.ts +51 -58
  66. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-containers-by-import-container-key-import-summaries-request-builder.d.ts +35 -0
  67. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  68. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-request-builder.d.ts +26 -33
  69. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  70. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-request-builder.d.ts +28 -33
  71. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  72. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-request-builder.d.ts +28 -33
  73. package/dist/declarations/src/generated/client/orders/by-project-key-orders-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  74. package/dist/declarations/src/generated/client/orders/by-project-key-orders-request-builder.d.ts +28 -33
  75. package/dist/declarations/src/generated/client/prices/by-project-key-prices-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  76. package/dist/declarations/src/generated/client/prices/by-project-key-prices-request-builder.d.ts +28 -33
  77. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-import-sink-key-by-import-sink-key-request-builder.d.ts +38 -45
  78. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-request-builder.d.ts +28 -33
  79. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  80. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-request-builder.d.ts +28 -33
  81. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  82. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-request-builder.d.ts +28 -33
  83. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  84. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-request-builder.d.ts +28 -33
  85. package/dist/declarations/src/generated/client/products/by-project-key-products-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  86. package/dist/declarations/src/generated/client/products/by-project-key-products-request-builder.d.ts +28 -33
  87. package/dist/declarations/src/generated/index.d.ts +26 -32
  88. package/dist/declarations/src/generated/models/categories.d.ts +79 -86
  89. package/dist/declarations/src/generated/models/common.d.ts +570 -551
  90. package/dist/declarations/src/generated/models/customers.d.ts +252 -259
  91. package/dist/declarations/src/generated/models/customfields.d.ts +260 -267
  92. package/dist/declarations/src/generated/models/errors.d.ts +356 -359
  93. package/dist/declarations/src/generated/models/importcontainers.d.ts +114 -0
  94. package/dist/declarations/src/generated/models/importoperations.d.ts +128 -136
  95. package/dist/declarations/src/generated/models/importrequests.d.ts +175 -182
  96. package/dist/declarations/src/generated/models/importsinks.d.ts +113 -120
  97. package/dist/declarations/src/generated/models/importsummaries.d.ts +55 -57
  98. package/dist/declarations/src/generated/models/inventories.d.ts +44 -51
  99. package/dist/declarations/src/generated/models/order-patches.d.ts +227 -234
  100. package/dist/declarations/src/generated/models/orders.d.ts +778 -785
  101. package/dist/declarations/src/generated/models/prices.d.ts +130 -137
  102. package/dist/declarations/src/generated/models/productdrafts.d.ts +226 -231
  103. package/dist/declarations/src/generated/models/products.d.ts +181 -186
  104. package/dist/declarations/src/generated/models/producttypes.d.ts +173 -180
  105. package/dist/declarations/src/generated/models/productvariants.d.ts +529 -534
  106. package/dist/declarations/src/generated/shared/utils/common-types.d.ts +26 -33
  107. package/dist/declarations/src/generated/shared/utils/middleware.d.ts +8 -15
  108. package/dist/declarations/src/generated/shared/utils/requests-utils.d.ts +13 -20
  109. package/dist/declarations/src/generated/shared/utils/uri-utils.d.ts +7 -14
  110. package/dist/declarations/src/index.d.ts +2 -2
  111. package/package.json +8 -6
@@ -1,57 +1,55 @@
1
- /**
2
- *
3
- * Generated file, please do not change!!!
4
- * From http://www.commercetools.com/ with love
5
- *
6
- * ,d88b.d88b,
7
- * 88888888888
8
- * `Y8888888Y'
9
- * `Y888Y'
10
- * `Y'
11
- *
12
- */
13
- /**
14
- * Describes the status of an [ImportSink](/import-sink#importsink) by the number of resources in each [Processing State](/processing-state#the-list-of-processing-states).
15
- * Can be used to monitor the import progress per [Import Sink](/import-sink).
16
- *
17
- */
18
- export interface ImportSummary {
19
- /**
20
- * The import status of an [ImportSink](/import-sink#importsink) given by the number of resources in each [Processing State](/processing-state#the-list-of-processing-states).
21
- *
22
- *
23
- */
24
- readonly states: OperationStates;
25
- /**
26
- * The total number of [ImportOperations](/import-operation#importoperation) received for this Import Summary.
27
- *
28
- */
29
- readonly total: number;
30
- }
31
- export interface OperationStates {
32
- /**
33
- * The number of resources in the `ValidationFailed` state.
34
- *
35
- */
36
- readonly ValidationFailed: number;
37
- /**
38
- * The number of resources in the `Unresolved` state.
39
- *
40
- */
41
- readonly Unresolved: number;
42
- /**
43
- * The number of resources in the `WaitForMasterVariant` state.
44
- *
45
- */
46
- readonly WaitForMasterVariant: number;
47
- /**
48
- * The number of resources in the `Imported` state.
49
- *
50
- */
51
- readonly Imported: number;
52
- /**
53
- * The number of resources in the `Rejected` state.
54
- *
55
- */
56
- readonly Rejected: number;
57
- }
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ /**
7
+ * Describes the status of an [ImportContainer](/import-container#importcontainer) by the number of resources in each [Processing State](/processing-state#processingState).
8
+ * Can be used to monitor the import progress per [Import Container](/import-container).
9
+ *
10
+ */
11
+ export interface ImportSummary {
12
+ /**
13
+ * The import status of an [ImportContainer](/import-container#importcontainer) given by the number of resources in each [Processing State](/processing-state#processingState).
14
+ *
15
+ *
16
+ */
17
+ readonly states: OperationStates;
18
+ /**
19
+ * The total number of [ImportOperations](/import-operation#importoperation) received for this Import Summary.
20
+ *
21
+ */
22
+ readonly total: number;
23
+ }
24
+ export interface OperationStates {
25
+ /**
26
+ * The number of resources in the `processing` state.
27
+ *
28
+ */
29
+ readonly processing: number;
30
+ /**
31
+ * The number of resources in the `validationFailed` state.
32
+ *
33
+ */
34
+ readonly validationFailed: number;
35
+ /**
36
+ * The number of resources in the `unresolved` state.
37
+ *
38
+ */
39
+ readonly unresolved: number;
40
+ /**
41
+ * The number of resources in the `waitForMasterVariant` state.
42
+ *
43
+ */
44
+ readonly waitForMasterVariant: number;
45
+ /**
46
+ * The number of resources in the `imported` state.
47
+ *
48
+ */
49
+ readonly imported: number;
50
+ /**
51
+ * The number of resources in the `rejected` state.
52
+ *
53
+ */
54
+ readonly rejected: number;
55
+ }
@@ -1,51 +1,44 @@
1
- /**
2
- *
3
- * Generated file, please do not change!!!
4
- * From http://www.commercetools.com/ with love
5
- *
6
- * ,d88b.d88b,
7
- * 88888888888
8
- * `Y8888888Y'
9
- * `Y888Y'
10
- * `Y'
11
- *
12
- */
13
- import { ChannelKeyReference, ImportResource } from './common';
14
- import { Custom } from './customfields';
15
- /**
16
- * The data representation for an Inventory to be imported that is persisted as a [Inventory](/../api/projects/inventory#top) in the Project.
17
- *
18
- */
19
- export interface InventoryImport extends ImportResource {
20
- /**
21
- *
22
- */
23
- readonly sku: string;
24
- /**
25
- * Maps to `Inventory.quantityOnStock`
26
- *
27
- *
28
- */
29
- readonly quantityOnStock: number;
30
- /**
31
- * Maps to `Inventory.restockableInDays`
32
- *
33
- *
34
- */
35
- readonly restockableInDays?: number;
36
- /**
37
- *
38
- */
39
- readonly expectedDelivery?: string;
40
- /**
41
- * References a channel by its key.
42
- *
43
- */
44
- readonly supplyChannel?: ChannelKeyReference;
45
- /**
46
- * Maps to `Inventory.custom`.
47
- *
48
- *
49
- */
50
- readonly custom?: Custom;
51
- }
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ import { ChannelKeyReference, ImportResource } from './common';
7
+ import { Custom } from './customfields';
8
+ /**
9
+ * The data representation for an Inventory to be imported that is persisted as a [Inventory](/../api/projects/inventory#top) in the Project.
10
+ *
11
+ */
12
+ export interface InventoryImport extends ImportResource {
13
+ /**
14
+ *
15
+ */
16
+ readonly sku: string;
17
+ /**
18
+ * Maps to `Inventory.quantityOnStock`
19
+ *
20
+ *
21
+ */
22
+ readonly quantityOnStock: number;
23
+ /**
24
+ * Maps to `Inventory.restockableInDays`
25
+ *
26
+ *
27
+ */
28
+ readonly restockableInDays?: number;
29
+ /**
30
+ *
31
+ */
32
+ readonly expectedDelivery?: string;
33
+ /**
34
+ * References a channel by key.
35
+ *
36
+ */
37
+ readonly supplyChannel?: ChannelKeyReference;
38
+ /**
39
+ * Maps to `Inventory.custom`.
40
+ *
41
+ *
42
+ */
43
+ readonly custom?: Custom;
44
+ }
@@ -1,234 +1,227 @@
1
- /**
2
- *
3
- * Generated file, please do not change!!!
4
- * From http://www.commercetools.com/ with love
5
- *
6
- * ,d88b.d88b,
7
- * 88888888888
8
- * `Y8888888Y'
9
- * `Y888Y'
10
- * `Y'
11
- *
12
- */
13
- import { Address } from './common';
14
- import { DeliveryItem, ParcelMeasurements, TrackingData } from './orders';
15
- /**
16
- * Maps to `ReturnItem.shipmentState`
17
- */
18
- export declare type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable';
19
- export interface ReturnItemDraft {
20
- /**
21
- *
22
- */
23
- readonly quantity: number;
24
- /**
25
- *
26
- */
27
- readonly lineItemId?: string;
28
- /**
29
- *
30
- */
31
- readonly customLineItemId?: string;
32
- /**
33
- *
34
- */
35
- readonly comment?: string;
36
- /**
37
- * Maps to `ReturnItem.shipmentState`
38
- *
39
- */
40
- readonly shipmentState: ReturnShipmentState;
41
- }
42
- export interface ReturnInfo {
43
- /**
44
- *
45
- */
46
- readonly items: ReturnItemDraft[];
47
- /**
48
- * Maps to `ReturnInfo.returnTrackingId`
49
- *
50
- */
51
- readonly returnTrackingId?: string;
52
- /**
53
- * Maps to `ReturnInfo.returnDate`
54
- *
55
- */
56
- readonly returnDate?: string;
57
- }
58
- export interface DeliveryParcel {
59
- /**
60
- *
61
- */
62
- readonly deliveryId: string;
63
- /**
64
- *
65
- */
66
- readonly measurements?: ParcelMeasurements;
67
- /**
68
- *
69
- */
70
- readonly trackingData?: TrackingData;
71
- /**
72
- *
73
- */
74
- readonly items?: DeliveryItem[];
75
- }
76
- export interface DeliveryParcelDraft {
77
- /**
78
- *
79
- */
80
- readonly measurements?: ParcelMeasurements;
81
- /**
82
- *
83
- */
84
- readonly trackingData?: TrackingData;
85
- /**
86
- *
87
- */
88
- readonly items?: DeliveryItem[];
89
- }
90
- export interface DeliveryDraft {
91
- /**
92
- *
93
- */
94
- readonly items: DeliveryItem[];
95
- /**
96
- *
97
- */
98
- readonly address?: Address;
99
- /**
100
- *
101
- */
102
- readonly parcels: DeliveryParcelDraft[];
103
- }
104
- export interface DeliveryAddressDraft {
105
- /**
106
- *
107
- */
108
- readonly deliveryId: string;
109
- /**
110
- *
111
- */
112
- readonly address?: Address;
113
- }
114
- export interface ParcelMeasurementDraft {
115
- /**
116
- *
117
- */
118
- readonly parcelId: string;
119
- /**
120
- *
121
- */
122
- readonly measurements?: ParcelMeasurements;
123
- }
124
- export interface ParcelTrackingData {
125
- /**
126
- *
127
- */
128
- readonly parcelId: string;
129
- /**
130
- *
131
- */
132
- readonly trackingData?: TrackingData;
133
- }
134
- export interface ParcelItems {
135
- /**
136
- *
137
- */
138
- readonly parcelId: string;
139
- /**
140
- *
141
- */
142
- readonly items?: DeliveryItem[];
143
- }
144
- export interface RemoveDeliveryDraft {
145
- /**
146
- *
147
- */
148
- readonly id: string;
149
- }
150
- export interface RemoveParcelFromDeliveryDraft {
151
- /**
152
- *
153
- */
154
- readonly parcelId: string;
155
- }
156
- /**
157
- * Order fields that needs to be added or updated.
158
- *
159
- */
160
- export interface OrderField {
161
- /**
162
- * Maps to `Order.returnInfo`
163
- *
164
- *
165
- */
166
- readonly addReturnInfo?: ReturnInfo;
167
- /**
168
- * Maps to `Order.delivery`
169
- *
170
- *
171
- */
172
- readonly addParcelToDelivery?: DeliveryParcel;
173
- /**
174
- * Maps to `Order.delivery`
175
- *
176
- *
177
- */
178
- readonly addDeliveries?: DeliveryDraft[];
179
- /**
180
- * Maps to `Order.removeDelivery`
181
- *
182
- *
183
- */
184
- readonly removeDelivery?: RemoveDeliveryDraft;
185
- /**
186
- * Maps to `Order.removeParcelFromDelivery`
187
- *
188
- *
189
- */
190
- readonly removeParcelFromDelivery?: RemoveParcelFromDeliveryDraft;
191
- /**
192
- * Maps to `Order.addressDraft`
193
- *
194
- *
195
- */
196
- readonly setDeliveryAddress?: DeliveryAddressDraft;
197
- /**
198
- * Maps to `Order.parcelMeasurements`
199
- *
200
- *
201
- */
202
- readonly setParcelMeasurements?: ParcelMeasurementDraft;
203
- /**
204
- * Maps to `Order.parcelTrackingData`
205
- *
206
- *
207
- */
208
- readonly setParcelTrackingData?: ParcelTrackingData;
209
- /**
210
- * Maps to `Order.parcelItems`
211
- *
212
- *
213
- */
214
- readonly setParcelItems?: ParcelItems[];
215
- }
216
- /**
217
- * Representation for an update of an [Order](/../api/projects/orders#order). Use this type to import updates for existing
218
- * [Orders](/../api/projects/orders#order) in a commercetools Project.
219
- *
220
- */
221
- export interface OrderPatchImport {
222
- /**
223
- * Maps to `Order.orderNumber`, String that uniquely identifies an order, unique across a project.
224
- *
225
- *
226
- */
227
- readonly orderNumber: string;
228
- /**
229
- * Each field referenced must be defined in an already existing order in the commercetools project or the import operation state is set to `ValidationFailed`.
230
- *
231
- *
232
- */
233
- readonly fields: OrderField;
234
- }
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ import { Address } from './common';
7
+ import { DeliveryItem, ParcelMeasurements, TrackingData } from './orders';
8
+ /**
9
+ * Maps to `ReturnItem.shipmentState`
10
+ */
11
+ export declare type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable';
12
+ export interface ReturnItemDraft {
13
+ /**
14
+ *
15
+ */
16
+ readonly quantity: number;
17
+ /**
18
+ *
19
+ */
20
+ readonly lineItemId?: string;
21
+ /**
22
+ *
23
+ */
24
+ readonly customLineItemId?: string;
25
+ /**
26
+ *
27
+ */
28
+ readonly comment?: string;
29
+ /**
30
+ * Maps to `ReturnItem.shipmentState`
31
+ *
32
+ */
33
+ readonly shipmentState: ReturnShipmentState;
34
+ }
35
+ export interface ReturnInfo {
36
+ /**
37
+ *
38
+ */
39
+ readonly items: ReturnItemDraft[];
40
+ /**
41
+ * Maps to `ReturnInfo.returnTrackingId`
42
+ *
43
+ */
44
+ readonly returnTrackingId?: string;
45
+ /**
46
+ * Maps to `ReturnInfo.returnDate`
47
+ *
48
+ */
49
+ readonly returnDate?: string;
50
+ }
51
+ export interface DeliveryParcel {
52
+ /**
53
+ *
54
+ */
55
+ readonly deliveryId: string;
56
+ /**
57
+ *
58
+ */
59
+ readonly measurements?: ParcelMeasurements;
60
+ /**
61
+ *
62
+ */
63
+ readonly trackingData?: TrackingData;
64
+ /**
65
+ *
66
+ */
67
+ readonly items?: DeliveryItem[];
68
+ }
69
+ export interface DeliveryParcelDraft {
70
+ /**
71
+ *
72
+ */
73
+ readonly measurements?: ParcelMeasurements;
74
+ /**
75
+ *
76
+ */
77
+ readonly trackingData?: TrackingData;
78
+ /**
79
+ *
80
+ */
81
+ readonly items?: DeliveryItem[];
82
+ }
83
+ export interface DeliveryDraft {
84
+ /**
85
+ *
86
+ */
87
+ readonly items: DeliveryItem[];
88
+ /**
89
+ *
90
+ */
91
+ readonly address?: Address;
92
+ /**
93
+ *
94
+ */
95
+ readonly parcels: DeliveryParcelDraft[];
96
+ }
97
+ export interface DeliveryAddressDraft {
98
+ /**
99
+ *
100
+ */
101
+ readonly deliveryId: string;
102
+ /**
103
+ *
104
+ */
105
+ readonly address?: Address;
106
+ }
107
+ export interface ParcelMeasurementDraft {
108
+ /**
109
+ *
110
+ */
111
+ readonly parcelId: string;
112
+ /**
113
+ *
114
+ */
115
+ readonly measurements?: ParcelMeasurements;
116
+ }
117
+ export interface ParcelTrackingData {
118
+ /**
119
+ *
120
+ */
121
+ readonly parcelId: string;
122
+ /**
123
+ *
124
+ */
125
+ readonly trackingData?: TrackingData;
126
+ }
127
+ export interface ParcelItems {
128
+ /**
129
+ *
130
+ */
131
+ readonly parcelId: string;
132
+ /**
133
+ *
134
+ */
135
+ readonly items?: DeliveryItem[];
136
+ }
137
+ export interface RemoveDeliveryDraft {
138
+ /**
139
+ *
140
+ */
141
+ readonly id: string;
142
+ }
143
+ export interface RemoveParcelFromDeliveryDraft {
144
+ /**
145
+ *
146
+ */
147
+ readonly parcelId: string;
148
+ }
149
+ /**
150
+ * Order fields that needs to be added or updated.
151
+ *
152
+ */
153
+ export interface OrderField {
154
+ /**
155
+ * Maps to `Order.returnInfo`
156
+ *
157
+ *
158
+ */
159
+ readonly addReturnInfo?: ReturnInfo;
160
+ /**
161
+ * Maps to `Order.delivery`
162
+ *
163
+ *
164
+ */
165
+ readonly addParcelToDelivery?: DeliveryParcel;
166
+ /**
167
+ * Maps to `Order.delivery`
168
+ *
169
+ *
170
+ */
171
+ readonly addDeliveries?: DeliveryDraft[];
172
+ /**
173
+ * Maps to `Order.removeDelivery`
174
+ *
175
+ *
176
+ */
177
+ readonly removeDelivery?: RemoveDeliveryDraft;
178
+ /**
179
+ * Maps to `Order.removeParcelFromDelivery`
180
+ *
181
+ *
182
+ */
183
+ readonly removeParcelFromDelivery?: RemoveParcelFromDeliveryDraft;
184
+ /**
185
+ * Maps to `Order.addressDraft`
186
+ *
187
+ *
188
+ */
189
+ readonly setDeliveryAddress?: DeliveryAddressDraft;
190
+ /**
191
+ * Maps to `Order.parcelMeasurements`
192
+ *
193
+ *
194
+ */
195
+ readonly setParcelMeasurements?: ParcelMeasurementDraft;
196
+ /**
197
+ * Maps to `Order.parcelTrackingData`
198
+ *
199
+ *
200
+ */
201
+ readonly setParcelTrackingData?: ParcelTrackingData;
202
+ /**
203
+ * Maps to `Order.parcelItems`
204
+ *
205
+ *
206
+ */
207
+ readonly setParcelItems?: ParcelItems[];
208
+ }
209
+ /**
210
+ * Representation for an update of an [Order](/../api/projects/orders#order). Use this type to import updates for existing
211
+ * [Orders](/../api/projects/orders#order) in a commercetools Project.
212
+ *
213
+ */
214
+ export interface OrderPatchImport {
215
+ /**
216
+ * Maps to `Order.orderNumber`, String that uniquely identifies an order, unique across a project.
217
+ *
218
+ *
219
+ */
220
+ readonly orderNumber: string;
221
+ /**
222
+ * Each field referenced must be defined in an already existing order in the commercetools project or the import operation state is set to `validationFailed`.
223
+ *
224
+ *
225
+ */
226
+ readonly fields: OrderField;
227
+ }