@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -1,19 +1,312 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
-
const
|
|
4
|
-
|
|
3
|
+
const OrderPlatformModel = require("./OrderPlatformModel");
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* @typedef AttachOrderUserParam
|
|
7
|
+
* @property {OrderPlatformModel.AttachOrderUser} body
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* @typedef CheckOrderStatusParam
|
|
12
|
+
* @property {OrderPlatformModel.OrderStatus} body
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @typedef Click2CallParam
|
|
17
|
+
* @property {string} caller - Call Number
|
|
18
|
+
* @property {string} receiver - Receiver Number
|
|
19
|
+
* @property {string} bagId - Bag Id for the query
|
|
20
|
+
* @property {string} [callerId] - Caller Id
|
|
21
|
+
* @property {string} [method] - Provider Method to Call
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* @typedef CreateChannelConfigParam
|
|
26
|
+
* @property {OrderPlatformModel.CreateChannelConfigData} body
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* @typedef CreateOrderParam
|
|
31
|
+
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
32
|
+
*/
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* @typedef DispatchManifestParam
|
|
36
|
+
* @property {OrderPlatformModel.DispatchManifest} body
|
|
37
|
+
*/
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* @typedef DownloadBulkActionTemplateParam
|
|
41
|
+
* @property {string} [templateSlug] - Slug name of template to be downloaded
|
|
42
|
+
*/
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* @typedef FetchCreditBalanceDetailParam
|
|
46
|
+
* @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
|
|
47
|
+
*/
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* @typedef FetchRefundModeConfigParam
|
|
51
|
+
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
52
|
+
*/
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* @typedef GeneratePOSReceiptByOrderIdParam
|
|
56
|
+
* @property {string} orderId
|
|
57
|
+
* @property {string} [shipmentId]
|
|
58
|
+
* @property {string} [documentType]
|
|
59
|
+
*/
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @typedef GetAnnouncementsParam
|
|
63
|
+
* @property {string} [date] - Date On which the announcement is Active (Date
|
|
64
|
+
* should in ISO Datetime format IST Time)
|
|
65
|
+
*/
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* @typedef GetBagByIdParam
|
|
69
|
+
* @property {string} [bagId] - Id of bag
|
|
70
|
+
* @property {string} [channelBagId] - Id of application bag
|
|
71
|
+
* @property {string} [channelId] - Id of application
|
|
72
|
+
*/
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* @typedef GetBagsParam
|
|
76
|
+
* @property {string} [bagIds] - Comma separated values of bag ids
|
|
77
|
+
* @property {string} [shipmentIds] - Comma separated values of shipment ids
|
|
78
|
+
* @property {string} [orderIds] - Comma separated values of order ids
|
|
79
|
+
* @property {string} [channelBagIds] - Comma separated values of app bag ids
|
|
80
|
+
* @property {string} [channelShipmentIds] - Comma separated values of app shipment ids
|
|
81
|
+
* @property {string} [channelOrderIds] - Comma separated values of app order ids
|
|
82
|
+
* @property {string} [channelId] - Comma separated values of app ids
|
|
83
|
+
* @property {number} [pageNo] - Page number for paginated data
|
|
84
|
+
* @property {number} [pageSize] - Page size of data received per page
|
|
85
|
+
*/
|
|
86
|
+
|
|
87
|
+
/** @typedef GetBulkActionTemplateParam */
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* @typedef GetBulkShipmentExcelFileParam
|
|
91
|
+
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
92
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
93
|
+
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
94
|
+
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
95
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
96
|
+
* @property {string} [tags] - Comma separated values of tags
|
|
97
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
98
|
+
* @property {string} [paymentMethods] - Comma separated values of payment methods
|
|
99
|
+
* @property {string} [fileType] - File type to be downloaded
|
|
100
|
+
* @property {number} [timeToDispatch] - Sla breached or not breached
|
|
101
|
+
* @property {number} [pageNo]
|
|
102
|
+
* @property {number} [pageSize]
|
|
103
|
+
*/
|
|
104
|
+
|
|
105
|
+
/** @typedef GetChannelConfigParam */
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* @typedef GetLaneConfigParam
|
|
109
|
+
* @property {string} [superLane] - Name of lane for which data is to be fetched
|
|
110
|
+
* @property {string} [groupEntity] - Name of group entity
|
|
111
|
+
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
112
|
+
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
113
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
114
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
115
|
+
* @property {string} [salesChannels]
|
|
116
|
+
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
117
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
118
|
+
* @property {string} [searchType]
|
|
119
|
+
* @property {string} [searchValue]
|
|
120
|
+
* @property {string} [tags]
|
|
121
|
+
* @property {string} [timeToDispatch]
|
|
122
|
+
* @property {string} [paymentMethods]
|
|
123
|
+
* @property {boolean} [myOrders]
|
|
124
|
+
*/
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* @typedef GetOrderByIdParam
|
|
128
|
+
* @property {string} orderId
|
|
129
|
+
*/
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* @typedef GetOrdersParam
|
|
133
|
+
* @property {string} [lane] - Lane refers to a section where orders are
|
|
134
|
+
* assigned, indicating its grouping
|
|
135
|
+
* @property {string} [searchType] - Search_type refers to the field that will
|
|
136
|
+
* be used as the target for the search operation
|
|
137
|
+
* @property {string} [bagStatus] - Bag_status refers to status of the entity.
|
|
138
|
+
* Filters orders based on the status.
|
|
139
|
+
* @property {string} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
140
|
+
* @property {string} [paymentMethods]
|
|
141
|
+
* @property {string} [tags] - Tags refers to additional descriptive labels
|
|
142
|
+
* associated with the order
|
|
143
|
+
* @property {string} [searchValue] - Search_value is matched against the field
|
|
144
|
+
* specified by the search_type
|
|
145
|
+
* @property {string} [fromDate]
|
|
146
|
+
* @property {string} [toDate]
|
|
147
|
+
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
148
|
+
* @property {string} [stores]
|
|
149
|
+
* @property {string} [salesChannels]
|
|
150
|
+
* @property {number} [pageNo]
|
|
151
|
+
* @property {number} [pageSize]
|
|
152
|
+
* @property {boolean} [isPrioritySort]
|
|
153
|
+
* @property {string} [customMeta]
|
|
154
|
+
* @property {boolean} [myOrders]
|
|
155
|
+
*/
|
|
156
|
+
|
|
157
|
+
/** @typedef GetRoleBasedActionsParam */
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* @typedef GetShipmentByIdParam
|
|
161
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
162
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
163
|
+
*/
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* @typedef GetShipmentHistoryParam
|
|
167
|
+
* @property {string} [shipmentId] - Shipment Id
|
|
168
|
+
* @property {number} [bagId] - Bag/Product Id
|
|
169
|
+
*/
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* @typedef GetShipmentReasonsParam
|
|
173
|
+
* @property {string} shipmentId - ID of the shipment. An order may contain
|
|
174
|
+
* multiple items and may get divided into one or more shipment, each having
|
|
175
|
+
* its own ID.
|
|
176
|
+
* @property {string} bagId - ID of the bag. An order may contain multiple items
|
|
177
|
+
* and may get divided into one or more shipment, each having its own ID.
|
|
178
|
+
* @property {string} state - State for which reasons are required.
|
|
179
|
+
*/
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* @typedef GetShipmentsParam
|
|
183
|
+
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
184
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
185
|
+
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
186
|
+
* bag_status and override lane
|
|
187
|
+
* @property {string} [timeToDispatch]
|
|
188
|
+
* @property {string} [searchType] - Search type key
|
|
189
|
+
* @property {string} [searchValue] - Search type value
|
|
190
|
+
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
191
|
+
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
192
|
+
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
193
|
+
* @property {string} [stores] - Comma separated values of store ids
|
|
194
|
+
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
195
|
+
* @property {number} [pageNo] - Page number for paginated data
|
|
196
|
+
* @property {number} [pageSize] - Page size of data received per page
|
|
197
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
|
|
198
|
+
* @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
|
|
199
|
+
* @property {string} [paymentMethods] - Comma separated values of payment methods
|
|
200
|
+
* @property {string} [channelShipmentId] - App Shipment Id
|
|
201
|
+
* @property {string} [channelOrderId] - App Order Id
|
|
202
|
+
* @property {string} [customMeta]
|
|
203
|
+
* @property {string} [orderingChannel]
|
|
204
|
+
* @property {string} [companyAffiliateTag]
|
|
205
|
+
* @property {boolean} [myOrders]
|
|
206
|
+
* @property {string} [platformUserId]
|
|
207
|
+
* @property {string} [tags] - Comma separated values of tags
|
|
208
|
+
*/
|
|
209
|
+
|
|
210
|
+
/** @typedef GetStateTransitionMapParam */
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* @typedef GetfiltersParam
|
|
214
|
+
* @property {string} view - Name of view
|
|
215
|
+
* @property {string} [groupEntity] - Name of group entity
|
|
216
|
+
*/
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* @typedef InvalidateShipmentCacheParam
|
|
220
|
+
* @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
|
|
221
|
+
*/
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* @typedef OrderUpdateParam
|
|
225
|
+
* @property {OrderPlatformModel.PlatformOrderUpdate} body
|
|
226
|
+
*/
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* @typedef PostShipmentHistoryParam
|
|
230
|
+
* @property {OrderPlatformModel.PostShipmentHistory} body
|
|
231
|
+
*/
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* @typedef ProcessManifestParam
|
|
235
|
+
* @property {OrderPlatformModel.CreateOrderPayload} body
|
|
236
|
+
*/
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* @typedef ReassignLocationParam
|
|
240
|
+
* @property {OrderPlatformModel.StoreReassign} body
|
|
241
|
+
*/
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* @typedef SendSmsNinjaParam
|
|
245
|
+
* @property {OrderPlatformModel.SendSmsPayload} body
|
|
246
|
+
*/
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* @typedef SendUserMobileOTPParam
|
|
250
|
+
* @property {OrderPlatformModel.SendUserMobileOTP} body
|
|
251
|
+
*/
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* @typedef UpdateAddressParam
|
|
255
|
+
* @property {string} shipmentId
|
|
256
|
+
* @property {string} [name]
|
|
257
|
+
* @property {string} [address]
|
|
258
|
+
* @property {string} [addressType]
|
|
259
|
+
* @property {string} [pincode]
|
|
260
|
+
* @property {string} [phone]
|
|
261
|
+
* @property {string} [email]
|
|
262
|
+
* @property {string} [landmark]
|
|
263
|
+
* @property {string} addressCategory
|
|
264
|
+
* @property {string} [city]
|
|
265
|
+
* @property {string} [state]
|
|
266
|
+
* @property {string} [country]
|
|
267
|
+
*/
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* @typedef UpdatePackagingDimensionsParam
|
|
271
|
+
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
272
|
+
*/
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* @typedef UpdateShipmentLockParam
|
|
276
|
+
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
277
|
+
*/
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* @typedef UpdateShipmentStatusParam
|
|
281
|
+
* @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
|
|
282
|
+
*/
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* @typedef UploadConsentParam
|
|
286
|
+
* @property {OrderPlatformModel.UploadConsent} body
|
|
287
|
+
*/
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* @typedef VerifyMobileOTPParam
|
|
291
|
+
* @property {OrderPlatformModel.VerifyMobileOTP} body
|
|
292
|
+
*/
|
|
293
|
+
|
|
294
|
+
class OrderPlatformValidator {
|
|
295
|
+
/** @returns {AttachOrderUserParam} */
|
|
5
296
|
static attachOrderUser() {
|
|
6
297
|
return Joi.object({
|
|
7
|
-
body:
|
|
298
|
+
body: OrderPlatformModel.AttachOrderUser().required(),
|
|
8
299
|
}).required();
|
|
9
300
|
}
|
|
10
301
|
|
|
302
|
+
/** @returns {CheckOrderStatusParam} */
|
|
11
303
|
static checkOrderStatus() {
|
|
12
304
|
return Joi.object({
|
|
13
|
-
body:
|
|
305
|
+
body: OrderPlatformModel.OrderStatus().required(),
|
|
14
306
|
}).required();
|
|
15
307
|
}
|
|
16
308
|
|
|
309
|
+
/** @returns {Click2CallParam} */
|
|
17
310
|
static click2Call() {
|
|
18
311
|
return Joi.object({
|
|
19
312
|
caller: Joi.string().allow("").required(),
|
|
@@ -24,42 +317,49 @@ class OrderValidator {
|
|
|
24
317
|
}).required();
|
|
25
318
|
}
|
|
26
319
|
|
|
320
|
+
/** @returns {CreateChannelConfigParam} */
|
|
27
321
|
static createChannelConfig() {
|
|
28
322
|
return Joi.object({
|
|
29
|
-
body:
|
|
323
|
+
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
30
324
|
}).required();
|
|
31
325
|
}
|
|
32
326
|
|
|
327
|
+
/** @returns {CreateOrderParam} */
|
|
33
328
|
static createOrder() {
|
|
34
329
|
return Joi.object({
|
|
35
|
-
body:
|
|
330
|
+
body: OrderPlatformModel.CreateOrderAPI().required(),
|
|
36
331
|
}).required();
|
|
37
332
|
}
|
|
38
333
|
|
|
334
|
+
/** @returns {DispatchManifestParam} */
|
|
39
335
|
static dispatchManifest() {
|
|
40
336
|
return Joi.object({
|
|
41
|
-
body:
|
|
337
|
+
body: OrderPlatformModel.DispatchManifest().required(),
|
|
42
338
|
}).required();
|
|
43
339
|
}
|
|
44
340
|
|
|
341
|
+
/** @returns {DownloadBulkActionTemplateParam} */
|
|
45
342
|
static downloadBulkActionTemplate() {
|
|
46
343
|
return Joi.object({
|
|
47
344
|
templateSlug: Joi.string().allow(""),
|
|
48
345
|
}).required();
|
|
49
346
|
}
|
|
50
347
|
|
|
348
|
+
/** @returns {FetchCreditBalanceDetailParam} */
|
|
51
349
|
static fetchCreditBalanceDetail() {
|
|
52
350
|
return Joi.object({
|
|
53
|
-
body:
|
|
351
|
+
body: OrderPlatformModel.FetchCreditBalanceRequestPayload().required(),
|
|
54
352
|
}).required();
|
|
55
353
|
}
|
|
56
354
|
|
|
355
|
+
/** @returns {FetchRefundModeConfigParam} */
|
|
57
356
|
static fetchRefundModeConfig() {
|
|
58
357
|
return Joi.object({
|
|
59
|
-
body:
|
|
358
|
+
body: OrderPlatformModel.RefundModeConfigRequestPayload().required(),
|
|
60
359
|
}).required();
|
|
61
360
|
}
|
|
62
361
|
|
|
362
|
+
/** @returns {GeneratePOSReceiptByOrderIdParam} */
|
|
63
363
|
static generatePOSReceiptByOrderId() {
|
|
64
364
|
return Joi.object({
|
|
65
365
|
orderId: Joi.string().allow("").required(),
|
|
@@ -68,12 +368,14 @@ class OrderValidator {
|
|
|
68
368
|
}).required();
|
|
69
369
|
}
|
|
70
370
|
|
|
371
|
+
/** @returns {GetAnnouncementsParam} */
|
|
71
372
|
static getAnnouncements() {
|
|
72
373
|
return Joi.object({
|
|
73
374
|
date: Joi.string().allow(""),
|
|
74
375
|
}).required();
|
|
75
376
|
}
|
|
76
377
|
|
|
378
|
+
/** @returns {GetBagByIdParam} */
|
|
77
379
|
static getBagById() {
|
|
78
380
|
return Joi.object({
|
|
79
381
|
bagId: Joi.string().allow(""),
|
|
@@ -82,6 +384,7 @@ class OrderValidator {
|
|
|
82
384
|
}).required();
|
|
83
385
|
}
|
|
84
386
|
|
|
387
|
+
/** @returns {GetBagsParam} */
|
|
85
388
|
static getBags() {
|
|
86
389
|
return Joi.object({
|
|
87
390
|
bagIds: Joi.string().allow(""),
|
|
@@ -96,10 +399,12 @@ class OrderValidator {
|
|
|
96
399
|
}).required();
|
|
97
400
|
}
|
|
98
401
|
|
|
402
|
+
/** @returns {GetBulkActionTemplateParam} */
|
|
99
403
|
static getBulkActionTemplate() {
|
|
100
404
|
return Joi.object({}).required();
|
|
101
405
|
}
|
|
102
406
|
|
|
407
|
+
/** @returns {GetBulkShipmentExcelFileParam} */
|
|
103
408
|
static getBulkShipmentExcelFile() {
|
|
104
409
|
return Joi.object({
|
|
105
410
|
salesChannels: Joi.string().allow(""),
|
|
@@ -117,10 +422,12 @@ class OrderValidator {
|
|
|
117
422
|
}).required();
|
|
118
423
|
}
|
|
119
424
|
|
|
425
|
+
/** @returns {GetChannelConfigParam} */
|
|
120
426
|
static getChannelConfig() {
|
|
121
427
|
return Joi.object({}).required();
|
|
122
428
|
}
|
|
123
429
|
|
|
430
|
+
/** @returns {GetLaneConfigParam} */
|
|
124
431
|
static getLaneConfig() {
|
|
125
432
|
return Joi.object({
|
|
126
433
|
superLane: Joi.string().allow(""),
|
|
@@ -141,12 +448,14 @@ class OrderValidator {
|
|
|
141
448
|
}).required();
|
|
142
449
|
}
|
|
143
450
|
|
|
451
|
+
/** @returns {GetOrderByIdParam} */
|
|
144
452
|
static getOrderById() {
|
|
145
453
|
return Joi.object({
|
|
146
454
|
orderId: Joi.string().allow("").required(),
|
|
147
455
|
}).required();
|
|
148
456
|
}
|
|
149
457
|
|
|
458
|
+
/** @returns {GetOrdersParam} */
|
|
150
459
|
static getOrders() {
|
|
151
460
|
return Joi.object({
|
|
152
461
|
lane: Joi.string().allow(""),
|
|
@@ -169,10 +478,12 @@ class OrderValidator {
|
|
|
169
478
|
}).required();
|
|
170
479
|
}
|
|
171
480
|
|
|
481
|
+
/** @returns {GetRoleBasedActionsParam} */
|
|
172
482
|
static getRoleBasedActions() {
|
|
173
483
|
return Joi.object({}).required();
|
|
174
484
|
}
|
|
175
485
|
|
|
486
|
+
/** @returns {GetShipmentByIdParam} */
|
|
176
487
|
static getShipmentById() {
|
|
177
488
|
return Joi.object({
|
|
178
489
|
channelShipmentId: Joi.string().allow(""),
|
|
@@ -180,6 +491,7 @@ class OrderValidator {
|
|
|
180
491
|
}).required();
|
|
181
492
|
}
|
|
182
493
|
|
|
494
|
+
/** @returns {GetShipmentHistoryParam} */
|
|
183
495
|
static getShipmentHistory() {
|
|
184
496
|
return Joi.object({
|
|
185
497
|
shipmentId: Joi.string().allow(""),
|
|
@@ -187,6 +499,7 @@ class OrderValidator {
|
|
|
187
499
|
}).required();
|
|
188
500
|
}
|
|
189
501
|
|
|
502
|
+
/** @returns {GetShipmentReasonsParam} */
|
|
190
503
|
static getShipmentReasons() {
|
|
191
504
|
return Joi.object({
|
|
192
505
|
shipmentId: Joi.string().allow("").required(),
|
|
@@ -195,6 +508,7 @@ class OrderValidator {
|
|
|
195
508
|
}).required();
|
|
196
509
|
}
|
|
197
510
|
|
|
511
|
+
/** @returns {GetShipmentsParam} */
|
|
198
512
|
static getShipments() {
|
|
199
513
|
return Joi.object({
|
|
200
514
|
lane: Joi.string().allow(""),
|
|
@@ -224,10 +538,12 @@ class OrderValidator {
|
|
|
224
538
|
}).required();
|
|
225
539
|
}
|
|
226
540
|
|
|
541
|
+
/** @returns {GetStateTransitionMapParam} */
|
|
227
542
|
static getStateTransitionMap() {
|
|
228
543
|
return Joi.object({}).required();
|
|
229
544
|
}
|
|
230
545
|
|
|
546
|
+
/** @returns {GetfiltersParam} */
|
|
231
547
|
static getfilters() {
|
|
232
548
|
return Joi.object({
|
|
233
549
|
view: Joi.string().allow("").required(),
|
|
@@ -235,48 +551,56 @@ class OrderValidator {
|
|
|
235
551
|
}).required();
|
|
236
552
|
}
|
|
237
553
|
|
|
554
|
+
/** @returns {InvalidateShipmentCacheParam} */
|
|
238
555
|
static invalidateShipmentCache() {
|
|
239
556
|
return Joi.object({
|
|
240
|
-
body:
|
|
557
|
+
body: OrderPlatformModel.InvalidateShipmentCachePayload().required(),
|
|
241
558
|
}).required();
|
|
242
559
|
}
|
|
243
560
|
|
|
561
|
+
/** @returns {OrderUpdateParam} */
|
|
244
562
|
static orderUpdate() {
|
|
245
563
|
return Joi.object({
|
|
246
|
-
body:
|
|
564
|
+
body: OrderPlatformModel.PlatformOrderUpdate().required(),
|
|
247
565
|
}).required();
|
|
248
566
|
}
|
|
249
567
|
|
|
568
|
+
/** @returns {PostShipmentHistoryParam} */
|
|
250
569
|
static postShipmentHistory() {
|
|
251
570
|
return Joi.object({
|
|
252
|
-
body:
|
|
571
|
+
body: OrderPlatformModel.PostShipmentHistory().required(),
|
|
253
572
|
}).required();
|
|
254
573
|
}
|
|
255
574
|
|
|
575
|
+
/** @returns {ProcessManifestParam} */
|
|
256
576
|
static processManifest() {
|
|
257
577
|
return Joi.object({
|
|
258
|
-
body:
|
|
578
|
+
body: OrderPlatformModel.CreateOrderPayload().required(),
|
|
259
579
|
}).required();
|
|
260
580
|
}
|
|
261
581
|
|
|
582
|
+
/** @returns {ReassignLocationParam} */
|
|
262
583
|
static reassignLocation() {
|
|
263
584
|
return Joi.object({
|
|
264
|
-
body:
|
|
585
|
+
body: OrderPlatformModel.StoreReassign().required(),
|
|
265
586
|
}).required();
|
|
266
587
|
}
|
|
267
588
|
|
|
589
|
+
/** @returns {SendSmsNinjaParam} */
|
|
268
590
|
static sendSmsNinja() {
|
|
269
591
|
return Joi.object({
|
|
270
|
-
body:
|
|
592
|
+
body: OrderPlatformModel.SendSmsPayload().required(),
|
|
271
593
|
}).required();
|
|
272
594
|
}
|
|
273
595
|
|
|
596
|
+
/** @returns {SendUserMobileOTPParam} */
|
|
274
597
|
static sendUserMobileOTP() {
|
|
275
598
|
return Joi.object({
|
|
276
|
-
body:
|
|
599
|
+
body: OrderPlatformModel.SendUserMobileOTP().required(),
|
|
277
600
|
}).required();
|
|
278
601
|
}
|
|
279
602
|
|
|
603
|
+
/** @returns {UpdateAddressParam} */
|
|
280
604
|
static updateAddress() {
|
|
281
605
|
return Joi.object({
|
|
282
606
|
shipmentId: Joi.string().allow("").required(),
|
|
@@ -294,35 +618,40 @@ class OrderValidator {
|
|
|
294
618
|
}).required();
|
|
295
619
|
}
|
|
296
620
|
|
|
621
|
+
/** @returns {UpdatePackagingDimensionsParam} */
|
|
297
622
|
static updatePackagingDimensions() {
|
|
298
623
|
return Joi.object({
|
|
299
|
-
body:
|
|
624
|
+
body: OrderPlatformModel.UpdatePackagingDimensionsPayload().required(),
|
|
300
625
|
}).required();
|
|
301
626
|
}
|
|
302
627
|
|
|
628
|
+
/** @returns {UpdateShipmentLockParam} */
|
|
303
629
|
static updateShipmentLock() {
|
|
304
630
|
return Joi.object({
|
|
305
|
-
body:
|
|
631
|
+
body: OrderPlatformModel.UpdateShipmentLockPayload().required(),
|
|
306
632
|
}).required();
|
|
307
633
|
}
|
|
308
634
|
|
|
635
|
+
/** @returns {UpdateShipmentStatusParam} */
|
|
309
636
|
static updateShipmentStatus() {
|
|
310
637
|
return Joi.object({
|
|
311
|
-
body:
|
|
638
|
+
body: OrderPlatformModel.UpdateShipmentStatusRequest().required(),
|
|
312
639
|
}).required();
|
|
313
640
|
}
|
|
314
641
|
|
|
642
|
+
/** @returns {UploadConsentParam} */
|
|
315
643
|
static uploadConsent() {
|
|
316
644
|
return Joi.object({
|
|
317
|
-
body:
|
|
645
|
+
body: OrderPlatformModel.UploadConsent().required(),
|
|
318
646
|
}).required();
|
|
319
647
|
}
|
|
320
648
|
|
|
649
|
+
/** @returns {VerifyMobileOTPParam} */
|
|
321
650
|
static verifyMobileOTP() {
|
|
322
651
|
return Joi.object({
|
|
323
|
-
body:
|
|
652
|
+
body: OrderPlatformModel.VerifyMobileOTP().required(),
|
|
324
653
|
}).required();
|
|
325
654
|
}
|
|
326
655
|
}
|
|
327
656
|
|
|
328
|
-
module.exports =
|
|
657
|
+
module.exports = OrderPlatformValidator;
|
|
@@ -4,51 +4,43 @@ declare class Partner {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {
|
|
8
|
-
* @param {
|
|
9
|
-
*
|
|
10
|
-
* @
|
|
11
|
-
* @returns {Promise<AddProxyResponse>} - Success response
|
|
7
|
+
* @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
|
|
8
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
10
|
+
* @name addProxyPath
|
|
12
11
|
* @summary: Create proxy URL for the external URL
|
|
13
|
-
* @description: Use this API to generate proxy URL for the external URL
|
|
12
|
+
* @description: Use this API to generate proxy URL for the external URL - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
|
|
14
13
|
*/
|
|
15
|
-
addProxyPath({ extensionId, body }?: {
|
|
16
|
-
extensionId: string;
|
|
17
|
-
body: AddProxyReq;
|
|
18
|
-
}): Promise<AddProxyResponse>;
|
|
14
|
+
addProxyPath({ extensionId, body }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.AddProxyResponse>;
|
|
19
15
|
/**
|
|
20
|
-
* @param {
|
|
21
|
-
* @param {
|
|
22
|
-
* @returns {Promise<getProxyPathRes>} - Success response
|
|
16
|
+
* @param {PartnerPlatformApplicationValidator.GetProxyPathParam} arg - Arg object
|
|
17
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
18
|
+
* @returns {Promise<PartnerPlatformModel.getProxyPathRes>} - Success response
|
|
19
|
+
* @name getProxyPath
|
|
23
20
|
* @summary: Proxy
|
|
24
|
-
* @description: Use this API to get proxy url
|
|
21
|
+
* @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPath/).
|
|
25
22
|
*/
|
|
26
|
-
getProxyPath({ extensionId }?: {
|
|
27
|
-
extensionId?: string;
|
|
28
|
-
}): Promise<getProxyPathRes>;
|
|
23
|
+
getProxyPath({ extensionId }?: PartnerPlatformApplicationValidator.GetProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.getProxyPathRes>;
|
|
29
24
|
/**
|
|
30
|
-
* @param {
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* @
|
|
25
|
+
* @param {PartnerPlatformApplicationValidator.GetProxyPathAttachedPathParam} arg
|
|
26
|
+
* - Arg object
|
|
27
|
+
*
|
|
28
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
+
* @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
|
|
30
|
+
* @name getProxyPathAttachedPath
|
|
34
31
|
* @summary: Proxy
|
|
35
|
-
* @description: Use this API to get proxy url
|
|
32
|
+
* @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPathAttachedPath/).
|
|
36
33
|
*/
|
|
37
|
-
getProxyPathAttachedPath({ extensionId, attachedPath }?: {
|
|
38
|
-
extensionId?: string;
|
|
39
|
-
attachedPath?: string;
|
|
40
|
-
}): Promise<AddProxyResponse>;
|
|
34
|
+
getProxyPathAttachedPath({ extensionId, attachedPath }?: PartnerPlatformApplicationValidator.GetProxyPathAttachedPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.AddProxyResponse>;
|
|
41
35
|
/**
|
|
42
|
-
* @param {
|
|
43
|
-
* @param {
|
|
44
|
-
*
|
|
45
|
-
* @
|
|
46
|
-
* @returns {Promise<RemoveProxyResponse>} - Success response
|
|
36
|
+
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
37
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
38
|
+
* @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
|
|
39
|
+
* @name removeProxyPath
|
|
47
40
|
* @summary: Remove proxy URL for the external URL
|
|
48
|
-
* @description: Use this API to remove the proxy URL which is already generated for the external URL
|
|
41
|
+
* @description: Use this API to remove the proxy URL which is already generated for the external URL - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
|
|
49
42
|
*/
|
|
50
|
-
removeProxyPath({ extensionId, attachedPath }?: {
|
|
51
|
-
extensionId: string;
|
|
52
|
-
attachedPath: string;
|
|
53
|
-
}): Promise<RemoveProxyResponse>;
|
|
43
|
+
removeProxyPath({ extensionId, attachedPath }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { headers }?: import("../PlatformAPIClient").Options): Promise<PartnerPlatformModel.RemoveProxyResponse>;
|
|
54
44
|
}
|
|
45
|
+
import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
46
|
+
import PartnerPlatformModel = require("./PartnerPlatformModel");
|