@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +111 -1200
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
- package/sdk/application/Content/ContentApplicationClient.js +46 -990
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- 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 +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5067 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1988 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- 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 +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1893 -623
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +924 -568
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- 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 +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -35,6 +35,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
35
35
|
* @property {OrderPlatformModel.OrderStatus} body
|
|
36
36
|
*/
|
|
37
37
|
|
|
38
|
+
/**
|
|
39
|
+
* @typedef CreateChannelConfigParam
|
|
40
|
+
* @property {OrderPlatformModel.CreateChannelConfigData} body
|
|
41
|
+
*/
|
|
42
|
+
|
|
38
43
|
/**
|
|
39
44
|
* @typedef CreateOrderParam
|
|
40
45
|
* @property {OrderPlatformModel.CreateOrderAPI} body
|
|
@@ -52,7 +57,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
52
57
|
|
|
53
58
|
/**
|
|
54
59
|
* @typedef DownloadLanesReportParam
|
|
55
|
-
* @property {OrderPlatformModel.
|
|
60
|
+
* @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
|
|
56
61
|
*/
|
|
57
62
|
|
|
58
63
|
/**
|
|
@@ -85,7 +90,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
85
90
|
|
|
86
91
|
/**
|
|
87
92
|
* @typedef GenerateProcessManifestParam
|
|
88
|
-
* @property {OrderPlatformModel.
|
|
93
|
+
* @property {OrderPlatformModel.ProcessManifestRequestSchema} body
|
|
89
94
|
*/
|
|
90
95
|
|
|
91
96
|
/**
|
|
@@ -104,7 +109,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
104
109
|
|
|
105
110
|
/**
|
|
106
111
|
* @typedef GetBagByIdParam
|
|
107
|
-
* @property {string} [bagId] -
|
|
112
|
+
* @property {string} [bagId] - Unique identifier of a bag
|
|
108
113
|
* @property {string} [channelBagId] - Id of application bag
|
|
109
114
|
* @property {string} [channelId] - Id of application
|
|
110
115
|
*/
|
|
@@ -128,8 +133,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
128
133
|
* @typedef GetBulkShipmentExcelFileParam
|
|
129
134
|
* @property {string} [salesChannels] - Comma separated values of sales channel ids
|
|
130
135
|
* @property {string} [dpIds] - Comma separated values of delivery partner ids
|
|
131
|
-
* @property {string} [startDate] - UTC
|
|
132
|
-
* @property {string} [endDate] - UTC
|
|
136
|
+
* @property {string} [startDate] - Date time in UTC timezone as per ISO format.
|
|
137
|
+
* @property {string} [endDate] - Date time in UTC timezone as per ISO format.
|
|
133
138
|
* @property {string} [stores] - Comma separated values of store ids
|
|
134
139
|
* @property {string} [tags] - Comma separated values of tags
|
|
135
140
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
@@ -140,11 +145,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
140
145
|
* @property {number} [pageSize]
|
|
141
146
|
*/
|
|
142
147
|
|
|
148
|
+
/** @typedef GetChannelConfigParam */
|
|
149
|
+
|
|
143
150
|
/**
|
|
144
151
|
* @typedef GetFileByStatusParam
|
|
145
152
|
* @property {string} batchId - Batch Id to identify the bulk operation request.
|
|
146
153
|
* @property {string} status - The status of the jobs to filter the results.
|
|
147
|
-
* @property {string} fileType
|
|
154
|
+
* @property {string} fileType
|
|
148
155
|
* @property {string} [reportType] - The type of report to be downloaded.
|
|
149
156
|
*/
|
|
150
157
|
|
|
@@ -161,15 +168,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
161
168
|
* @property {string} [salesChannels]
|
|
162
169
|
* @property {string} [paymentMode] - Comma separated values of payment modes
|
|
163
170
|
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
164
|
-
* @property {string} [searchType]
|
|
171
|
+
* @property {string} [searchType] - Search_type refers to the field that will
|
|
172
|
+
* be used as the target for the search operation
|
|
165
173
|
* @property {string} [searchValue]
|
|
166
174
|
* @property {string} [tags]
|
|
167
|
-
* @property {number} [timeToDispatch]
|
|
175
|
+
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
168
176
|
* @property {string} [paymentMethods]
|
|
169
177
|
* @property {boolean} [myOrders]
|
|
170
178
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
171
179
|
* company order
|
|
172
|
-
* @property {string} [orderType]
|
|
180
|
+
* @property {string} [orderType] - Defines the specific journey a shipment will
|
|
181
|
+
* follow based on the application's operational needs and customer
|
|
182
|
+
* preferences. This field categorizes orders into distinct types, each
|
|
183
|
+
* associated with a unique processing flow. For example:
|
|
184
|
+
*
|
|
185
|
+
* - "HomeDelivery": The order goes through all the steps needed for delivery,
|
|
186
|
+
* from being packed to arriving at the customer’s address.
|
|
187
|
+
* - "PickAtStore": The order is prepared for pickup at the store, skipping
|
|
188
|
+
* shipping steps to make it ready faster for the customer to collect in person.
|
|
189
|
+
* - "Digital": This order type likely refers to orders that involve digital goods
|
|
190
|
+
* or services, such as software, digital subscriptions, e-books, online
|
|
191
|
+
* courses, or any other item that can be delivered electronically.
|
|
173
192
|
*/
|
|
174
193
|
|
|
175
194
|
/**
|
|
@@ -232,35 +251,44 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
232
251
|
/**
|
|
233
252
|
* @typedef GetOrdersParam
|
|
234
253
|
* @property {string} [lane] - Lane refers to a section where orders are
|
|
235
|
-
* assigned, indicating its grouping
|
|
254
|
+
* assigned, indicating its grouping.
|
|
236
255
|
* @property {string} [searchType] - Search_type refers to the field that will
|
|
237
|
-
* be used as the target for the search operation
|
|
256
|
+
* be used as the target for the search operation.
|
|
238
257
|
* @property {string} [bagStatus] - Bag_status refers to status of the entity.
|
|
239
258
|
* Filters orders based on the status.
|
|
240
259
|
* @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
|
|
241
|
-
* @property {string} [paymentMethods]
|
|
260
|
+
* @property {string} [paymentMethods] - Comma separated values of payment
|
|
261
|
+
* methods that were used to place order.
|
|
242
262
|
* @property {string} [tags] - Tags refers to additional descriptive labels
|
|
243
263
|
* associated with the order
|
|
244
264
|
* @property {string} [searchValue] - Search_value is matched against the field
|
|
245
265
|
* specified by the search_type
|
|
246
|
-
* @property {string} [fromDate]
|
|
247
|
-
* @property {string} [toDate]
|
|
248
|
-
* @property {string} [startDate]
|
|
249
|
-
* @property {string} [endDate]
|
|
266
|
+
* @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
|
|
267
|
+
* @property {string} [toDate] - Date time in UTC timezone as per ISO format.
|
|
268
|
+
* @property {string} [startDate] - Date time in UTC timezone as per ISO format.
|
|
269
|
+
* @property {string} [endDate] - Date time in UTC timezone as per ISO format.
|
|
250
270
|
* @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
251
|
-
* @property {string} [stores]
|
|
252
|
-
*
|
|
253
|
-
* @property {
|
|
254
|
-
*
|
|
271
|
+
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
272
|
+
* filter results to only those related to specific stores.
|
|
273
|
+
* @property {string} [salesChannels] - A comma-separated list of sales channel
|
|
274
|
+
* IDs to filter results based on the sales channels involved.
|
|
275
|
+
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
276
|
+
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
255
277
|
* @property {boolean} [isPrioritySort]
|
|
256
278
|
* @property {string} [customMeta]
|
|
257
279
|
* @property {boolean} [myOrders]
|
|
258
280
|
* @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
|
|
259
281
|
* company order
|
|
260
|
-
* @property {string} [customerId]
|
|
282
|
+
* @property {string} [customerId] - The unique identifier for the customer
|
|
283
|
+
* associated with the query, useful for filtering results to a specific customer.
|
|
261
284
|
* @property {string} [orderType]
|
|
262
285
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
263
286
|
* shipments are allowed
|
|
287
|
+
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
288
|
+
* retrieving shipments or orders. It specifies whether the results should be
|
|
289
|
+
* organized based on shipment groups or order groups. For example, using
|
|
290
|
+
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
291
|
+
* may not be recognized, leading to errors or default behavior.
|
|
264
292
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
265
293
|
* orders. This is useful when fetching data for a specific date range while
|
|
266
294
|
* performing searches.
|
|
@@ -270,8 +298,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
270
298
|
|
|
271
299
|
/**
|
|
272
300
|
* @typedef GetShipmentByIdParam
|
|
273
|
-
* @property {string} [channelShipmentId] -
|
|
274
|
-
*
|
|
301
|
+
* @property {string} [channelShipmentId] - The shipment ID used in the
|
|
302
|
+
* application, which can be used to reference specific shipments.
|
|
303
|
+
* @property {string} [shipmentId] - The unique identifier for a shipment.
|
|
275
304
|
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
276
305
|
* deactivated shipments
|
|
277
306
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
@@ -297,38 +326,61 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
297
326
|
/**
|
|
298
327
|
* @typedef GetShipmentsParam
|
|
299
328
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
300
|
-
* @property {string} [bagStatus] - Comma separated values of bag statuses
|
|
329
|
+
* @property {string} [bagStatus] - Comma separated values of bag statuses.
|
|
301
330
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
302
|
-
* bag_status and override lane
|
|
303
|
-
* @property {number} [timeToDispatch]
|
|
304
|
-
* @property {string} [searchType] -
|
|
305
|
-
*
|
|
331
|
+
* bag_status and override lane.
|
|
332
|
+
* @property {number} [timeToDispatch] - Indicates the time to dispatch.
|
|
333
|
+
* @property {string} [searchType] - Specifies the key used to determine the
|
|
334
|
+
* type of search being performed.
|
|
335
|
+
* @property {string} [searchValue] - The value corresponding to the search
|
|
336
|
+
* type, such as a specific shipment ID or order ID.
|
|
306
337
|
* @property {string} [fromDate] - Start Date in DD-MM-YYYY format
|
|
307
338
|
* @property {string} [toDate] - End Date in DD-MM-YYYY format
|
|
308
|
-
* @property {string} [startDate] - UTC
|
|
309
|
-
*
|
|
310
|
-
* @property {string} [
|
|
311
|
-
*
|
|
312
|
-
* @property {string} [
|
|
313
|
-
*
|
|
314
|
-
* @property {
|
|
315
|
-
*
|
|
316
|
-
* @property {
|
|
317
|
-
*
|
|
318
|
-
* @property {
|
|
319
|
-
* @property {
|
|
320
|
-
* @property {
|
|
321
|
-
*
|
|
322
|
-
* @property {
|
|
323
|
-
*
|
|
324
|
-
* @property {boolean} [
|
|
325
|
-
*
|
|
326
|
-
* @property {string} [
|
|
327
|
-
* @property {
|
|
328
|
-
*
|
|
329
|
-
* @property {string} [
|
|
330
|
-
* @property {string} [
|
|
331
|
-
*
|
|
339
|
+
* @property {string} [startDate] - The UTC start date in ISO format
|
|
340
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
341
|
+
* @property {string} [endDate] - The UTC end date in ISO format
|
|
342
|
+
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
343
|
+
* @property {string} [dpIds] - A comma-separated list of delivery partner IDs
|
|
344
|
+
* to filter results by specific delivery partners.
|
|
345
|
+
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
346
|
+
* filter results to only those related to specific stores.
|
|
347
|
+
* @property {string} [salesChannels] - A comma-separated list of sales channel
|
|
348
|
+
* IDs to filter results based on the sales channels involved.
|
|
349
|
+
* @property {number} [pageNo] - Specifies the page number for paginated results.
|
|
350
|
+
* @property {number} [pageSize] - Determines the number of results returned per page.
|
|
351
|
+
* @property {boolean} [fetchActiveShipment] - A boolean flag that indicates
|
|
352
|
+
* whether to include only active shipments in the results.
|
|
353
|
+
* @property {boolean} [allowInactive] - A flag indicating whether to allow the
|
|
354
|
+
* inclusion of inactive shipments in the results.
|
|
355
|
+
* @property {boolean} [excludeLockedShipments] - A flag to specify whether to
|
|
356
|
+
* exclude shipments that are locked from the results.
|
|
357
|
+
* @property {string} [paymentMethods] - A comma-separated list of payment methods.
|
|
358
|
+
* @property {string} [channelShipmentId] - The shipment ID used in the
|
|
359
|
+
* application, which can be used to reference specific shipments.
|
|
360
|
+
* @property {string} [channelOrderId] - The order ID used in the application.
|
|
361
|
+
* @property {string} [customMeta] - Custom metadata associated with the query,
|
|
362
|
+
* allowing for additional filtering or information to be passed.
|
|
363
|
+
* @property {string} [orderingChannel] - The channel through which the order was placed.
|
|
364
|
+
* @property {string} [companyAffiliateTag] - A tag used to identify the
|
|
365
|
+
* company's affiliation for filtering or reporting purposes.
|
|
366
|
+
* @property {boolean} [myOrders] - A boolean flag indicating whether the query
|
|
367
|
+
* should return only the user's orders.
|
|
368
|
+
* @property {string} [platformUserId] - The unique identifier of the user on
|
|
369
|
+
* the platform, useful for filtering orders related to a specific user.
|
|
370
|
+
* @property {string} [sortType] - Determines the sorting order of the results
|
|
371
|
+
* based on specific criteria.
|
|
372
|
+
* @property {boolean} [showCrossCompanyData] - A flag indicating whether to
|
|
373
|
+
* include data from both cross-company and non-cross-company orders in the results.
|
|
374
|
+
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
375
|
+
* the orders to filter results based on specific characteristics.
|
|
376
|
+
* @property {string} [customerId] - The unique identifier for the customer
|
|
377
|
+
* associated with the query, useful for filtering results to a specific customer.
|
|
378
|
+
* @property {string} [orderType] - The type of order being queried.
|
|
379
|
+
* @property {string} [groupEntity] - Defines the grouping criterion for
|
|
380
|
+
* retrieving shipments or orders. It specifies whether the results should be
|
|
381
|
+
* organized based on shipment groups or order groups. For example, using
|
|
382
|
+
* 'shipments' groups results by shipment, while an invalid value like 'abcd'
|
|
383
|
+
* may not be recognized, leading to errors or default behavior.
|
|
332
384
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
333
385
|
* shipments. This is useful when fetching data for a specific date range
|
|
334
386
|
* while performing searches.
|
|
@@ -400,18 +452,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
400
452
|
|
|
401
453
|
/**
|
|
402
454
|
* @typedef UpdateAddressParam
|
|
403
|
-
* @property {string} shipmentId
|
|
404
|
-
* @property {
|
|
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]
|
|
455
|
+
* @property {string} shipmentId - Unique shipment no. that is auto-generated
|
|
456
|
+
* @property {OrderPlatformModel.UpdateAddressRequestBody} body
|
|
415
457
|
*/
|
|
416
458
|
|
|
417
459
|
/**
|
|
@@ -419,6 +461,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
419
461
|
* @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
|
|
420
462
|
*/
|
|
421
463
|
|
|
464
|
+
/**
|
|
465
|
+
* @typedef UpdatePaymentInfoParam
|
|
466
|
+
* @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
|
|
467
|
+
*/
|
|
468
|
+
|
|
422
469
|
/**
|
|
423
470
|
* @typedef UpdateShipmentLockParam
|
|
424
471
|
* @property {OrderPlatformModel.UpdateShipmentLockPayload} body
|
|
@@ -486,6 +533,13 @@ class OrderPlatformValidator {
|
|
|
486
533
|
}).required();
|
|
487
534
|
}
|
|
488
535
|
|
|
536
|
+
/** @returns {CreateChannelConfigParam} */
|
|
537
|
+
static createChannelConfig() {
|
|
538
|
+
return Joi.object({
|
|
539
|
+
body: OrderPlatformModel.CreateChannelConfigData().required(),
|
|
540
|
+
}).required();
|
|
541
|
+
}
|
|
542
|
+
|
|
489
543
|
/** @returns {CreateOrderParam} */
|
|
490
544
|
static createOrder() {
|
|
491
545
|
return Joi.object({
|
|
@@ -510,7 +564,7 @@ class OrderPlatformValidator {
|
|
|
510
564
|
/** @returns {DownloadLanesReportParam} */
|
|
511
565
|
static downloadLanesReport() {
|
|
512
566
|
return Joi.object({
|
|
513
|
-
body: OrderPlatformModel.
|
|
567
|
+
body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
|
|
514
568
|
}).required();
|
|
515
569
|
}
|
|
516
570
|
|
|
@@ -555,7 +609,7 @@ class OrderPlatformValidator {
|
|
|
555
609
|
/** @returns {GenerateProcessManifestParam} */
|
|
556
610
|
static generateProcessManifest() {
|
|
557
611
|
return Joi.object({
|
|
558
|
-
body: OrderPlatformModel.
|
|
612
|
+
body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
|
|
559
613
|
}).required();
|
|
560
614
|
}
|
|
561
615
|
|
|
@@ -626,6 +680,11 @@ class OrderPlatformValidator {
|
|
|
626
680
|
}).required();
|
|
627
681
|
}
|
|
628
682
|
|
|
683
|
+
/** @returns {GetChannelConfigParam} */
|
|
684
|
+
static getChannelConfig() {
|
|
685
|
+
return Joi.object({}).required();
|
|
686
|
+
}
|
|
687
|
+
|
|
629
688
|
/** @returns {GetFileByStatusParam} */
|
|
630
689
|
static getFileByStatus() {
|
|
631
690
|
return Joi.object({
|
|
@@ -746,6 +805,7 @@ class OrderPlatformValidator {
|
|
|
746
805
|
customerId: Joi.string().allow(""),
|
|
747
806
|
orderType: Joi.string().allow(""),
|
|
748
807
|
allowInactive: Joi.boolean(),
|
|
808
|
+
groupEntity: Joi.string().allow(""),
|
|
749
809
|
enforceDateFilter: Joi.boolean(),
|
|
750
810
|
}).required();
|
|
751
811
|
}
|
|
@@ -816,6 +876,7 @@ class OrderPlatformValidator {
|
|
|
816
876
|
tags: Joi.string().allow(""),
|
|
817
877
|
customerId: Joi.string().allow(""),
|
|
818
878
|
orderType: Joi.string().allow(""),
|
|
879
|
+
groupEntity: Joi.string().allow(""),
|
|
819
880
|
enforceDateFilter: Joi.boolean(),
|
|
820
881
|
}).required();
|
|
821
882
|
}
|
|
@@ -912,17 +973,7 @@ class OrderPlatformValidator {
|
|
|
912
973
|
static updateAddress() {
|
|
913
974
|
return Joi.object({
|
|
914
975
|
shipmentId: Joi.string().allow("").required(),
|
|
915
|
-
|
|
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(""),
|
|
976
|
+
body: OrderPlatformModel.UpdateAddressRequestBody().required(),
|
|
926
977
|
}).required();
|
|
927
978
|
}
|
|
928
979
|
|
|
@@ -933,6 +984,13 @@ class OrderPlatformValidator {
|
|
|
933
984
|
}).required();
|
|
934
985
|
}
|
|
935
986
|
|
|
987
|
+
/** @returns {UpdatePaymentInfoParam} */
|
|
988
|
+
static updatePaymentInfo() {
|
|
989
|
+
return Joi.object({
|
|
990
|
+
body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
|
|
991
|
+
}).required();
|
|
992
|
+
}
|
|
993
|
+
|
|
936
994
|
/** @returns {UpdateShipmentLockParam} */
|
|
937
995
|
static updateShipmentLock() {
|
|
938
996
|
return Joi.object({
|
|
@@ -7,22 +7,24 @@ 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.
|
|
10
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
|
|
11
|
+
* Success response
|
|
11
12
|
* @name addProxyPath
|
|
12
13
|
* @summary: Create extension proxy
|
|
13
14
|
* @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/).
|
|
14
15
|
*/
|
|
15
|
-
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
16
|
+
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
|
|
16
17
|
/**
|
|
17
18
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
18
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
21
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
|
|
22
|
+
* Success response
|
|
21
23
|
* @name removeProxyPath
|
|
22
24
|
* @summary: Remove extension proxy
|
|
23
25
|
* @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/).
|
|
24
26
|
*/
|
|
25
|
-
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.
|
|
27
|
+
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
|
|
26
28
|
}
|
|
27
29
|
import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
28
30
|
import PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
@@ -19,7 +19,8 @@ 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.
|
|
22
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
|
|
23
|
+
* Success response
|
|
23
24
|
* @name addProxyPath
|
|
24
25
|
* @summary: Create extension proxy
|
|
25
26
|
* @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/).
|
|
@@ -77,10 +78,10 @@ class Partner {
|
|
|
77
78
|
|
|
78
79
|
const {
|
|
79
80
|
error: res_error,
|
|
80
|
-
} = PartnerPlatformModel.
|
|
81
|
-
|
|
82
|
-
allowUnknown: true
|
|
83
|
-
|
|
81
|
+
} = PartnerPlatformModel.ExtensionProxyPathCreation().validate(
|
|
82
|
+
responseData,
|
|
83
|
+
{ abortEarly: false, allowUnknown: true }
|
|
84
|
+
);
|
|
84
85
|
|
|
85
86
|
if (res_error) {
|
|
86
87
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -100,7 +101,8 @@ class Partner {
|
|
|
100
101
|
* @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
|
|
101
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
102
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
-
* @returns {Promise<PartnerPlatformModel.
|
|
104
|
+
* @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
|
|
105
|
+
* Success response
|
|
104
106
|
* @name removeProxyPath
|
|
105
107
|
* @summary: Remove extension proxy
|
|
106
108
|
* @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/).
|
|
@@ -158,7 +160,7 @@ class Partner {
|
|
|
158
160
|
|
|
159
161
|
const {
|
|
160
162
|
error: res_error,
|
|
161
|
-
} = PartnerPlatformModel.
|
|
163
|
+
} = PartnerPlatformModel.ExtensionProxyPathDelete().validate(responseData, {
|
|
162
164
|
abortEarly: false,
|
|
163
165
|
allowUnknown: true,
|
|
164
166
|
});
|
|
@@ -6,7 +6,7 @@ export = PartnerPlatformModel;
|
|
|
6
6
|
* will be generated
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef ExtensionProxyPathCreation
|
|
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 ExtensionProxyPathDelete
|
|
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, ExtensionProxyPathCreation, ExtensionProxyPathDelete, 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 {ExtensionProxyPathCreation} */
|
|
51
|
+
declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
|
|
52
|
+
type ExtensionProxyPathCreation = {
|
|
53
53
|
_id?: string;
|
|
54
54
|
attached_path?: string;
|
|
55
55
|
proxy_url?: string;
|
|
@@ -59,9 +59,9 @@ type AddProxyResponse = {
|
|
|
59
59
|
created_at?: string;
|
|
60
60
|
modified_at?: string;
|
|
61
61
|
};
|
|
62
|
-
/** @returns {
|
|
63
|
-
declare function
|
|
64
|
-
type
|
|
62
|
+
/** @returns {ExtensionProxyPathDelete} */
|
|
63
|
+
declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
|
|
64
|
+
type ExtensionProxyPathDelete = {
|
|
65
65
|
message?: string;
|
|
66
66
|
data?: any;
|
|
67
67
|
};
|
|
@@ -8,7 +8,7 @@ const Joi = require("joi");
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
|
-
* @typedef
|
|
11
|
+
* @typedef ExtensionProxyPathCreation
|
|
12
12
|
* @property {string} [_id]
|
|
13
13
|
* @property {string} [attached_path]
|
|
14
14
|
* @property {string} [proxy_url]
|
|
@@ -20,7 +20,7 @@ const Joi = require("joi");
|
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* @typedef
|
|
23
|
+
* @typedef ExtensionProxyPathDelete
|
|
24
24
|
* @property {string} [message]
|
|
25
25
|
* @property {Object} [data]
|
|
26
26
|
*/
|
|
@@ -43,8 +43,8 @@ class PartnerPlatformModel {
|
|
|
43
43
|
});
|
|
44
44
|
}
|
|
45
45
|
|
|
46
|
-
/** @returns {
|
|
47
|
-
static
|
|
46
|
+
/** @returns {ExtensionProxyPathCreation} */
|
|
47
|
+
static ExtensionProxyPathCreation() {
|
|
48
48
|
return Joi.object({
|
|
49
49
|
_id: Joi.string().allow(""),
|
|
50
50
|
attached_path: Joi.string().allow(""),
|
|
@@ -57,11 +57,11 @@ class PartnerPlatformModel {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
|
|
60
|
-
/** @returns {
|
|
61
|
-
static
|
|
60
|
+
/** @returns {ExtensionProxyPathDelete} */
|
|
61
|
+
static ExtensionProxyPathDelete() {
|
|
62
62
|
return Joi.object({
|
|
63
63
|
message: Joi.string().allow(""),
|
|
64
|
-
data: Joi.any(),
|
|
64
|
+
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
65
65
|
});
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -72,7 +72,7 @@ class PartnerPlatformModel {
|
|
|
72
72
|
message: Joi.string().allow(""),
|
|
73
73
|
info: Joi.string().allow(""),
|
|
74
74
|
request_id: Joi.string().allow(""),
|
|
75
|
-
meta: Joi.any(),
|
|
75
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
76
76
|
});
|
|
77
77
|
}
|
|
78
78
|
}
|