@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-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 +53 -60
- package/sdk/application/Cart/CartApplicationClient.js +53 -130
- package/sdk/application/Cart/CartApplicationModel.d.ts +143 -489
- package/sdk/application/Cart/CartApplicationModel.js +159 -380
- package/sdk/application/Cart/CartApplicationValidator.d.ts +19 -38
- package/sdk/application/Cart/CartApplicationValidator.js +18 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +68 -88
- package/sdk/application/Catalog/CatalogApplicationClient.js +94 -114
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +142 -194
- package/sdk/application/Catalog/CatalogApplicationModel.js +133 -171
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -3
- package/sdk/application/Common/CommonApplicationClient.js +5 -6
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +57 -45
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +47 -35
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +33 -23
- package/sdk/application/Content/ContentApplicationClient.js +75 -54
- package/sdk/application/Content/ContentApplicationModel.d.ts +37 -93
- package/sdk/application/Content/ContentApplicationModel.js +32 -83
- package/sdk/application/Content/ContentApplicationValidator.d.ts +17 -23
- package/sdk/application/Content/ContentApplicationValidator.js +10 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +13 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +25 -23
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +18 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -2
- package/sdk/application/Lead/LeadApplicationClient.js +3 -2
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +21 -189
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +173 -532
- package/sdk/application/Logistic/LogisticApplicationModel.js +139 -409
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +9 -54
- package/sdk/application/Logistic/LogisticApplicationValidator.js +8 -42
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -24
- package/sdk/application/Order/OrderApplicationClient.js +13 -96
- package/sdk/application/Order/OrderApplicationModel.d.ts +120 -436
- package/sdk/application/Order/OrderApplicationModel.js +81 -279
- package/sdk/application/Order/OrderApplicationValidator.d.ts +3 -17
- package/sdk/application/Order/OrderApplicationValidator.js +2 -15
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +99 -96
- package/sdk/application/Payment/PaymentApplicationClient.js +114 -111
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +289 -293
- package/sdk/application/Payment/PaymentApplicationModel.js +241 -243
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +22 -19
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +17 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +22 -42
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +3 -16
- package/sdk/application/Theme/ThemeApplicationValidator.js +2 -9
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +9 -11
- package/sdk/application/Webhook/WebhookApplicationModel.js +6 -8
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +0 -1
- package/sdk/application/index.js +0 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1304 -4979
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1922
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
- package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1751 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1224 -1393
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +124 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +94 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- 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 +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -83
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -25
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -16
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -178
- package/sdk/platform/Order/OrderPlatformClient.js +245 -597
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3071 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1656 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +190 -237
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -153
- 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 +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
- package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +35 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +341 -602
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +284 -483
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- 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/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -36
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
- package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
- package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
|
@@ -14,13 +14,15 @@ 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} [
|
|
17
|
+
* @property {number} pageSize - The number of records to return per page in the response.
|
|
18
|
+
* @property {number} pageNo - The page number to fetch from the paginated results.
|
|
19
|
+
* @property {string} startDate - The start date for filtering the jobs,
|
|
20
|
+
* expressed in UTC format
|
|
21
|
+
* @property {string} endDate - The end date for filtering the jobs, expressed
|
|
22
|
+
* in UTC format
|
|
23
|
+
* @property {string} [status] - The status of the jobs to filter the results.
|
|
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.
|
|
24
26
|
*/
|
|
25
27
|
|
|
26
28
|
/**
|
|
@@ -33,11 +35,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
33
35
|
* @property {OrderPlatformModel.OrderStatus} body
|
|
34
36
|
*/
|
|
35
37
|
|
|
36
|
-
/**
|
|
37
|
-
* @typedef CreateChannelConfigParam
|
|
38
|
-
* @property {OrderPlatformModel.CreateChannelConfigData} body
|
|
39
|
-
*/
|
|
40
|
-
|
|
41
38
|
/**
|
|
42
39
|
* @typedef CreateOrderParam
|
|
43
40
|
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
@@ -55,7 +52,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
55
52
|
|
|
56
53
|
/**
|
|
57
54
|
* @typedef DownloadLanesReportParam
|
|
58
|
-
* @property {OrderPlatformModel.
|
|
55
|
+
* @property {OrderPlatformModel.BulkReportsDownloadRequest} body
|
|
59
56
|
*/
|
|
60
57
|
|
|
61
58
|
/**
|
|
@@ -68,11 +65,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
68
65
|
* @property {string} logId - Log Error ID
|
|
69
66
|
*/
|
|
70
67
|
|
|
71
|
-
/**
|
|
72
|
-
* @typedef FetchCreditBalanceDetailParam
|
|
73
|
-
* @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
|
|
74
|
-
*/
|
|
75
|
-
|
|
76
68
|
/**
|
|
77
69
|
* @typedef FetchRefundModeConfigParam
|
|
78
70
|
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
@@ -93,21 +85,21 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
93
85
|
|
|
94
86
|
/**
|
|
95
87
|
* @typedef GenerateProcessManifestParam
|
|
96
|
-
* @property {OrderPlatformModel.
|
|
88
|
+
* @property {OrderPlatformModel.ProcessManifestRequest} body
|
|
97
89
|
*/
|
|
98
90
|
|
|
99
91
|
/**
|
|
100
92
|
* @typedef GetAllowedStateTransitionParam
|
|
101
|
-
* @property {string} orderingChannel -
|
|
102
|
-
* @property {string} status -
|
|
93
|
+
* @property {string} orderingChannel - The channel through which orders are placed.
|
|
94
|
+
* @property {string} status - The status key indicates the current status for
|
|
95
|
+
* which the API will provide a list of possible next state transitions.
|
|
103
96
|
*/
|
|
104
97
|
|
|
105
98
|
/** @typedef GetAllowedTemplatesForBulkParam */
|
|
106
99
|
|
|
107
100
|
/**
|
|
108
101
|
* @typedef GetAnnouncementsParam
|
|
109
|
-
* @property {string} [date] - Date On which the announcement is Active
|
|
110
|
-
* should in ISO Datetime format IST Time)
|
|
102
|
+
* @property {string} [date] - Date On which the announcement is Active.
|
|
111
103
|
*/
|
|
112
104
|
|
|
113
105
|
/**
|
|
@@ -136,8 +128,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
136
128
|
* @typedef GetBulkShipmentExcelFileParam
|
|
137
129
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
138
130
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
139
|
-
* @property {string} [startDate] -
|
|
140
|
-
* @property {string} [endDate] -
|
|
131
|
+
* @property {string} [startDate] - UTC start date in ISO format
|
|
132
|
+
* @property {string} [endDate] - UTC end date in ISO format
|
|
141
133
|
* @property {string} [stores] - Comma separated values of store ids
|
|
142
134
|
* @property {string} [tags] - Comma separated values of tags
|
|
143
135
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -148,14 +140,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
148
140
|
* @property {number} [pageSize]
|
|
149
141
|
*/
|
|
150
142
|
|
|
151
|
-
/** @typedef GetChannelConfigParam */
|
|
152
|
-
|
|
153
143
|
/**
|
|
154
144
|
* @typedef GetFileByStatusParam
|
|
155
|
-
* @property {string} batchId
|
|
156
|
-
* @property {string} status
|
|
157
|
-
* @property {string} fileType -
|
|
158
|
-
* @property {string} [reportType]
|
|
145
|
+
* @property {string} batchId - Batch Id to identify the bulk operation request.
|
|
146
|
+
* @property {string} status - The status of the jobs to filter the results.
|
|
147
|
+
* @property {string} fileType - The type of file to be downloaded.
|
|
148
|
+
* @property {string} [reportType] - The type of report to be downloaded.
|
|
159
149
|
*/
|
|
160
150
|
|
|
161
151
|
/**
|
|
@@ -171,46 +161,40 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
171
161
|
* @property {string} [salesChannels]
|
|
172
162
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
173
163
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
174
|
-
* @property {string} [searchType]
|
|
175
|
-
* be used as the target for the search operation
|
|
164
|
+
* @property {string} [searchType]
|
|
176
165
|
* @property {string} [searchValue]
|
|
177
166
|
* @property {string} [tags]
|
|
178
|
-
* @property {number} [timeToDispatch]
|
|
167
|
+
* @property {number} [timeToDispatch]
|
|
179
168
|
* @property {string} [paymentMethods]
|
|
180
169
|
* @property {boolean} [myOrders]
|
|
181
170
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
182
171
|
* company order
|
|
183
|
-
* @property {string} [orderType]
|
|
184
|
-
* follow based on the application's operational needs and customer
|
|
185
|
-
* preferences. This field categorizes orders into distinct types, each
|
|
186
|
-
* associated with a unique processing flow. For example:
|
|
187
|
-
*
|
|
188
|
-
* - "HomeDelivery": The order undergoes all state transitions typical for a
|
|
189
|
-
* delivery, from processing the shipment to final delivery at the
|
|
190
|
-
* customer's address.
|
|
191
|
-
* - "PickAtStore": The order is prepared for pickup and moved to a state where it
|
|
192
|
-
* is ready to be handed over directly to the customer at the store. This
|
|
193
|
-
* type streamlines the process by bypassing traditional shipping stages
|
|
194
|
-
* and facilitating a quicker transition to the final handover stage.
|
|
172
|
+
* @property {string} [orderType]
|
|
195
173
|
*/
|
|
196
174
|
|
|
197
175
|
/**
|
|
198
176
|
* @typedef GetManifestDetailsParam
|
|
199
|
-
* @property {string} manifestId
|
|
177
|
+
* @property {string} manifestId - The unique identifier assigned to the manifest.
|
|
178
|
+
* @property {string} [dpIds] - Filter shipments with the specific Courier
|
|
179
|
+
* partner Ids which is a combination of courier partner extension and scheme Ids.
|
|
180
|
+
* @property {string} [endDate] - End date for the shipment search range in manifest.
|
|
181
|
+
* @property {string} [startDate] - Start date for the shipment search range in manifest.
|
|
182
|
+
* @property {number} [pageNo] - Page number for pagination.
|
|
183
|
+
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
200
184
|
*/
|
|
201
185
|
|
|
202
186
|
/**
|
|
203
187
|
* @typedef GetManifestShipmentsParam
|
|
204
188
|
* @property {string} dpIds - Filter shipments with the specific Courier partner
|
|
205
189
|
* Ids which is a combination of courier partner extension and scheme Ids.
|
|
206
|
-
* @property {number} stores - Filter
|
|
190
|
+
* @property {number} stores - Filter results based on specific store IDs.
|
|
207
191
|
* @property {string} toDate - End date for the shipment search range.
|
|
208
192
|
* @property {string} fromDate - Start date for the shipment search range.
|
|
209
|
-
* @property {string} [dpName] - Filter
|
|
210
|
-
* @property {string} [salesChannels] -
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
* @property {string} [searchValue] -
|
|
193
|
+
* @property {string} [dpName] - Filter results based on specific courier partner name.
|
|
194
|
+
* @property {string} [salesChannels] - Filter results based on comma-separated
|
|
195
|
+
* list of sales channels.
|
|
196
|
+
* @property {string} [searchType] - Filter results based on search type.
|
|
197
|
+
* @property {string} [searchValue] - Filter results based on the search value.
|
|
214
198
|
* @property {number} [pageNo] - Page number for pagination.
|
|
215
199
|
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
216
200
|
*/
|
|
@@ -222,16 +206,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
222
206
|
|
|
223
207
|
/**
|
|
224
208
|
* @typedef GetManifestsParam
|
|
225
|
-
* @property {string} [status] -
|
|
226
|
-
* @property {string} [startDate] -
|
|
227
|
-
*
|
|
228
|
-
* @property {string} [
|
|
229
|
-
*
|
|
230
|
-
* @property {number} [storeId] -
|
|
231
|
-
*
|
|
232
|
-
* @property {string} [
|
|
233
|
-
*
|
|
234
|
-
* @property {
|
|
209
|
+
* @property {string} [status] - Filter for the status of manifests.
|
|
210
|
+
* @property {string} [startDate] - The starting date for filtering manifests in
|
|
211
|
+
* ISO format
|
|
212
|
+
* @property {string} [endDate] - The end date for filtering manifests in ISO format
|
|
213
|
+
* @property {string} [searchType] - Specifies the type of search to perform.
|
|
214
|
+
* @property {number} [storeId] - Filter to fetch manifests for a specific store
|
|
215
|
+
* by its ID.
|
|
216
|
+
* @property {string} [searchValue] - The value to search for based on the
|
|
217
|
+
* selected search type.
|
|
218
|
+
* @property {string} [dpIds] - A comma-separated list of courier partner IDs
|
|
219
|
+
* (DP IDs) to filter the manifests.
|
|
220
|
+
* @property {number} [pageNo] - The number of the page to fetch data.
|
|
221
|
+
* @property {number} [pageSize] - The number of records to return per page for
|
|
222
|
+
* pagination.
|
|
235
223
|
*/
|
|
236
224
|
|
|
237
225
|
/**
|
|
@@ -255,10 +243,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
255
243
|
* associated with the order
|
|
256
244
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
257
245
|
* specified by the search_type
|
|
258
|
-
* @property {string} [fromDate]
|
|
259
|
-
* @property {string} [toDate]
|
|
260
|
-
* @property {string} [startDate]
|
|
261
|
-
* @property {string} [endDate]
|
|
246
|
+
* @property {string} [fromDate]
|
|
247
|
+
* @property {string} [toDate]
|
|
248
|
+
* @property {string} [startDate]
|
|
249
|
+
* @property {string} [endDate]
|
|
262
250
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
263
251
|
* @property {string} [stores]
|
|
264
252
|
* @property {string} [salesChannels]
|
|
@@ -273,11 +261,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
273
261
|
* @property {string} [orderType]
|
|
274
262
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
275
263
|
* shipments are allowed
|
|
276
|
-
* @property {
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
280
|
-
* may not be recognized, leading to errors or default behavior.
|
|
264
|
+
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
265
|
+
* orders. This is useful when fetching data for a specific date range while
|
|
266
|
+
* performing searches.
|
|
281
267
|
*/
|
|
282
268
|
|
|
283
269
|
/** @typedef GetRoleBasedActionsParam */
|
|
@@ -294,8 +280,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
294
280
|
|
|
295
281
|
/**
|
|
296
282
|
* @typedef GetShipmentHistoryParam
|
|
297
|
-
* @property {string} [shipmentId] -
|
|
298
|
-
* @property {number} [bagId] -
|
|
283
|
+
* @property {string} [shipmentId] - Identifier for the shipment
|
|
284
|
+
* @property {number} [bagId] - Identifier for a bag or product.
|
|
299
285
|
*/
|
|
300
286
|
|
|
301
287
|
/**
|
|
@@ -314,9 +300,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
314
300
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
315
301
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
316
302
|
* bag_status and override lane
|
|
317
|
-
* @property {number} [timeToDispatch]
|
|
318
|
-
* @property {string} [searchType] -
|
|
319
|
-
* be used as the target for the search operation
|
|
303
|
+
* @property {number} [timeToDispatch]
|
|
304
|
+
* @property {string} [searchType] - Search type key
|
|
320
305
|
* @property {string} [searchValue] - Search type value
|
|
321
306
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
322
307
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
@@ -343,24 +328,10 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
343
328
|
* company order
|
|
344
329
|
* @property {string} [tags] - Comma separated values of tags
|
|
345
330
|
* @property {string} [customerId]
|
|
346
|
-
* @property {string} [orderType]
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
* - "HomeDelivery": The order undergoes all state transitions typical for a
|
|
352
|
-
* delivery, from processing the shipment to final delivery at the
|
|
353
|
-
* customer's address.
|
|
354
|
-
* - "PickAtStore": The order is prepared for pickup and moved to a state where it
|
|
355
|
-
* is ready to be handed over directly to the customer at the store. This
|
|
356
|
-
* type streamlines the process by bypassing traditional shipping stages
|
|
357
|
-
* and facilitating a quicker transition to the final handover stage.
|
|
358
|
-
*
|
|
359
|
-
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
360
|
-
* retrieving shipments or orders. It specifies whether the results should be
|
|
361
|
-
* organized based on shipment groups or order groups. For example, using
|
|
362
|
-
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
363
|
-
* may not be recognized, leading to errors or default behavior.
|
|
331
|
+
* @property {string} [orderType]
|
|
332
|
+
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
333
|
+
* shipments. This is useful when fetching data for a specific date range
|
|
334
|
+
* while performing searches.
|
|
364
335
|
*/
|
|
365
336
|
|
|
366
337
|
/**
|
|
@@ -390,7 +361,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
390
361
|
|
|
391
362
|
/**
|
|
392
363
|
* @typedef JobDetailsParam
|
|
393
|
-
* @property {string} batchId
|
|
364
|
+
* @property {string} batchId - A unique identifier for the batch associated
|
|
365
|
+
* with this bulk action.
|
|
394
366
|
*/
|
|
395
367
|
|
|
396
368
|
/**
|
|
@@ -403,11 +375,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
403
375
|
* @property {OrderPlatformModel.PostShipmentHistory} body
|
|
404
376
|
*/
|
|
405
377
|
|
|
406
|
-
/**
|
|
407
|
-
* @typedef ProcessManifestsParam
|
|
408
|
-
* @property {OrderPlatformModel.ProcessManifest} body
|
|
409
|
-
*/
|
|
410
|
-
|
|
411
378
|
/**
|
|
412
379
|
* @typedef ReassignLocationParam
|
|
413
380
|
* @property {OrderPlatformModel.StoreReassign} body
|
|
@@ -425,16 +392,26 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
425
392
|
|
|
426
393
|
/**
|
|
427
394
|
* @typedef TrackShipmentParam
|
|
428
|
-
* @property {string} [shipmentId] -
|
|
395
|
+
* @property {string} [shipmentId] - Unique identifier of a shipment on the platform.
|
|
429
396
|
* @property {string} [awb] - AWB number
|
|
430
|
-
* @property {number} [pageNo] - Page number
|
|
431
|
-
* @property {number} [pageSize] -
|
|
397
|
+
* @property {number} [pageNo] - Page number for pagination.
|
|
398
|
+
* @property {number} [pageSize] - Number of records per page for pagination.
|
|
432
399
|
*/
|
|
433
400
|
|
|
434
401
|
/**
|
|
435
402
|
* @typedef UpdateAddressParam
|
|
436
|
-
* @property {string} shipmentId
|
|
437
|
-
* @property {
|
|
403
|
+
* @property {string} shipmentId
|
|
404
|
+
* @property {string} [name]
|
|
405
|
+
* @property {string} [address]
|
|
406
|
+
* @property {string} [addressType]
|
|
407
|
+
* @property {string} [pincode]
|
|
408
|
+
* @property {string} [phone]
|
|
409
|
+
* @property {string} [email]
|
|
410
|
+
* @property {string} [landmark]
|
|
411
|
+
* @property {string} addressCategory
|
|
412
|
+
* @property {string} [city]
|
|
413
|
+
* @property {string} [state]
|
|
414
|
+
* @property {string} [country]
|
|
438
415
|
*/
|
|
439
416
|
|
|
440
417
|
/**
|
|
@@ -442,11 +419,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
442
419
|
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
443
420
|
*/
|
|
444
421
|
|
|
445
|
-
/**
|
|
446
|
-
* @typedef UpdatePaymentInfoParam
|
|
447
|
-
* @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
|
|
448
|
-
*/
|
|
449
|
-
|
|
450
422
|
/**
|
|
451
423
|
* @typedef UpdateShipmentLockParam
|
|
452
424
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
@@ -464,8 +436,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
464
436
|
|
|
465
437
|
/**
|
|
466
438
|
* @typedef UploadConsentsParam
|
|
467
|
-
* @property {
|
|
468
|
-
* @property {OrderPlatformModel.UploadConsent} body
|
|
439
|
+
* @property {OrderPlatformModel.UploadManifestConsent} body
|
|
469
440
|
*/
|
|
470
441
|
|
|
471
442
|
/**
|
|
@@ -515,13 +486,6 @@ class OrderPlatformValidator {
|
|
|
515
486
|
}).required();
|
|
516
487
|
}
|
|
517
488
|
|
|
518
|
-
/** @returns {CreateChannelConfigParam} */
|
|
519
|
-
static createChannelConfig() {
|
|
520
|
-
return Joi.object({
|
|
521
|
-
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
522
|
-
}).required();
|
|
523
|
-
}
|
|
524
|
-
|
|
525
489
|
/** @returns {CreateOrderParam} */
|
|
526
490
|
static createOrder() {
|
|
527
491
|
return Joi.object({
|
|
@@ -546,7 +510,7 @@ class OrderPlatformValidator {
|
|
|
546
510
|
/** @returns {DownloadLanesReportParam} */
|
|
547
511
|
static downloadLanesReport() {
|
|
548
512
|
return Joi.object({
|
|
549
|
-
body: OrderPlatformModel.
|
|
513
|
+
body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
|
|
550
514
|
}).required();
|
|
551
515
|
}
|
|
552
516
|
|
|
@@ -564,13 +528,6 @@ class OrderPlatformValidator {
|
|
|
564
528
|
}).required();
|
|
565
529
|
}
|
|
566
530
|
|
|
567
|
-
/** @returns {FetchCreditBalanceDetailParam} */
|
|
568
|
-
static fetchCreditBalanceDetail() {
|
|
569
|
-
return Joi.object({
|
|
570
|
-
body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
|
|
571
|
-
}).required();
|
|
572
|
-
}
|
|
573
|
-
|
|
574
531
|
/** @returns {FetchRefundModeConfigParam} */
|
|
575
532
|
static fetchRefundModeConfig() {
|
|
576
533
|
return Joi.object({
|
|
@@ -598,7 +555,7 @@ class OrderPlatformValidator {
|
|
|
598
555
|
/** @returns {GenerateProcessManifestParam} */
|
|
599
556
|
static generateProcessManifest() {
|
|
600
557
|
return Joi.object({
|
|
601
|
-
body: OrderPlatformModel.
|
|
558
|
+
body: OrderPlatformModel.ProcessManifestRequest().required(),
|
|
602
559
|
}).required();
|
|
603
560
|
}
|
|
604
561
|
|
|
@@ -669,11 +626,6 @@ class OrderPlatformValidator {
|
|
|
669
626
|
}).required();
|
|
670
627
|
}
|
|
671
628
|
|
|
672
|
-
/** @returns {GetChannelConfigParam} */
|
|
673
|
-
static getChannelConfig() {
|
|
674
|
-
return Joi.object({}).required();
|
|
675
|
-
}
|
|
676
|
-
|
|
677
629
|
/** @returns {GetFileByStatusParam} */
|
|
678
630
|
static getFileByStatus() {
|
|
679
631
|
return Joi.object({
|
|
@@ -713,6 +665,11 @@ class OrderPlatformValidator {
|
|
|
713
665
|
static getManifestDetails() {
|
|
714
666
|
return Joi.object({
|
|
715
667
|
manifestId: Joi.string().allow("").required(),
|
|
668
|
+
dpIds: Joi.string().allow(""),
|
|
669
|
+
endDate: Joi.string().allow(""),
|
|
670
|
+
startDate: Joi.string().allow(""),
|
|
671
|
+
pageNo: Joi.number(),
|
|
672
|
+
pageSize: Joi.number(),
|
|
716
673
|
}).required();
|
|
717
674
|
}
|
|
718
675
|
|
|
@@ -789,7 +746,7 @@ class OrderPlatformValidator {
|
|
|
789
746
|
customerId: Joi.string().allow(""),
|
|
790
747
|
orderType: Joi.string().allow(""),
|
|
791
748
|
allowInactive: Joi.boolean(),
|
|
792
|
-
|
|
749
|
+
enforceDateFilter: Joi.boolean(),
|
|
793
750
|
}).required();
|
|
794
751
|
}
|
|
795
752
|
|
|
@@ -859,7 +816,7 @@ class OrderPlatformValidator {
|
|
|
859
816
|
tags: Joi.string().allow(""),
|
|
860
817
|
customerId: Joi.string().allow(""),
|
|
861
818
|
orderType: Joi.string().allow(""),
|
|
862
|
-
|
|
819
|
+
enforceDateFilter: Joi.boolean(),
|
|
863
820
|
}).required();
|
|
864
821
|
}
|
|
865
822
|
|
|
@@ -920,13 +877,6 @@ class OrderPlatformValidator {
|
|
|
920
877
|
}).required();
|
|
921
878
|
}
|
|
922
879
|
|
|
923
|
-
/** @returns {ProcessManifestsParam} */
|
|
924
|
-
static processManifests() {
|
|
925
|
-
return Joi.object({
|
|
926
|
-
body: OrderPlatformModel.ProcessManifest().required(),
|
|
927
|
-
}).required();
|
|
928
|
-
}
|
|
929
|
-
|
|
930
880
|
/** @returns {ReassignLocationParam} */
|
|
931
881
|
static reassignLocation() {
|
|
932
882
|
return Joi.object({
|
|
@@ -962,7 +912,17 @@ class OrderPlatformValidator {
|
|
|
962
912
|
static updateAddress() {
|
|
963
913
|
return Joi.object({
|
|
964
914
|
shipmentId: Joi.string().allow("").required(),
|
|
965
|
-
|
|
915
|
+
name: Joi.string().allow(""),
|
|
916
|
+
address: Joi.string().allow(""),
|
|
917
|
+
addressType: Joi.string().allow(""),
|
|
918
|
+
pincode: Joi.string().allow(""),
|
|
919
|
+
phone: Joi.string().allow(""),
|
|
920
|
+
email: Joi.string().allow(""),
|
|
921
|
+
landmark: Joi.string().allow(""),
|
|
922
|
+
addressCategory: Joi.string().allow("").required(),
|
|
923
|
+
city: Joi.string().allow(""),
|
|
924
|
+
state: Joi.string().allow(""),
|
|
925
|
+
country: Joi.string().allow(""),
|
|
966
926
|
}).required();
|
|
967
927
|
}
|
|
968
928
|
|
|
@@ -973,13 +933,6 @@ class OrderPlatformValidator {
|
|
|
973
933
|
}).required();
|
|
974
934
|
}
|
|
975
935
|
|
|
976
|
-
/** @returns {UpdatePaymentInfoParam} */
|
|
977
|
-
static updatePaymentInfo() {
|
|
978
|
-
return Joi.object({
|
|
979
|
-
body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
|
|
980
|
-
}).required();
|
|
981
|
-
}
|
|
982
|
-
|
|
983
936
|
/** @returns {UpdateShipmentLockParam} */
|
|
984
937
|
static updateShipmentLock() {
|
|
985
938
|
return Joi.object({
|
|
@@ -1004,8 +957,7 @@ class OrderPlatformValidator {
|
|
|
1004
957
|
/** @returns {UploadConsentsParam} */
|
|
1005
958
|
static uploadConsents() {
|
|
1006
959
|
return Joi.object({
|
|
1007
|
-
|
|
1008
|
-
body: OrderPlatformModel.UploadConsent().required(),
|
|
960
|
+
body: OrderPlatformModel.UploadManifestConsent().required(),
|
|
1009
961
|
}).required();
|
|
1010
962
|
}
|
|
1011
963
|
|
|
@@ -7,24 +7,22 @@ declare class Partner {
|
|
|
7
7
|
* @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
|
|
8
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
11
|
-
* Success response
|
|
10
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
12
11
|
* @name addProxyPath
|
|
13
12
|
* @summary: Create extension proxy
|
|
14
13
|
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
|
|
15
14
|
*/
|
|
16
|
-
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
15
|
+
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
|
|
17
16
|
/**
|
|
18
17
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
19
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
22
|
-
* Success response
|
|
20
|
+
* @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
|
|
23
21
|
* @name removeProxyPath
|
|
24
22
|
* @summary: Remove extension proxy
|
|
25
23
|
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
|
|
26
24
|
*/
|
|
27
|
-
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
25
|
+
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
|
|
28
26
|
}
|
|
29
27
|
import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
30
28
|
import PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
@@ -19,8 +19,7 @@ class Partner {
|
|
|
19
19
|
* @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
|
|
20
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
23
|
-
* Success response
|
|
22
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
24
23
|
* @name addProxyPath
|
|
25
24
|
* @summary: Create extension proxy
|
|
26
25
|
* @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
|
|
@@ -78,10 +77,10 @@ class Partner {
|
|
|
78
77
|
|
|
79
78
|
const {
|
|
80
79
|
error: res_error,
|
|
81
|
-
} = PartnerPlatformModel.
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
);
|
|
80
|
+
} = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
|
|
81
|
+
abortEarly: false,
|
|
82
|
+
allowUnknown: true,
|
|
83
|
+
});
|
|
85
84
|
|
|
86
85
|
if (res_error) {
|
|
87
86
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -101,8 +100,7 @@ class Partner {
|
|
|
101
100
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
102
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
105
|
-
* Success response
|
|
103
|
+
* @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
|
|
106
104
|
* @name removeProxyPath
|
|
107
105
|
* @summary: Remove extension proxy
|
|
108
106
|
* @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
|
|
@@ -160,7 +158,7 @@ class Partner {
|
|
|
160
158
|
|
|
161
159
|
const {
|
|
162
160
|
error: res_error,
|
|
163
|
-
} = PartnerPlatformModel.
|
|
161
|
+
} = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
|
|
164
162
|
abortEarly: false,
|
|
165
163
|
allowUnknown: true,
|
|
166
164
|
});
|
|
@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
|
|
|
6
6
|
* will be generated
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef AddProxyResponse
|
|
10
10
|
* @property {string} [_id]
|
|
11
11
|
* @property {string} [attached_path]
|
|
12
12
|
* @property {string} [proxy_url]
|
|
@@ -17,7 +17,7 @@ export = PartnerPlatformModel;
|
|
|
17
17
|
* @property {string} [modified_at]
|
|
18
18
|
*/
|
|
19
19
|
/**
|
|
20
|
-
* @typedef
|
|
20
|
+
* @typedef RemoveProxyResponse
|
|
21
21
|
* @property {string} [message]
|
|
22
22
|
* @property {Object} [data]
|
|
23
23
|
*/
|
|
@@ -32,7 +32,7 @@ export = PartnerPlatformModel;
|
|
|
32
32
|
declare class PartnerPlatformModel {
|
|
33
33
|
}
|
|
34
34
|
declare namespace PartnerPlatformModel {
|
|
35
|
-
export { AddProxyReq,
|
|
35
|
+
export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
|
|
36
36
|
}
|
|
37
37
|
/** @returns {AddProxyReq} */
|
|
38
38
|
declare function AddProxyReq(): AddProxyReq;
|
|
@@ -47,9 +47,9 @@ type AddProxyReq = {
|
|
|
47
47
|
*/
|
|
48
48
|
proxy_url?: string;
|
|
49
49
|
};
|
|
50
|
-
/** @returns {
|
|
51
|
-
declare function
|
|
52
|
-
type
|
|
50
|
+
/** @returns {AddProxyResponse} */
|
|
51
|
+
declare function AddProxyResponse(): AddProxyResponse;
|
|
52
|
+
type AddProxyResponse = {
|
|
53
53
|
_id?: string;
|
|
54
54
|
attached_path?: string;
|
|
55
55
|
proxy_url?: string;
|
|
@@ -59,9 +59,9 @@ type ExtensionProxyPathCreation = {
|
|
|
59
59
|
created_at?: string;
|
|
60
60
|
modified_at?: string;
|
|
61
61
|
};
|
|
62
|
-
/** @returns {
|
|
63
|
-
declare function
|
|
64
|
-
type
|
|
62
|
+
/** @returns {RemoveProxyResponse} */
|
|
63
|
+
declare function RemoveProxyResponse(): RemoveProxyResponse;
|
|
64
|
+
type RemoveProxyResponse = {
|
|
65
65
|
message?: string;
|
|
66
66
|
data?: any;
|
|
67
67
|
};
|