@commercetools/importapi-sdk 1.17.1 → 1.21.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 (124) hide show
  1. package/CHANGELOG.md +40 -1
  2. package/dist/commercetools-importapi-sdk.browser.cjs.js +2781 -0
  3. package/dist/commercetools-importapi-sdk.browser.esm.js +2775 -0
  4. package/dist/commercetools-importapi-sdk.cjs.d.ts +1 -0
  5. package/dist/commercetools-importapi-sdk.cjs.dev.js +2781 -0
  6. package/dist/commercetools-importapi-sdk.cjs.js +7 -0
  7. package/dist/commercetools-importapi-sdk.cjs.prod.js +2781 -0
  8. package/dist/commercetools-importapi-sdk.esm.js +2775 -0
  9. package/dist/{ctp → declarations/src/ctp}/ctp-client.d.ts +2 -2
  10. package/dist/{generated → declarations/src/generated}/client/api-root.d.ts +18 -25
  11. package/dist/{generated → declarations/src/generated}/client/by-project-key-request-builder.d.ts +52 -55
  12. package/dist/{generated → declarations/src/generated}/client/categories/by-project-key-categories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  13. package/dist/{generated → declarations/src/generated}/client/categories/by-project-key-categories-request-builder.d.ts +28 -33
  14. package/dist/{generated → declarations/src/generated}/client/customers/by-project-key-customers-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  15. package/dist/{generated → declarations/src/generated}/client/customers/by-project-key-customers-request-builder.d.ts +28 -33
  16. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  17. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-request-builder.d.ts +26 -0
  18. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  19. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-request-builder.d.ts +26 -0
  20. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +55 -0
  21. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +51 -0
  22. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  23. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-request-builder.d.ts +26 -0
  24. 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
  25. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-request-builder.d.ts +26 -0
  26. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  27. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-request-builder.d.ts +26 -0
  28. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  29. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-request-builder.d.ts +26 -0
  30. 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
  31. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-request-builder.d.ts +26 -0
  32. 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
  33. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-request-builder.d.ts +26 -0
  34. 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
  35. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-request-builder.d.ts +26 -0
  36. 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
  37. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-request-builder.d.ts +26 -0
  38. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +35 -0
  39. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-request-builder.d.ts +26 -0
  40. package/dist/{generated → 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
  41. package/dist/{generated → 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
  42. package/dist/{generated → 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
  43. package/dist/{generated → 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
  44. 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
  45. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +35 -0
  46. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-request-builder.d.ts +26 -0
  47. package/dist/{generated → 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
  48. package/dist/{generated → 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
  49. package/dist/{generated → 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
  50. package/dist/{generated → 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
  51. package/dist/{generated → 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
  52. package/dist/{generated → 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
  53. package/dist/{generated → 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
  54. package/dist/{generated → 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
  55. package/dist/{generated → 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
  56. package/dist/{generated → 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
  57. package/dist/{generated → 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
  58. package/dist/{generated → 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
  59. package/dist/{generated → 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
  60. package/dist/{generated → 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
  61. package/dist/{generated → 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
  62. package/dist/{generated → 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
  63. package/dist/{generated → 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
  64. package/dist/{generated → 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
  65. package/dist/{generated → declarations/src/generated}/client/import-sinks/by-project-key-import-sinks-by-import-sink-key-request-builder.d.ts +51 -58
  66. package/dist/{generated → declarations/src/generated}/client/import-sinks/by-project-key-import-sinks-request-builder.d.ts +51 -58
  67. 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
  68. package/dist/{generated → declarations/src/generated}/client/import-summaries/by-project-key-import-summaries-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  69. package/dist/{generated → declarations/src/generated}/client/import-summaries/by-project-key-import-summaries-request-builder.d.ts +26 -33
  70. package/dist/{generated → declarations/src/generated}/client/inventories/by-project-key-inventories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  71. package/dist/{generated → declarations/src/generated}/client/inventories/by-project-key-inventories-request-builder.d.ts +28 -33
  72. package/dist/{generated → declarations/src/generated}/client/order-patches/by-project-key-order-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  73. package/dist/{generated → declarations/src/generated}/client/order-patches/by-project-key-order-patches-request-builder.d.ts +28 -33
  74. package/dist/{generated → declarations/src/generated}/client/orders/by-project-key-orders-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  75. package/dist/{generated → declarations/src/generated}/client/orders/by-project-key-orders-request-builder.d.ts +28 -33
  76. package/dist/{generated → declarations/src/generated}/client/prices/by-project-key-prices-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  77. package/dist/{generated → declarations/src/generated}/client/prices/by-project-key-prices-request-builder.d.ts +28 -33
  78. package/dist/{generated → declarations/src/generated}/client/product-drafts/by-project-key-product-drafts-import-sink-key-by-import-sink-key-request-builder.d.ts +38 -45
  79. package/dist/{generated → declarations/src/generated}/client/product-drafts/by-project-key-product-drafts-request-builder.d.ts +28 -33
  80. package/dist/{generated → declarations/src/generated}/client/product-types/by-project-key-product-types-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  81. package/dist/{generated → declarations/src/generated}/client/product-types/by-project-key-product-types-request-builder.d.ts +28 -33
  82. package/dist/{generated → 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
  83. package/dist/{generated → declarations/src/generated}/client/product-variant-patches/by-project-key-product-variant-patches-request-builder.d.ts +28 -33
  84. package/dist/{generated → declarations/src/generated}/client/product-variants/by-project-key-product-variants-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  85. package/dist/{generated → declarations/src/generated}/client/product-variants/by-project-key-product-variants-request-builder.d.ts +28 -33
  86. package/dist/{generated → declarations/src/generated}/client/products/by-project-key-products-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -44
  87. package/dist/{generated → declarations/src/generated}/client/products/by-project-key-products-request-builder.d.ts +28 -33
  88. package/dist/{generated → declarations/src/generated}/index.d.ts +26 -32
  89. package/dist/{generated → declarations/src/generated}/models/categories.d.ts +79 -86
  90. package/dist/{generated → declarations/src/generated}/models/common.d.ts +570 -551
  91. package/dist/{generated → declarations/src/generated}/models/customers.d.ts +252 -259
  92. package/dist/{generated → declarations/src/generated}/models/customfields.d.ts +260 -267
  93. package/dist/{generated → declarations/src/generated}/models/errors.d.ts +356 -359
  94. package/dist/declarations/src/generated/models/importcontainers.d.ts +114 -0
  95. package/dist/{generated → declarations/src/generated}/models/importoperations.d.ts +128 -136
  96. package/dist/{generated → declarations/src/generated}/models/importrequests.d.ts +175 -182
  97. package/dist/{generated → declarations/src/generated}/models/importsinks.d.ts +113 -120
  98. package/dist/declarations/src/generated/models/importsummaries.d.ts +55 -0
  99. package/dist/{generated → declarations/src/generated}/models/inventories.d.ts +44 -51
  100. package/dist/{generated → declarations/src/generated}/models/order-patches.d.ts +227 -234
  101. package/dist/{generated → declarations/src/generated}/models/orders.d.ts +778 -785
  102. package/dist/{generated → declarations/src/generated}/models/prices.d.ts +130 -137
  103. package/dist/{generated → declarations/src/generated}/models/productdrafts.d.ts +226 -231
  104. package/dist/{generated → declarations/src/generated}/models/products.d.ts +181 -186
  105. package/dist/{generated → declarations/src/generated}/models/producttypes.d.ts +173 -180
  106. package/dist/{generated → declarations/src/generated}/models/productvariants.d.ts +529 -534
  107. package/dist/{generated → declarations/src/generated}/shared/utils/common-types.d.ts +26 -33
  108. package/dist/declarations/src/generated/shared/utils/middleware.d.ts +8 -0
  109. package/dist/declarations/src/generated/shared/utils/requests-utils.d.ts +13 -0
  110. package/dist/declarations/src/generated/shared/utils/uri-utils.d.ts +7 -0
  111. package/dist/{index.d.ts → declarations/src/index.d.ts} +2 -2
  112. package/package.json +16 -26
  113. package/dist/generated/models/importsummaries.d.ts +0 -57
  114. package/dist/generated/shared/utils/middleware.d.ts +0 -15
  115. package/dist/generated/shared/utils/requests-utils.d.ts +0 -20
  116. package/dist/generated/shared/utils/uri-utils.d.ts +0 -14
  117. package/dist/importapi-sdk.es.js +0 -2
  118. package/dist/importapi-sdk.es.js.map +0 -1
  119. package/dist/importapi-sdk.js +0 -2
  120. package/dist/importapi-sdk.js.map +0 -1
  121. package/dist/importapi-sdk.modern.js +0 -2
  122. package/dist/importapi-sdk.modern.js.map +0 -1
  123. package/dist/importapi-sdk.umd.js +0 -2
  124. package/dist/importapi-sdk.umd.js.map +0 -1
@@ -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
+ }