@gofynd/fdk-client-javascript 0.1.35 → 0.1.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/documentation/application/CART.md +256 -239
- package/documentation/application/CATALOG.md +413 -409
- package/documentation/application/COMMON.md +4 -0
- package/documentation/application/COMMUNICATION.md +4 -0
- package/documentation/application/CONFIGURATION.md +4 -0
- package/documentation/application/CONTENT.md +7 -20
- package/documentation/application/FILESTORAGE.md +85 -0
- package/documentation/application/LEAD.md +6 -2
- package/documentation/application/LOGISTIC.md +4 -0
- package/documentation/application/ORDER.md +307 -303
- package/documentation/application/PAYMENT.md +445 -259
- package/documentation/application/POSCART.md +317 -300
- package/documentation/application/REWARDS.md +153 -160
- package/documentation/application/SHARE.md +4 -0
- package/documentation/application/THEME.md +4 -0
- package/documentation/application/USER.md +4 -0
- package/documentation/platform/ANALYTICS.md +4 -0
- package/documentation/platform/AUDITTRAIL.md +4 -0
- package/documentation/platform/BILLING.md +4 -0
- package/documentation/platform/CART.md +480 -463
- package/documentation/platform/CATALOG.md +3895 -2942
- package/documentation/platform/COMMON.md +4 -0
- package/documentation/platform/COMMUNICATION.md +4 -0
- package/documentation/platform/COMPANYPROFILE.md +224 -193
- package/documentation/platform/CONFIGURATION.md +4 -0
- package/documentation/platform/CONTENT.md +8 -21
- package/documentation/platform/DISCOUNT.md +4 -0
- package/documentation/platform/FILESTORAGE.md +85 -0
- package/documentation/platform/INVENTORY.md +4 -0
- package/documentation/platform/LEAD.md +6 -2
- package/documentation/platform/ORDER.md +6298 -1448
- package/documentation/platform/PARTNER.md +12 -8
- package/documentation/platform/PAYMENT.md +107 -103
- package/documentation/platform/README.md +2 -2
- package/documentation/platform/REWARDS.md +219 -152
- package/documentation/platform/SHARE.md +4 -0
- package/documentation/platform/THEME.md +4 -0
- package/documentation/platform/USER.md +4 -0
- package/documentation/platform/WEBHOOK.md +4 -0
- package/documentation/public/CONFIGURATION.md +4 -0
- package/documentation/public/INVENTORY.md +4 -0
- package/documentation/public/WEBHOOK.md +4 -0
- package/package.json +1 -1
- package/sdk/application/ApplicationModels.d.ts +77 -73
- package/sdk/application/ApplicationModels.js +1751 -1725
- package/sdk/application/client/CartApplicationClient.d.ts +36 -36
- package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
- package/sdk/application/client/CatalogApplicationClient.js +16 -16
- package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
- package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
- package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
- package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
- package/sdk/application/client/FileStorageApplicationClient.js +2 -0
- package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
- package/sdk/application/client/LogisticApplicationClient.d.ts +5 -5
- package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
- package/sdk/application/client/OrderApplicationClient.js +1 -1
- package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
- package/sdk/application/client/PaymentApplicationClient.js +66 -0
- package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
- package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
- package/sdk/application/client/RewardsApplicationClient.js +77 -77
- package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
- package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/client/UserApplicationClient.d.ts +63 -63
- package/sdk/application/models/CatalogValidator.d.ts +1 -1
- package/sdk/application/models/CatalogValidator.js +2 -2
- package/sdk/application/models/PaymentValidator.d.ts +2 -0
- package/sdk/application/models/PaymentValidator.js +12 -0
- package/sdk/application/models/RewardsValidator.d.ts +3 -3
- package/sdk/application/models/RewardsValidator.js +12 -12
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +8600 -7286
- package/sdk/platform/PlatformApplicationClient.js +4338 -3678
- package/sdk/platform/PlatformApplicationModels.d.ts +21 -26
- package/sdk/platform/PlatformApplicationModels.js +5561 -4301
- package/sdk/platform/PlatformClient.d.ts +3448 -2801
- package/sdk/platform/PlatformClient.js +3903 -3108
- package/sdk/platform/PlatformModels.d.ts +352 -278
- package/sdk/platform/PlatformModels.js +5230 -3942
- package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
- package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
- package/sdk/platform/client/CatalogPlatformClient.d.ts +209 -150
- package/sdk/platform/client/CatalogPlatformClient.js +441 -294
- package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
- package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
- package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
- package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
- package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
- package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
- package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
- package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
- package/sdk/platform/client/OrderPlatformClient.js +1551 -247
- package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/models/CatalogValidator.d.ts +24 -21
- package/sdk/platform/models/CatalogValidator.js +103 -72
- package/sdk/platform/models/OrderValidator.d.ts +43 -11
- package/sdk/platform/models/OrderValidator.js +312 -51
- package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
- package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
- package/tests/common/schema/action-url.json +15 -0
- package/tests/common/schema/url-action.json +16 -0
|
@@ -9,14 +9,70 @@ class Order {
|
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
11
|
* @param {Object} arg - Arg object.
|
|
12
|
-
* @param {
|
|
13
|
-
* @
|
|
14
|
-
* @
|
|
12
|
+
* @param {string} [arg.lane] -
|
|
13
|
+
* @param {string} [arg.searchType] -
|
|
14
|
+
* @param {string} [arg.searchValue] -
|
|
15
|
+
* @param {string} [arg.searchId] -
|
|
16
|
+
* @param {string} [arg.fromDate] -
|
|
17
|
+
* @param {string} [arg.toDate] -
|
|
18
|
+
* @param {string} [arg.dpIds] -
|
|
19
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
20
|
+
* @param {string} [arg.stores] -
|
|
21
|
+
* @param {string} [arg.salesChannel] -
|
|
22
|
+
* @param {string} [arg.requestByExt] -
|
|
23
|
+
* @param {number} [arg.pageNo] -
|
|
24
|
+
* @param {number} [arg.pageSize] -
|
|
25
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
26
|
+
* @param {boolean} [arg.excludeLockedShipments] -
|
|
27
|
+
* @param {string} [arg.paymentMethods] -
|
|
28
|
+
* @param {string} [arg.channelShipmentId] -
|
|
29
|
+
* @param {string} [arg.channelOrderId] -
|
|
30
|
+
* @param {string} [arg.customMeta] -
|
|
31
|
+
* @summary:
|
|
32
|
+
* @description:
|
|
15
33
|
*/
|
|
16
|
-
|
|
17
|
-
|
|
34
|
+
getShipments({
|
|
35
|
+
lane,
|
|
36
|
+
searchType,
|
|
37
|
+
searchValue,
|
|
38
|
+
searchId,
|
|
39
|
+
fromDate,
|
|
40
|
+
toDate,
|
|
41
|
+
dpIds,
|
|
42
|
+
orderingCompanyId,
|
|
43
|
+
stores,
|
|
44
|
+
salesChannel,
|
|
45
|
+
requestByExt,
|
|
46
|
+
pageNo,
|
|
47
|
+
pageSize,
|
|
48
|
+
isPrioritySort,
|
|
49
|
+
excludeLockedShipments,
|
|
50
|
+
paymentMethods,
|
|
51
|
+
channelShipmentId,
|
|
52
|
+
channelOrderId,
|
|
53
|
+
customMeta,
|
|
54
|
+
} = {}) {
|
|
55
|
+
const { error } = OrderValidator.getShipments().validate(
|
|
18
56
|
{
|
|
19
|
-
|
|
57
|
+
lane,
|
|
58
|
+
searchType,
|
|
59
|
+
searchValue,
|
|
60
|
+
searchId,
|
|
61
|
+
fromDate,
|
|
62
|
+
toDate,
|
|
63
|
+
dpIds,
|
|
64
|
+
orderingCompanyId,
|
|
65
|
+
stores,
|
|
66
|
+
salesChannel,
|
|
67
|
+
requestByExt,
|
|
68
|
+
pageNo,
|
|
69
|
+
pageSize,
|
|
70
|
+
isPrioritySort,
|
|
71
|
+
excludeLockedShipments,
|
|
72
|
+
paymentMethods,
|
|
73
|
+
channelShipmentId,
|
|
74
|
+
channelOrderId,
|
|
75
|
+
customMeta,
|
|
20
76
|
},
|
|
21
77
|
{ abortEarly: false, allowUnknown: true }
|
|
22
78
|
);
|
|
@@ -25,29 +81,59 @@ class Order {
|
|
|
25
81
|
}
|
|
26
82
|
|
|
27
83
|
const query_params = {};
|
|
84
|
+
query_params["lane"] = lane;
|
|
85
|
+
query_params["search_type"] = searchType;
|
|
86
|
+
query_params["search_value"] = searchValue;
|
|
87
|
+
query_params["search_id"] = searchId;
|
|
88
|
+
query_params["from_date"] = fromDate;
|
|
89
|
+
query_params["to_date"] = toDate;
|
|
90
|
+
query_params["dp_ids"] = dpIds;
|
|
91
|
+
query_params["ordering_company_id"] = orderingCompanyId;
|
|
92
|
+
query_params["stores"] = stores;
|
|
93
|
+
query_params["sales_channel"] = salesChannel;
|
|
94
|
+
query_params["request_by_ext"] = requestByExt;
|
|
95
|
+
query_params["page_no"] = pageNo;
|
|
96
|
+
query_params["page_size"] = pageSize;
|
|
97
|
+
query_params["is_priority_sort"] = isPrioritySort;
|
|
98
|
+
query_params["exclude_locked_shipments"] = excludeLockedShipments;
|
|
99
|
+
query_params["payment_methods"] = paymentMethods;
|
|
100
|
+
query_params["channel_shipment_id"] = channelShipmentId;
|
|
101
|
+
query_params["channel_order_id"] = channelOrderId;
|
|
102
|
+
query_params["custom_meta"] = customMeta;
|
|
28
103
|
|
|
29
104
|
const xHeaders = {};
|
|
30
105
|
|
|
31
106
|
return PlatformAPIClient.execute(
|
|
32
107
|
this.config,
|
|
33
|
-
"
|
|
34
|
-
`/service/platform/
|
|
108
|
+
"get",
|
|
109
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/shipments-listing`,
|
|
35
110
|
query_params,
|
|
36
|
-
|
|
111
|
+
undefined,
|
|
37
112
|
xHeaders
|
|
38
113
|
);
|
|
39
114
|
}
|
|
40
115
|
|
|
41
116
|
/**
|
|
42
117
|
* @param {Object} arg - Arg object.
|
|
43
|
-
* @param {string} arg.
|
|
44
|
-
* @
|
|
45
|
-
* @
|
|
118
|
+
* @param {string} [arg.channelShipmentId] -
|
|
119
|
+
* @param {string} [arg.shipmentId] -
|
|
120
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
121
|
+
* @param {string} [arg.requestByExt] -
|
|
122
|
+
* @summary:
|
|
123
|
+
* @description:
|
|
46
124
|
*/
|
|
47
|
-
|
|
48
|
-
|
|
125
|
+
getShipmentById({
|
|
126
|
+
channelShipmentId,
|
|
127
|
+
shipmentId,
|
|
128
|
+
orderingCompanyId,
|
|
129
|
+
requestByExt,
|
|
130
|
+
} = {}) {
|
|
131
|
+
const { error } = OrderValidator.getShipmentById().validate(
|
|
49
132
|
{
|
|
50
|
-
|
|
133
|
+
channelShipmentId,
|
|
134
|
+
shipmentId,
|
|
135
|
+
orderingCompanyId,
|
|
136
|
+
requestByExt,
|
|
51
137
|
},
|
|
52
138
|
{ abortEarly: false, allowUnknown: true }
|
|
53
139
|
);
|
|
@@ -56,14 +142,17 @@ class Order {
|
|
|
56
142
|
}
|
|
57
143
|
|
|
58
144
|
const query_params = {};
|
|
59
|
-
query_params["
|
|
145
|
+
query_params["channel_shipment_id"] = channelShipmentId;
|
|
146
|
+
query_params["shipment_id"] = shipmentId;
|
|
147
|
+
query_params["ordering_company_id"] = orderingCompanyId;
|
|
148
|
+
query_params["request_by_ext"] = requestByExt;
|
|
60
149
|
|
|
61
150
|
const xHeaders = {};
|
|
62
151
|
|
|
63
152
|
return PlatformAPIClient.execute(
|
|
64
153
|
this.config,
|
|
65
154
|
"get",
|
|
66
|
-
`/service/platform/
|
|
155
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/shipment-details`,
|
|
67
156
|
query_params,
|
|
68
157
|
undefined,
|
|
69
158
|
xHeaders
|
|
@@ -72,14 +161,14 @@ class Order {
|
|
|
72
161
|
|
|
73
162
|
/**
|
|
74
163
|
* @param {Object} arg - Arg object.
|
|
75
|
-
* @param {
|
|
76
|
-
* @summary:
|
|
77
|
-
* @description:
|
|
164
|
+
* @param {string} arg.orderId -
|
|
165
|
+
* @summary:
|
|
166
|
+
* @description:
|
|
78
167
|
*/
|
|
79
|
-
|
|
80
|
-
const { error } = OrderValidator.
|
|
168
|
+
getOrderById({ orderId } = {}) {
|
|
169
|
+
const { error } = OrderValidator.getOrderById().validate(
|
|
81
170
|
{
|
|
82
|
-
|
|
171
|
+
orderId,
|
|
83
172
|
},
|
|
84
173
|
{ abortEarly: false, allowUnknown: true }
|
|
85
174
|
);
|
|
@@ -88,29 +177,56 @@ class Order {
|
|
|
88
177
|
}
|
|
89
178
|
|
|
90
179
|
const query_params = {};
|
|
180
|
+
query_params["order_id"] = orderId;
|
|
91
181
|
|
|
92
182
|
const xHeaders = {};
|
|
93
183
|
|
|
94
184
|
return PlatformAPIClient.execute(
|
|
95
185
|
this.config,
|
|
96
|
-
"
|
|
97
|
-
`/service/platform/
|
|
186
|
+
"get",
|
|
187
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/order-details`,
|
|
98
188
|
query_params,
|
|
99
|
-
|
|
189
|
+
undefined,
|
|
100
190
|
xHeaders
|
|
101
191
|
);
|
|
102
192
|
}
|
|
103
193
|
|
|
104
194
|
/**
|
|
105
195
|
* @param {Object} arg - Arg object.
|
|
106
|
-
* @param {string} arg.
|
|
107
|
-
* @
|
|
108
|
-
* @
|
|
196
|
+
* @param {string} [arg.superLane] -
|
|
197
|
+
* @param {string} [arg.groupEntity] -
|
|
198
|
+
* @param {string} [arg.fromDate] -
|
|
199
|
+
* @param {string} [arg.toDate] -
|
|
200
|
+
* @param {string} [arg.dpIds] -
|
|
201
|
+
* @param {string} [arg.stores] -
|
|
202
|
+
* @param {string} [arg.salesChannel] -
|
|
203
|
+
* @param {string} [arg.paymentMode] -
|
|
204
|
+
* @param {string} [arg.bagStatus] -
|
|
205
|
+
* @summary:
|
|
206
|
+
* @description:
|
|
109
207
|
*/
|
|
110
|
-
|
|
111
|
-
|
|
208
|
+
getLaneConfig({
|
|
209
|
+
superLane,
|
|
210
|
+
groupEntity,
|
|
211
|
+
fromDate,
|
|
212
|
+
toDate,
|
|
213
|
+
dpIds,
|
|
214
|
+
stores,
|
|
215
|
+
salesChannel,
|
|
216
|
+
paymentMode,
|
|
217
|
+
bagStatus,
|
|
218
|
+
} = {}) {
|
|
219
|
+
const { error } = OrderValidator.getLaneConfig().validate(
|
|
112
220
|
{
|
|
113
|
-
|
|
221
|
+
superLane,
|
|
222
|
+
groupEntity,
|
|
223
|
+
fromDate,
|
|
224
|
+
toDate,
|
|
225
|
+
dpIds,
|
|
226
|
+
stores,
|
|
227
|
+
salesChannel,
|
|
228
|
+
paymentMode,
|
|
229
|
+
bagStatus,
|
|
114
230
|
},
|
|
115
231
|
{ abortEarly: false, allowUnknown: true }
|
|
116
232
|
);
|
|
@@ -119,13 +235,22 @@ class Order {
|
|
|
119
235
|
}
|
|
120
236
|
|
|
121
237
|
const query_params = {};
|
|
238
|
+
query_params["super_lane"] = superLane;
|
|
239
|
+
query_params["group_entity"] = groupEntity;
|
|
240
|
+
query_params["from_date"] = fromDate;
|
|
241
|
+
query_params["to_date"] = toDate;
|
|
242
|
+
query_params["dp_ids"] = dpIds;
|
|
243
|
+
query_params["stores"] = stores;
|
|
244
|
+
query_params["sales_channel"] = salesChannel;
|
|
245
|
+
query_params["payment_mode"] = paymentMode;
|
|
246
|
+
query_params["bag_status"] = bagStatus;
|
|
122
247
|
|
|
123
248
|
const xHeaders = {};
|
|
124
249
|
|
|
125
250
|
return PlatformAPIClient.execute(
|
|
126
251
|
this.config,
|
|
127
252
|
"get",
|
|
128
|
-
`/service/platform/
|
|
253
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/lane-config/`,
|
|
129
254
|
query_params,
|
|
130
255
|
undefined,
|
|
131
256
|
xHeaders
|
|
@@ -134,14 +259,49 @@ class Order {
|
|
|
134
259
|
|
|
135
260
|
/**
|
|
136
261
|
* @param {Object} arg - Arg object.
|
|
137
|
-
* @param {
|
|
138
|
-
* @
|
|
139
|
-
* @
|
|
262
|
+
* @param {string} [arg.lane] -
|
|
263
|
+
* @param {string} [arg.searchType] -
|
|
264
|
+
* @param {string} [arg.searchValue] -
|
|
265
|
+
* @param {string} [arg.fromDate] -
|
|
266
|
+
* @param {string} [arg.toDate] -
|
|
267
|
+
* @param {string} [arg.dpIds] -
|
|
268
|
+
* @param {string} [arg.stores] -
|
|
269
|
+
* @param {string} [arg.salesChannel] -
|
|
270
|
+
* @param {number} [arg.pageNo] -
|
|
271
|
+
* @param {number} [arg.pageSize] -
|
|
272
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
273
|
+
* @param {string} [arg.customMeta] -
|
|
274
|
+
* @summary:
|
|
275
|
+
* @description:
|
|
140
276
|
*/
|
|
141
|
-
|
|
142
|
-
|
|
277
|
+
getOrders({
|
|
278
|
+
lane,
|
|
279
|
+
searchType,
|
|
280
|
+
searchValue,
|
|
281
|
+
fromDate,
|
|
282
|
+
toDate,
|
|
283
|
+
dpIds,
|
|
284
|
+
stores,
|
|
285
|
+
salesChannel,
|
|
286
|
+
pageNo,
|
|
287
|
+
pageSize,
|
|
288
|
+
isPrioritySort,
|
|
289
|
+
customMeta,
|
|
290
|
+
} = {}) {
|
|
291
|
+
const { error } = OrderValidator.getOrders().validate(
|
|
143
292
|
{
|
|
144
|
-
|
|
293
|
+
lane,
|
|
294
|
+
searchType,
|
|
295
|
+
searchValue,
|
|
296
|
+
fromDate,
|
|
297
|
+
toDate,
|
|
298
|
+
dpIds,
|
|
299
|
+
stores,
|
|
300
|
+
salesChannel,
|
|
301
|
+
pageNo,
|
|
302
|
+
pageSize,
|
|
303
|
+
isPrioritySort,
|
|
304
|
+
customMeta,
|
|
145
305
|
},
|
|
146
306
|
{ abortEarly: false, allowUnknown: true }
|
|
147
307
|
);
|
|
@@ -150,76 +310,43 @@ class Order {
|
|
|
150
310
|
}
|
|
151
311
|
|
|
152
312
|
const query_params = {};
|
|
313
|
+
query_params["lane"] = lane;
|
|
314
|
+
query_params["search_type"] = searchType;
|
|
315
|
+
query_params["search_value"] = searchValue;
|
|
316
|
+
query_params["from_date"] = fromDate;
|
|
317
|
+
query_params["to_date"] = toDate;
|
|
318
|
+
query_params["dp_ids"] = dpIds;
|
|
319
|
+
query_params["stores"] = stores;
|
|
320
|
+
query_params["sales_channel"] = salesChannel;
|
|
321
|
+
query_params["page_no"] = pageNo;
|
|
322
|
+
query_params["page_size"] = pageSize;
|
|
323
|
+
query_params["is_priority_sort"] = isPrioritySort;
|
|
324
|
+
query_params["custom_meta"] = customMeta;
|
|
153
325
|
|
|
154
326
|
const xHeaders = {};
|
|
155
327
|
|
|
156
328
|
return PlatformAPIClient.execute(
|
|
157
329
|
this.config,
|
|
158
|
-
"
|
|
159
|
-
`/service/platform/
|
|
330
|
+
"get",
|
|
331
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/orders-listing`,
|
|
160
332
|
query_params,
|
|
161
|
-
|
|
333
|
+
undefined,
|
|
162
334
|
xHeaders
|
|
163
335
|
);
|
|
164
336
|
}
|
|
165
337
|
|
|
166
338
|
/**
|
|
167
339
|
* @param {Object} arg - Arg object.
|
|
168
|
-
* @param {string} [arg.
|
|
169
|
-
* @param {string} [arg.
|
|
170
|
-
* @
|
|
171
|
-
* @
|
|
172
|
-
* @param {boolean} [arg.isPrioritySort] - Sorting Order
|
|
173
|
-
* @param {boolean} [arg.lockStatus] - Hide Lock Status
|
|
174
|
-
* @param {string} [arg.userId] - User Id
|
|
175
|
-
* @param {string} [arg.q] - Keyword for Search
|
|
176
|
-
* @param {string} [arg.stage] - Specefic Order Stage
|
|
177
|
-
* @param {string} [arg.salesChannels] - Selected Sales Channel
|
|
178
|
-
* @param {string} [arg.orderId] - Order Id
|
|
179
|
-
* @param {string} [arg.stores] - Selected Stores
|
|
180
|
-
* @param {string} [arg.deploymentStores] - Selected Deployment Stores
|
|
181
|
-
* @param {string} [arg.status] - Status of order
|
|
182
|
-
* @param {string} [arg.dp] - Delivery Partners
|
|
183
|
-
* @param {string} [arg.filterType] - Filters
|
|
184
|
-
* @summary: Get Orders for company based on Company Id
|
|
185
|
-
* @description: Get Orders
|
|
340
|
+
* @param {string} [arg.fromDate] -
|
|
341
|
+
* @param {string} [arg.toDate] -
|
|
342
|
+
* @summary:
|
|
343
|
+
* @description:
|
|
186
344
|
*/
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
pageSize,
|
|
190
|
-
fromDate,
|
|
191
|
-
toDate,
|
|
192
|
-
isPrioritySort,
|
|
193
|
-
lockStatus,
|
|
194
|
-
userId,
|
|
195
|
-
q,
|
|
196
|
-
stage,
|
|
197
|
-
salesChannels,
|
|
198
|
-
orderId,
|
|
199
|
-
stores,
|
|
200
|
-
deploymentStores,
|
|
201
|
-
status,
|
|
202
|
-
dp,
|
|
203
|
-
filterType,
|
|
204
|
-
} = {}) {
|
|
205
|
-
const { error } = OrderValidator.getOrdersByCompanyId().validate(
|
|
345
|
+
getMetricCount({ fromDate, toDate } = {}) {
|
|
346
|
+
const { error } = OrderValidator.getMetricCount().validate(
|
|
206
347
|
{
|
|
207
|
-
pageNo,
|
|
208
|
-
pageSize,
|
|
209
348
|
fromDate,
|
|
210
349
|
toDate,
|
|
211
|
-
isPrioritySort,
|
|
212
|
-
lockStatus,
|
|
213
|
-
userId,
|
|
214
|
-
q,
|
|
215
|
-
stage,
|
|
216
|
-
salesChannels,
|
|
217
|
-
orderId,
|
|
218
|
-
stores,
|
|
219
|
-
deploymentStores,
|
|
220
|
-
status,
|
|
221
|
-
dp,
|
|
222
|
-
filterType,
|
|
223
350
|
},
|
|
224
351
|
{ abortEarly: false, allowUnknown: true }
|
|
225
352
|
);
|
|
@@ -228,29 +355,15 @@ class Order {
|
|
|
228
355
|
}
|
|
229
356
|
|
|
230
357
|
const query_params = {};
|
|
231
|
-
query_params["page_no"] = pageNo;
|
|
232
|
-
query_params["page_size"] = pageSize;
|
|
233
358
|
query_params["from_date"] = fromDate;
|
|
234
359
|
query_params["to_date"] = toDate;
|
|
235
|
-
query_params["is_priority_sort"] = isPrioritySort;
|
|
236
|
-
query_params["lock_status"] = lockStatus;
|
|
237
|
-
query_params["user_id"] = userId;
|
|
238
|
-
query_params["q"] = q;
|
|
239
|
-
query_params["stage"] = stage;
|
|
240
|
-
query_params["sales_channels"] = salesChannels;
|
|
241
|
-
query_params["order_id"] = orderId;
|
|
242
|
-
query_params["stores"] = stores;
|
|
243
|
-
query_params["deployment_stores"] = deploymentStores;
|
|
244
|
-
query_params["status"] = status;
|
|
245
|
-
query_params["dp"] = dp;
|
|
246
|
-
query_params["filter_type"] = filterType;
|
|
247
360
|
|
|
248
361
|
const xHeaders = {};
|
|
249
362
|
|
|
250
363
|
return PlatformAPIClient.execute(
|
|
251
364
|
this.config,
|
|
252
365
|
"get",
|
|
253
|
-
`/service/platform/
|
|
366
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/shipment/metrics-count/`,
|
|
254
367
|
query_params,
|
|
255
368
|
undefined,
|
|
256
369
|
xHeaders
|
|
@@ -259,46 +372,16 @@ class Order {
|
|
|
259
372
|
|
|
260
373
|
/**
|
|
261
374
|
* @param {Object} arg - Arg object.
|
|
262
|
-
* @param {string}
|
|
263
|
-
* @param {string} [arg.
|
|
264
|
-
* @
|
|
265
|
-
* @
|
|
266
|
-
* @param {string} [arg.q] - Keyword for Search
|
|
267
|
-
* @param {string} [arg.stage] - Specefic Order Stage
|
|
268
|
-
* @param {string} [arg.salesChannels] - Selected Sales Channel
|
|
269
|
-
* @param {string} [arg.orderId] - Order Id
|
|
270
|
-
* @param {string} [arg.stores] - Selected Stores
|
|
271
|
-
* @param {string} [arg.status] - Status of order
|
|
272
|
-
* @param {string} [arg.filterType] - Filters
|
|
273
|
-
* @summary: Get Order Lanes Count for company based on Company Id
|
|
274
|
-
* @description: Get Orders Seperate Lane Count
|
|
375
|
+
* @param {string} arg.view -
|
|
376
|
+
* @param {string} [arg.groupEntity] -
|
|
377
|
+
* @summary:
|
|
378
|
+
* @description:
|
|
275
379
|
*/
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
pageSize,
|
|
279
|
-
fromDate,
|
|
280
|
-
toDate,
|
|
281
|
-
q,
|
|
282
|
-
stage,
|
|
283
|
-
salesChannels,
|
|
284
|
-
orderId,
|
|
285
|
-
stores,
|
|
286
|
-
status,
|
|
287
|
-
filterType,
|
|
288
|
-
} = {}) {
|
|
289
|
-
const { error } = OrderValidator.getOrderLanesCountByCompanyId().validate(
|
|
380
|
+
getfilters({ view, groupEntity } = {}) {
|
|
381
|
+
const { error } = OrderValidator.getfilters().validate(
|
|
290
382
|
{
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
fromDate,
|
|
294
|
-
toDate,
|
|
295
|
-
q,
|
|
296
|
-
stage,
|
|
297
|
-
salesChannels,
|
|
298
|
-
orderId,
|
|
299
|
-
stores,
|
|
300
|
-
status,
|
|
301
|
-
filterType,
|
|
383
|
+
view,
|
|
384
|
+
groupEntity,
|
|
302
385
|
},
|
|
303
386
|
{ abortEarly: false, allowUnknown: true }
|
|
304
387
|
);
|
|
@@ -307,24 +390,15 @@ class Order {
|
|
|
307
390
|
}
|
|
308
391
|
|
|
309
392
|
const query_params = {};
|
|
310
|
-
query_params["
|
|
311
|
-
query_params["
|
|
312
|
-
query_params["from_date"] = fromDate;
|
|
313
|
-
query_params["to_date"] = toDate;
|
|
314
|
-
query_params["q"] = q;
|
|
315
|
-
query_params["stage"] = stage;
|
|
316
|
-
query_params["sales_channels"] = salesChannels;
|
|
317
|
-
query_params["order_id"] = orderId;
|
|
318
|
-
query_params["stores"] = stores;
|
|
319
|
-
query_params["status"] = status;
|
|
320
|
-
query_params["filter_type"] = filterType;
|
|
393
|
+
query_params["view"] = view;
|
|
394
|
+
query_params["group_entity"] = groupEntity;
|
|
321
395
|
|
|
322
396
|
const xHeaders = {};
|
|
323
397
|
|
|
324
398
|
return PlatformAPIClient.execute(
|
|
325
399
|
this.config,
|
|
326
400
|
"get",
|
|
327
|
-
`/service/platform/
|
|
401
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/filter-listing`,
|
|
328
402
|
query_params,
|
|
329
403
|
undefined,
|
|
330
404
|
xHeaders
|
|
@@ -333,18 +407,16 @@ class Order {
|
|
|
333
407
|
|
|
334
408
|
/**
|
|
335
409
|
* @param {Object} arg - Arg object.
|
|
336
|
-
* @param {string} [arg.
|
|
337
|
-
* @param {string} [arg.
|
|
338
|
-
* @
|
|
339
|
-
* @
|
|
340
|
-
* @description: Get Orders
|
|
410
|
+
* @param {string} [arg.fromDate] -
|
|
411
|
+
* @param {string} [arg.toDate] -
|
|
412
|
+
* @summary:
|
|
413
|
+
* @description:
|
|
341
414
|
*/
|
|
342
|
-
|
|
343
|
-
const { error } = OrderValidator.
|
|
415
|
+
createShipmentReport({ fromDate, toDate } = {}) {
|
|
416
|
+
const { error } = OrderValidator.createShipmentReport().validate(
|
|
344
417
|
{
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
previous,
|
|
418
|
+
fromDate,
|
|
419
|
+
toDate,
|
|
348
420
|
},
|
|
349
421
|
{ abortEarly: false, allowUnknown: true }
|
|
350
422
|
);
|
|
@@ -353,16 +425,15 @@ class Order {
|
|
|
353
425
|
}
|
|
354
426
|
|
|
355
427
|
const query_params = {};
|
|
356
|
-
query_params["
|
|
357
|
-
query_params["
|
|
358
|
-
query_params["previous"] = previous;
|
|
428
|
+
query_params["from_date"] = fromDate;
|
|
429
|
+
query_params["to_date"] = toDate;
|
|
359
430
|
|
|
360
431
|
const xHeaders = {};
|
|
361
432
|
|
|
362
433
|
return PlatformAPIClient.execute(
|
|
363
434
|
this.config,
|
|
364
|
-
"
|
|
365
|
-
`/service/platform/
|
|
435
|
+
"post",
|
|
436
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/reports/shipment`,
|
|
366
437
|
query_params,
|
|
367
438
|
undefined,
|
|
368
439
|
xHeaders
|
|
@@ -371,46 +442,16 @@ class Order {
|
|
|
371
442
|
|
|
372
443
|
/**
|
|
373
444
|
* @param {Object} arg - Arg object.
|
|
374
|
-
* @param {
|
|
375
|
-
* @param {
|
|
376
|
-
* @
|
|
377
|
-
* @
|
|
378
|
-
* @param {string} [arg.q] - Keyword for Search
|
|
379
|
-
* @param {string} [arg.stage] - Specefic Order Stage
|
|
380
|
-
* @param {string} [arg.salesChannels] - Selected Sales Channel
|
|
381
|
-
* @param {string} [arg.orderId] - Order Id
|
|
382
|
-
* @param {string} [arg.stores] - Selected Stores
|
|
383
|
-
* @param {string} [arg.status] - Status of order
|
|
384
|
-
* @param {string} [arg.filterType] - Filters
|
|
385
|
-
* @summary: Get Orders for company based on Company Id
|
|
386
|
-
* @description: Get Orders
|
|
445
|
+
* @param {number} [arg.pageNo] -
|
|
446
|
+
* @param {number} [arg.pageSize] -
|
|
447
|
+
* @summary:
|
|
448
|
+
* @description:
|
|
387
449
|
*/
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
pageSize,
|
|
391
|
-
fromDate,
|
|
392
|
-
toDate,
|
|
393
|
-
q,
|
|
394
|
-
stage,
|
|
395
|
-
salesChannels,
|
|
396
|
-
orderId,
|
|
397
|
-
stores,
|
|
398
|
-
status,
|
|
399
|
-
filterType,
|
|
400
|
-
} = {}) {
|
|
401
|
-
const { error } = OrderValidator.getPicklistOrdersByCompanyId().validate(
|
|
450
|
+
getReportsShipmentListing({ pageNo, pageSize } = {}) {
|
|
451
|
+
const { error } = OrderValidator.getReportsShipmentListing().validate(
|
|
402
452
|
{
|
|
403
453
|
pageNo,
|
|
404
454
|
pageSize,
|
|
405
|
-
fromDate,
|
|
406
|
-
toDate,
|
|
407
|
-
q,
|
|
408
|
-
stage,
|
|
409
|
-
salesChannels,
|
|
410
|
-
orderId,
|
|
411
|
-
stores,
|
|
412
|
-
status,
|
|
413
|
-
filterType,
|
|
414
455
|
},
|
|
415
456
|
{ abortEarly: false, allowUnknown: true }
|
|
416
457
|
);
|
|
@@ -421,22 +462,13 @@ class Order {
|
|
|
421
462
|
const query_params = {};
|
|
422
463
|
query_params["page_no"] = pageNo;
|
|
423
464
|
query_params["page_size"] = pageSize;
|
|
424
|
-
query_params["from_date"] = fromDate;
|
|
425
|
-
query_params["to_date"] = toDate;
|
|
426
|
-
query_params["q"] = q;
|
|
427
|
-
query_params["stage"] = stage;
|
|
428
|
-
query_params["sales_channels"] = salesChannels;
|
|
429
|
-
query_params["order_id"] = orderId;
|
|
430
|
-
query_params["stores"] = stores;
|
|
431
|
-
query_params["status"] = status;
|
|
432
|
-
query_params["filter_type"] = filterType;
|
|
433
465
|
|
|
434
466
|
const xHeaders = {};
|
|
435
467
|
|
|
436
468
|
return PlatformAPIClient.execute(
|
|
437
469
|
this.config,
|
|
438
470
|
"get",
|
|
439
|
-
`/service/platform/
|
|
471
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/reports/shipment-listing`,
|
|
440
472
|
query_params,
|
|
441
473
|
undefined,
|
|
442
474
|
xHeaders
|
|
@@ -445,19 +477,47 @@ class Order {
|
|
|
445
477
|
|
|
446
478
|
/**
|
|
447
479
|
* @param {Object} arg - Arg object.
|
|
448
|
-
* @param {
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
* @param {string} arg.addressCategory - Category of the address it falls
|
|
452
|
-
* into(billing or delivery).
|
|
453
|
-
* @summary: Use this API to get address of a shipment using its shipment ID and Address Category.
|
|
454
|
-
* @description: Get Shipment Address
|
|
480
|
+
* @param {JioCodeUpsertPayload} arg.body
|
|
481
|
+
* @summary:
|
|
482
|
+
* @description:
|
|
455
483
|
*/
|
|
456
|
-
|
|
457
|
-
const { error } = OrderValidator.
|
|
484
|
+
upsertJioCode({ body } = {}) {
|
|
485
|
+
const { error } = OrderValidator.upsertJioCode().validate(
|
|
458
486
|
{
|
|
459
|
-
|
|
460
|
-
|
|
487
|
+
body,
|
|
488
|
+
},
|
|
489
|
+
{ abortEarly: false, allowUnknown: true }
|
|
490
|
+
);
|
|
491
|
+
if (error) {
|
|
492
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
const query_params = {};
|
|
496
|
+
|
|
497
|
+
const xHeaders = {};
|
|
498
|
+
|
|
499
|
+
return PlatformAPIClient.execute(
|
|
500
|
+
this.config,
|
|
501
|
+
"post",
|
|
502
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/upsert/jiocode/article`,
|
|
503
|
+
query_params,
|
|
504
|
+
body,
|
|
505
|
+
xHeaders
|
|
506
|
+
);
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* @param {Object} arg - Arg object.
|
|
511
|
+
* @param {string} arg.batchId -
|
|
512
|
+
* @param {string} arg.docType -
|
|
513
|
+
* @summary:
|
|
514
|
+
* @description:
|
|
515
|
+
*/
|
|
516
|
+
getBulkInvoice({ batchId, docType } = {}) {
|
|
517
|
+
const { error } = OrderValidator.getBulkInvoice().validate(
|
|
518
|
+
{
|
|
519
|
+
batchId,
|
|
520
|
+
docType,
|
|
461
521
|
},
|
|
462
522
|
{ abortEarly: false, allowUnknown: true }
|
|
463
523
|
);
|
|
@@ -466,13 +526,15 @@ class Order {
|
|
|
466
526
|
}
|
|
467
527
|
|
|
468
528
|
const query_params = {};
|
|
529
|
+
query_params["batch_id"] = batchId;
|
|
530
|
+
query_params["doc_type"] = docType;
|
|
469
531
|
|
|
470
532
|
const xHeaders = {};
|
|
471
533
|
|
|
472
534
|
return PlatformAPIClient.execute(
|
|
473
535
|
this.config,
|
|
474
536
|
"get",
|
|
475
|
-
`/service/platform/
|
|
537
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/bulk-action/invoice`,
|
|
476
538
|
query_params,
|
|
477
539
|
undefined,
|
|
478
540
|
xHeaders
|
|
@@ -481,21 +543,14 @@ class Order {
|
|
|
481
543
|
|
|
482
544
|
/**
|
|
483
545
|
* @param {Object} arg - Arg object.
|
|
484
|
-
* @param {string} arg.
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
* @param {string} arg.addressCategory - Category of the address it falls
|
|
488
|
-
* into(billing or delivery).
|
|
489
|
-
* @param {UpdateShipmentAddressRequest} arg.body
|
|
490
|
-
* @summary: Use this API to update address of a shipment using its shipment ID and Address Category.
|
|
491
|
-
* @description: Update Shipment Address
|
|
546
|
+
* @param {string} arg.batchId -
|
|
547
|
+
* @summary:
|
|
548
|
+
* @description:
|
|
492
549
|
*/
|
|
493
|
-
|
|
494
|
-
const { error } = OrderValidator.
|
|
550
|
+
getBulkInvoiceLabel({ batchId } = {}) {
|
|
551
|
+
const { error } = OrderValidator.getBulkInvoiceLabel().validate(
|
|
495
552
|
{
|
|
496
|
-
|
|
497
|
-
addressCategory,
|
|
498
|
-
body,
|
|
553
|
+
batchId,
|
|
499
554
|
},
|
|
500
555
|
{ abortEarly: false, allowUnknown: true }
|
|
501
556
|
);
|
|
@@ -504,15 +559,1264 @@ class Order {
|
|
|
504
559
|
}
|
|
505
560
|
|
|
506
561
|
const query_params = {};
|
|
562
|
+
query_params["batch_id"] = batchId;
|
|
507
563
|
|
|
508
564
|
const xHeaders = {};
|
|
509
565
|
|
|
510
566
|
return PlatformAPIClient.execute(
|
|
511
567
|
this.config,
|
|
512
|
-
"
|
|
513
|
-
`/service/platform/
|
|
568
|
+
"get",
|
|
569
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/invoice-label-external`,
|
|
514
570
|
query_params,
|
|
515
|
-
|
|
571
|
+
undefined,
|
|
572
|
+
xHeaders
|
|
573
|
+
);
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
/**
|
|
577
|
+
* @param {Object} arg - Arg object.
|
|
578
|
+
* @param {string} [arg.lane] -
|
|
579
|
+
* @param {string} [arg.searchType] -
|
|
580
|
+
* @param {string} [arg.searchId] -
|
|
581
|
+
* @param {string} [arg.fromDate] -
|
|
582
|
+
* @param {string} [arg.toDate] -
|
|
583
|
+
* @param {string} [arg.dpIds] -
|
|
584
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
585
|
+
* @param {string} [arg.stores] -
|
|
586
|
+
* @param {string} [arg.salesChannel] -
|
|
587
|
+
* @param {string} [arg.requestByExt] -
|
|
588
|
+
* @param {number} [arg.pageNo] -
|
|
589
|
+
* @param {number} [arg.pageSize] -
|
|
590
|
+
* @param {string} [arg.customerId] -
|
|
591
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
592
|
+
* @summary:
|
|
593
|
+
* @description:
|
|
594
|
+
*/
|
|
595
|
+
getBulkShipmentExcelFile({
|
|
596
|
+
lane,
|
|
597
|
+
searchType,
|
|
598
|
+
searchId,
|
|
599
|
+
fromDate,
|
|
600
|
+
toDate,
|
|
601
|
+
dpIds,
|
|
602
|
+
orderingCompanyId,
|
|
603
|
+
stores,
|
|
604
|
+
salesChannel,
|
|
605
|
+
requestByExt,
|
|
606
|
+
pageNo,
|
|
607
|
+
pageSize,
|
|
608
|
+
customerId,
|
|
609
|
+
isPrioritySort,
|
|
610
|
+
} = {}) {
|
|
611
|
+
const { error } = OrderValidator.getBulkShipmentExcelFile().validate(
|
|
612
|
+
{
|
|
613
|
+
lane,
|
|
614
|
+
searchType,
|
|
615
|
+
searchId,
|
|
616
|
+
fromDate,
|
|
617
|
+
toDate,
|
|
618
|
+
dpIds,
|
|
619
|
+
orderingCompanyId,
|
|
620
|
+
stores,
|
|
621
|
+
salesChannel,
|
|
622
|
+
requestByExt,
|
|
623
|
+
pageNo,
|
|
624
|
+
pageSize,
|
|
625
|
+
customerId,
|
|
626
|
+
isPrioritySort,
|
|
627
|
+
},
|
|
628
|
+
{ abortEarly: false, allowUnknown: true }
|
|
629
|
+
);
|
|
630
|
+
if (error) {
|
|
631
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
const query_params = {};
|
|
635
|
+
query_params["lane"] = lane;
|
|
636
|
+
query_params["search_type"] = searchType;
|
|
637
|
+
query_params["search_id"] = searchId;
|
|
638
|
+
query_params["from_date"] = fromDate;
|
|
639
|
+
query_params["to_date"] = toDate;
|
|
640
|
+
query_params["dp_ids"] = dpIds;
|
|
641
|
+
query_params["ordering_company_id"] = orderingCompanyId;
|
|
642
|
+
query_params["stores"] = stores;
|
|
643
|
+
query_params["sales_channel"] = salesChannel;
|
|
644
|
+
query_params["request_by_ext"] = requestByExt;
|
|
645
|
+
query_params["page_no"] = pageNo;
|
|
646
|
+
query_params["page_size"] = pageSize;
|
|
647
|
+
query_params["customer_id"] = customerId;
|
|
648
|
+
query_params["is_priority_sort"] = isPrioritySort;
|
|
649
|
+
|
|
650
|
+
const xHeaders = {};
|
|
651
|
+
|
|
652
|
+
return PlatformAPIClient.execute(
|
|
653
|
+
this.config,
|
|
654
|
+
"get",
|
|
655
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/generate/file`,
|
|
656
|
+
query_params,
|
|
657
|
+
undefined,
|
|
658
|
+
xHeaders
|
|
659
|
+
);
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* @param {Object} arg - Arg object.
|
|
664
|
+
* @param {string} [arg.lane] -
|
|
665
|
+
* @param {string} [arg.searchType] -
|
|
666
|
+
* @param {string} [arg.searchId] -
|
|
667
|
+
* @param {string} [arg.fromDate] -
|
|
668
|
+
* @param {string} [arg.toDate] -
|
|
669
|
+
* @param {string} [arg.dpIds] -
|
|
670
|
+
* @param {string} [arg.orderingCompanyId] -
|
|
671
|
+
* @param {string} [arg.stores] -
|
|
672
|
+
* @param {string} [arg.salesChannel] -
|
|
673
|
+
* @param {string} [arg.requestByExt] -
|
|
674
|
+
* @param {number} [arg.pageNo] -
|
|
675
|
+
* @param {number} [arg.pageSize] -
|
|
676
|
+
* @param {string} [arg.customerId] -
|
|
677
|
+
* @param {boolean} [arg.isPrioritySort] -
|
|
678
|
+
* @summary:
|
|
679
|
+
* @description:
|
|
680
|
+
*/
|
|
681
|
+
getBulkList({
|
|
682
|
+
lane,
|
|
683
|
+
searchType,
|
|
684
|
+
searchId,
|
|
685
|
+
fromDate,
|
|
686
|
+
toDate,
|
|
687
|
+
dpIds,
|
|
688
|
+
orderingCompanyId,
|
|
689
|
+
stores,
|
|
690
|
+
salesChannel,
|
|
691
|
+
requestByExt,
|
|
692
|
+
pageNo,
|
|
693
|
+
pageSize,
|
|
694
|
+
customerId,
|
|
695
|
+
isPrioritySort,
|
|
696
|
+
} = {}) {
|
|
697
|
+
const { error } = OrderValidator.getBulkList().validate(
|
|
698
|
+
{
|
|
699
|
+
lane,
|
|
700
|
+
searchType,
|
|
701
|
+
searchId,
|
|
702
|
+
fromDate,
|
|
703
|
+
toDate,
|
|
704
|
+
dpIds,
|
|
705
|
+
orderingCompanyId,
|
|
706
|
+
stores,
|
|
707
|
+
salesChannel,
|
|
708
|
+
requestByExt,
|
|
709
|
+
pageNo,
|
|
710
|
+
pageSize,
|
|
711
|
+
customerId,
|
|
712
|
+
isPrioritySort,
|
|
713
|
+
},
|
|
714
|
+
{ abortEarly: false, allowUnknown: true }
|
|
715
|
+
);
|
|
716
|
+
if (error) {
|
|
717
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
const query_params = {};
|
|
721
|
+
query_params["lane"] = lane;
|
|
722
|
+
query_params["search_type"] = searchType;
|
|
723
|
+
query_params["search_id"] = searchId;
|
|
724
|
+
query_params["from_date"] = fromDate;
|
|
725
|
+
query_params["to_date"] = toDate;
|
|
726
|
+
query_params["dp_ids"] = dpIds;
|
|
727
|
+
query_params["ordering_company_id"] = orderingCompanyId;
|
|
728
|
+
query_params["stores"] = stores;
|
|
729
|
+
query_params["sales_channel"] = salesChannel;
|
|
730
|
+
query_params["request_by_ext"] = requestByExt;
|
|
731
|
+
query_params["page_no"] = pageNo;
|
|
732
|
+
query_params["page_size"] = pageSize;
|
|
733
|
+
query_params["customer_id"] = customerId;
|
|
734
|
+
query_params["is_priority_sort"] = isPrioritySort;
|
|
735
|
+
|
|
736
|
+
const xHeaders = {};
|
|
737
|
+
|
|
738
|
+
return PlatformAPIClient.execute(
|
|
739
|
+
this.config,
|
|
740
|
+
"get",
|
|
741
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/bulk-action/listing`,
|
|
742
|
+
query_params,
|
|
743
|
+
undefined,
|
|
744
|
+
xHeaders
|
|
745
|
+
);
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
/**
|
|
749
|
+
* @param {Object} arg - Arg object.
|
|
750
|
+
* @param {string} [arg.status] -
|
|
751
|
+
* @param {number} [arg.storeId] -
|
|
752
|
+
* @param {number} [arg.pageNo] -
|
|
753
|
+
* @param {number} [arg.pageSize] -
|
|
754
|
+
* @param {string} [arg.searchValue] -
|
|
755
|
+
* @param {string} [arg.fromDate] -
|
|
756
|
+
* @param {string} [arg.toDate] -
|
|
757
|
+
* @summary:
|
|
758
|
+
* @description:
|
|
759
|
+
*/
|
|
760
|
+
getManifestList({
|
|
761
|
+
status,
|
|
762
|
+
storeId,
|
|
763
|
+
pageNo,
|
|
764
|
+
pageSize,
|
|
765
|
+
searchValue,
|
|
766
|
+
fromDate,
|
|
767
|
+
toDate,
|
|
768
|
+
} = {}) {
|
|
769
|
+
const { error } = OrderValidator.getManifestList().validate(
|
|
770
|
+
{
|
|
771
|
+
status,
|
|
772
|
+
storeId,
|
|
773
|
+
pageNo,
|
|
774
|
+
pageSize,
|
|
775
|
+
searchValue,
|
|
776
|
+
fromDate,
|
|
777
|
+
toDate,
|
|
778
|
+
},
|
|
779
|
+
{ abortEarly: false, allowUnknown: true }
|
|
780
|
+
);
|
|
781
|
+
if (error) {
|
|
782
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
const query_params = {};
|
|
786
|
+
query_params["status"] = status;
|
|
787
|
+
query_params["store_id"] = storeId;
|
|
788
|
+
query_params["page_no"] = pageNo;
|
|
789
|
+
query_params["page_size"] = pageSize;
|
|
790
|
+
query_params["search_value"] = searchValue;
|
|
791
|
+
query_params["from_date"] = fromDate;
|
|
792
|
+
query_params["to_date"] = toDate;
|
|
793
|
+
|
|
794
|
+
const xHeaders = {};
|
|
795
|
+
|
|
796
|
+
return PlatformAPIClient.execute(
|
|
797
|
+
this.config,
|
|
798
|
+
"get",
|
|
799
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/generated-manifests`,
|
|
800
|
+
query_params,
|
|
801
|
+
undefined,
|
|
802
|
+
xHeaders
|
|
803
|
+
);
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* @param {Object} arg - Arg object.
|
|
808
|
+
* @param {string} arg.manifestId -
|
|
809
|
+
* @param {string} [arg.fromDate] -
|
|
810
|
+
* @param {string} [arg.toDate] -
|
|
811
|
+
* @param {number} arg.storeId -
|
|
812
|
+
* @param {number} [arg.page] -
|
|
813
|
+
* @param {number} [arg.pageSize] -
|
|
814
|
+
* @param {string} [arg.lane] -
|
|
815
|
+
* @param {number} [arg.dpIds] -
|
|
816
|
+
* @param {string} [arg.searchType] -
|
|
817
|
+
* @param {string} [arg.searchValue] -
|
|
818
|
+
* @summary:
|
|
819
|
+
* @description:
|
|
820
|
+
*/
|
|
821
|
+
getManifestDetailsWithShipments({
|
|
822
|
+
manifestId,
|
|
823
|
+
storeId,
|
|
824
|
+
fromDate,
|
|
825
|
+
toDate,
|
|
826
|
+
page,
|
|
827
|
+
pageSize,
|
|
828
|
+
lane,
|
|
829
|
+
dpIds,
|
|
830
|
+
searchType,
|
|
831
|
+
searchValue,
|
|
832
|
+
} = {}) {
|
|
833
|
+
const { error } = OrderValidator.getManifestDetailsWithShipments().validate(
|
|
834
|
+
{
|
|
835
|
+
manifestId,
|
|
836
|
+
storeId,
|
|
837
|
+
fromDate,
|
|
838
|
+
toDate,
|
|
839
|
+
page,
|
|
840
|
+
pageSize,
|
|
841
|
+
lane,
|
|
842
|
+
dpIds,
|
|
843
|
+
searchType,
|
|
844
|
+
searchValue,
|
|
845
|
+
},
|
|
846
|
+
{ abortEarly: false, allowUnknown: true }
|
|
847
|
+
);
|
|
848
|
+
if (error) {
|
|
849
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
const query_params = {};
|
|
853
|
+
query_params["manifest_id"] = manifestId;
|
|
854
|
+
query_params["from_date"] = fromDate;
|
|
855
|
+
query_params["to_date"] = toDate;
|
|
856
|
+
query_params["store_id"] = storeId;
|
|
857
|
+
query_params["page"] = page;
|
|
858
|
+
query_params["page_size"] = pageSize;
|
|
859
|
+
query_params["lane"] = lane;
|
|
860
|
+
query_params["dp_ids"] = dpIds;
|
|
861
|
+
query_params["search_type"] = searchType;
|
|
862
|
+
query_params["search_value"] = searchValue;
|
|
863
|
+
|
|
864
|
+
const xHeaders = {};
|
|
865
|
+
|
|
866
|
+
return PlatformAPIClient.execute(
|
|
867
|
+
this.config,
|
|
868
|
+
"get",
|
|
869
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/manifest-details`,
|
|
870
|
+
query_params,
|
|
871
|
+
undefined,
|
|
872
|
+
xHeaders
|
|
873
|
+
);
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* @param {Object} arg - Arg object.
|
|
878
|
+
* @param {string} arg.batchId -
|
|
879
|
+
* @param {string} [arg.reportType] -
|
|
880
|
+
* @summary:
|
|
881
|
+
* @description:
|
|
882
|
+
*/
|
|
883
|
+
getBulkActionFailedReport({ batchId, reportType } = {}) {
|
|
884
|
+
const { error } = OrderValidator.getBulkActionFailedReport().validate(
|
|
885
|
+
{
|
|
886
|
+
batchId,
|
|
887
|
+
reportType,
|
|
888
|
+
},
|
|
889
|
+
{ abortEarly: false, allowUnknown: true }
|
|
890
|
+
);
|
|
891
|
+
if (error) {
|
|
892
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
const query_params = {};
|
|
896
|
+
query_params["batch_id"] = batchId;
|
|
897
|
+
query_params["report_type"] = reportType;
|
|
898
|
+
|
|
899
|
+
const xHeaders = {};
|
|
900
|
+
|
|
901
|
+
return PlatformAPIClient.execute(
|
|
902
|
+
this.config,
|
|
903
|
+
"get",
|
|
904
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/bulk-action-failed-report/`,
|
|
905
|
+
query_params,
|
|
906
|
+
undefined,
|
|
907
|
+
xHeaders
|
|
908
|
+
);
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
* @param {Object} arg - Arg object.
|
|
913
|
+
* @param {string} arg.shipmentId - ID of the shipment. An order may contain
|
|
914
|
+
* multiple items and may get divided into one or more shipment, each
|
|
915
|
+
* having its own ID.
|
|
916
|
+
* @param {string} arg.bagId - ID of the bag. An order may contain multiple
|
|
917
|
+
* items and may get divided into one or more shipment, each having its own ID.
|
|
918
|
+
* @param {string} arg.state - State for which reasons are required.
|
|
919
|
+
* @summary: Get reasons behind full or partial cancellation of a shipment
|
|
920
|
+
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
|
|
921
|
+
*/
|
|
922
|
+
getShipmentReasons({ shipmentId, bagId, state } = {}) {
|
|
923
|
+
const { error } = OrderValidator.getShipmentReasons().validate(
|
|
924
|
+
{
|
|
925
|
+
shipmentId,
|
|
926
|
+
bagId,
|
|
927
|
+
state,
|
|
928
|
+
},
|
|
929
|
+
{ abortEarly: false, allowUnknown: true }
|
|
930
|
+
);
|
|
931
|
+
if (error) {
|
|
932
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
const query_params = {};
|
|
936
|
+
|
|
937
|
+
const xHeaders = {};
|
|
938
|
+
|
|
939
|
+
return PlatformAPIClient.execute(
|
|
940
|
+
this.config,
|
|
941
|
+
"get",
|
|
942
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/shipments/${shipmentId}/bags/${bagId}/state/${state}/reasons`,
|
|
943
|
+
query_params,
|
|
944
|
+
undefined,
|
|
945
|
+
xHeaders
|
|
946
|
+
);
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
/**
|
|
950
|
+
* @param {Object} arg - Arg object.
|
|
951
|
+
* @param {BulkActionPayload} arg.body
|
|
952
|
+
* @summary: emits uuid to kafka topic.
|
|
953
|
+
* @description: Use this API to start processing Xlsx file.
|
|
954
|
+
*/
|
|
955
|
+
bulkActionProcessXlsxFile({ body } = {}) {
|
|
956
|
+
const { error } = OrderValidator.bulkActionProcessXlsxFile().validate(
|
|
957
|
+
{
|
|
958
|
+
body,
|
|
959
|
+
},
|
|
960
|
+
{ abortEarly: false, allowUnknown: true }
|
|
961
|
+
);
|
|
962
|
+
if (error) {
|
|
963
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
const query_params = {};
|
|
967
|
+
|
|
968
|
+
const xHeaders = {};
|
|
969
|
+
|
|
970
|
+
return PlatformAPIClient.execute(
|
|
971
|
+
this.config,
|
|
972
|
+
"post",
|
|
973
|
+
`/service/platform/orders/v2.0/company/${this.config.companyId}/bulk-action/`,
|
|
974
|
+
query_params,
|
|
975
|
+
body,
|
|
976
|
+
xHeaders
|
|
977
|
+
);
|
|
978
|
+
}
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
* @param {Object} arg - Arg object.
|
|
982
|
+
* @param {string} arg.batchId -
|
|
983
|
+
* @summary: Returns failed, processing and successfully processed shipments.
|
|
984
|
+
* @description: Returns failed, processing and successfully processed shipments along with their counts and failed reasons.
|
|
985
|
+
*/
|
|
986
|
+
bulkActionDetails({ batchId } = {}) {
|
|
987
|
+
const { error } = OrderValidator.bulkActionDetails().validate(
|
|
988
|
+
{
|
|
989
|
+
batchId,
|
|
990
|
+
},
|
|
991
|
+
{ abortEarly: false, allowUnknown: true }
|
|
992
|
+
);
|
|
993
|
+
if (error) {
|
|
994
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
995
|
+
}
|
|
996
|
+
|
|
997
|
+
const query_params = {};
|
|
998
|
+
|
|
999
|
+
const xHeaders = {};
|
|
1000
|
+
|
|
1001
|
+
return PlatformAPIClient.execute(
|
|
1002
|
+
this.config,
|
|
1003
|
+
"get",
|
|
1004
|
+
`/service/platform/orders/v2.0/company/${this.config.companyId}/bulk-action/${batchId}`,
|
|
1005
|
+
query_params,
|
|
1006
|
+
undefined,
|
|
1007
|
+
xHeaders
|
|
1008
|
+
);
|
|
1009
|
+
}
|
|
1010
|
+
|
|
1011
|
+
/**
|
|
1012
|
+
* @param {Object} arg - Arg object.
|
|
1013
|
+
* @param {string} [arg.bagId] -
|
|
1014
|
+
* @param {string} [arg.channelBagId] -
|
|
1015
|
+
* @param {string} [arg.channelId] -
|
|
1016
|
+
* @summary:
|
|
1017
|
+
* @description:
|
|
1018
|
+
*/
|
|
1019
|
+
getBagById({ bagId, channelBagId, channelId } = {}) {
|
|
1020
|
+
const { error } = OrderValidator.getBagById().validate(
|
|
1021
|
+
{
|
|
1022
|
+
bagId,
|
|
1023
|
+
channelBagId,
|
|
1024
|
+
channelId,
|
|
1025
|
+
},
|
|
1026
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1027
|
+
);
|
|
1028
|
+
if (error) {
|
|
1029
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1030
|
+
}
|
|
1031
|
+
|
|
1032
|
+
const query_params = {};
|
|
1033
|
+
query_params["bag_id"] = bagId;
|
|
1034
|
+
query_params["channel_bag_id"] = channelBagId;
|
|
1035
|
+
query_params["channel_id"] = channelId;
|
|
1036
|
+
|
|
1037
|
+
const xHeaders = {};
|
|
1038
|
+
|
|
1039
|
+
return PlatformAPIClient.execute(
|
|
1040
|
+
this.config,
|
|
1041
|
+
"get",
|
|
1042
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/bag-details/`,
|
|
1043
|
+
query_params,
|
|
1044
|
+
undefined,
|
|
1045
|
+
xHeaders
|
|
1046
|
+
);
|
|
1047
|
+
}
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* @param {Object} arg - Arg object.
|
|
1051
|
+
* @param {string} [arg.bagIds] -
|
|
1052
|
+
* @param {string} [arg.shipmentIds] -
|
|
1053
|
+
* @param {string} [arg.orderIds] -
|
|
1054
|
+
* @param {string} [arg.channelBagIds] -
|
|
1055
|
+
* @param {string} [arg.channelShipmentIds] -
|
|
1056
|
+
* @param {string} [arg.channelOrderIds] -
|
|
1057
|
+
* @param {string} [arg.channelId] -
|
|
1058
|
+
* @param {number} [arg.pageNo] -
|
|
1059
|
+
* @param {number} [arg.pageSize] -
|
|
1060
|
+
* @summary:
|
|
1061
|
+
* @description:
|
|
1062
|
+
*/
|
|
1063
|
+
getBags({
|
|
1064
|
+
bagIds,
|
|
1065
|
+
shipmentIds,
|
|
1066
|
+
orderIds,
|
|
1067
|
+
channelBagIds,
|
|
1068
|
+
channelShipmentIds,
|
|
1069
|
+
channelOrderIds,
|
|
1070
|
+
channelId,
|
|
1071
|
+
pageNo,
|
|
1072
|
+
pageSize,
|
|
1073
|
+
} = {}) {
|
|
1074
|
+
const { error } = OrderValidator.getBags().validate(
|
|
1075
|
+
{
|
|
1076
|
+
bagIds,
|
|
1077
|
+
shipmentIds,
|
|
1078
|
+
orderIds,
|
|
1079
|
+
channelBagIds,
|
|
1080
|
+
channelShipmentIds,
|
|
1081
|
+
channelOrderIds,
|
|
1082
|
+
channelId,
|
|
1083
|
+
pageNo,
|
|
1084
|
+
pageSize,
|
|
1085
|
+
},
|
|
1086
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1087
|
+
);
|
|
1088
|
+
if (error) {
|
|
1089
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
const query_params = {};
|
|
1093
|
+
query_params["bag_ids"] = bagIds;
|
|
1094
|
+
query_params["shipment_ids"] = shipmentIds;
|
|
1095
|
+
query_params["order_ids"] = orderIds;
|
|
1096
|
+
query_params["channel_bag_ids"] = channelBagIds;
|
|
1097
|
+
query_params["channel_shipment_ids"] = channelShipmentIds;
|
|
1098
|
+
query_params["channel_order_ids"] = channelOrderIds;
|
|
1099
|
+
query_params["channel_id"] = channelId;
|
|
1100
|
+
query_params["page_no"] = pageNo;
|
|
1101
|
+
query_params["page_size"] = pageSize;
|
|
1102
|
+
|
|
1103
|
+
const xHeaders = {};
|
|
1104
|
+
|
|
1105
|
+
return PlatformAPIClient.execute(
|
|
1106
|
+
this.config,
|
|
1107
|
+
"get",
|
|
1108
|
+
`/service/platform/orders/v1.0/company/${this.config.companyId}/bags`,
|
|
1109
|
+
query_params,
|
|
1110
|
+
undefined,
|
|
1111
|
+
xHeaders
|
|
1112
|
+
);
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* @param {Object} arg - Arg object.
|
|
1117
|
+
* @param {InvalidateShipmentCachePayload} arg.body
|
|
1118
|
+
* @summary:
|
|
1119
|
+
* @description: Invalidate shipment Cache
|
|
1120
|
+
*/
|
|
1121
|
+
invalidateShipmentCache({ body } = {}) {
|
|
1122
|
+
const { error } = OrderValidator.invalidateShipmentCache().validate(
|
|
1123
|
+
{
|
|
1124
|
+
body,
|
|
1125
|
+
},
|
|
1126
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1127
|
+
);
|
|
1128
|
+
if (error) {
|
|
1129
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
const query_params = {};
|
|
1133
|
+
|
|
1134
|
+
const xHeaders = {};
|
|
1135
|
+
|
|
1136
|
+
return PlatformAPIClient.execute(
|
|
1137
|
+
this.config,
|
|
1138
|
+
"put",
|
|
1139
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/update-cache`,
|
|
1140
|
+
query_params,
|
|
1141
|
+
body,
|
|
1142
|
+
xHeaders
|
|
1143
|
+
);
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
/**
|
|
1147
|
+
* @param {Object} arg - Arg object.
|
|
1148
|
+
* @param {StoreReassign} arg.body
|
|
1149
|
+
* @summary:
|
|
1150
|
+
* @description: Reassign Location
|
|
1151
|
+
*/
|
|
1152
|
+
reassignLocation({ body } = {}) {
|
|
1153
|
+
const { error } = OrderValidator.reassignLocation().validate(
|
|
1154
|
+
{
|
|
1155
|
+
body,
|
|
1156
|
+
},
|
|
1157
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1158
|
+
);
|
|
1159
|
+
if (error) {
|
|
1160
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1161
|
+
}
|
|
1162
|
+
|
|
1163
|
+
const query_params = {};
|
|
1164
|
+
|
|
1165
|
+
const xHeaders = {};
|
|
1166
|
+
|
|
1167
|
+
return PlatformAPIClient.execute(
|
|
1168
|
+
this.config,
|
|
1169
|
+
"post",
|
|
1170
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/store/reassign-internal`,
|
|
1171
|
+
query_params,
|
|
1172
|
+
body,
|
|
1173
|
+
xHeaders
|
|
1174
|
+
);
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
/**
|
|
1178
|
+
* @param {Object} arg - Arg object.
|
|
1179
|
+
* @param {UpdateShipmentLockPayload} arg.body
|
|
1180
|
+
* @summary:
|
|
1181
|
+
* @description: update shipment lock
|
|
1182
|
+
*/
|
|
1183
|
+
updateShipmentLock({ body } = {}) {
|
|
1184
|
+
const { error } = OrderValidator.updateShipmentLock().validate(
|
|
1185
|
+
{
|
|
1186
|
+
body,
|
|
1187
|
+
},
|
|
1188
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1189
|
+
);
|
|
1190
|
+
if (error) {
|
|
1191
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1192
|
+
}
|
|
1193
|
+
|
|
1194
|
+
const query_params = {};
|
|
1195
|
+
|
|
1196
|
+
const xHeaders = {};
|
|
1197
|
+
|
|
1198
|
+
return PlatformAPIClient.execute(
|
|
1199
|
+
this.config,
|
|
1200
|
+
"post",
|
|
1201
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/entity/lock-manager`,
|
|
1202
|
+
query_params,
|
|
1203
|
+
body,
|
|
1204
|
+
xHeaders
|
|
1205
|
+
);
|
|
1206
|
+
}
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* @param {Object} arg - Arg object.
|
|
1210
|
+
* @param {string} [arg.date] -
|
|
1211
|
+
* @summary:
|
|
1212
|
+
* @description:
|
|
1213
|
+
*/
|
|
1214
|
+
getAnnouncements({ date } = {}) {
|
|
1215
|
+
const { error } = OrderValidator.getAnnouncements().validate(
|
|
1216
|
+
{
|
|
1217
|
+
date,
|
|
1218
|
+
},
|
|
1219
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1220
|
+
);
|
|
1221
|
+
if (error) {
|
|
1222
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
const query_params = {};
|
|
1226
|
+
query_params["date"] = date;
|
|
1227
|
+
|
|
1228
|
+
const xHeaders = {};
|
|
1229
|
+
|
|
1230
|
+
return PlatformAPIClient.execute(
|
|
1231
|
+
this.config,
|
|
1232
|
+
"get",
|
|
1233
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/announcements`,
|
|
1234
|
+
query_params,
|
|
1235
|
+
undefined,
|
|
1236
|
+
xHeaders
|
|
1237
|
+
);
|
|
1238
|
+
}
|
|
1239
|
+
|
|
1240
|
+
/**
|
|
1241
|
+
* @param {Object} arg - Arg object.
|
|
1242
|
+
* @param {string} arg.shipmentId -
|
|
1243
|
+
* @param {string} [arg.name] -
|
|
1244
|
+
* @param {string} [arg.address] -
|
|
1245
|
+
* @param {string} [arg.addressType] -
|
|
1246
|
+
* @param {string} [arg.pincode] -
|
|
1247
|
+
* @param {string} [arg.phone] -
|
|
1248
|
+
* @param {string} [arg.email] -
|
|
1249
|
+
* @param {string} [arg.landmark] -
|
|
1250
|
+
* @param {string} arg.addressCategory -
|
|
1251
|
+
* @param {string} [arg.city] -
|
|
1252
|
+
* @param {string} [arg.state] -
|
|
1253
|
+
* @param {string} [arg.country] -
|
|
1254
|
+
* @summary:
|
|
1255
|
+
* @description:
|
|
1256
|
+
*/
|
|
1257
|
+
updateAddress({
|
|
1258
|
+
shipmentId,
|
|
1259
|
+
addressCategory,
|
|
1260
|
+
name,
|
|
1261
|
+
address,
|
|
1262
|
+
addressType,
|
|
1263
|
+
pincode,
|
|
1264
|
+
phone,
|
|
1265
|
+
email,
|
|
1266
|
+
landmark,
|
|
1267
|
+
city,
|
|
1268
|
+
state,
|
|
1269
|
+
country,
|
|
1270
|
+
} = {}) {
|
|
1271
|
+
const { error } = OrderValidator.updateAddress().validate(
|
|
1272
|
+
{
|
|
1273
|
+
shipmentId,
|
|
1274
|
+
addressCategory,
|
|
1275
|
+
name,
|
|
1276
|
+
address,
|
|
1277
|
+
addressType,
|
|
1278
|
+
pincode,
|
|
1279
|
+
phone,
|
|
1280
|
+
email,
|
|
1281
|
+
landmark,
|
|
1282
|
+
city,
|
|
1283
|
+
state,
|
|
1284
|
+
country,
|
|
1285
|
+
},
|
|
1286
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1287
|
+
);
|
|
1288
|
+
if (error) {
|
|
1289
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1290
|
+
}
|
|
1291
|
+
|
|
1292
|
+
const query_params = {};
|
|
1293
|
+
query_params["shipment_id"] = shipmentId;
|
|
1294
|
+
query_params["name"] = name;
|
|
1295
|
+
query_params["address"] = address;
|
|
1296
|
+
query_params["address_type"] = addressType;
|
|
1297
|
+
query_params["pincode"] = pincode;
|
|
1298
|
+
query_params["phone"] = phone;
|
|
1299
|
+
query_params["email"] = email;
|
|
1300
|
+
query_params["landmark"] = landmark;
|
|
1301
|
+
query_params["address_category"] = addressCategory;
|
|
1302
|
+
query_params["city"] = city;
|
|
1303
|
+
query_params["state"] = state;
|
|
1304
|
+
query_params["country"] = country;
|
|
1305
|
+
|
|
1306
|
+
const xHeaders = {};
|
|
1307
|
+
|
|
1308
|
+
return PlatformAPIClient.execute(
|
|
1309
|
+
this.config,
|
|
1310
|
+
"post",
|
|
1311
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/delight/update-address`,
|
|
1312
|
+
query_params,
|
|
1313
|
+
undefined,
|
|
1314
|
+
xHeaders
|
|
1315
|
+
);
|
|
1316
|
+
}
|
|
1317
|
+
|
|
1318
|
+
/**
|
|
1319
|
+
* @param {Object} arg - Arg object.
|
|
1320
|
+
* @param {string} arg.caller -
|
|
1321
|
+
* @param {string} arg.receiver -
|
|
1322
|
+
* @param {string} arg.bagId -
|
|
1323
|
+
* @param {string} [arg.callingTo] -
|
|
1324
|
+
* @param {string} [arg.callerId] -
|
|
1325
|
+
* @summary:
|
|
1326
|
+
* @description:
|
|
1327
|
+
*/
|
|
1328
|
+
click2Call({ caller, receiver, bagId, callingTo, callerId } = {}) {
|
|
1329
|
+
const { error } = OrderValidator.click2Call().validate(
|
|
1330
|
+
{
|
|
1331
|
+
caller,
|
|
1332
|
+
receiver,
|
|
1333
|
+
bagId,
|
|
1334
|
+
callingTo,
|
|
1335
|
+
callerId,
|
|
1336
|
+
},
|
|
1337
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1338
|
+
);
|
|
1339
|
+
if (error) {
|
|
1340
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1341
|
+
}
|
|
1342
|
+
|
|
1343
|
+
const query_params = {};
|
|
1344
|
+
query_params["caller"] = caller;
|
|
1345
|
+
query_params["receiver"] = receiver;
|
|
1346
|
+
query_params["bag_id"] = bagId;
|
|
1347
|
+
query_params["calling_to"] = callingTo;
|
|
1348
|
+
query_params["caller_id"] = callerId;
|
|
1349
|
+
|
|
1350
|
+
const xHeaders = {};
|
|
1351
|
+
|
|
1352
|
+
return PlatformAPIClient.execute(
|
|
1353
|
+
this.config,
|
|
1354
|
+
"get",
|
|
1355
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/ninja/click2call`,
|
|
1356
|
+
query_params,
|
|
1357
|
+
undefined,
|
|
1358
|
+
xHeaders
|
|
1359
|
+
);
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
/**
|
|
1363
|
+
* @param {Object} arg - Arg object.
|
|
1364
|
+
* @param {UpdateShipmentStatusRequest} arg.body
|
|
1365
|
+
* @summary:
|
|
1366
|
+
* @description: Update shipment status
|
|
1367
|
+
*/
|
|
1368
|
+
updateShipmentStatus({ body } = {}) {
|
|
1369
|
+
const { error } = OrderValidator.updateShipmentStatus().validate(
|
|
1370
|
+
{
|
|
1371
|
+
body,
|
|
1372
|
+
},
|
|
1373
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1374
|
+
);
|
|
1375
|
+
if (error) {
|
|
1376
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
const query_params = {};
|
|
1380
|
+
|
|
1381
|
+
const xHeaders = {};
|
|
1382
|
+
|
|
1383
|
+
return PlatformAPIClient.execute(
|
|
1384
|
+
this.config,
|
|
1385
|
+
"put",
|
|
1386
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/shipment/status-internal`,
|
|
1387
|
+
query_params,
|
|
1388
|
+
body,
|
|
1389
|
+
xHeaders
|
|
1390
|
+
);
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
/**
|
|
1394
|
+
* @param {Object} arg - Arg object.
|
|
1395
|
+
* @param {CreateOrderPayload} arg.body
|
|
1396
|
+
* @summary:
|
|
1397
|
+
* @description:
|
|
1398
|
+
*/
|
|
1399
|
+
processManifest({ body } = {}) {
|
|
1400
|
+
const { error } = OrderValidator.processManifest().validate(
|
|
1401
|
+
{
|
|
1402
|
+
body,
|
|
1403
|
+
},
|
|
1404
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1405
|
+
);
|
|
1406
|
+
if (error) {
|
|
1407
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1408
|
+
}
|
|
1409
|
+
|
|
1410
|
+
const query_params = {};
|
|
1411
|
+
|
|
1412
|
+
const xHeaders = {};
|
|
1413
|
+
|
|
1414
|
+
return PlatformAPIClient.execute(
|
|
1415
|
+
this.config,
|
|
1416
|
+
"post",
|
|
1417
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/process-manifest`,
|
|
1418
|
+
query_params,
|
|
1419
|
+
body,
|
|
1420
|
+
xHeaders
|
|
1421
|
+
);
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1424
|
+
/**
|
|
1425
|
+
* @param {Object} arg - Arg object.
|
|
1426
|
+
* @param {DispatchManifest} arg.body
|
|
1427
|
+
* @summary:
|
|
1428
|
+
* @description:
|
|
1429
|
+
*/
|
|
1430
|
+
dispatchManifest({ body } = {}) {
|
|
1431
|
+
const { error } = OrderValidator.dispatchManifest().validate(
|
|
1432
|
+
{
|
|
1433
|
+
body,
|
|
1434
|
+
},
|
|
1435
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1436
|
+
);
|
|
1437
|
+
if (error) {
|
|
1438
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1439
|
+
}
|
|
1440
|
+
|
|
1441
|
+
const query_params = {};
|
|
1442
|
+
|
|
1443
|
+
const xHeaders = {};
|
|
1444
|
+
|
|
1445
|
+
return PlatformAPIClient.execute(
|
|
1446
|
+
this.config,
|
|
1447
|
+
"post",
|
|
1448
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/dispatch`,
|
|
1449
|
+
query_params,
|
|
1450
|
+
body,
|
|
1451
|
+
xHeaders
|
|
1452
|
+
);
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
/**
|
|
1456
|
+
* @param {Object} arg - Arg object.
|
|
1457
|
+
* @summary:
|
|
1458
|
+
* @description:
|
|
1459
|
+
*/
|
|
1460
|
+
getRoleBasedActions({} = {}) {
|
|
1461
|
+
const { error } = OrderValidator.getRoleBasedActions().validate(
|
|
1462
|
+
{},
|
|
1463
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1464
|
+
);
|
|
1465
|
+
if (error) {
|
|
1466
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1467
|
+
}
|
|
1468
|
+
|
|
1469
|
+
const query_params = {};
|
|
1470
|
+
|
|
1471
|
+
const xHeaders = {};
|
|
1472
|
+
|
|
1473
|
+
return PlatformAPIClient.execute(
|
|
1474
|
+
this.config,
|
|
1475
|
+
"get",
|
|
1476
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/roles`,
|
|
1477
|
+
query_params,
|
|
1478
|
+
undefined,
|
|
1479
|
+
xHeaders
|
|
1480
|
+
);
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1483
|
+
/**
|
|
1484
|
+
* @param {Object} arg - Arg object.
|
|
1485
|
+
* @param {number} [arg.shipmentId] -
|
|
1486
|
+
* @param {number} [arg.bagId] -
|
|
1487
|
+
* @summary:
|
|
1488
|
+
* @description:
|
|
1489
|
+
*/
|
|
1490
|
+
getShipmentHistory({ shipmentId, bagId } = {}) {
|
|
1491
|
+
const { error } = OrderValidator.getShipmentHistory().validate(
|
|
1492
|
+
{
|
|
1493
|
+
shipmentId,
|
|
1494
|
+
bagId,
|
|
1495
|
+
},
|
|
1496
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1497
|
+
);
|
|
1498
|
+
if (error) {
|
|
1499
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
const query_params = {};
|
|
1503
|
+
query_params["shipment_id"] = shipmentId;
|
|
1504
|
+
query_params["bag_id"] = bagId;
|
|
1505
|
+
|
|
1506
|
+
const xHeaders = {};
|
|
1507
|
+
|
|
1508
|
+
return PlatformAPIClient.execute(
|
|
1509
|
+
this.config,
|
|
1510
|
+
"get",
|
|
1511
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/shipment/history`,
|
|
1512
|
+
query_params,
|
|
1513
|
+
undefined,
|
|
1514
|
+
xHeaders
|
|
1515
|
+
);
|
|
1516
|
+
}
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* @param {Object} arg - Arg object.
|
|
1520
|
+
* @param {SendSmsPayload} arg.body
|
|
1521
|
+
* @summary:
|
|
1522
|
+
* @description:
|
|
1523
|
+
*/
|
|
1524
|
+
sendSmsNinja({ body } = {}) {
|
|
1525
|
+
const { error } = OrderValidator.sendSmsNinja().validate(
|
|
1526
|
+
{
|
|
1527
|
+
body,
|
|
1528
|
+
},
|
|
1529
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1530
|
+
);
|
|
1531
|
+
if (error) {
|
|
1532
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1533
|
+
}
|
|
1534
|
+
|
|
1535
|
+
const query_params = {};
|
|
1536
|
+
|
|
1537
|
+
const xHeaders = {};
|
|
1538
|
+
|
|
1539
|
+
return PlatformAPIClient.execute(
|
|
1540
|
+
this.config,
|
|
1541
|
+
"post",
|
|
1542
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/ninja/send-sms`,
|
|
1543
|
+
query_params,
|
|
1544
|
+
body,
|
|
1545
|
+
xHeaders
|
|
1546
|
+
);
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
/**
|
|
1550
|
+
* @param {Object} arg - Arg object.
|
|
1551
|
+
* @param {ManualAssignDPToShipment} arg.body
|
|
1552
|
+
* @summary:
|
|
1553
|
+
* @description:
|
|
1554
|
+
*/
|
|
1555
|
+
platformManualAssignDPToShipment({ body } = {}) {
|
|
1556
|
+
const {
|
|
1557
|
+
error,
|
|
1558
|
+
} = OrderValidator.platformManualAssignDPToShipment().validate(
|
|
1559
|
+
{
|
|
1560
|
+
body,
|
|
1561
|
+
},
|
|
1562
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1563
|
+
);
|
|
1564
|
+
if (error) {
|
|
1565
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
const query_params = {};
|
|
1569
|
+
|
|
1570
|
+
const xHeaders = {};
|
|
1571
|
+
|
|
1572
|
+
return PlatformAPIClient.execute(
|
|
1573
|
+
this.config,
|
|
1574
|
+
"post",
|
|
1575
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/oms/manual-place-shipment`,
|
|
1576
|
+
query_params,
|
|
1577
|
+
body,
|
|
1578
|
+
xHeaders
|
|
1579
|
+
);
|
|
1580
|
+
}
|
|
1581
|
+
|
|
1582
|
+
/**
|
|
1583
|
+
* @param {Object} arg - Arg object.
|
|
1584
|
+
* @param {CreateOrderPayload} arg.body
|
|
1585
|
+
* @summary:
|
|
1586
|
+
* @description:
|
|
1587
|
+
*/
|
|
1588
|
+
updatePackagingDimensions({ body } = {}) {
|
|
1589
|
+
const { error } = OrderValidator.updatePackagingDimensions().validate(
|
|
1590
|
+
{
|
|
1591
|
+
body,
|
|
1592
|
+
},
|
|
1593
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1594
|
+
);
|
|
1595
|
+
if (error) {
|
|
1596
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1597
|
+
}
|
|
1598
|
+
|
|
1599
|
+
const query_params = {};
|
|
1600
|
+
|
|
1601
|
+
const xHeaders = {};
|
|
1602
|
+
|
|
1603
|
+
return PlatformAPIClient.execute(
|
|
1604
|
+
this.config,
|
|
1605
|
+
"post",
|
|
1606
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/update-packaging-dimension`,
|
|
1607
|
+
query_params,
|
|
1608
|
+
body,
|
|
1609
|
+
xHeaders
|
|
1610
|
+
);
|
|
1611
|
+
}
|
|
1612
|
+
|
|
1613
|
+
/**
|
|
1614
|
+
* @param {Object} arg - Arg object.
|
|
1615
|
+
* @param {CreateOrderAPI} arg.body
|
|
1616
|
+
* @summary:
|
|
1617
|
+
* @description:
|
|
1618
|
+
*/
|
|
1619
|
+
createOrder({ body } = {}) {
|
|
1620
|
+
const { error } = OrderValidator.createOrder().validate(
|
|
1621
|
+
{
|
|
1622
|
+
body,
|
|
1623
|
+
},
|
|
1624
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1625
|
+
);
|
|
1626
|
+
if (error) {
|
|
1627
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1628
|
+
}
|
|
1629
|
+
|
|
1630
|
+
const query_params = {};
|
|
1631
|
+
|
|
1632
|
+
const xHeaders = {};
|
|
1633
|
+
|
|
1634
|
+
return PlatformAPIClient.execute(
|
|
1635
|
+
this.config,
|
|
1636
|
+
"post",
|
|
1637
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/create-order`,
|
|
1638
|
+
query_params,
|
|
1639
|
+
body,
|
|
1640
|
+
xHeaders
|
|
1641
|
+
);
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
/**
|
|
1645
|
+
* @param {Object} arg - Arg object.
|
|
1646
|
+
* @param {CreateChannelConfigData} arg.body
|
|
1647
|
+
* @summary:
|
|
1648
|
+
* @description: createChannelConfig
|
|
1649
|
+
*/
|
|
1650
|
+
createChannelConfig({ body } = {}) {
|
|
1651
|
+
const { error } = OrderValidator.createChannelConfig().validate(
|
|
1652
|
+
{
|
|
1653
|
+
body,
|
|
1654
|
+
},
|
|
1655
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1656
|
+
);
|
|
1657
|
+
if (error) {
|
|
1658
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1659
|
+
}
|
|
1660
|
+
|
|
1661
|
+
const query_params = {};
|
|
1662
|
+
|
|
1663
|
+
const xHeaders = {};
|
|
1664
|
+
|
|
1665
|
+
return PlatformAPIClient.execute(
|
|
1666
|
+
this.config,
|
|
1667
|
+
"post",
|
|
1668
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
1669
|
+
query_params,
|
|
1670
|
+
body,
|
|
1671
|
+
xHeaders
|
|
1672
|
+
);
|
|
1673
|
+
}
|
|
1674
|
+
|
|
1675
|
+
/**
|
|
1676
|
+
* @param {Object} arg - Arg object.
|
|
1677
|
+
* @summary:
|
|
1678
|
+
* @description: getChannelConfig
|
|
1679
|
+
*/
|
|
1680
|
+
getChannelConfig({} = {}) {
|
|
1681
|
+
const { error } = OrderValidator.getChannelConfig().validate(
|
|
1682
|
+
{},
|
|
1683
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1684
|
+
);
|
|
1685
|
+
if (error) {
|
|
1686
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1687
|
+
}
|
|
1688
|
+
|
|
1689
|
+
const query_params = {};
|
|
1690
|
+
|
|
1691
|
+
const xHeaders = {};
|
|
1692
|
+
|
|
1693
|
+
return PlatformAPIClient.execute(
|
|
1694
|
+
this.config,
|
|
1695
|
+
"get",
|
|
1696
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
1697
|
+
query_params,
|
|
1698
|
+
undefined,
|
|
1699
|
+
xHeaders
|
|
1700
|
+
);
|
|
1701
|
+
}
|
|
1702
|
+
|
|
1703
|
+
/**
|
|
1704
|
+
* @param {Object} arg - Arg object.
|
|
1705
|
+
* @param {UploadConsent} arg.body
|
|
1706
|
+
* @summary:
|
|
1707
|
+
* @description:
|
|
1708
|
+
*/
|
|
1709
|
+
uploadConsent({ body } = {}) {
|
|
1710
|
+
const { error } = OrderValidator.uploadConsent().validate(
|
|
1711
|
+
{
|
|
1712
|
+
body,
|
|
1713
|
+
},
|
|
1714
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1715
|
+
);
|
|
1716
|
+
if (error) {
|
|
1717
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1718
|
+
}
|
|
1719
|
+
|
|
1720
|
+
const query_params = {};
|
|
1721
|
+
|
|
1722
|
+
const xHeaders = {};
|
|
1723
|
+
|
|
1724
|
+
return PlatformAPIClient.execute(
|
|
1725
|
+
this.config,
|
|
1726
|
+
"post",
|
|
1727
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/uploadConsent`,
|
|
1728
|
+
query_params,
|
|
1729
|
+
body,
|
|
1730
|
+
xHeaders
|
|
1731
|
+
);
|
|
1732
|
+
}
|
|
1733
|
+
|
|
1734
|
+
/**
|
|
1735
|
+
* @param {Object} arg - Arg object.
|
|
1736
|
+
* @param {PlatformOrderUpdate} arg.body
|
|
1737
|
+
* @summary:
|
|
1738
|
+
* @description:
|
|
1739
|
+
*/
|
|
1740
|
+
orderUpdate({ body } = {}) {
|
|
1741
|
+
const { error } = OrderValidator.orderUpdate().validate(
|
|
1742
|
+
{
|
|
1743
|
+
body,
|
|
1744
|
+
},
|
|
1745
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1746
|
+
);
|
|
1747
|
+
if (error) {
|
|
1748
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
const query_params = {};
|
|
1752
|
+
|
|
1753
|
+
const xHeaders = {};
|
|
1754
|
+
|
|
1755
|
+
return PlatformAPIClient.execute(
|
|
1756
|
+
this.config,
|
|
1757
|
+
"put",
|
|
1758
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order/validation`,
|
|
1759
|
+
query_params,
|
|
1760
|
+
body,
|
|
1761
|
+
xHeaders
|
|
1762
|
+
);
|
|
1763
|
+
}
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* @param {Object} arg - Arg object.
|
|
1767
|
+
* @param {OrderStatus} arg.body
|
|
1768
|
+
* @summary:
|
|
1769
|
+
* @description:
|
|
1770
|
+
*/
|
|
1771
|
+
checkOrderStatus({ body } = {}) {
|
|
1772
|
+
const { error } = OrderValidator.checkOrderStatus().validate(
|
|
1773
|
+
{
|
|
1774
|
+
body,
|
|
1775
|
+
},
|
|
1776
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1777
|
+
);
|
|
1778
|
+
if (error) {
|
|
1779
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
const query_params = {};
|
|
1783
|
+
|
|
1784
|
+
const xHeaders = {};
|
|
1785
|
+
|
|
1786
|
+
return PlatformAPIClient.execute(
|
|
1787
|
+
this.config,
|
|
1788
|
+
"post",
|
|
1789
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/debug/order_status`,
|
|
1790
|
+
query_params,
|
|
1791
|
+
body,
|
|
1792
|
+
xHeaders
|
|
1793
|
+
);
|
|
1794
|
+
}
|
|
1795
|
+
|
|
1796
|
+
/**
|
|
1797
|
+
* @param {Object} arg - Arg object.
|
|
1798
|
+
* @summary:
|
|
1799
|
+
* @description:
|
|
1800
|
+
*/
|
|
1801
|
+
sendSmsNinjaPlatform({} = {}) {
|
|
1802
|
+
const { error } = OrderValidator.sendSmsNinjaPlatform().validate(
|
|
1803
|
+
{},
|
|
1804
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1805
|
+
);
|
|
1806
|
+
if (error) {
|
|
1807
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1808
|
+
}
|
|
1809
|
+
|
|
1810
|
+
const query_params = {};
|
|
1811
|
+
|
|
1812
|
+
const xHeaders = {};
|
|
1813
|
+
|
|
1814
|
+
return PlatformAPIClient.execute(
|
|
1815
|
+
this.config,
|
|
1816
|
+
"get",
|
|
1817
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/bag/state/transition`,
|
|
1818
|
+
query_params,
|
|
1819
|
+
undefined,
|
|
516
1820
|
xHeaders
|
|
517
1821
|
);
|
|
518
1822
|
}
|