@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1
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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
- package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -3,8 +3,8 @@ const Joi = require("joi");
|
|
|
3
3
|
const OrderPlatformModel = require("./OrderPlatformModel");
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
* @typedef
|
|
7
|
-
* @property {OrderPlatformModel.
|
|
6
|
+
* @typedef AddUserViewsParam
|
|
7
|
+
* @property {OrderPlatformModel.UserViewsResponse} body
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
/**
|
|
@@ -14,20 +14,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
16
|
* @typedef BulkListingParam
|
|
17
|
-
* @property {number} pageSize -
|
|
18
|
-
* @property {number} pageNo -
|
|
19
|
-
* @property {string} startDate -
|
|
20
|
-
*
|
|
21
|
-
* @property {string}
|
|
22
|
-
*
|
|
23
|
-
* @property {string} [
|
|
24
|
-
* @property {string} [bulkActionType] - Pecifies the type of job action being requested.
|
|
25
|
-
* @property {string} [searchKey] - A key or keyword used to search for specific jobs.
|
|
17
|
+
* @property {number} pageSize - Page size
|
|
18
|
+
* @property {number} pageNo - Page number
|
|
19
|
+
* @property {string} [startDate] - UTC start date in ISO format
|
|
20
|
+
* @property {string} [endDate] - UTC end date in ISO format
|
|
21
|
+
* @property {string} [status] - Status for which to fetch the jobs.
|
|
22
|
+
* @property {string} [bulkActionType] - Job type.
|
|
23
|
+
* @property {string} [searchKey] - Search_key.
|
|
26
24
|
*/
|
|
27
25
|
|
|
28
26
|
/**
|
|
29
27
|
* @typedef BulkStateTransistionParam
|
|
30
|
-
* @property {OrderPlatformModel.
|
|
28
|
+
* @property {OrderPlatformModel.BulkStateTransistionRequest} body
|
|
31
29
|
*/
|
|
32
30
|
|
|
33
31
|
/**
|
|
@@ -36,8 +34,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
36
34
|
*/
|
|
37
35
|
|
|
38
36
|
/**
|
|
39
|
-
* @typedef
|
|
40
|
-
* @property {
|
|
37
|
+
* @typedef Click2CallParam
|
|
38
|
+
* @property {string} caller - Call Number
|
|
39
|
+
* @property {string} receiver - Receiver Number
|
|
40
|
+
* @property {string} bagId - Bag Id for the query
|
|
41
|
+
* @property {string} [callerId] - Caller Id
|
|
42
|
+
* @property {string} [method] - Provider Method to Call
|
|
41
43
|
*/
|
|
42
44
|
|
|
43
45
|
/**
|
|
@@ -46,8 +48,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
46
48
|
*/
|
|
47
49
|
|
|
48
50
|
/**
|
|
49
|
-
* @typedef
|
|
50
|
-
* @property {
|
|
51
|
+
* @typedef DeleteUserViewsParam
|
|
52
|
+
* @property {string} viewId - Comma separated values of view ids
|
|
51
53
|
*/
|
|
52
54
|
|
|
53
55
|
/**
|
|
@@ -57,7 +59,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
57
59
|
|
|
58
60
|
/**
|
|
59
61
|
* @typedef DownloadLanesReportParam
|
|
60
|
-
* @property {OrderPlatformModel.
|
|
62
|
+
* @property {OrderPlatformModel.BulkReportsDownloadRequest} body
|
|
61
63
|
*/
|
|
62
64
|
|
|
63
65
|
/**
|
|
@@ -71,14 +73,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
71
73
|
*/
|
|
72
74
|
|
|
73
75
|
/**
|
|
74
|
-
* @typedef
|
|
75
|
-
* @property {OrderPlatformModel.
|
|
76
|
+
* @typedef FetchCreditBalanceDetailParam
|
|
77
|
+
* @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
|
|
76
78
|
*/
|
|
77
79
|
|
|
78
80
|
/**
|
|
79
|
-
* @typedef
|
|
80
|
-
* @property {
|
|
81
|
-
* @property {OrderPlatformModel.GenerateInvoiceIDRequestSchema} body
|
|
81
|
+
* @typedef FetchRefundModeConfigParam
|
|
82
|
+
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
82
83
|
*/
|
|
83
84
|
|
|
84
85
|
/**
|
|
@@ -88,28 +89,23 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
88
89
|
* @property {string} [documentType]
|
|
89
90
|
*/
|
|
90
91
|
|
|
91
|
-
/**
|
|
92
|
-
* @typedef GenerateProcessManifestParam
|
|
93
|
-
* @property {OrderPlatformModel.ProcessManifestRequestSchema} body
|
|
94
|
-
*/
|
|
95
|
-
|
|
96
92
|
/**
|
|
97
93
|
* @typedef GetAllowedStateTransitionParam
|
|
98
|
-
* @property {string} orderingChannel -
|
|
99
|
-
* @property {string} status -
|
|
100
|
-
* which the API will provide a list of possible next state transitions.
|
|
94
|
+
* @property {string} orderingChannel - Ordering channel
|
|
95
|
+
* @property {string} status - Current status of a shipment
|
|
101
96
|
*/
|
|
102
97
|
|
|
103
98
|
/** @typedef GetAllowedTemplatesForBulkParam */
|
|
104
99
|
|
|
105
100
|
/**
|
|
106
101
|
* @typedef GetAnnouncementsParam
|
|
107
|
-
* @property {string} [date] - Date On which the announcement is Active
|
|
102
|
+
* @property {string} [date] - Date On which the announcement is Active (Date
|
|
103
|
+
* should in ISO Datetime format IST Time)
|
|
108
104
|
*/
|
|
109
105
|
|
|
110
106
|
/**
|
|
111
107
|
* @typedef GetBagByIdParam
|
|
112
|
-
* @property {string} [bagId] -
|
|
108
|
+
* @property {string} [bagId] - Id of bag
|
|
113
109
|
* @property {string} [channelBagId] - Id of application bag
|
|
114
110
|
* @property {string} [channelId] - Id of application
|
|
115
111
|
*/
|
|
@@ -133,8 +129,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
133
129
|
* @typedef GetBulkShipmentExcelFileParam
|
|
134
130
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
135
131
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
136
|
-
* @property {string} [startDate] -
|
|
137
|
-
* @property {string} [endDate] -
|
|
132
|
+
* @property {string} [startDate] - UTC start date in ISO format
|
|
133
|
+
* @property {string} [endDate] - UTC end date in ISO format
|
|
138
134
|
* @property {string} [stores] - Comma separated values of store ids
|
|
139
135
|
* @property {string} [tags] - Comma separated values of tags
|
|
140
136
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -145,14 +141,25 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
145
141
|
* @property {number} [pageSize]
|
|
146
142
|
*/
|
|
147
143
|
|
|
148
|
-
/**
|
|
144
|
+
/**
|
|
145
|
+
* @typedef GetFailedOrderLogsParam
|
|
146
|
+
* @property {number} [pageNo] - Page Number
|
|
147
|
+
* @property {number} [pageSize] - Page Size
|
|
148
|
+
* @property {string} [searchType] - Search type for filter
|
|
149
|
+
* @property {string} [searchValue] - Search value for filter
|
|
150
|
+
*/
|
|
149
151
|
|
|
150
152
|
/**
|
|
151
153
|
* @typedef GetFileByStatusParam
|
|
152
|
-
* @property {string} batchId
|
|
153
|
-
* @property {string} status
|
|
154
|
+
* @property {string} batchId
|
|
155
|
+
* @property {string} status
|
|
154
156
|
* @property {string} fileType
|
|
155
|
-
* @property {string} [reportType]
|
|
157
|
+
* @property {string} [reportType]
|
|
158
|
+
*/
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* @typedef GetGlobalFiltersParam
|
|
162
|
+
* @property {string} showIn - Name of view to get filters for
|
|
156
163
|
*/
|
|
157
164
|
|
|
158
165
|
/**
|
|
@@ -160,7 +167,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
160
167
|
* @property {string} [superLane] - Name of lane for which data is to be fetched
|
|
161
168
|
* @property {string} [groupEntity] - Name of group entity
|
|
162
169
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
163
|
-
* @property {string} [toDate]
|
|
170
|
+
* @property {string} [toDate]
|
|
164
171
|
* @property {string} [startDate] - UTC Start Date in ISO format
|
|
165
172
|
* @property {string} [endDate] - UTC End Date in ISO format
|
|
166
173
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
@@ -168,54 +175,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
168
175
|
* @property {string} [salesChannels]
|
|
169
176
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
170
177
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
171
|
-
* @property {string} [searchType]
|
|
172
|
-
* be used as the target for the search operation
|
|
178
|
+
* @property {string} [searchType]
|
|
173
179
|
* @property {string} [searchValue]
|
|
174
180
|
* @property {string} [tags]
|
|
175
|
-
* @property {number} [timeToDispatch]
|
|
181
|
+
* @property {number} [timeToDispatch]
|
|
176
182
|
* @property {string} [paymentMethods]
|
|
177
183
|
* @property {boolean} [myOrders]
|
|
178
184
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
179
185
|
* company order
|
|
180
|
-
* @property {string} [orderType]
|
|
181
|
-
* follow based on the application's operational needs and customer
|
|
182
|
-
* preferences. This field categorizes orders into distinct types, each
|
|
183
|
-
* associated with a unique processing flow. For example:
|
|
184
|
-
*
|
|
185
|
-
* - "HomeDelivery": The order goes through all the steps needed for delivery,
|
|
186
|
-
* from being packed to arriving at the customer’s address.
|
|
187
|
-
* - "PickAtStore": The order is prepared for pickup at the store, skipping
|
|
188
|
-
* shipping steps to make it ready faster for the customer to collect in person.
|
|
189
|
-
* - "Digital": This order type likely refers to orders that involve digital goods
|
|
190
|
-
* or services, such as software, digital subscriptions, e-books, online
|
|
191
|
-
* courses, or any other item that can be delivered electronically.
|
|
192
|
-
*/
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* @typedef GetManifestDetailsParam
|
|
196
|
-
* @property {string} manifestId - The unique identifier assigned to the manifest.
|
|
197
|
-
* @property {string} [dpIds] - Filter shipments with the specific Courier
|
|
198
|
-
* partner Ids which is a combination of courier partner extension and scheme Ids.
|
|
199
|
-
* @property {string} [endDate] - End date for the shipment search range in manifest.
|
|
200
|
-
* @property {string} [startDate] - Start date for the shipment search range in manifest.
|
|
201
|
-
* @property {number} [pageNo] - Page number for pagination.
|
|
202
|
-
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
203
|
-
*/
|
|
204
|
-
|
|
205
|
-
/**
|
|
206
|
-
* @typedef GetManifestShipmentsParam
|
|
207
|
-
* @property {string} dpIds - Filter shipments with the specific Courier partner
|
|
208
|
-
* Ids which is a combination of courier partner extension and scheme Ids.
|
|
209
|
-
* @property {number} stores - Filter results based on specific store IDs.
|
|
210
|
-
* @property {string} toDate - End date for the shipment search range.
|
|
211
|
-
* @property {string} fromDate - Start date for the shipment search range.
|
|
212
|
-
* @property {string} [dpName] - Filter results based on specific courier partner name.
|
|
213
|
-
* @property {string} [salesChannels] - Filter results based on comma-separated
|
|
214
|
-
* list of sales channels.
|
|
215
|
-
* @property {string} [searchType] - Filter results based on search type.
|
|
216
|
-
* @property {string} [searchValue] - Filter results based on the search value.
|
|
217
|
-
* @property {number} [pageNo] - Page number for pagination.
|
|
218
|
-
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
186
|
+
* @property {string} [orderType]
|
|
219
187
|
*/
|
|
220
188
|
|
|
221
189
|
/**
|
|
@@ -223,27 +191,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
223
191
|
* @property {string} view - Name of View
|
|
224
192
|
*/
|
|
225
193
|
|
|
226
|
-
/**
|
|
227
|
-
* @typedef GetManifestsParam
|
|
228
|
-
* @property {string} [status] - Filter for the status of manifests.
|
|
229
|
-
* @property {string} [startDate] - The starting date for filtering manifests in
|
|
230
|
-
* ISO format
|
|
231
|
-
* @property {string} [endDate] - The end date for filtering manifests in ISO format
|
|
232
|
-
* @property {string} [searchType] - Specifies the type of search to perform.
|
|
233
|
-
* @property {number} [storeId] - Filter to fetch manifests for a specific store
|
|
234
|
-
* by its ID.
|
|
235
|
-
* @property {string} [searchValue] - The value to search for based on the
|
|
236
|
-
* selected search type.
|
|
237
|
-
* @property {string} [dpIds] - A comma-separated list of courier partner IDs
|
|
238
|
-
* (DP IDs) to filter the manifests.
|
|
239
|
-
* @property {number} [pageNo] - The number of the page to fetch data.
|
|
240
|
-
* @property {number} [pageSize] - The number of records to return per page for
|
|
241
|
-
* pagination.
|
|
242
|
-
*/
|
|
243
|
-
|
|
244
194
|
/**
|
|
245
195
|
* @typedef GetOrderByIdParam
|
|
246
|
-
* @property {string} orderId
|
|
196
|
+
* @property {string} orderId - Flag for order id
|
|
247
197
|
* @property {boolean} [myOrders]
|
|
248
198
|
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
249
199
|
*/
|
|
@@ -251,70 +201,99 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
251
201
|
/**
|
|
252
202
|
* @typedef GetOrdersParam
|
|
253
203
|
* @property {string} [lane] - Lane refers to a section where orders are
|
|
254
|
-
* assigned, indicating its grouping
|
|
204
|
+
* assigned, indicating its grouping
|
|
255
205
|
* @property {string} [searchType] - Search_type refers to the field that will
|
|
256
|
-
* be used as the target for the search operation
|
|
257
|
-
* @property {string} [bagStatus] - Bag_status refers to status of the
|
|
258
|
-
* Filters orders based on the status.
|
|
259
|
-
* @property {number} [timeToDispatch] - Time_to_dispatch refers to
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* @property {string} [tags] - Tags
|
|
206
|
+
* be used as the target for the search operation
|
|
207
|
+
* @property {string} [bagStatus] - Bag_status refers to the status of the
|
|
208
|
+
* entity. Filters orders based on the status.
|
|
209
|
+
* @property {number} [timeToDispatch] - Time_to_dispatch refers to the
|
|
210
|
+
* estimated SLA time.
|
|
211
|
+
* @property {string} [paymentMethods]
|
|
212
|
+
* @property {string} [tags] - Tags refer to additional descriptive labels
|
|
263
213
|
* associated with the order
|
|
264
214
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
265
215
|
* specified by the search_type
|
|
266
|
-
* @property {string} [fromDate]
|
|
267
|
-
* @property {string} [toDate]
|
|
268
|
-
* @property {string} [startDate]
|
|
269
|
-
* @property {string} [endDate]
|
|
216
|
+
* @property {string} [fromDate]
|
|
217
|
+
* @property {string} [toDate]
|
|
218
|
+
* @property {string} [startDate]
|
|
219
|
+
* @property {string} [endDate]
|
|
270
220
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
271
|
-
* @property {string} [stores]
|
|
272
|
-
*
|
|
273
|
-
* @property {
|
|
274
|
-
*
|
|
275
|
-
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
276
|
-
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
221
|
+
* @property {string} [stores]
|
|
222
|
+
* @property {string} [salesChannels]
|
|
223
|
+
* @property {number} [pageNo]
|
|
224
|
+
* @property {number} [pageSize]
|
|
277
225
|
* @property {boolean} [isPrioritySort]
|
|
278
|
-
* @property {
|
|
226
|
+
* @property {Object[]} [customMeta]
|
|
279
227
|
* @property {boolean} [myOrders]
|
|
280
228
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
281
229
|
* company order
|
|
282
|
-
* @property {string} [customerId]
|
|
283
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
230
|
+
* @property {string} [customerId]
|
|
284
231
|
* @property {string} [orderType]
|
|
285
|
-
* @property {
|
|
286
|
-
*
|
|
232
|
+
* @property {string} [operationalStatus] - Statuses relating to shipment
|
|
233
|
+
* transition in order processing journey. Comma separated values of
|
|
234
|
+
* operational statuses.
|
|
235
|
+
* @property {string} [financialStatus] - Statuses relating to finance related
|
|
236
|
+
* operations in the order processing journey. Comma separated values of
|
|
237
|
+
* financial statuses.
|
|
238
|
+
* @property {string} [logisticsStatus] - Statuses relating to delivery and
|
|
239
|
+
* pickup related operations in the order processing journey. Comma separated
|
|
240
|
+
* values of logistics statuses.
|
|
241
|
+
* @property {string} [parentViewSlug] - Parent view is used for grouping of
|
|
242
|
+
* child views. Slug of parent view.
|
|
243
|
+
* @property {string} [childViewSlug] - Child view is user configured view,
|
|
244
|
+
* which has filters added by the user on which shipments/orders are fetched.
|
|
245
|
+
* Slug of child view.
|
|
287
246
|
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
288
247
|
* retrieving shipments or orders. It specifies whether the results should be
|
|
289
248
|
* organized based on shipment groups or order groups. For example, using
|
|
290
249
|
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
291
250
|
* may not be recognized, leading to errors or default behavior.
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
* @
|
|
296
|
-
*
|
|
297
|
-
|
|
298
|
-
|
|
251
|
+
*/
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* @typedef GetRefundConfigurationParam
|
|
255
|
+
* @property {string} appId
|
|
256
|
+
*/
|
|
257
|
+
|
|
258
|
+
/** @typedef GetRefundEnableStateListParam */
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* @typedef GetRefundOptionsParam
|
|
262
|
+
* @property {string} shipmentId - ID of the shipment. An order may contain
|
|
263
|
+
* multiple items and may get divided into one or more shipment, each having
|
|
264
|
+
* its own ID.
|
|
265
|
+
* @property {string} [bagIds] - It is the bag_id of the bags with comma separated.
|
|
266
|
+
* @property {string} [state] - It is the desired state at which refund amount
|
|
267
|
+
* needs to be calculated.
|
|
268
|
+
* @property {string} [optinAppId] - It is affiliate id of the order in case of
|
|
269
|
+
* cross selling.
|
|
270
|
+
* @property {number} [optinCompanyId] - It is company id of the order in case
|
|
271
|
+
* of cross selling.
|
|
272
|
+
* @property {string} [status] - It specifies the desired status to which the
|
|
273
|
+
* shipment should be updated. It represents the next step in the shipment's
|
|
274
|
+
* lifecycle, such as being cancelled by the customer or moved to another
|
|
275
|
+
* status in the shipping process.
|
|
276
|
+
*/
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* @typedef GetRefundStateConfigurationParam
|
|
280
|
+
* @property {string} appId
|
|
299
281
|
*/
|
|
300
282
|
|
|
301
283
|
/** @typedef GetRoleBasedActionsParam */
|
|
302
284
|
|
|
303
285
|
/**
|
|
304
286
|
* @typedef GetShipmentByIdParam
|
|
305
|
-
* @property {string} [channelShipmentId] -
|
|
306
|
-
*
|
|
307
|
-
* @property {string} [shipmentId] - The unique identifier for a shipment.
|
|
287
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
288
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
308
289
|
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
309
290
|
* deactivated shipments
|
|
310
|
-
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
311
|
-
* shipments are allowed
|
|
312
291
|
*/
|
|
313
292
|
|
|
314
293
|
/**
|
|
315
294
|
* @typedef GetShipmentHistoryParam
|
|
316
|
-
* @property {string} [shipmentId] -
|
|
317
|
-
* @property {number} [bagId] -
|
|
295
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
296
|
+
* @property {number} [bagId] - Bag/Product Id
|
|
318
297
|
*/
|
|
319
298
|
|
|
320
299
|
/**
|
|
@@ -330,87 +309,58 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
330
309
|
/**
|
|
331
310
|
* @typedef GetShipmentsParam
|
|
332
311
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
333
|
-
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
334
|
-
* @property {string} [statusAssigned] - Used to filter shipments based on
|
|
335
|
-
* status present in shipment_status_history. For more information on these
|
|
336
|
-
* statuses, refer to the Fynd Partners documentation.
|
|
312
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
337
313
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
338
|
-
* bag_status and override lane
|
|
339
|
-
* @property {number} [timeToDispatch]
|
|
340
|
-
* @property {string} [searchType] -
|
|
341
|
-
*
|
|
342
|
-
* @property {string} [searchValue] - The value corresponding to the search
|
|
343
|
-
* type, such as a specific shipment ID or order ID.
|
|
314
|
+
* bag_status and override lane
|
|
315
|
+
* @property {number} [timeToDispatch]
|
|
316
|
+
* @property {string} [searchType] - Search type key
|
|
317
|
+
* @property {string} [searchValue] - Search type value
|
|
344
318
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
345
319
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
346
|
-
* @property {string} [startDate] -
|
|
347
|
-
*
|
|
348
|
-
* @property {string} [
|
|
349
|
-
*
|
|
350
|
-
* @property {string} [
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
-
* @property {
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
* @property {string} [
|
|
360
|
-
*
|
|
361
|
-
* @property {string} [
|
|
362
|
-
*
|
|
363
|
-
* @property {string} [
|
|
364
|
-
*
|
|
365
|
-
* @property {
|
|
366
|
-
*
|
|
367
|
-
* @property {
|
|
368
|
-
*
|
|
369
|
-
* @property {
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
* @property {string} [
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
* @property {string} [
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
* @property {string} [
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
* @property {string} [
|
|
385
|
-
* the platform, useful for filtering orders related to a specific user.
|
|
386
|
-
* @property {string} [sortType] - Determines the sorting order of the results
|
|
387
|
-
* based on specific criteria.
|
|
388
|
-
* @property {boolean} [showCrossCompanyData] - A flag indicating whether to
|
|
389
|
-
* include data from both cross-company and non-cross-company orders in the results.
|
|
390
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
391
|
-
* the orders to filter results based on specific characteristics.
|
|
392
|
-
* @property {string} [customerId] - The unique identifier for the customer
|
|
393
|
-
* associated with the query, useful for filtering results to a specific customer.
|
|
394
|
-
* @property {string} [orderType] - The type of order being queried.
|
|
320
|
+
* @property {string} [startDate] - UTC Start Date in ISO format
|
|
321
|
+
* @property {string} [endDate] - UTC End Date in ISO format
|
|
322
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
323
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
324
|
+
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
325
|
+
* @property {number} [pageNo] - Page number for paginated data
|
|
326
|
+
* @property {number} [pageSize] - Page size of data received per page
|
|
327
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
|
|
328
|
+
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
329
|
+
* @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
|
|
330
|
+
* @property {string} [paymentMethods] - Comma separated values of payment methods
|
|
331
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
332
|
+
* @property {string} [channelOrderId] - App Order Id
|
|
333
|
+
* @property {string} [customMeta]
|
|
334
|
+
* @property {string} [orderingChannel]
|
|
335
|
+
* @property {string} [companyAffiliateTag]
|
|
336
|
+
* @property {boolean} [myOrders]
|
|
337
|
+
* @property {string} [platformUserId]
|
|
338
|
+
* @property {string} [sortType] - Sort the result data on basis of input
|
|
339
|
+
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
340
|
+
* company order
|
|
341
|
+
* @property {string} [tags] - Comma separated values of tags
|
|
342
|
+
* @property {string} [customerId]
|
|
343
|
+
* @property {string} [orderType]
|
|
344
|
+
* @property {string} [operationalStatus] - Statuses relating to shipment
|
|
345
|
+
* transition in order processing journey. Comma separated values of
|
|
346
|
+
* operational statuses.
|
|
347
|
+
* @property {string} [financialStatus] - Statuses relating to finance related
|
|
348
|
+
* operations in the order processing journey. Comma separated values of
|
|
349
|
+
* financial statuses.
|
|
350
|
+
* @property {string} [logisticsStatus] - Statuses relating to delivery and
|
|
351
|
+
* pickup related operations in the order processing journey. Comma separated
|
|
352
|
+
* values of logistics statuses.
|
|
353
|
+
* @property {string} [parentViewSlug] - Parent view is used for grouping of
|
|
354
|
+
* child views. Slug of parent view.
|
|
355
|
+
* @property {string} [childViewSlug] - Child view is user configured view which
|
|
356
|
+
* has filters added by the user on which shipments/orders are fetched. Slug
|
|
357
|
+
* of child view.
|
|
358
|
+
* @property {string} [lockStatus] - Flag to identify if a shipment is locked or not.
|
|
395
359
|
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
396
360
|
* retrieving shipments or orders. It specifies whether the results should be
|
|
397
361
|
* organized based on shipment groups or order groups. For example, using
|
|
398
362
|
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
399
363
|
* may not be recognized, leading to errors or default behavior.
|
|
400
|
-
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
401
|
-
* shipments. This is useful when fetching data for a specific date range
|
|
402
|
-
* while performing searches.
|
|
403
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
404
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
405
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
406
|
-
* also depends on the login user accessType and store access
|
|
407
|
-
*/
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* @typedef GetStateManagerConfigParam
|
|
411
|
-
* @property {string} [appId] - The unique identifier of the application.
|
|
412
|
-
* @property {string} [orderingChannel] - The channel through which orders are placed.
|
|
413
|
-
* @property {string} [entity] - The entity for which the configuration is applied.
|
|
414
364
|
*/
|
|
415
365
|
|
|
416
366
|
/** @typedef GetStateTransitionMapParam */
|
|
@@ -420,6 +370,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
420
370
|
* @property {string} templateName
|
|
421
371
|
*/
|
|
422
372
|
|
|
373
|
+
/**
|
|
374
|
+
* @typedef GetUserViewsParam
|
|
375
|
+
* @property {string} showIn - Name of view to get filters for.
|
|
376
|
+
*/
|
|
377
|
+
|
|
423
378
|
/**
|
|
424
379
|
* @typedef GetfiltersParam
|
|
425
380
|
* @property {string} view - Name of view
|
|
@@ -433,8 +388,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
433
388
|
|
|
434
389
|
/**
|
|
435
390
|
* @typedef JobDetailsParam
|
|
436
|
-
* @property {string} batchId
|
|
437
|
-
* with this bulk action.
|
|
391
|
+
* @property {string} batchId
|
|
438
392
|
*/
|
|
439
393
|
|
|
440
394
|
/**
|
|
@@ -442,6 +396,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
442
396
|
* @property {OrderPlatformModel.PlatformOrderUpdate} body
|
|
443
397
|
*/
|
|
444
398
|
|
|
399
|
+
/**
|
|
400
|
+
* @typedef PostRefundConfigurationParam
|
|
401
|
+
* @property {string} appId
|
|
402
|
+
* @property {OrderPlatformModel.RefundStateConfigurationManualSchema} body
|
|
403
|
+
*/
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* @typedef PostRefundStateConfigurationParam
|
|
407
|
+
* @property {string} appId
|
|
408
|
+
* @property {OrderPlatformModel.PostRefundStateConfiguration} body
|
|
409
|
+
*/
|
|
410
|
+
|
|
445
411
|
/**
|
|
446
412
|
* @typedef PostShipmentHistoryParam
|
|
447
413
|
* @property {OrderPlatformModel.PostShipmentHistory} body
|
|
@@ -464,16 +430,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
464
430
|
|
|
465
431
|
/**
|
|
466
432
|
* @typedef TrackShipmentParam
|
|
467
|
-
* @property {string} [shipmentId] -
|
|
433
|
+
* @property {string} [shipmentId] - Shipment ID
|
|
468
434
|
* @property {string} [awb] - AWB number
|
|
469
|
-
* @property {number} [pageNo] - Page number
|
|
470
|
-
* @property {number} [pageSize] -
|
|
435
|
+
* @property {number} [pageNo] - Page number
|
|
436
|
+
* @property {number} [pageSize] - Page size
|
|
471
437
|
*/
|
|
472
438
|
|
|
473
439
|
/**
|
|
474
|
-
* @typedef
|
|
475
|
-
* @property {string}
|
|
476
|
-
* @property {OrderPlatformModel.
|
|
440
|
+
* @typedef UpdateOrderParam
|
|
441
|
+
* @property {string} orderId
|
|
442
|
+
* @property {OrderPlatformModel.OrderUpdatePayload} body
|
|
477
443
|
*/
|
|
478
444
|
|
|
479
445
|
/**
|
|
@@ -482,8 +448,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
482
448
|
*/
|
|
483
449
|
|
|
484
450
|
/**
|
|
485
|
-
* @typedef
|
|
486
|
-
* @property {OrderPlatformModel.
|
|
451
|
+
* @typedef UpdateShipmentParam
|
|
452
|
+
* @property {OrderPlatformModel.UpdateShipmentActionRequest} body
|
|
487
453
|
*/
|
|
488
454
|
|
|
489
455
|
/**
|
|
@@ -493,7 +459,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
493
459
|
|
|
494
460
|
/**
|
|
495
461
|
* @typedef UpdateShipmentStatusParam
|
|
496
|
-
* @property {OrderPlatformModel.
|
|
462
|
+
* @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
|
|
497
463
|
*/
|
|
498
464
|
|
|
499
465
|
/**
|
|
@@ -502,8 +468,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
502
468
|
*/
|
|
503
469
|
|
|
504
470
|
/**
|
|
505
|
-
* @typedef
|
|
506
|
-
* @property {OrderPlatformModel.
|
|
471
|
+
* @typedef UpdateUserViewPositionParam
|
|
472
|
+
* @property {OrderPlatformModel.UserViewPosition} body
|
|
473
|
+
*/
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* @typedef UpdateUserViewsParam
|
|
477
|
+
* @property {OrderPlatformModel.UserViewsResponse} body
|
|
507
478
|
*/
|
|
508
479
|
|
|
509
480
|
/**
|
|
@@ -512,10 +483,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
512
483
|
*/
|
|
513
484
|
|
|
514
485
|
class OrderPlatformValidator {
|
|
515
|
-
/** @returns {
|
|
516
|
-
static
|
|
486
|
+
/** @returns {AddUserViewsParam} */
|
|
487
|
+
static addUserViews() {
|
|
517
488
|
return Joi.object({
|
|
518
|
-
body: OrderPlatformModel.
|
|
489
|
+
body: OrderPlatformModel.UserViewsResponse().required(),
|
|
519
490
|
}).required();
|
|
520
491
|
}
|
|
521
492
|
|
|
@@ -531,8 +502,8 @@ class OrderPlatformValidator {
|
|
|
531
502
|
return Joi.object({
|
|
532
503
|
pageSize: Joi.number().required(),
|
|
533
504
|
pageNo: Joi.number().required(),
|
|
534
|
-
startDate: Joi.string().allow("")
|
|
535
|
-
endDate: Joi.string().allow("")
|
|
505
|
+
startDate: Joi.string().allow(""),
|
|
506
|
+
endDate: Joi.string().allow(""),
|
|
536
507
|
status: Joi.string().allow(""),
|
|
537
508
|
bulkActionType: Joi.string().allow(""),
|
|
538
509
|
searchKey: Joi.string().allow(""),
|
|
@@ -542,7 +513,7 @@ class OrderPlatformValidator {
|
|
|
542
513
|
/** @returns {BulkStateTransistionParam} */
|
|
543
514
|
static bulkStateTransistion() {
|
|
544
515
|
return Joi.object({
|
|
545
|
-
body: OrderPlatformModel.
|
|
516
|
+
body: OrderPlatformModel.BulkStateTransistionRequest().required(),
|
|
546
517
|
}).required();
|
|
547
518
|
}
|
|
548
519
|
|
|
@@ -553,10 +524,14 @@ class OrderPlatformValidator {
|
|
|
553
524
|
}).required();
|
|
554
525
|
}
|
|
555
526
|
|
|
556
|
-
/** @returns {
|
|
557
|
-
static
|
|
527
|
+
/** @returns {Click2CallParam} */
|
|
528
|
+
static click2Call() {
|
|
558
529
|
return Joi.object({
|
|
559
|
-
|
|
530
|
+
caller: Joi.string().allow("").required(),
|
|
531
|
+
receiver: Joi.string().allow("").required(),
|
|
532
|
+
bagId: Joi.string().allow("").required(),
|
|
533
|
+
callerId: Joi.string().allow(""),
|
|
534
|
+
method: Joi.string().allow(""),
|
|
560
535
|
}).required();
|
|
561
536
|
}
|
|
562
537
|
|
|
@@ -567,10 +542,10 @@ class OrderPlatformValidator {
|
|
|
567
542
|
}).required();
|
|
568
543
|
}
|
|
569
544
|
|
|
570
|
-
/** @returns {
|
|
571
|
-
static
|
|
545
|
+
/** @returns {DeleteUserViewsParam} */
|
|
546
|
+
static deleteUserViews() {
|
|
572
547
|
return Joi.object({
|
|
573
|
-
|
|
548
|
+
viewId: Joi.string().allow("").required(),
|
|
574
549
|
}).required();
|
|
575
550
|
}
|
|
576
551
|
|
|
@@ -584,7 +559,7 @@ class OrderPlatformValidator {
|
|
|
584
559
|
/** @returns {DownloadLanesReportParam} */
|
|
585
560
|
static downloadLanesReport() {
|
|
586
561
|
return Joi.object({
|
|
587
|
-
body: OrderPlatformModel.
|
|
562
|
+
body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
|
|
588
563
|
}).required();
|
|
589
564
|
}
|
|
590
565
|
|
|
@@ -602,18 +577,17 @@ class OrderPlatformValidator {
|
|
|
602
577
|
}).required();
|
|
603
578
|
}
|
|
604
579
|
|
|
605
|
-
/** @returns {
|
|
606
|
-
static
|
|
580
|
+
/** @returns {FetchCreditBalanceDetailParam} */
|
|
581
|
+
static fetchCreditBalanceDetail() {
|
|
607
582
|
return Joi.object({
|
|
608
|
-
body: OrderPlatformModel.
|
|
583
|
+
body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
|
|
609
584
|
}).required();
|
|
610
585
|
}
|
|
611
586
|
|
|
612
|
-
/** @returns {
|
|
613
|
-
static
|
|
587
|
+
/** @returns {FetchRefundModeConfigParam} */
|
|
588
|
+
static fetchRefundModeConfig() {
|
|
614
589
|
return Joi.object({
|
|
615
|
-
|
|
616
|
-
body: OrderPlatformModel.GenerateInvoiceIDRequestSchema().required(),
|
|
590
|
+
body: OrderPlatformModel.RefundModeConfigRequestPayload().required(),
|
|
617
591
|
}).required();
|
|
618
592
|
}
|
|
619
593
|
|
|
@@ -626,13 +600,6 @@ class OrderPlatformValidator {
|
|
|
626
600
|
}).required();
|
|
627
601
|
}
|
|
628
602
|
|
|
629
|
-
/** @returns {GenerateProcessManifestParam} */
|
|
630
|
-
static generateProcessManifest() {
|
|
631
|
-
return Joi.object({
|
|
632
|
-
body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
|
|
633
|
-
}).required();
|
|
634
|
-
}
|
|
635
|
-
|
|
636
603
|
/** @returns {GetAllowedStateTransitionParam} */
|
|
637
604
|
static getAllowedStateTransition() {
|
|
638
605
|
return Joi.object({
|
|
@@ -700,9 +667,14 @@ class OrderPlatformValidator {
|
|
|
700
667
|
}).required();
|
|
701
668
|
}
|
|
702
669
|
|
|
703
|
-
/** @returns {
|
|
704
|
-
static
|
|
705
|
-
return Joi.object({
|
|
670
|
+
/** @returns {GetFailedOrderLogsParam} */
|
|
671
|
+
static getFailedOrderLogs() {
|
|
672
|
+
return Joi.object({
|
|
673
|
+
pageNo: Joi.number(),
|
|
674
|
+
pageSize: Joi.number(),
|
|
675
|
+
searchType: Joi.string().allow(""),
|
|
676
|
+
searchValue: Joi.string().allow(""),
|
|
677
|
+
}).required();
|
|
706
678
|
}
|
|
707
679
|
|
|
708
680
|
/** @returns {GetFileByStatusParam} */
|
|
@@ -715,6 +687,13 @@ class OrderPlatformValidator {
|
|
|
715
687
|
}).required();
|
|
716
688
|
}
|
|
717
689
|
|
|
690
|
+
/** @returns {GetGlobalFiltersParam} */
|
|
691
|
+
static getGlobalFilters() {
|
|
692
|
+
return Joi.object({
|
|
693
|
+
showIn: Joi.string().allow("").required(),
|
|
694
|
+
}).required();
|
|
695
|
+
}
|
|
696
|
+
|
|
718
697
|
/** @returns {GetLaneConfigParam} */
|
|
719
698
|
static getLaneConfig() {
|
|
720
699
|
return Joi.object({
|
|
@@ -740,34 +719,6 @@ class OrderPlatformValidator {
|
|
|
740
719
|
}).required();
|
|
741
720
|
}
|
|
742
721
|
|
|
743
|
-
/** @returns {GetManifestDetailsParam} */
|
|
744
|
-
static getManifestDetails() {
|
|
745
|
-
return Joi.object({
|
|
746
|
-
manifestId: Joi.string().allow("").required(),
|
|
747
|
-
dpIds: Joi.string().allow(""),
|
|
748
|
-
endDate: Joi.string().allow(""),
|
|
749
|
-
startDate: Joi.string().allow(""),
|
|
750
|
-
pageNo: Joi.number(),
|
|
751
|
-
pageSize: Joi.number(),
|
|
752
|
-
}).required();
|
|
753
|
-
}
|
|
754
|
-
|
|
755
|
-
/** @returns {GetManifestShipmentsParam} */
|
|
756
|
-
static getManifestShipments() {
|
|
757
|
-
return Joi.object({
|
|
758
|
-
dpIds: Joi.string().allow("").required(),
|
|
759
|
-
stores: Joi.number().required(),
|
|
760
|
-
toDate: Joi.string().allow("").required(),
|
|
761
|
-
fromDate: Joi.string().allow("").required(),
|
|
762
|
-
dpName: Joi.string().allow(""),
|
|
763
|
-
salesChannels: Joi.string().allow(""),
|
|
764
|
-
searchType: Joi.string().allow(""),
|
|
765
|
-
searchValue: Joi.string().allow(""),
|
|
766
|
-
pageNo: Joi.number(),
|
|
767
|
-
pageSize: Joi.number(),
|
|
768
|
-
}).required();
|
|
769
|
-
}
|
|
770
|
-
|
|
771
722
|
/** @returns {GetManifestfiltersParam} */
|
|
772
723
|
static getManifestfilters() {
|
|
773
724
|
return Joi.object({
|
|
@@ -775,21 +726,6 @@ class OrderPlatformValidator {
|
|
|
775
726
|
}).required();
|
|
776
727
|
}
|
|
777
728
|
|
|
778
|
-
/** @returns {GetManifestsParam} */
|
|
779
|
-
static getManifests() {
|
|
780
|
-
return Joi.object({
|
|
781
|
-
status: Joi.string().allow(""),
|
|
782
|
-
startDate: Joi.string().allow(""),
|
|
783
|
-
endDate: Joi.string().allow(""),
|
|
784
|
-
searchType: Joi.string().allow(""),
|
|
785
|
-
storeId: Joi.number(),
|
|
786
|
-
searchValue: Joi.string().allow(""),
|
|
787
|
-
dpIds: Joi.string().allow(""),
|
|
788
|
-
pageNo: Joi.number(),
|
|
789
|
-
pageSize: Joi.number(),
|
|
790
|
-
}).required();
|
|
791
|
-
}
|
|
792
|
-
|
|
793
729
|
/** @returns {GetOrderByIdParam} */
|
|
794
730
|
static getOrderById() {
|
|
795
731
|
return Joi.object({
|
|
@@ -819,15 +755,48 @@ class OrderPlatformValidator {
|
|
|
819
755
|
pageNo: Joi.number(),
|
|
820
756
|
pageSize: Joi.number(),
|
|
821
757
|
isPrioritySort: Joi.boolean(),
|
|
822
|
-
customMeta: Joi.
|
|
758
|
+
customMeta: Joi.array().items(Joi.any()),
|
|
823
759
|
myOrders: Joi.boolean(),
|
|
824
760
|
showCrossCompanyData: Joi.boolean(),
|
|
825
761
|
customerId: Joi.string().allow(""),
|
|
826
762
|
orderType: Joi.string().allow(""),
|
|
827
|
-
|
|
763
|
+
operationalStatus: Joi.string().allow(""),
|
|
764
|
+
financialStatus: Joi.string().allow(""),
|
|
765
|
+
logisticsStatus: Joi.string().allow(""),
|
|
766
|
+
parentViewSlug: Joi.string().allow(""),
|
|
767
|
+
childViewSlug: Joi.string().allow(""),
|
|
828
768
|
groupEntity: Joi.string().allow(""),
|
|
829
|
-
|
|
830
|
-
|
|
769
|
+
}).required();
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
/** @returns {GetRefundConfigurationParam} */
|
|
773
|
+
static getRefundConfiguration() {
|
|
774
|
+
return Joi.object({
|
|
775
|
+
appId: Joi.string().allow("").required(),
|
|
776
|
+
}).required();
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
/** @returns {GetRefundEnableStateListParam} */
|
|
780
|
+
static getRefundEnableStateList() {
|
|
781
|
+
return Joi.object({}).required();
|
|
782
|
+
}
|
|
783
|
+
|
|
784
|
+
/** @returns {GetRefundOptionsParam} */
|
|
785
|
+
static getRefundOptions() {
|
|
786
|
+
return Joi.object({
|
|
787
|
+
shipmentId: Joi.string().allow("").required(),
|
|
788
|
+
bagIds: Joi.string().allow(""),
|
|
789
|
+
state: Joi.string().allow(""),
|
|
790
|
+
optinAppId: Joi.string().allow(""),
|
|
791
|
+
optinCompanyId: Joi.number(),
|
|
792
|
+
status: Joi.string().allow(""),
|
|
793
|
+
}).required();
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
/** @returns {GetRefundStateConfigurationParam} */
|
|
797
|
+
static getRefundStateConfiguration() {
|
|
798
|
+
return Joi.object({
|
|
799
|
+
appId: Joi.string().allow("").required(),
|
|
831
800
|
}).required();
|
|
832
801
|
}
|
|
833
802
|
|
|
@@ -842,7 +811,6 @@ class OrderPlatformValidator {
|
|
|
842
811
|
channelShipmentId: Joi.string().allow(""),
|
|
843
812
|
shipmentId: Joi.string().allow(""),
|
|
844
813
|
fetchActiveShipment: Joi.boolean(),
|
|
845
|
-
allowInactive: Joi.boolean(),
|
|
846
814
|
}).required();
|
|
847
815
|
}
|
|
848
816
|
|
|
@@ -868,7 +836,6 @@ class OrderPlatformValidator {
|
|
|
868
836
|
return Joi.object({
|
|
869
837
|
lane: Joi.string().allow(""),
|
|
870
838
|
bagStatus: Joi.string().allow(""),
|
|
871
|
-
statusAssigned: Joi.string().allow(""),
|
|
872
839
|
statusOverrideLane: Joi.boolean(),
|
|
873
840
|
timeToDispatch: Joi.number(),
|
|
874
841
|
searchType: Joi.string().allow(""),
|
|
@@ -877,8 +844,6 @@ class OrderPlatformValidator {
|
|
|
877
844
|
toDate: Joi.string().allow(""),
|
|
878
845
|
startDate: Joi.string().allow(""),
|
|
879
846
|
endDate: Joi.string().allow(""),
|
|
880
|
-
statusAssignedStartDate: Joi.string().allow(""),
|
|
881
|
-
statusAssignedEndDate: Joi.string().allow(""),
|
|
882
847
|
dpIds: Joi.string().allow(""),
|
|
883
848
|
stores: Joi.string().allow(""),
|
|
884
849
|
salesChannels: Joi.string().allow(""),
|
|
@@ -900,18 +865,13 @@ class OrderPlatformValidator {
|
|
|
900
865
|
tags: Joi.string().allow(""),
|
|
901
866
|
customerId: Joi.string().allow(""),
|
|
902
867
|
orderType: Joi.string().allow(""),
|
|
868
|
+
operationalStatus: Joi.string().allow(""),
|
|
869
|
+
financialStatus: Joi.string().allow(""),
|
|
870
|
+
logisticsStatus: Joi.string().allow(""),
|
|
871
|
+
parentViewSlug: Joi.string().allow(""),
|
|
872
|
+
childViewSlug: Joi.string().allow(""),
|
|
873
|
+
lockStatus: Joi.string().allow(""),
|
|
903
874
|
groupEntity: Joi.string().allow(""),
|
|
904
|
-
enforceDateFilter: Joi.boolean(),
|
|
905
|
-
fulfillmentType: Joi.string().allow(""),
|
|
906
|
-
}).required();
|
|
907
|
-
}
|
|
908
|
-
|
|
909
|
-
/** @returns {GetStateManagerConfigParam} */
|
|
910
|
-
static getStateManagerConfig() {
|
|
911
|
-
return Joi.object({
|
|
912
|
-
appId: Joi.string().allow(""),
|
|
913
|
-
orderingChannel: Joi.string().allow(""),
|
|
914
|
-
entity: Joi.string().allow(""),
|
|
915
875
|
}).required();
|
|
916
876
|
}
|
|
917
877
|
|
|
@@ -927,6 +887,13 @@ class OrderPlatformValidator {
|
|
|
927
887
|
}).required();
|
|
928
888
|
}
|
|
929
889
|
|
|
890
|
+
/** @returns {GetUserViewsParam} */
|
|
891
|
+
static getUserViews() {
|
|
892
|
+
return Joi.object({
|
|
893
|
+
showIn: Joi.string().allow("").required(),
|
|
894
|
+
}).required();
|
|
895
|
+
}
|
|
896
|
+
|
|
930
897
|
/** @returns {GetfiltersParam} */
|
|
931
898
|
static getfilters() {
|
|
932
899
|
return Joi.object({
|
|
@@ -956,6 +923,22 @@ class OrderPlatformValidator {
|
|
|
956
923
|
}).required();
|
|
957
924
|
}
|
|
958
925
|
|
|
926
|
+
/** @returns {PostRefundConfigurationParam} */
|
|
927
|
+
static postRefundConfiguration() {
|
|
928
|
+
return Joi.object({
|
|
929
|
+
appId: Joi.string().allow("").required(),
|
|
930
|
+
body: OrderPlatformModel.RefundStateConfigurationManualSchema().required(),
|
|
931
|
+
}).required();
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
/** @returns {PostRefundStateConfigurationParam} */
|
|
935
|
+
static postRefundStateConfiguration() {
|
|
936
|
+
return Joi.object({
|
|
937
|
+
appId: Joi.string().allow("").required(),
|
|
938
|
+
body: OrderPlatformModel.PostRefundStateConfiguration().required(),
|
|
939
|
+
}).required();
|
|
940
|
+
}
|
|
941
|
+
|
|
959
942
|
/** @returns {PostShipmentHistoryParam} */
|
|
960
943
|
static postShipmentHistory() {
|
|
961
944
|
return Joi.object({
|
|
@@ -994,11 +977,11 @@ class OrderPlatformValidator {
|
|
|
994
977
|
}).required();
|
|
995
978
|
}
|
|
996
979
|
|
|
997
|
-
/** @returns {
|
|
998
|
-
static
|
|
980
|
+
/** @returns {UpdateOrderParam} */
|
|
981
|
+
static updateOrder() {
|
|
999
982
|
return Joi.object({
|
|
1000
|
-
|
|
1001
|
-
body: OrderPlatformModel.
|
|
983
|
+
orderId: Joi.string().allow("").required(),
|
|
984
|
+
body: OrderPlatformModel.OrderUpdatePayload().required(),
|
|
1002
985
|
}).required();
|
|
1003
986
|
}
|
|
1004
987
|
|
|
@@ -1009,10 +992,10 @@ class OrderPlatformValidator {
|
|
|
1009
992
|
}).required();
|
|
1010
993
|
}
|
|
1011
994
|
|
|
1012
|
-
/** @returns {
|
|
1013
|
-
static
|
|
995
|
+
/** @returns {UpdateShipmentParam} */
|
|
996
|
+
static updateShipment() {
|
|
1014
997
|
return Joi.object({
|
|
1015
|
-
body: OrderPlatformModel.
|
|
998
|
+
body: OrderPlatformModel.UpdateShipmentActionRequest().required(),
|
|
1016
999
|
}).required();
|
|
1017
1000
|
}
|
|
1018
1001
|
|
|
@@ -1026,7 +1009,7 @@ class OrderPlatformValidator {
|
|
|
1026
1009
|
/** @returns {UpdateShipmentStatusParam} */
|
|
1027
1010
|
static updateShipmentStatus() {
|
|
1028
1011
|
return Joi.object({
|
|
1029
|
-
body: OrderPlatformModel.
|
|
1012
|
+
body: OrderPlatformModel.UpdateShipmentStatusRequest().required(),
|
|
1030
1013
|
}).required();
|
|
1031
1014
|
}
|
|
1032
1015
|
|
|
@@ -1037,10 +1020,17 @@ class OrderPlatformValidator {
|
|
|
1037
1020
|
}).required();
|
|
1038
1021
|
}
|
|
1039
1022
|
|
|
1040
|
-
/** @returns {
|
|
1041
|
-
static
|
|
1023
|
+
/** @returns {UpdateUserViewPositionParam} */
|
|
1024
|
+
static updateUserViewPosition() {
|
|
1025
|
+
return Joi.object({
|
|
1026
|
+
body: OrderPlatformModel.UserViewPosition().required(),
|
|
1027
|
+
}).required();
|
|
1028
|
+
}
|
|
1029
|
+
|
|
1030
|
+
/** @returns {UpdateUserViewsParam} */
|
|
1031
|
+
static updateUserViews() {
|
|
1042
1032
|
return Joi.object({
|
|
1043
|
-
body: OrderPlatformModel.
|
|
1033
|
+
body: OrderPlatformModel.UserViewsResponse().required(),
|
|
1044
1034
|
}).required();
|
|
1045
1035
|
}
|
|
1046
1036
|
|