@gofynd/fdk-client-javascript 1.4.5 → 1.4.7
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/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -2
- package/sdk/application/ApplicationClient.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +5 -5
- package/sdk/application/Catalog/CatalogApplicationClient.js +5 -5
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +6 -0
- package/sdk/application/Catalog/CatalogApplicationModel.js +6 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +2 -0
- package/sdk/application/Content/ContentApplicationModel.js +2 -0
- package/sdk/application/Logistic/LogisticApplicationModel.js +2 -2
- package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.js +1 -1
- package/sdk/application/Order/OrderApplicationModel.d.ts +70 -9
- package/sdk/application/Order/OrderApplicationModel.js +43 -7
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -2
- package/sdk/application/Order/OrderApplicationValidator.js +1 -1
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +18 -18
- package/sdk/application/Payment/PaymentApplicationModel.js +41 -35
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +22 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +115 -0
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +37 -0
- package/sdk/application/Webhook/WebhookApplicationModel.js +46 -0
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +16 -0
- package/sdk/application/Webhook/WebhookApplicationValidator.js +19 -0
- package/sdk/application/index.d.ts +1 -1
- package/sdk/application/index.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +23 -19
- package/sdk/partner/Webhook/WebhookPartnerModel.js +20 -23
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +43 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +257 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +39 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +45 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +60 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +57 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +80 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -0
- package/sdk/platform/Cart/CartPlatformModel.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +34 -7
- package/sdk/platform/Catalog/CatalogPlatformClient.js +88 -13
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +120 -17
- package/sdk/platform/Catalog/CatalogPlatformModel.js +153 -27
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +71 -7
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +32 -5
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -0
- package/sdk/platform/Content/ContentPlatformModel.js +2 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -1
- package/sdk/platform/Order/OrderPlatformClient.js +82 -5
- package/sdk/platform/Order/OrderPlatformModel.d.ts +163 -15
- package/sdk/platform/Order/OrderPlatformModel.js +157 -55
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +58 -17
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -16
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +24 -18
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -0
- package/sdk/platform/PlatformApplicationClient.js +4 -0
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +24 -0
- package/sdk/platform/Webhook/WebhookPlatformClient.js +164 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +71 -18
- package/sdk/platform/Webhook/WebhookPlatformModel.js +76 -23
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +19 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +24 -0
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +2 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +3 -1
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +0 -323
- package/sdk/application/PosCart/PosCartApplicationClient.js +0 -2364
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +0 -1857
- package/sdk/application/PosCart/PosCartApplicationModel.js +0 -1906
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +0 -483
- package/sdk/application/PosCart/PosCartApplicationValidator.js +0 -492
|
@@ -506,7 +506,7 @@ const Joi = require("joi");
|
|
|
506
506
|
|
|
507
507
|
/**
|
|
508
508
|
* @typedef DispatchManifest
|
|
509
|
-
* @property {string} manifest_id
|
|
509
|
+
* @property {string} manifest_id - Id of the manifest.
|
|
510
510
|
*/
|
|
511
511
|
|
|
512
512
|
/**
|
|
@@ -1307,15 +1307,18 @@ const Joi = require("joi");
|
|
|
1307
1307
|
/**
|
|
1308
1308
|
* @typedef Filters
|
|
1309
1309
|
* @property {DateRange} [date_range]
|
|
1310
|
-
* @property {string} [logo]
|
|
1311
|
-
* @property {string} [from_date]
|
|
1312
|
-
* @property {number} [stores]
|
|
1313
|
-
* @property {string} [to_date]
|
|
1314
|
-
* @property {string} [dp_name]
|
|
1315
|
-
* @property {
|
|
1316
|
-
*
|
|
1317
|
-
* @property {string} [
|
|
1318
|
-
* @property {string} [
|
|
1310
|
+
* @property {string} [logo] - CDN link of the logo displayed on the manifest page.
|
|
1311
|
+
* @property {string} [from_date] - UTC start date in ISO format.
|
|
1312
|
+
* @property {number} [stores] - Filter with the specific store.
|
|
1313
|
+
* @property {string} [to_date] - UTC end date in ISO format.
|
|
1314
|
+
* @property {string} [dp_name] - Filter with the specific courier partner name.
|
|
1315
|
+
* @property {string} [dp_ids] - Combination of courier partner ids separated by
|
|
1316
|
+
* byte operator.
|
|
1317
|
+
* @property {string} [lane] - Criteria for lane on which shipments must be fetched.
|
|
1318
|
+
* @property {string} [selected_shipments] - Selected shipments mapped to the manifest.
|
|
1319
|
+
* @property {string} [store_name] - Filter with the specific store name.
|
|
1320
|
+
* @property {string} [deselected_shipments] - Deselected shipments unmapped
|
|
1321
|
+
* from the manifest.
|
|
1319
1322
|
*/
|
|
1320
1323
|
|
|
1321
1324
|
/**
|
|
@@ -1405,10 +1408,10 @@ const Joi = require("joi");
|
|
|
1405
1408
|
|
|
1406
1409
|
/**
|
|
1407
1410
|
* @typedef ProcessManifestResponse
|
|
1408
|
-
* @property {number} [company_id]
|
|
1411
|
+
* @property {number} [company_id] - Id of the company.
|
|
1409
1412
|
* @property {Filters} [filters]
|
|
1410
|
-
* @property {string} [user_id]
|
|
1411
|
-
* @property {string} [manifest_id]
|
|
1413
|
+
* @property {string} [user_id] - Id of the user.
|
|
1414
|
+
* @property {string} [manifest_id] - Id of the manifest.
|
|
1412
1415
|
* @property {string} [action]
|
|
1413
1416
|
* @property {string} [uid]
|
|
1414
1417
|
* @property {string} [created_by]
|
|
@@ -1624,6 +1627,40 @@ const Joi = require("joi");
|
|
|
1624
1627
|
* @property {GenerateInvoiceIDErrorResponseData[]} [items]
|
|
1625
1628
|
*/
|
|
1626
1629
|
|
|
1630
|
+
/**
|
|
1631
|
+
* @typedef ManifestResponse
|
|
1632
|
+
* @property {ManifestItems} [items]
|
|
1633
|
+
*/
|
|
1634
|
+
|
|
1635
|
+
/**
|
|
1636
|
+
* @typedef ProcessManifestRequest
|
|
1637
|
+
* @property {string} [action] - Expected Actions: [save, process,
|
|
1638
|
+
* pdf_generated,invalidate,pdf_failed,complete]
|
|
1639
|
+
* @property {string} [manifest_id] - Id of The Manifest.
|
|
1640
|
+
* @property {Filters} [filters]
|
|
1641
|
+
* @property {string} [unique_id] - Unique Id.
|
|
1642
|
+
*/
|
|
1643
|
+
|
|
1644
|
+
/**
|
|
1645
|
+
* @typedef ManifestItems
|
|
1646
|
+
* @property {Filters} [filters]
|
|
1647
|
+
* @property {string} [manifest_id] - Id of the manifest.
|
|
1648
|
+
* @property {string} [unique_id] - Unique Id.
|
|
1649
|
+
* @property {number} [company_id] - Id of the company.
|
|
1650
|
+
* @property {string} [dp_id] - Shipment with the specific courier partner Id.
|
|
1651
|
+
* @property {string} [courier_partner_slug]
|
|
1652
|
+
* @property {string} [action] - Expected Actions: [Save, Process, Pdf
|
|
1653
|
+
* Generated, Invalidate, Pdf Failed, Complete]
|
|
1654
|
+
* @property {string} [created_by] - Created date of the manifest.
|
|
1655
|
+
* @property {string} [user_id] - Id of user.
|
|
1656
|
+
*/
|
|
1657
|
+
|
|
1658
|
+
/**
|
|
1659
|
+
* @typedef ManifestErrorResponse
|
|
1660
|
+
* @property {boolean} [success] - Success State.
|
|
1661
|
+
* @property {string} [error] - Error String.
|
|
1662
|
+
*/
|
|
1663
|
+
|
|
1627
1664
|
/**
|
|
1628
1665
|
* @typedef Page
|
|
1629
1666
|
* @property {number} [item_total]
|
|
@@ -3190,7 +3227,7 @@ class OrderPlatformModel {
|
|
|
3190
3227
|
fynd_order_id: Joi.string().allow("").allow(null),
|
|
3191
3228
|
set_id: Joi.string().allow("").allow(null),
|
|
3192
3229
|
affiliate_bag_id: Joi.string().allow("").allow(null),
|
|
3193
|
-
reason_ids: Joi.array().items(Joi.number()),
|
|
3230
|
+
reason_ids: Joi.array().items(Joi.number()).allow(null, ""),
|
|
3194
3231
|
mongo_article_id: Joi.string().allow("").allow(null),
|
|
3195
3232
|
});
|
|
3196
3233
|
}
|
|
@@ -4095,7 +4132,7 @@ class OrderPlatformModel {
|
|
|
4095
4132
|
eway_bill_id: Joi.string().allow("").allow(null),
|
|
4096
4133
|
affiliate_shipment_id: Joi.string().allow("").allow(null),
|
|
4097
4134
|
fynd_order_id: Joi.string().allow(""),
|
|
4098
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
4135
|
+
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
4099
4136
|
created_at: Joi.string().allow(""),
|
|
4100
4137
|
delivery_awb_number: Joi.string().allow("").allow(null),
|
|
4101
4138
|
hand_over_contact_json: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
@@ -4747,10 +4784,11 @@ class OrderPlatformModel {
|
|
|
4747
4784
|
stores: Joi.number(),
|
|
4748
4785
|
to_date: Joi.string().allow(""),
|
|
4749
4786
|
dp_name: Joi.string().allow(""),
|
|
4750
|
-
dp_ids: Joi.
|
|
4787
|
+
dp_ids: Joi.string().allow(""),
|
|
4751
4788
|
lane: Joi.string().allow(""),
|
|
4752
4789
|
selected_shipments: Joi.string().allow(""),
|
|
4753
4790
|
store_name: Joi.string().allow(""),
|
|
4791
|
+
deselected_shipments: Joi.string().allow(""),
|
|
4754
4792
|
});
|
|
4755
4793
|
}
|
|
4756
4794
|
|
|
@@ -4896,7 +4934,9 @@ class OrderPlatformModel {
|
|
|
4896
4934
|
/** @returns {FiltersInfo} */
|
|
4897
4935
|
static FiltersInfo() {
|
|
4898
4936
|
return Joi.object({
|
|
4899
|
-
options: Joi.array()
|
|
4937
|
+
options: Joi.array()
|
|
4938
|
+
.items(OrderPlatformModel.FilterInfoOption())
|
|
4939
|
+
.allow(null, ""),
|
|
4900
4940
|
text: Joi.string().allow("").required(),
|
|
4901
4941
|
placeholder_text: Joi.string().allow("").allow(null),
|
|
4902
4942
|
value: Joi.string().allow("").required(),
|
|
@@ -5154,6 +5194,46 @@ class OrderPlatformModel {
|
|
|
5154
5194
|
});
|
|
5155
5195
|
}
|
|
5156
5196
|
|
|
5197
|
+
/** @returns {ManifestResponse} */
|
|
5198
|
+
static ManifestResponse() {
|
|
5199
|
+
return Joi.object({
|
|
5200
|
+
items: OrderPlatformModel.ManifestItems(),
|
|
5201
|
+
});
|
|
5202
|
+
}
|
|
5203
|
+
|
|
5204
|
+
/** @returns {ProcessManifestRequest} */
|
|
5205
|
+
static ProcessManifestRequest() {
|
|
5206
|
+
return Joi.object({
|
|
5207
|
+
action: Joi.string().allow(""),
|
|
5208
|
+
manifest_id: Joi.string().allow(""),
|
|
5209
|
+
filters: OrderPlatformModel.Filters(),
|
|
5210
|
+
unique_id: Joi.string().allow(""),
|
|
5211
|
+
});
|
|
5212
|
+
}
|
|
5213
|
+
|
|
5214
|
+
/** @returns {ManifestItems} */
|
|
5215
|
+
static ManifestItems() {
|
|
5216
|
+
return Joi.object({
|
|
5217
|
+
filters: OrderPlatformModel.Filters(),
|
|
5218
|
+
manifest_id: Joi.string().allow(""),
|
|
5219
|
+
unique_id: Joi.string().allow(""),
|
|
5220
|
+
company_id: Joi.number(),
|
|
5221
|
+
dp_id: Joi.string().allow("").allow(null),
|
|
5222
|
+
courier_partner_slug: Joi.string().allow(""),
|
|
5223
|
+
action: Joi.string().allow(""),
|
|
5224
|
+
created_by: Joi.string().allow(""),
|
|
5225
|
+
user_id: Joi.string().allow(""),
|
|
5226
|
+
});
|
|
5227
|
+
}
|
|
5228
|
+
|
|
5229
|
+
/** @returns {ManifestErrorResponse} */
|
|
5230
|
+
static ManifestErrorResponse() {
|
|
5231
|
+
return Joi.object({
|
|
5232
|
+
success: Joi.boolean(),
|
|
5233
|
+
error: Joi.string().allow(""),
|
|
5234
|
+
});
|
|
5235
|
+
}
|
|
5236
|
+
|
|
5157
5237
|
/** @returns {Page} */
|
|
5158
5238
|
static Page() {
|
|
5159
5239
|
return Joi.object({
|
|
@@ -5208,7 +5288,7 @@ class OrderPlatformModel {
|
|
|
5208
5288
|
current_shipment_status: Joi.string().allow("").allow(null),
|
|
5209
5289
|
meta: Joi.any().allow(null),
|
|
5210
5290
|
shipment_status_id: Joi.number().allow(null),
|
|
5211
|
-
bag_list: Joi.array().items(Joi.string().allow("")),
|
|
5291
|
+
bag_list: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5212
5292
|
title: Joi.string().allow("").required(),
|
|
5213
5293
|
created_at: Joi.string().allow("").allow(null),
|
|
5214
5294
|
created_ts: Joi.string().allow("").allow(null),
|
|
@@ -5401,7 +5481,7 @@ class OrderPlatformModel {
|
|
|
5401
5481
|
updated_ts: Joi.string().allow("").allow(null),
|
|
5402
5482
|
bag_state_mapper: OrderPlatformModel.BagStateMapper(),
|
|
5403
5483
|
bag_id: Joi.number().allow(null),
|
|
5404
|
-
reasons: Joi.array().items(Joi.any()),
|
|
5484
|
+
reasons: Joi.array().items(Joi.any()).allow(null, ""),
|
|
5405
5485
|
status: Joi.string().allow("").required(),
|
|
5406
5486
|
display_name: Joi.string().allow("").allow(null),
|
|
5407
5487
|
});
|
|
@@ -5454,7 +5534,7 @@ class OrderPlatformModel {
|
|
|
5454
5534
|
raw_meta: Joi.string().allow("").allow(null),
|
|
5455
5535
|
size: Joi.string().allow("").required(),
|
|
5456
5536
|
is_set: Joi.boolean().allow(null),
|
|
5457
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
5537
|
+
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5458
5538
|
});
|
|
5459
5539
|
}
|
|
5460
5540
|
|
|
@@ -5527,11 +5607,11 @@ class OrderPlatformModel {
|
|
|
5527
5607
|
l3_category_name: Joi.string().allow("").allow(null),
|
|
5528
5608
|
last_updated_at: Joi.string().allow("").allow(null),
|
|
5529
5609
|
name: Joi.string().allow("").allow(null),
|
|
5530
|
-
l2_category: Joi.array().items(Joi.string().allow("")),
|
|
5610
|
+
l2_category: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5531
5611
|
brand: Joi.string().allow("").allow(null),
|
|
5532
|
-
image: Joi.array().items(Joi.string().allow("")),
|
|
5612
|
+
image: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5533
5613
|
code: Joi.string().allow("").allow(null),
|
|
5534
|
-
l1_category: Joi.array().items(Joi.string().allow("")),
|
|
5614
|
+
l1_category: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5535
5615
|
size: Joi.string().allow("").allow(null),
|
|
5536
5616
|
can_cancel: Joi.boolean().allow(null),
|
|
5537
5617
|
can_return: Joi.boolean().allow(null),
|
|
@@ -5539,7 +5619,7 @@ class OrderPlatformModel {
|
|
|
5539
5619
|
meta: Joi.any().allow(null),
|
|
5540
5620
|
color: Joi.string().allow("").allow(null),
|
|
5541
5621
|
department_id: Joi.number().allow(null),
|
|
5542
|
-
images: Joi.array().items(Joi.string().allow("")),
|
|
5622
|
+
images: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5543
5623
|
});
|
|
5544
5624
|
}
|
|
5545
5625
|
|
|
@@ -5577,7 +5657,7 @@ class OrderPlatformModel {
|
|
|
5577
5657
|
brand: OrderPlatformModel.ShipmentListingBrand(),
|
|
5578
5658
|
affiliate_bag_details: OrderPlatformModel.AffiliateBagDetails(),
|
|
5579
5659
|
item: OrderPlatformModel.PlatformItem(),
|
|
5580
|
-
reasons: Joi.array().items(Joi.any()),
|
|
5660
|
+
reasons: Joi.array().items(Joi.any()).allow(null, ""),
|
|
5581
5661
|
product_quantity: Joi.number().required(),
|
|
5582
5662
|
can_return: Joi.boolean().allow(null),
|
|
5583
5663
|
display_name: Joi.string().allow("").allow(null),
|
|
@@ -5598,7 +5678,9 @@ class OrderPlatformModel {
|
|
|
5598
5678
|
static ShipmentItemFulFillingStore() {
|
|
5599
5679
|
return Joi.object({
|
|
5600
5680
|
phone: Joi.string().allow("").allow(null),
|
|
5601
|
-
brand_store_tags: Joi.array()
|
|
5681
|
+
brand_store_tags: Joi.array()
|
|
5682
|
+
.items(Joi.string().allow(""))
|
|
5683
|
+
.allow(null, ""),
|
|
5602
5684
|
pincode: Joi.string().allow("").allow(null),
|
|
5603
5685
|
meta: Joi.any().allow(null),
|
|
5604
5686
|
address: Joi.string().allow("").allow(null),
|
|
@@ -5611,7 +5693,7 @@ class OrderPlatformModel {
|
|
|
5611
5693
|
name: Joi.string().allow("").allow(null),
|
|
5612
5694
|
state: Joi.string().allow("").allow(null),
|
|
5613
5695
|
city: Joi.string().allow("").allow(null),
|
|
5614
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
5696
|
+
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5615
5697
|
});
|
|
5616
5698
|
}
|
|
5617
5699
|
|
|
@@ -5664,7 +5746,7 @@ class OrderPlatformModel {
|
|
|
5664
5746
|
lock_status: Joi.boolean().allow(null),
|
|
5665
5747
|
invoice_id: Joi.string().allow("").allow(null),
|
|
5666
5748
|
payment_methods: Joi.any().allow(null),
|
|
5667
|
-
payment_info: Joi.array().items(Joi.any()),
|
|
5749
|
+
payment_info: Joi.array().items(Joi.any()).allow(null, ""),
|
|
5668
5750
|
status_created_at: Joi.string().allow(""),
|
|
5669
5751
|
status_created_ts: Joi.string().allow(""),
|
|
5670
5752
|
display_name: Joi.string().allow("").allow(null),
|
|
@@ -5775,8 +5857,10 @@ class OrderPlatformModel {
|
|
|
5775
5857
|
/** @returns {ContactDetails} */
|
|
5776
5858
|
static ContactDetails() {
|
|
5777
5859
|
return Joi.object({
|
|
5778
|
-
phone: Joi.array()
|
|
5779
|
-
|
|
5860
|
+
phone: Joi.array()
|
|
5861
|
+
.items(OrderPlatformModel.PhoneDetails())
|
|
5862
|
+
.allow(null, ""),
|
|
5863
|
+
emails: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5780
5864
|
});
|
|
5781
5865
|
}
|
|
5782
5866
|
|
|
@@ -5994,7 +6078,7 @@ class OrderPlatformModel {
|
|
|
5994
6078
|
return_config: OrderPlatformModel.ReturnConfig(),
|
|
5995
6079
|
uid: Joi.string().allow("").allow(null),
|
|
5996
6080
|
size: Joi.string().allow("").allow(null),
|
|
5997
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
6081
|
+
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
5998
6082
|
});
|
|
5999
6083
|
}
|
|
6000
6084
|
|
|
@@ -6038,7 +6122,7 @@ class OrderPlatformModel {
|
|
|
6038
6122
|
/** @returns {ItemCriterias} */
|
|
6039
6123
|
static ItemCriterias() {
|
|
6040
6124
|
return Joi.object({
|
|
6041
|
-
item_brand: Joi.array().items(Joi.number()),
|
|
6125
|
+
item_brand: Joi.array().items(Joi.number()).allow(null, ""),
|
|
6042
6126
|
});
|
|
6043
6127
|
}
|
|
6044
6128
|
|
|
@@ -6152,7 +6236,7 @@ class OrderPlatformModel {
|
|
|
6152
6236
|
static ShipmentStatusData() {
|
|
6153
6237
|
return Joi.object({
|
|
6154
6238
|
meta: Joi.any().allow(null),
|
|
6155
|
-
bag_list: Joi.array().items(Joi.string().allow("")),
|
|
6239
|
+
bag_list: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
6156
6240
|
id: Joi.number().allow(null),
|
|
6157
6241
|
created_at: Joi.string().allow("").allow(null),
|
|
6158
6242
|
created_ts: Joi.string().allow("").allow(null),
|
|
@@ -6189,13 +6273,15 @@ class OrderPlatformModel {
|
|
|
6189
6273
|
estimated_sla_time: Joi.string().allow("").allow(null),
|
|
6190
6274
|
estimated_sla_ts: Joi.string().allow("").allow(null),
|
|
6191
6275
|
can_update_dimension: Joi.boolean().allow(null),
|
|
6192
|
-
shipment_images: Joi.array()
|
|
6276
|
+
shipment_images: Joi.array()
|
|
6277
|
+
.items(Joi.string().allow(""))
|
|
6278
|
+
.allow(null, ""),
|
|
6193
6279
|
delivery_details: OrderPlatformModel.UserDetailsData(),
|
|
6194
6280
|
billing_details: OrderPlatformModel.UserDetailsData(),
|
|
6195
6281
|
forward_shipment_id: Joi.string().allow("").allow(null),
|
|
6196
6282
|
fulfilment_priority: Joi.number().allow(null),
|
|
6197
6283
|
shipment_details: OrderPlatformModel.ShipmentLockDetails(),
|
|
6198
|
-
custom_meta: Joi.array().items(Joi.any()),
|
|
6284
|
+
custom_meta: Joi.array().items(Joi.any()).allow(null, ""),
|
|
6199
6285
|
shipment_quantity: Joi.number().allow(null),
|
|
6200
6286
|
company_details: OrderPlatformModel.CompanyDetails(),
|
|
6201
6287
|
ordering_store: OrderPlatformModel.OrderingStoreDetails(),
|
|
@@ -6206,7 +6292,7 @@ class OrderPlatformModel {
|
|
|
6206
6292
|
dp_details: OrderPlatformModel.DPDetailsData(),
|
|
6207
6293
|
invoice_id: Joi.string().allow("").allow(null),
|
|
6208
6294
|
payment_methods: Joi.any().allow(null),
|
|
6209
|
-
payment_info: Joi.array().items(Joi.any()),
|
|
6295
|
+
payment_info: Joi.array().items(Joi.any()).allow(null, ""),
|
|
6210
6296
|
coupon: Joi.any().allow(null),
|
|
6211
6297
|
affiliate_details: OrderPlatformModel.AffiliateDetails(),
|
|
6212
6298
|
priority_text: Joi.string().allow("").allow(null),
|
|
@@ -6285,7 +6371,9 @@ class OrderPlatformModel {
|
|
|
6285
6371
|
fynd_order_id: Joi.string().allow("").required(),
|
|
6286
6372
|
prices: OrderPlatformModel.Prices(),
|
|
6287
6373
|
payment_methods: Joi.any().allow(null),
|
|
6288
|
-
payment_info: Joi.array()
|
|
6374
|
+
payment_info: Joi.array()
|
|
6375
|
+
.items(OrderPlatformModel.PaymentInfoData())
|
|
6376
|
+
.allow(null, ""),
|
|
6289
6377
|
});
|
|
6290
6378
|
}
|
|
6291
6379
|
|
|
@@ -6403,11 +6491,21 @@ class OrderPlatformModel {
|
|
|
6403
6491
|
/** @returns {AdvanceFilterInfo} */
|
|
6404
6492
|
static AdvanceFilterInfo() {
|
|
6405
6493
|
return Joi.object({
|
|
6406
|
-
returned: Joi.array()
|
|
6407
|
-
|
|
6408
|
-
|
|
6409
|
-
|
|
6410
|
-
|
|
6494
|
+
returned: Joi.array()
|
|
6495
|
+
.items(OrderPlatformModel.FiltersInfo())
|
|
6496
|
+
.allow(null, ""),
|
|
6497
|
+
action_centre: Joi.array()
|
|
6498
|
+
.items(OrderPlatformModel.FiltersInfo())
|
|
6499
|
+
.allow(null, ""),
|
|
6500
|
+
unfulfilled: Joi.array()
|
|
6501
|
+
.items(OrderPlatformModel.FiltersInfo())
|
|
6502
|
+
.allow(null, ""),
|
|
6503
|
+
filters: Joi.array()
|
|
6504
|
+
.items(OrderPlatformModel.FiltersInfo())
|
|
6505
|
+
.allow(null, ""),
|
|
6506
|
+
processed: Joi.array()
|
|
6507
|
+
.items(OrderPlatformModel.FiltersInfo())
|
|
6508
|
+
.allow(null, ""),
|
|
6411
6509
|
applied_filters: Joi.any().allow(null),
|
|
6412
6510
|
page: Joi.any().allow(null),
|
|
6413
6511
|
});
|
|
@@ -6572,8 +6670,10 @@ class OrderPlatformModel {
|
|
|
6572
6670
|
static StoreMeta() {
|
|
6573
6671
|
return Joi.object({
|
|
6574
6672
|
additional_contact_details: Joi.any().allow(null),
|
|
6575
|
-
timing: Joi.array().items(Joi.any()),
|
|
6576
|
-
notification_emails: Joi.array()
|
|
6673
|
+
timing: Joi.array().items(Joi.any()).allow(null, ""),
|
|
6674
|
+
notification_emails: Joi.array()
|
|
6675
|
+
.items(Joi.string().allow(""))
|
|
6676
|
+
.allow(null, ""),
|
|
6577
6677
|
gst_number: Joi.string().allow("").allow(null),
|
|
6578
6678
|
ewaybill_portal_details: Joi.any().allow(null),
|
|
6579
6679
|
einvoice_portal_details: OrderPlatformModel.EInvoicePortalDetails(),
|
|
@@ -6605,7 +6705,9 @@ class OrderPlatformModel {
|
|
|
6605
6705
|
city: Joi.string().allow("").required(),
|
|
6606
6706
|
name: Joi.string().allow("").required(),
|
|
6607
6707
|
longitude: Joi.number().allow(null),
|
|
6608
|
-
brand_store_tags: Joi.array()
|
|
6708
|
+
brand_store_tags: Joi.array()
|
|
6709
|
+
.items(Joi.string().allow(""))
|
|
6710
|
+
.allow(null, ""),
|
|
6609
6711
|
order_integration_id: Joi.string().allow("").allow(null),
|
|
6610
6712
|
parent_store_id: Joi.number().allow(null),
|
|
6611
6713
|
location_type: Joi.string().allow("").required(),
|
|
@@ -6657,7 +6759,7 @@ class OrderPlatformModel {
|
|
|
6657
6759
|
primary_color_hex: Joi.string().allow("").allow(null),
|
|
6658
6760
|
brand_name: Joi.string().allow("").allow(null),
|
|
6659
6761
|
name: Joi.string().allow("").allow(null),
|
|
6660
|
-
gender: Joi.array().items(Joi.string().allow("")),
|
|
6762
|
+
gender: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
6661
6763
|
});
|
|
6662
6764
|
}
|
|
6663
6765
|
|
|
@@ -6672,13 +6774,13 @@ class OrderPlatformModel {
|
|
|
6672
6774
|
l3_category_name: Joi.string().allow("").allow(null),
|
|
6673
6775
|
last_updated_at: Joi.string().allow("").allow(null),
|
|
6674
6776
|
name: Joi.string().allow("").required(),
|
|
6675
|
-
l2_category: Joi.array().items(Joi.string().allow("")),
|
|
6777
|
+
l2_category: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
6676
6778
|
brand: Joi.string().allow("").required(),
|
|
6677
6779
|
image: Joi.array().items(Joi.string().allow("")).required(),
|
|
6678
6780
|
code: Joi.string().allow("").allow(null),
|
|
6679
6781
|
l1_category_id: Joi.number().allow(null),
|
|
6680
6782
|
item_id: Joi.number().required(),
|
|
6681
|
-
l1_category: Joi.array().items(Joi.string().allow("")),
|
|
6783
|
+
l1_category: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
6682
6784
|
gender: Joi.string().allow("").allow(null),
|
|
6683
6785
|
can_cancel: Joi.boolean().allow(null),
|
|
6684
6786
|
can_return: Joi.boolean().allow(null),
|
|
@@ -6778,7 +6880,7 @@ class OrderPlatformModel {
|
|
|
6778
6880
|
bag_id: Joi.number().allow(null),
|
|
6779
6881
|
affiliate_bag_details: OrderPlatformModel.AffiliateBagDetails(),
|
|
6780
6882
|
affiliate_details: OrderPlatformModel.AffiliateDetails(),
|
|
6781
|
-
applied_promos: Joi.array().items(Joi.any()),
|
|
6883
|
+
applied_promos: Joi.array().items(Joi.any()).allow(null, ""),
|
|
6782
6884
|
article: OrderPlatformModel.Article(),
|
|
6783
6885
|
article_details: OrderPlatformModel.ArticleStatusDetails(),
|
|
6784
6886
|
bag_status: Joi.array().items(OrderPlatformModel.BagStatusHistory()),
|
|
@@ -6823,7 +6925,7 @@ class OrderPlatformModel {
|
|
|
6823
6925
|
prices: OrderPlatformModel.Prices(),
|
|
6824
6926
|
qc_required: Joi.boolean().allow(null),
|
|
6825
6927
|
quantity: Joi.number().allow(null),
|
|
6826
|
-
reasons: Joi.array().items(Joi.any()),
|
|
6928
|
+
reasons: Joi.array().items(Joi.any()).allow(null, ""),
|
|
6827
6929
|
restore_coupon: Joi.boolean().allow(null),
|
|
6828
6930
|
restore_promos: Joi.any().allow(null),
|
|
6829
6931
|
rto_address: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
@@ -6833,11 +6935,11 @@ class OrderPlatformModel {
|
|
|
6833
6935
|
shipment_id: Joi.string().allow("").allow(null),
|
|
6834
6936
|
shipment_gst: OrderPlatformModel.ShipmentGstDetails(),
|
|
6835
6937
|
shipment_status: OrderPlatformModel.ShipmentStatusData(),
|
|
6836
|
-
shipment_status_history: Joi.array()
|
|
6837
|
-
OrderPlatformModel.ShipmentStatusData()
|
|
6838
|
-
|
|
6938
|
+
shipment_status_history: Joi.array()
|
|
6939
|
+
.items(OrderPlatformModel.ShipmentStatusData())
|
|
6940
|
+
.allow(null, ""),
|
|
6839
6941
|
status: OrderPlatformModel.BagReturnableCancelableStatus(),
|
|
6840
|
-
tags: Joi.array().items(Joi.string().allow("")),
|
|
6942
|
+
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
6841
6943
|
total_shipment_bags: Joi.number().allow(null),
|
|
6842
6944
|
total_shipments_in_order: Joi.number().allow(null),
|
|
6843
6945
|
transaction_type: Joi.string().allow("").allow(null),
|
|
@@ -6845,7 +6947,7 @@ class OrderPlatformModel {
|
|
|
6845
6947
|
updated_at: Joi.string().allow("").allow(null),
|
|
6846
6948
|
user: OrderPlatformModel.UserDetails(),
|
|
6847
6949
|
weight: OrderPlatformModel.WeightData(),
|
|
6848
|
-
original_bag_list: Joi.array().items(Joi.number()),
|
|
6950
|
+
original_bag_list: Joi.array().items(Joi.number()).allow(null, ""),
|
|
6849
6951
|
identifier: Joi.string().allow("").allow(null),
|
|
6850
6952
|
});
|
|
6851
6953
|
}
|
|
@@ -31,7 +31,6 @@ export = OrderPlatformValidator;
|
|
|
31
31
|
*/
|
|
32
32
|
/**
|
|
33
33
|
* @typedef DispatchManifestsParam
|
|
34
|
-
* @property {string} manifestId
|
|
35
34
|
* @property {OrderPlatformModel.DispatchManifest} body
|
|
36
35
|
*/
|
|
37
36
|
/**
|
|
@@ -69,6 +68,10 @@ export = OrderPlatformValidator;
|
|
|
69
68
|
* @property {string} [shipmentId]
|
|
70
69
|
* @property {string} [documentType]
|
|
71
70
|
*/
|
|
71
|
+
/**
|
|
72
|
+
* @typedef GenerateProcessManifestParam
|
|
73
|
+
* @property {OrderPlatformModel.ProcessManifestRequest} body
|
|
74
|
+
*/
|
|
72
75
|
/**
|
|
73
76
|
* @typedef GetAllowedStateTransitionParam
|
|
74
77
|
* @property {string} orderingChannel - Ordering channel
|
|
@@ -151,16 +154,18 @@ export = OrderPlatformValidator;
|
|
|
151
154
|
*/
|
|
152
155
|
/**
|
|
153
156
|
* @typedef GetManifestShipmentsParam
|
|
154
|
-
* @property {
|
|
155
|
-
*
|
|
156
|
-
* @property {
|
|
157
|
-
* @property {string}
|
|
158
|
-
* @property {string}
|
|
159
|
-
* @property {string} [
|
|
160
|
-
* @property {string} [
|
|
161
|
-
* @property {string} [
|
|
162
|
-
*
|
|
163
|
-
* @property {string} [
|
|
157
|
+
* @property {string} dpIds - Filter shipments with the specific Courier partner
|
|
158
|
+
* Ids which is a combination of courier partner extension and scheme Ids.
|
|
159
|
+
* @property {number} stores - Filter with the specific store.
|
|
160
|
+
* @property {string} toDate - End date for the shipment search range.
|
|
161
|
+
* @property {string} fromDate - Start date for the shipment search range.
|
|
162
|
+
* @property {string} [dpName] - Filter with the specific courier partner name.
|
|
163
|
+
* @property {string} [salesChannels] - Comma-separated list of sales channels.
|
|
164
|
+
* @property {string} [searchType] - Type of search (e.g., by shipment ID, order
|
|
165
|
+
* ID, AWB number).
|
|
166
|
+
* @property {string} [searchValue] - Value to search for based on the search type.
|
|
167
|
+
* @property {number} [pageNo] - Page number for pagination.
|
|
168
|
+
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
164
169
|
*/
|
|
165
170
|
/**
|
|
166
171
|
* @typedef GetManifestfiltersParam
|
|
@@ -398,6 +403,8 @@ declare class OrderPlatformValidator {
|
|
|
398
403
|
static generateInvoiceID(): GenerateInvoiceIDParam;
|
|
399
404
|
/** @returns {GeneratePOSReceiptByOrderIdParam} */
|
|
400
405
|
static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
|
|
406
|
+
/** @returns {GenerateProcessManifestParam} */
|
|
407
|
+
static generateProcessManifest(): GenerateProcessManifestParam;
|
|
401
408
|
/** @returns {GetAllowedStateTransitionParam} */
|
|
402
409
|
static getAllowedStateTransition(): GetAllowedStateTransitionParam;
|
|
403
410
|
/** @returns {GetAllowedTemplatesForBulkParam} */
|
|
@@ -480,7 +487,7 @@ declare class OrderPlatformValidator {
|
|
|
480
487
|
static verifyMobileOTP(): VerifyMobileOTPParam;
|
|
481
488
|
}
|
|
482
489
|
declare namespace OrderPlatformValidator {
|
|
483
|
-
export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
490
|
+
export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
484
491
|
}
|
|
485
492
|
type AttachOrderUserParam = {
|
|
486
493
|
body: OrderPlatformModel.AttachOrderUser;
|
|
@@ -528,7 +535,6 @@ type CreateOrderParam = {
|
|
|
528
535
|
body: OrderPlatformModel.CreateOrderAPI;
|
|
529
536
|
};
|
|
530
537
|
type DispatchManifestsParam = {
|
|
531
|
-
manifestId: string;
|
|
532
538
|
body: OrderPlatformModel.DispatchManifest;
|
|
533
539
|
};
|
|
534
540
|
type DownloadBulkActionTemplateParam = {
|
|
@@ -567,6 +573,9 @@ type GeneratePOSReceiptByOrderIdParam = {
|
|
|
567
573
|
shipmentId?: string;
|
|
568
574
|
documentType?: string;
|
|
569
575
|
};
|
|
576
|
+
type GenerateProcessManifestParam = {
|
|
577
|
+
body: OrderPlatformModel.ProcessManifestRequest;
|
|
578
|
+
};
|
|
570
579
|
type GetAllowedStateTransitionParam = {
|
|
571
580
|
/**
|
|
572
581
|
* - Ordering channel
|
|
@@ -745,16 +754,48 @@ type GetManifestDetailsParam = {
|
|
|
745
754
|
manifestId: string;
|
|
746
755
|
};
|
|
747
756
|
type GetManifestShipmentsParam = {
|
|
748
|
-
|
|
749
|
-
|
|
757
|
+
/**
|
|
758
|
+
* - Filter shipments with the specific Courier partner
|
|
759
|
+
* Ids which is a combination of courier partner extension and scheme Ids.
|
|
760
|
+
*/
|
|
761
|
+
dpIds: string;
|
|
762
|
+
/**
|
|
763
|
+
* - Filter with the specific store.
|
|
764
|
+
*/
|
|
765
|
+
stores: number;
|
|
766
|
+
/**
|
|
767
|
+
* - End date for the shipment search range.
|
|
768
|
+
*/
|
|
750
769
|
toDate: string;
|
|
770
|
+
/**
|
|
771
|
+
* - Start date for the shipment search range.
|
|
772
|
+
*/
|
|
751
773
|
fromDate: string;
|
|
774
|
+
/**
|
|
775
|
+
* - Filter with the specific courier partner name.
|
|
776
|
+
*/
|
|
752
777
|
dpName?: string;
|
|
778
|
+
/**
|
|
779
|
+
* - Comma-separated list of sales channels.
|
|
780
|
+
*/
|
|
753
781
|
salesChannels?: string;
|
|
782
|
+
/**
|
|
783
|
+
* - Type of search (e.g., by shipment ID, order
|
|
784
|
+
* ID, AWB number).
|
|
785
|
+
*/
|
|
754
786
|
searchType?: string;
|
|
787
|
+
/**
|
|
788
|
+
* - Value to search for based on the search type.
|
|
789
|
+
*/
|
|
755
790
|
searchValue?: string;
|
|
756
|
-
|
|
757
|
-
|
|
791
|
+
/**
|
|
792
|
+
* - Page number for pagination.
|
|
793
|
+
*/
|
|
794
|
+
pageNo?: number;
|
|
795
|
+
/**
|
|
796
|
+
* - Number of records per page for pagination.
|
|
797
|
+
*/
|
|
798
|
+
pageSize?: number;
|
|
758
799
|
};
|
|
759
800
|
type GetManifestfiltersParam = {
|
|
760
801
|
/**
|