@gofynd/fdk-client-javascript 1.0.2 → 1.0.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/documentation/application/CART.md +5934 -4502
- package/documentation/application/CATALOG.md +6338 -7245
- package/documentation/application/COMMON.md +95 -222
- package/documentation/application/COMMUNICATION.md +106 -186
- package/documentation/application/CONFIGURATION.md +903 -1597
- package/documentation/application/CONTENT.md +557 -1279
- package/documentation/application/FILESTORAGE.md +84 -220
- package/documentation/application/LEAD.md +314 -660
- package/documentation/application/LOGISTIC.md +229 -305
- package/documentation/application/ORDER.md +642 -1137
- package/documentation/application/PAYMENT.md +2285 -3031
- package/documentation/application/POSCART.md +6079 -4642
- package/documentation/application/REWARDS.md +94 -248
- package/documentation/application/SHARE.md +152 -250
- package/documentation/application/THEME.md +952 -1235
- package/documentation/application/USER.md +1228 -1765
- package/documentation/platform/ANALYTICS.md +207 -349
- package/documentation/platform/AUDITTRAIL.md +121 -204
- package/documentation/platform/BILLING.md +865 -1376
- package/documentation/platform/CART.md +2814 -3662
- package/documentation/platform/CATALOG.md +14453 -17192
- package/documentation/platform/COMMON.md +95 -222
- package/documentation/platform/COMMUNICATION.md +1632 -2380
- package/documentation/platform/COMPANYPROFILE.md +572 -957
- package/documentation/platform/CONFIGURATION.md +3050 -4073
- package/documentation/platform/CONTENT.md +3438 -4172
- package/documentation/platform/DISCOUNT.md +140 -236
- package/documentation/platform/FILESTORAGE.md +187 -323
- package/documentation/platform/INVENTORY.md +268 -911
- package/documentation/platform/LEAD.md +2195 -2541
- package/documentation/platform/ORDER.md +3400 -5361
- package/documentation/platform/PARTNER.md +9 -36
- package/documentation/platform/PAYMENT.md +903 -1213
- package/documentation/platform/REWARDS.md +183 -347
- package/documentation/platform/SHARE.md +120 -213
- package/documentation/platform/THEME.md +12956 -13239
- package/documentation/platform/USER.md +975 -1120
- package/documentation/platform/WEBHOOK.md +78 -184
- package/documentation/public/CONFIGURATION.md +95 -222
- package/documentation/public/INVENTORY.md +100 -282
- package/documentation/public/WEBHOOK.md +27 -133
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
- package/sdk/application/Cart/CartApplicationClient.js +567 -567
- package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
- package/sdk/application/Cart/CartApplicationModel.js +489 -886
- package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
- package/sdk/application/Cart/CartApplicationValidator.js +98 -98
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
- package/sdk/application/Catalog/CatalogApplicationClient.js +1036 -1036
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
- package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
- package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
- package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
- package/sdk/application/Common/CommonApplicationClient.js +38 -38
- package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
- package/sdk/application/Common/CommonApplicationModel.js +83 -160
- package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
- package/sdk/application/Common/CommonApplicationValidator.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
- package/sdk/application/Communication/CommunicationApplicationClient.js +26 -26
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +330 -330
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
- package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
- package/sdk/application/Content/ContentApplicationClient.js +191 -191
- package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
- package/sdk/application/Content/ContentApplicationModel.js +467 -884
- package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
- package/sdk/application/Content/ContentApplicationValidator.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +59 -59
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
- package/sdk/application/Lead/LeadApplicationClient.js +100 -100
- package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
- package/sdk/application/Lead/LeadApplicationModel.js +267 -474
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -43
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
- package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
- package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
- package/sdk/application/Order/OrderApplicationClient.js +232 -232
- package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
- package/sdk/application/Order/OrderApplicationModel.js +352 -656
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
- package/sdk/application/Order/OrderApplicationValidator.js +28 -28
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
- package/sdk/application/Payment/PaymentApplicationClient.js +739 -739
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
- package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
- package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
- package/sdk/application/PosCart/PosCartApplicationClient.js +617 -617
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
- package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
- package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.js +112 -112
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
- package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
- package/sdk/application/Share/ShareApplicationClient.js +84 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
- package/sdk/application/Share/ShareApplicationModel.js +63 -123
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationValidator.js +12 -12
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +31 -31
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
- package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +280 -280
- package/sdk/application/User/UserApplicationClient.js +581 -581
- package/sdk/application/User/UserApplicationModel.d.ts +79 -72
- package/sdk/application/User/UserApplicationModel.js +440 -689
- package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
- package/sdk/application/User/UserApplicationValidator.js +89 -89
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
- package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
- package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
- package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +168 -168
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
- package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
- package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
- package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformClient.js +41 -41
- package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
- package/sdk/platform/Common/CommonPlatformModel.js +83 -160
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +534 -534
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
- package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
- package/sdk/platform/Content/ContentPlatformModel.js +484 -907
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
- package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -24
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
- package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
- package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
- package/sdk/platform/Lead/LeadPlatformClient.js +212 -212
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
- package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
- package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
- package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
- package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
- package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
- package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
- package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
- package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
- package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
- package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
- package/sdk/platform/PlatformApplicationClient.js +1584 -13899
- package/sdk/platform/PlatformClient.d.ts +7965 -7885
- package/sdk/platform/PlatformClient.js +8672 -10105
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
- package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
- package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
- package/sdk/platform/Share/SharePlatformModel.js +60 -118
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
- package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
- package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
- package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
- package/sdk/platform/User/UserPlatformModel.js +440 -689
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
- package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
- package/sdk/public/Configuration/ConfigurationPublicClient.js +38 -38
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
- package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
- package/sdk/public/Inventory/InventoryPublicClient.js +113 -113
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
- package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
- package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
- package/tests/application/catalog.spec.js +7 -0
|
@@ -10,26 +10,26 @@ class Configuration {
|
|
|
10
10
|
constructor(_conf) {
|
|
11
11
|
this._conf = _conf;
|
|
12
12
|
this._relativeUrls = {
|
|
13
|
+
getAppCurrencies: "/service/application/configuration/v1.0/currency",
|
|
14
|
+
getAppStaffList: "/service/application/configuration/v1.0/staff/list",
|
|
15
|
+
getAppStaffs: "/service/application/configuration/v1.0/staff",
|
|
13
16
|
getApplication: "/service/application/configuration/v1.0/application",
|
|
14
|
-
getOwnerInfo: "/service/application/configuration/v1.0/about",
|
|
15
17
|
getBasicDetails: "/service/application/configuration/v1.0/detail",
|
|
16
|
-
getIntegrationTokens: "/service/application/configuration/v1.0/token",
|
|
17
|
-
getOrderingStores:
|
|
18
|
-
"/service/application/configuration/v1.0/ordering-store/stores",
|
|
19
|
-
getStoreDetailById:
|
|
20
|
-
"/service/application/configuration/v1.0/ordering-store/stores/{store_id}",
|
|
21
|
-
getFeatures: "/service/application/configuration/v1.0/feature",
|
|
22
18
|
getContactInfo: "/service/application/configuration/v1.0/information",
|
|
23
19
|
getCurrencies: "/service/application/configuration/v1.0/currencies",
|
|
24
20
|
getCurrencyById: "/service/application/configuration/v1.0/currency/{id}",
|
|
25
|
-
|
|
21
|
+
getFeatures: "/service/application/configuration/v1.0/feature",
|
|
22
|
+
getIntegrationTokens: "/service/application/configuration/v1.0/token",
|
|
26
23
|
getLanguages: "/service/application/configuration/v1.0/languages",
|
|
27
24
|
getOrderingStoreCookie:
|
|
28
25
|
"/service/application/configuration/v1.0/ordering-store/select",
|
|
26
|
+
getOrderingStores:
|
|
27
|
+
"/service/application/configuration/v1.0/ordering-store/stores",
|
|
28
|
+
getOwnerInfo: "/service/application/configuration/v1.0/about",
|
|
29
|
+
getStoreDetailById:
|
|
30
|
+
"/service/application/configuration/v1.0/ordering-store/stores/{store_id}",
|
|
29
31
|
removeOrderingStoreCookie:
|
|
30
32
|
"/service/application/configuration/v1.0/ordering-store/select",
|
|
31
|
-
getAppStaffList: "/service/application/configuration/v1.0/staff/list",
|
|
32
|
-
getAppStaffs: "/service/application/configuration/v1.0/staff",
|
|
33
33
|
};
|
|
34
34
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
35
35
|
(urls, [method, relativeUrl]) => {
|
|
@@ -49,12 +49,12 @@ class Configuration {
|
|
|
49
49
|
|
|
50
50
|
/**
|
|
51
51
|
* @param {Object} arg - Arg object.
|
|
52
|
-
* @returns {Promise<
|
|
53
|
-
* @summary: Get
|
|
54
|
-
* @description: Use this API to get
|
|
52
|
+
* @returns {Promise<AppCurrencyResponse>} - Success response
|
|
53
|
+
* @summary: Get currencies enabled in the application
|
|
54
|
+
* @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
|
|
55
55
|
*/
|
|
56
|
-
async
|
|
57
|
-
const { error } = ConfigurationValidator.
|
|
56
|
+
async getAppCurrencies({} = {}) {
|
|
57
|
+
const { error } = ConfigurationValidator.getAppCurrencies().validate(
|
|
58
58
|
{},
|
|
59
59
|
{ abortEarly: false, allowUnknown: true }
|
|
60
60
|
);
|
|
@@ -65,14 +65,14 @@ class Configuration {
|
|
|
65
65
|
// Showing warrnings if extra unknown parameters are found
|
|
66
66
|
const {
|
|
67
67
|
error: warrning,
|
|
68
|
-
} = ConfigurationValidator.
|
|
68
|
+
} = ConfigurationValidator.getAppCurrencies().validate(
|
|
69
69
|
{},
|
|
70
70
|
{ abortEarly: false, allowUnknown: false }
|
|
71
71
|
);
|
|
72
72
|
if (warrning) {
|
|
73
73
|
Logger({
|
|
74
74
|
level: "WARN",
|
|
75
|
-
message: "Parameter Validation warrnings for
|
|
75
|
+
message: "Parameter Validation warrnings for getAppCurrencies",
|
|
76
76
|
});
|
|
77
77
|
Logger({ level: "WARN", message: warrning });
|
|
78
78
|
}
|
|
@@ -85,7 +85,7 @@ class Configuration {
|
|
|
85
85
|
this._conf,
|
|
86
86
|
"get",
|
|
87
87
|
constructUrl({
|
|
88
|
-
url: this._urls["
|
|
88
|
+
url: this._urls["getAppCurrencies"],
|
|
89
89
|
params: {},
|
|
90
90
|
}),
|
|
91
91
|
query_params,
|
|
@@ -95,7 +95,7 @@ class Configuration {
|
|
|
95
95
|
|
|
96
96
|
const {
|
|
97
97
|
error: res_error,
|
|
98
|
-
} = ConfigurationModel.
|
|
98
|
+
} = ConfigurationModel.AppCurrencyResponse().validate(response, {
|
|
99
99
|
abortEarly: false,
|
|
100
100
|
allowUnknown: false,
|
|
101
101
|
});
|
|
@@ -103,7 +103,7 @@ class Configuration {
|
|
|
103
103
|
if (res_error) {
|
|
104
104
|
Logger({
|
|
105
105
|
level: "WARN",
|
|
106
|
-
message: "Response Validation Warnnings for
|
|
106
|
+
message: "Response Validation Warnnings for getAppCurrencies",
|
|
107
107
|
});
|
|
108
108
|
Logger({ level: "WARN", message: res_error });
|
|
109
109
|
}
|
|
@@ -113,13 +113,27 @@ class Configuration {
|
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
115
|
* @param {Object} arg - Arg object.
|
|
116
|
-
* @
|
|
117
|
-
* @
|
|
118
|
-
* @
|
|
116
|
+
* @param {number} [arg.pageNo] -
|
|
117
|
+
* @param {number} [arg.pageSize] -
|
|
118
|
+
* @param {boolean} [arg.orderIncent] - This is a boolean value. Select
|
|
119
|
+
* `true` to retrieve the staff members eligible for getting incentives on orders.
|
|
120
|
+
* @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
|
|
121
|
+
* retrieving staff members working at a particular ordering store.
|
|
122
|
+
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
123
|
+
* the details of a particular staff member.
|
|
124
|
+
* @returns {Promise<AppStaffListResponse>} - Success response
|
|
125
|
+
* @summary: Get a list of staff.
|
|
126
|
+
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
119
127
|
*/
|
|
120
|
-
async
|
|
121
|
-
|
|
122
|
-
|
|
128
|
+
async getAppStaffList({
|
|
129
|
+
pageNo,
|
|
130
|
+
pageSize,
|
|
131
|
+
orderIncent,
|
|
132
|
+
orderingStore,
|
|
133
|
+
user,
|
|
134
|
+
} = {}) {
|
|
135
|
+
const { error } = ConfigurationValidator.getAppStaffList().validate(
|
|
136
|
+
{ pageNo, pageSize, orderIncent, orderingStore, user },
|
|
123
137
|
{ abortEarly: false, allowUnknown: true }
|
|
124
138
|
);
|
|
125
139
|
if (error) {
|
|
@@ -127,19 +141,26 @@ class Configuration {
|
|
|
127
141
|
}
|
|
128
142
|
|
|
129
143
|
// Showing warrnings if extra unknown parameters are found
|
|
130
|
-
const {
|
|
131
|
-
|
|
144
|
+
const {
|
|
145
|
+
error: warrning,
|
|
146
|
+
} = ConfigurationValidator.getAppStaffList().validate(
|
|
147
|
+
{ pageNo, pageSize, orderIncent, orderingStore, user },
|
|
132
148
|
{ abortEarly: false, allowUnknown: false }
|
|
133
149
|
);
|
|
134
150
|
if (warrning) {
|
|
135
151
|
Logger({
|
|
136
152
|
level: "WARN",
|
|
137
|
-
message: "Parameter Validation warrnings for
|
|
153
|
+
message: "Parameter Validation warrnings for getAppStaffList",
|
|
138
154
|
});
|
|
139
155
|
Logger({ level: "WARN", message: warrning });
|
|
140
156
|
}
|
|
141
157
|
|
|
142
158
|
const query_params = {};
|
|
159
|
+
query_params["page_no"] = pageNo;
|
|
160
|
+
query_params["page_size"] = pageSize;
|
|
161
|
+
query_params["order_incent"] = orderIncent;
|
|
162
|
+
query_params["ordering_store"] = orderingStore;
|
|
163
|
+
query_params["user"] = user;
|
|
143
164
|
|
|
144
165
|
const xHeaders = {};
|
|
145
166
|
|
|
@@ -147,7 +168,7 @@ class Configuration {
|
|
|
147
168
|
this._conf,
|
|
148
169
|
"get",
|
|
149
170
|
constructUrl({
|
|
150
|
-
url: this._urls["
|
|
171
|
+
url: this._urls["getAppStaffList"],
|
|
151
172
|
params: {},
|
|
152
173
|
}),
|
|
153
174
|
query_params,
|
|
@@ -157,7 +178,7 @@ class Configuration {
|
|
|
157
178
|
|
|
158
179
|
const {
|
|
159
180
|
error: res_error,
|
|
160
|
-
} = ConfigurationModel.
|
|
181
|
+
} = ConfigurationModel.AppStaffListResponse().validate(response, {
|
|
161
182
|
abortEarly: false,
|
|
162
183
|
allowUnknown: false,
|
|
163
184
|
});
|
|
@@ -165,7 +186,7 @@ class Configuration {
|
|
|
165
186
|
if (res_error) {
|
|
166
187
|
Logger({
|
|
167
188
|
level: "WARN",
|
|
168
|
-
message: "Response Validation Warnnings for
|
|
189
|
+
message: "Response Validation Warnnings for getAppStaffList",
|
|
169
190
|
});
|
|
170
191
|
Logger({ level: "WARN", message: res_error });
|
|
171
192
|
}
|
|
@@ -175,77 +196,59 @@ class Configuration {
|
|
|
175
196
|
|
|
176
197
|
/**
|
|
177
198
|
* @param {Object} arg - Arg object.
|
|
178
|
-
* @
|
|
179
|
-
* @
|
|
180
|
-
*
|
|
199
|
+
* @param {number} [arg.pageSize] -
|
|
200
|
+
* @param {boolean} [arg.orderIncent] - This is a boolean value. Select
|
|
201
|
+
* `true` to retrieve the staff members eligible for getting incentives on orders.
|
|
202
|
+
* @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
|
|
203
|
+
* retrieving staff members working at a particular ordering store.
|
|
204
|
+
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
205
|
+
* the details of a particular staff member.
|
|
206
|
+
* @summary: Get a list of staff.
|
|
207
|
+
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
181
208
|
*/
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
Logger({
|
|
200
|
-
level: "WARN",
|
|
201
|
-
message: "Parameter Validation warrnings for getBasicDetails",
|
|
209
|
+
getAppStaffListPaginator({
|
|
210
|
+
pageSize,
|
|
211
|
+
orderIncent,
|
|
212
|
+
orderingStore,
|
|
213
|
+
user,
|
|
214
|
+
} = {}) {
|
|
215
|
+
const paginator = new Paginator();
|
|
216
|
+
const callback = async () => {
|
|
217
|
+
const pageId = paginator.nextId;
|
|
218
|
+
const pageNo = paginator.pageNo;
|
|
219
|
+
const pageType = "number";
|
|
220
|
+
const data = await this.getAppStaffList({
|
|
221
|
+
pageNo: pageNo,
|
|
222
|
+
pageSize: pageSize,
|
|
223
|
+
orderIncent: orderIncent,
|
|
224
|
+
orderingStore: orderingStore,
|
|
225
|
+
user: user,
|
|
202
226
|
});
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
const query_params = {};
|
|
207
|
-
|
|
208
|
-
const xHeaders = {};
|
|
209
|
-
|
|
210
|
-
const response = await APIClient.execute(
|
|
211
|
-
this._conf,
|
|
212
|
-
"get",
|
|
213
|
-
constructUrl({
|
|
214
|
-
url: this._urls["getBasicDetails"],
|
|
215
|
-
params: {},
|
|
216
|
-
}),
|
|
217
|
-
query_params,
|
|
218
|
-
undefined,
|
|
219
|
-
xHeaders
|
|
220
|
-
);
|
|
221
|
-
|
|
222
|
-
const {
|
|
223
|
-
error: res_error,
|
|
224
|
-
} = ConfigurationModel.ApplicationDetail().validate(response, {
|
|
225
|
-
abortEarly: false,
|
|
226
|
-
allowUnknown: false,
|
|
227
|
-
});
|
|
228
|
-
|
|
229
|
-
if (res_error) {
|
|
230
|
-
Logger({
|
|
231
|
-
level: "WARN",
|
|
232
|
-
message: "Response Validation Warnnings for getBasicDetails",
|
|
227
|
+
paginator.setPaginator({
|
|
228
|
+
hasNext: data.page.has_next ? true : false,
|
|
229
|
+
nextId: data.page.next_id,
|
|
233
230
|
});
|
|
234
|
-
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
return
|
|
231
|
+
return data;
|
|
232
|
+
};
|
|
233
|
+
paginator.setCallback(callback);
|
|
234
|
+
return paginator;
|
|
238
235
|
}
|
|
239
236
|
|
|
240
237
|
/**
|
|
241
238
|
* @param {Object} arg - Arg object.
|
|
242
|
-
* @
|
|
243
|
-
*
|
|
244
|
-
* @
|
|
239
|
+
* @param {boolean} [arg.orderIncent] - This is a boolean value. Select
|
|
240
|
+
* `true` to retrieve the staff members eligible for getting incentives on orders.
|
|
241
|
+
* @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
|
|
242
|
+
* retrieving staff members working at a particular ordering store.
|
|
243
|
+
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
244
|
+
* the details of a particular staff member.
|
|
245
|
+
* @returns {Promise<AppStaffResponse>} - Success response
|
|
246
|
+
* @summary: Get a list of staff.
|
|
247
|
+
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
245
248
|
*/
|
|
246
|
-
async
|
|
247
|
-
const { error } = ConfigurationValidator.
|
|
248
|
-
{},
|
|
249
|
+
async getAppStaffs({ orderIncent, orderingStore, user } = {}) {
|
|
250
|
+
const { error } = ConfigurationValidator.getAppStaffs().validate(
|
|
251
|
+
{ orderIncent, orderingStore, user },
|
|
249
252
|
{ abortEarly: false, allowUnknown: true }
|
|
250
253
|
);
|
|
251
254
|
if (error) {
|
|
@@ -253,21 +256,22 @@ class Configuration {
|
|
|
253
256
|
}
|
|
254
257
|
|
|
255
258
|
// Showing warrnings if extra unknown parameters are found
|
|
256
|
-
const {
|
|
257
|
-
|
|
258
|
-
} = ConfigurationValidator.getIntegrationTokens().validate(
|
|
259
|
-
{},
|
|
259
|
+
const { error: warrning } = ConfigurationValidator.getAppStaffs().validate(
|
|
260
|
+
{ orderIncent, orderingStore, user },
|
|
260
261
|
{ abortEarly: false, allowUnknown: false }
|
|
261
262
|
);
|
|
262
263
|
if (warrning) {
|
|
263
264
|
Logger({
|
|
264
265
|
level: "WARN",
|
|
265
|
-
message: "Parameter Validation warrnings for
|
|
266
|
+
message: "Parameter Validation warrnings for getAppStaffs",
|
|
266
267
|
});
|
|
267
268
|
Logger({ level: "WARN", message: warrning });
|
|
268
269
|
}
|
|
269
270
|
|
|
270
271
|
const query_params = {};
|
|
272
|
+
query_params["order_incent"] = orderIncent;
|
|
273
|
+
query_params["ordering_store"] = orderingStore;
|
|
274
|
+
query_params["user"] = user;
|
|
271
275
|
|
|
272
276
|
const xHeaders = {};
|
|
273
277
|
|
|
@@ -275,7 +279,7 @@ class Configuration {
|
|
|
275
279
|
this._conf,
|
|
276
280
|
"get",
|
|
277
281
|
constructUrl({
|
|
278
|
-
url: this._urls["
|
|
282
|
+
url: this._urls["getAppStaffs"],
|
|
279
283
|
params: {},
|
|
280
284
|
}),
|
|
281
285
|
query_params,
|
|
@@ -285,7 +289,7 @@ class Configuration {
|
|
|
285
289
|
|
|
286
290
|
const {
|
|
287
291
|
error: res_error,
|
|
288
|
-
} = ConfigurationModel.
|
|
292
|
+
} = ConfigurationModel.AppStaffResponse().validate(response, {
|
|
289
293
|
abortEarly: false,
|
|
290
294
|
allowUnknown: false,
|
|
291
295
|
});
|
|
@@ -293,7 +297,7 @@ class Configuration {
|
|
|
293
297
|
if (res_error) {
|
|
294
298
|
Logger({
|
|
295
299
|
level: "WARN",
|
|
296
|
-
message: "Response Validation Warnnings for
|
|
300
|
+
message: "Response Validation Warnnings for getAppStaffs",
|
|
297
301
|
});
|
|
298
302
|
Logger({ level: "WARN", message: res_error });
|
|
299
303
|
}
|
|
@@ -303,18 +307,13 @@ class Configuration {
|
|
|
303
307
|
|
|
304
308
|
/**
|
|
305
309
|
* @param {Object} arg - Arg object.
|
|
306
|
-
* @
|
|
307
|
-
*
|
|
308
|
-
* @
|
|
309
|
-
* page. Default value is 10.
|
|
310
|
-
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
311
|
-
* @returns {Promise<OrderingStores>} - Success response
|
|
312
|
-
* @summary: Get deployment stores
|
|
313
|
-
* @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
|
|
310
|
+
* @returns {Promise<Application>} - Success response
|
|
311
|
+
* @summary: Get current application details
|
|
312
|
+
* @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
|
|
314
313
|
*/
|
|
315
|
-
async
|
|
316
|
-
const { error } = ConfigurationValidator.
|
|
317
|
-
{
|
|
314
|
+
async getApplication({} = {}) {
|
|
315
|
+
const { error } = ConfigurationValidator.getApplication().validate(
|
|
316
|
+
{},
|
|
318
317
|
{ abortEarly: false, allowUnknown: true }
|
|
319
318
|
);
|
|
320
319
|
if (error) {
|
|
@@ -324,22 +323,19 @@ class Configuration {
|
|
|
324
323
|
// Showing warrnings if extra unknown parameters are found
|
|
325
324
|
const {
|
|
326
325
|
error: warrning,
|
|
327
|
-
} = ConfigurationValidator.
|
|
328
|
-
{
|
|
326
|
+
} = ConfigurationValidator.getApplication().validate(
|
|
327
|
+
{},
|
|
329
328
|
{ abortEarly: false, allowUnknown: false }
|
|
330
329
|
);
|
|
331
330
|
if (warrning) {
|
|
332
331
|
Logger({
|
|
333
332
|
level: "WARN",
|
|
334
|
-
message: "Parameter Validation warrnings for
|
|
333
|
+
message: "Parameter Validation warrnings for getApplication",
|
|
335
334
|
});
|
|
336
335
|
Logger({ level: "WARN", message: warrning });
|
|
337
336
|
}
|
|
338
337
|
|
|
339
338
|
const query_params = {};
|
|
340
|
-
query_params["page_no"] = pageNo;
|
|
341
|
-
query_params["page_size"] = pageSize;
|
|
342
|
-
query_params["q"] = q;
|
|
343
339
|
|
|
344
340
|
const xHeaders = {};
|
|
345
341
|
|
|
@@ -347,7 +343,7 @@ class Configuration {
|
|
|
347
343
|
this._conf,
|
|
348
344
|
"get",
|
|
349
345
|
constructUrl({
|
|
350
|
-
url: this._urls["
|
|
346
|
+
url: this._urls["getApplication"],
|
|
351
347
|
params: {},
|
|
352
348
|
}),
|
|
353
349
|
query_params,
|
|
@@ -357,7 +353,7 @@ class Configuration {
|
|
|
357
353
|
|
|
358
354
|
const {
|
|
359
355
|
error: res_error,
|
|
360
|
-
} = ConfigurationModel.
|
|
356
|
+
} = ConfigurationModel.Application().validate(response, {
|
|
361
357
|
abortEarly: false,
|
|
362
358
|
allowUnknown: false,
|
|
363
359
|
});
|
|
@@ -365,7 +361,7 @@ class Configuration {
|
|
|
365
361
|
if (res_error) {
|
|
366
362
|
Logger({
|
|
367
363
|
level: "WARN",
|
|
368
|
-
message: "Response Validation Warnnings for
|
|
364
|
+
message: "Response Validation Warnnings for getApplication",
|
|
369
365
|
});
|
|
370
366
|
Logger({ level: "WARN", message: res_error });
|
|
371
367
|
}
|
|
@@ -375,43 +371,13 @@ class Configuration {
|
|
|
375
371
|
|
|
376
372
|
/**
|
|
377
373
|
* @param {Object} arg - Arg object.
|
|
378
|
-
* @
|
|
379
|
-
*
|
|
380
|
-
* @
|
|
381
|
-
* @summary: Get deployment stores
|
|
382
|
-
* @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
|
|
383
|
-
*/
|
|
384
|
-
getOrderingStoresPaginator({ pageSize, q } = {}) {
|
|
385
|
-
const paginator = new Paginator();
|
|
386
|
-
const callback = async () => {
|
|
387
|
-
const pageId = paginator.nextId;
|
|
388
|
-
const pageNo = paginator.pageNo;
|
|
389
|
-
const pageType = "number";
|
|
390
|
-
const data = await this.getOrderingStores({
|
|
391
|
-
pageNo: pageNo,
|
|
392
|
-
pageSize: pageSize,
|
|
393
|
-
q: q,
|
|
394
|
-
});
|
|
395
|
-
paginator.setPaginator({
|
|
396
|
-
hasNext: data.page.has_next ? true : false,
|
|
397
|
-
nextId: data.page.next_id,
|
|
398
|
-
});
|
|
399
|
-
return data;
|
|
400
|
-
};
|
|
401
|
-
paginator.setCallback(callback);
|
|
402
|
-
return paginator;
|
|
403
|
-
}
|
|
404
|
-
|
|
405
|
-
/**
|
|
406
|
-
* @param {Object} arg - Arg object.
|
|
407
|
-
* @param {number} arg.storeId - Store uid
|
|
408
|
-
* @returns {Promise<OrderingStore>} - Success response
|
|
409
|
-
* @summary: Get ordering store details
|
|
410
|
-
* @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
|
|
374
|
+
* @returns {Promise<ApplicationDetail>} - Success response
|
|
375
|
+
* @summary: Get basic application details
|
|
376
|
+
* @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
|
|
411
377
|
*/
|
|
412
|
-
async
|
|
413
|
-
const { error } = ConfigurationValidator.
|
|
414
|
-
{
|
|
378
|
+
async getBasicDetails({} = {}) {
|
|
379
|
+
const { error } = ConfigurationValidator.getBasicDetails().validate(
|
|
380
|
+
{},
|
|
415
381
|
{ abortEarly: false, allowUnknown: true }
|
|
416
382
|
);
|
|
417
383
|
if (error) {
|
|
@@ -421,14 +387,14 @@ class Configuration {
|
|
|
421
387
|
// Showing warrnings if extra unknown parameters are found
|
|
422
388
|
const {
|
|
423
389
|
error: warrning,
|
|
424
|
-
} = ConfigurationValidator.
|
|
425
|
-
{
|
|
390
|
+
} = ConfigurationValidator.getBasicDetails().validate(
|
|
391
|
+
{},
|
|
426
392
|
{ abortEarly: false, allowUnknown: false }
|
|
427
393
|
);
|
|
428
394
|
if (warrning) {
|
|
429
395
|
Logger({
|
|
430
396
|
level: "WARN",
|
|
431
|
-
message: "Parameter Validation warrnings for
|
|
397
|
+
message: "Parameter Validation warrnings for getBasicDetails",
|
|
432
398
|
});
|
|
433
399
|
Logger({ level: "WARN", message: warrning });
|
|
434
400
|
}
|
|
@@ -441,8 +407,8 @@ class Configuration {
|
|
|
441
407
|
this._conf,
|
|
442
408
|
"get",
|
|
443
409
|
constructUrl({
|
|
444
|
-
url: this._urls["
|
|
445
|
-
params: {
|
|
410
|
+
url: this._urls["getBasicDetails"],
|
|
411
|
+
params: {},
|
|
446
412
|
}),
|
|
447
413
|
query_params,
|
|
448
414
|
undefined,
|
|
@@ -451,7 +417,7 @@ class Configuration {
|
|
|
451
417
|
|
|
452
418
|
const {
|
|
453
419
|
error: res_error,
|
|
454
|
-
} = ConfigurationModel.
|
|
420
|
+
} = ConfigurationModel.ApplicationDetail().validate(response, {
|
|
455
421
|
abortEarly: false,
|
|
456
422
|
allowUnknown: false,
|
|
457
423
|
});
|
|
@@ -459,7 +425,7 @@ class Configuration {
|
|
|
459
425
|
if (res_error) {
|
|
460
426
|
Logger({
|
|
461
427
|
level: "WARN",
|
|
462
|
-
message: "Response Validation Warnnings for
|
|
428
|
+
message: "Response Validation Warnnings for getBasicDetails",
|
|
463
429
|
});
|
|
464
430
|
Logger({ level: "WARN", message: res_error });
|
|
465
431
|
}
|
|
@@ -469,12 +435,12 @@ class Configuration {
|
|
|
469
435
|
|
|
470
436
|
/**
|
|
471
437
|
* @param {Object} arg - Arg object.
|
|
472
|
-
* @returns {Promise<
|
|
473
|
-
* @summary: Get
|
|
474
|
-
* @description: Use this API to retrieve
|
|
438
|
+
* @returns {Promise<ApplicationInformation>} - Success response
|
|
439
|
+
* @summary: Get application information
|
|
440
|
+
* @description: Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application.
|
|
475
441
|
*/
|
|
476
|
-
async
|
|
477
|
-
const { error } = ConfigurationValidator.
|
|
442
|
+
async getContactInfo({} = {}) {
|
|
443
|
+
const { error } = ConfigurationValidator.getContactInfo().validate(
|
|
478
444
|
{},
|
|
479
445
|
{ abortEarly: false, allowUnknown: true }
|
|
480
446
|
);
|
|
@@ -483,14 +449,16 @@ class Configuration {
|
|
|
483
449
|
}
|
|
484
450
|
|
|
485
451
|
// Showing warrnings if extra unknown parameters are found
|
|
486
|
-
const {
|
|
452
|
+
const {
|
|
453
|
+
error: warrning,
|
|
454
|
+
} = ConfigurationValidator.getContactInfo().validate(
|
|
487
455
|
{},
|
|
488
456
|
{ abortEarly: false, allowUnknown: false }
|
|
489
457
|
);
|
|
490
458
|
if (warrning) {
|
|
491
459
|
Logger({
|
|
492
460
|
level: "WARN",
|
|
493
|
-
message: "Parameter Validation warrnings for
|
|
461
|
+
message: "Parameter Validation warrnings for getContactInfo",
|
|
494
462
|
});
|
|
495
463
|
Logger({ level: "WARN", message: warrning });
|
|
496
464
|
}
|
|
@@ -503,7 +471,7 @@ class Configuration {
|
|
|
503
471
|
this._conf,
|
|
504
472
|
"get",
|
|
505
473
|
constructUrl({
|
|
506
|
-
url: this._urls["
|
|
474
|
+
url: this._urls["getContactInfo"],
|
|
507
475
|
params: {},
|
|
508
476
|
}),
|
|
509
477
|
query_params,
|
|
@@ -513,7 +481,7 @@ class Configuration {
|
|
|
513
481
|
|
|
514
482
|
const {
|
|
515
483
|
error: res_error,
|
|
516
|
-
} = ConfigurationModel.
|
|
484
|
+
} = ConfigurationModel.ApplicationInformation().validate(response, {
|
|
517
485
|
abortEarly: false,
|
|
518
486
|
allowUnknown: false,
|
|
519
487
|
});
|
|
@@ -521,7 +489,7 @@ class Configuration {
|
|
|
521
489
|
if (res_error) {
|
|
522
490
|
Logger({
|
|
523
491
|
level: "WARN",
|
|
524
|
-
message: "Response Validation Warnnings for
|
|
492
|
+
message: "Response Validation Warnnings for getContactInfo",
|
|
525
493
|
});
|
|
526
494
|
Logger({ level: "WARN", message: res_error });
|
|
527
495
|
}
|
|
@@ -531,12 +499,12 @@ class Configuration {
|
|
|
531
499
|
|
|
532
500
|
/**
|
|
533
501
|
* @param {Object} arg - Arg object.
|
|
534
|
-
* @returns {Promise<
|
|
535
|
-
* @summary: Get
|
|
536
|
-
* @description: Use this API to
|
|
502
|
+
* @returns {Promise<CurrenciesResponse>} - Success response
|
|
503
|
+
* @summary: Get all currencies list
|
|
504
|
+
* @description: Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
|
|
537
505
|
*/
|
|
538
|
-
async
|
|
539
|
-
const { error } = ConfigurationValidator.
|
|
506
|
+
async getCurrencies({} = {}) {
|
|
507
|
+
const { error } = ConfigurationValidator.getCurrencies().validate(
|
|
540
508
|
{},
|
|
541
509
|
{ abortEarly: false, allowUnknown: true }
|
|
542
510
|
);
|
|
@@ -545,16 +513,14 @@ class Configuration {
|
|
|
545
513
|
}
|
|
546
514
|
|
|
547
515
|
// Showing warrnings if extra unknown parameters are found
|
|
548
|
-
const {
|
|
549
|
-
error: warrning,
|
|
550
|
-
} = ConfigurationValidator.getContactInfo().validate(
|
|
516
|
+
const { error: warrning } = ConfigurationValidator.getCurrencies().validate(
|
|
551
517
|
{},
|
|
552
518
|
{ abortEarly: false, allowUnknown: false }
|
|
553
519
|
);
|
|
554
520
|
if (warrning) {
|
|
555
521
|
Logger({
|
|
556
522
|
level: "WARN",
|
|
557
|
-
message: "Parameter Validation warrnings for
|
|
523
|
+
message: "Parameter Validation warrnings for getCurrencies",
|
|
558
524
|
});
|
|
559
525
|
Logger({ level: "WARN", message: warrning });
|
|
560
526
|
}
|
|
@@ -567,7 +533,7 @@ class Configuration {
|
|
|
567
533
|
this._conf,
|
|
568
534
|
"get",
|
|
569
535
|
constructUrl({
|
|
570
|
-
url: this._urls["
|
|
536
|
+
url: this._urls["getCurrencies"],
|
|
571
537
|
params: {},
|
|
572
538
|
}),
|
|
573
539
|
query_params,
|
|
@@ -577,7 +543,7 @@ class Configuration {
|
|
|
577
543
|
|
|
578
544
|
const {
|
|
579
545
|
error: res_error,
|
|
580
|
-
} = ConfigurationModel.
|
|
546
|
+
} = ConfigurationModel.CurrenciesResponse().validate(response, {
|
|
581
547
|
abortEarly: false,
|
|
582
548
|
allowUnknown: false,
|
|
583
549
|
});
|
|
@@ -585,7 +551,7 @@ class Configuration {
|
|
|
585
551
|
if (res_error) {
|
|
586
552
|
Logger({
|
|
587
553
|
level: "WARN",
|
|
588
|
-
message: "Response Validation Warnnings for
|
|
554
|
+
message: "Response Validation Warnnings for getCurrencies",
|
|
589
555
|
});
|
|
590
556
|
Logger({ level: "WARN", message: res_error });
|
|
591
557
|
}
|
|
@@ -595,13 +561,14 @@ class Configuration {
|
|
|
595
561
|
|
|
596
562
|
/**
|
|
597
563
|
* @param {Object} arg - Arg object.
|
|
598
|
-
* @
|
|
599
|
-
* @
|
|
600
|
-
* @
|
|
564
|
+
* @param {string} arg.id - Object ID assigned to the currency
|
|
565
|
+
* @returns {Promise<Currency>} - Success response
|
|
566
|
+
* @summary: Get currency by its ID
|
|
567
|
+
* @description: Use this API to retrieve a currency using its ID.
|
|
601
568
|
*/
|
|
602
|
-
async
|
|
603
|
-
const { error } = ConfigurationValidator.
|
|
604
|
-
{},
|
|
569
|
+
async getCurrencyById({ id } = {}) {
|
|
570
|
+
const { error } = ConfigurationValidator.getCurrencyById().validate(
|
|
571
|
+
{ id },
|
|
605
572
|
{ abortEarly: false, allowUnknown: true }
|
|
606
573
|
);
|
|
607
574
|
if (error) {
|
|
@@ -609,14 +576,16 @@ class Configuration {
|
|
|
609
576
|
}
|
|
610
577
|
|
|
611
578
|
// Showing warrnings if extra unknown parameters are found
|
|
612
|
-
const {
|
|
613
|
-
|
|
579
|
+
const {
|
|
580
|
+
error: warrning,
|
|
581
|
+
} = ConfigurationValidator.getCurrencyById().validate(
|
|
582
|
+
{ id },
|
|
614
583
|
{ abortEarly: false, allowUnknown: false }
|
|
615
584
|
);
|
|
616
585
|
if (warrning) {
|
|
617
586
|
Logger({
|
|
618
587
|
level: "WARN",
|
|
619
|
-
message: "Parameter Validation warrnings for
|
|
588
|
+
message: "Parameter Validation warrnings for getCurrencyById",
|
|
620
589
|
});
|
|
621
590
|
Logger({ level: "WARN", message: warrning });
|
|
622
591
|
}
|
|
@@ -629,8 +598,8 @@ class Configuration {
|
|
|
629
598
|
this._conf,
|
|
630
599
|
"get",
|
|
631
600
|
constructUrl({
|
|
632
|
-
url: this._urls["
|
|
633
|
-
params: {},
|
|
601
|
+
url: this._urls["getCurrencyById"],
|
|
602
|
+
params: { id },
|
|
634
603
|
}),
|
|
635
604
|
query_params,
|
|
636
605
|
undefined,
|
|
@@ -639,7 +608,7 @@ class Configuration {
|
|
|
639
608
|
|
|
640
609
|
const {
|
|
641
610
|
error: res_error,
|
|
642
|
-
} = ConfigurationModel.
|
|
611
|
+
} = ConfigurationModel.Currency().validate(response, {
|
|
643
612
|
abortEarly: false,
|
|
644
613
|
allowUnknown: false,
|
|
645
614
|
});
|
|
@@ -647,7 +616,7 @@ class Configuration {
|
|
|
647
616
|
if (res_error) {
|
|
648
617
|
Logger({
|
|
649
618
|
level: "WARN",
|
|
650
|
-
message: "Response Validation Warnnings for
|
|
619
|
+
message: "Response Validation Warnnings for getCurrencyById",
|
|
651
620
|
});
|
|
652
621
|
Logger({ level: "WARN", message: res_error });
|
|
653
622
|
}
|
|
@@ -657,14 +626,13 @@ class Configuration {
|
|
|
657
626
|
|
|
658
627
|
/**
|
|
659
628
|
* @param {Object} arg - Arg object.
|
|
660
|
-
* @
|
|
661
|
-
* @
|
|
662
|
-
* @
|
|
663
|
-
* @description: Use this API to retrieve a currency using its ID.
|
|
629
|
+
* @returns {Promise<AppFeatureResponse>} - Success response
|
|
630
|
+
* @summary: Get features of application
|
|
631
|
+
* @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more.
|
|
664
632
|
*/
|
|
665
|
-
async
|
|
666
|
-
const { error } = ConfigurationValidator.
|
|
667
|
-
{
|
|
633
|
+
async getFeatures({} = {}) {
|
|
634
|
+
const { error } = ConfigurationValidator.getFeatures().validate(
|
|
635
|
+
{},
|
|
668
636
|
{ abortEarly: false, allowUnknown: true }
|
|
669
637
|
);
|
|
670
638
|
if (error) {
|
|
@@ -672,16 +640,14 @@ class Configuration {
|
|
|
672
640
|
}
|
|
673
641
|
|
|
674
642
|
// Showing warrnings if extra unknown parameters are found
|
|
675
|
-
const {
|
|
676
|
-
|
|
677
|
-
} = ConfigurationValidator.getCurrencyById().validate(
|
|
678
|
-
{ id },
|
|
643
|
+
const { error: warrning } = ConfigurationValidator.getFeatures().validate(
|
|
644
|
+
{},
|
|
679
645
|
{ abortEarly: false, allowUnknown: false }
|
|
680
646
|
);
|
|
681
647
|
if (warrning) {
|
|
682
648
|
Logger({
|
|
683
649
|
level: "WARN",
|
|
684
|
-
message: "Parameter Validation warrnings for
|
|
650
|
+
message: "Parameter Validation warrnings for getFeatures",
|
|
685
651
|
});
|
|
686
652
|
Logger({ level: "WARN", message: warrning });
|
|
687
653
|
}
|
|
@@ -694,8 +660,8 @@ class Configuration {
|
|
|
694
660
|
this._conf,
|
|
695
661
|
"get",
|
|
696
662
|
constructUrl({
|
|
697
|
-
url: this._urls["
|
|
698
|
-
params: {
|
|
663
|
+
url: this._urls["getFeatures"],
|
|
664
|
+
params: {},
|
|
699
665
|
}),
|
|
700
666
|
query_params,
|
|
701
667
|
undefined,
|
|
@@ -704,7 +670,7 @@ class Configuration {
|
|
|
704
670
|
|
|
705
671
|
const {
|
|
706
672
|
error: res_error,
|
|
707
|
-
} = ConfigurationModel.
|
|
673
|
+
} = ConfigurationModel.AppFeatureResponse().validate(response, {
|
|
708
674
|
abortEarly: false,
|
|
709
675
|
allowUnknown: false,
|
|
710
676
|
});
|
|
@@ -712,7 +678,7 @@ class Configuration {
|
|
|
712
678
|
if (res_error) {
|
|
713
679
|
Logger({
|
|
714
680
|
level: "WARN",
|
|
715
|
-
message: "Response Validation Warnnings for
|
|
681
|
+
message: "Response Validation Warnnings for getFeatures",
|
|
716
682
|
});
|
|
717
683
|
Logger({ level: "WARN", message: res_error });
|
|
718
684
|
}
|
|
@@ -722,12 +688,12 @@ class Configuration {
|
|
|
722
688
|
|
|
723
689
|
/**
|
|
724
690
|
* @param {Object} arg - Arg object.
|
|
725
|
-
* @returns {Promise<
|
|
726
|
-
* @summary: Get
|
|
727
|
-
* @description: Use this API to
|
|
691
|
+
* @returns {Promise<AppTokenResponse>} - Success response
|
|
692
|
+
* @summary: Get integration tokens
|
|
693
|
+
* @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key.
|
|
728
694
|
*/
|
|
729
|
-
async
|
|
730
|
-
const { error } = ConfigurationValidator.
|
|
695
|
+
async getIntegrationTokens({} = {}) {
|
|
696
|
+
const { error } = ConfigurationValidator.getIntegrationTokens().validate(
|
|
731
697
|
{},
|
|
732
698
|
{ abortEarly: false, allowUnknown: true }
|
|
733
699
|
);
|
|
@@ -738,14 +704,14 @@ class Configuration {
|
|
|
738
704
|
// Showing warrnings if extra unknown parameters are found
|
|
739
705
|
const {
|
|
740
706
|
error: warrning,
|
|
741
|
-
} = ConfigurationValidator.
|
|
707
|
+
} = ConfigurationValidator.getIntegrationTokens().validate(
|
|
742
708
|
{},
|
|
743
709
|
{ abortEarly: false, allowUnknown: false }
|
|
744
710
|
);
|
|
745
711
|
if (warrning) {
|
|
746
712
|
Logger({
|
|
747
713
|
level: "WARN",
|
|
748
|
-
message: "Parameter Validation warrnings for
|
|
714
|
+
message: "Parameter Validation warrnings for getIntegrationTokens",
|
|
749
715
|
});
|
|
750
716
|
Logger({ level: "WARN", message: warrning });
|
|
751
717
|
}
|
|
@@ -758,7 +724,7 @@ class Configuration {
|
|
|
758
724
|
this._conf,
|
|
759
725
|
"get",
|
|
760
726
|
constructUrl({
|
|
761
|
-
url: this._urls["
|
|
727
|
+
url: this._urls["getIntegrationTokens"],
|
|
762
728
|
params: {},
|
|
763
729
|
}),
|
|
764
730
|
query_params,
|
|
@@ -768,7 +734,7 @@ class Configuration {
|
|
|
768
734
|
|
|
769
735
|
const {
|
|
770
736
|
error: res_error,
|
|
771
|
-
} = ConfigurationModel.
|
|
737
|
+
} = ConfigurationModel.AppTokenResponse().validate(response, {
|
|
772
738
|
abortEarly: false,
|
|
773
739
|
allowUnknown: false,
|
|
774
740
|
});
|
|
@@ -776,7 +742,7 @@ class Configuration {
|
|
|
776
742
|
if (res_error) {
|
|
777
743
|
Logger({
|
|
778
744
|
level: "WARN",
|
|
779
|
-
message: "Response Validation Warnnings for
|
|
745
|
+
message: "Response Validation Warnnings for getIntegrationTokens",
|
|
780
746
|
});
|
|
781
747
|
Logger({ level: "WARN", message: res_error });
|
|
782
748
|
}
|
|
@@ -913,15 +879,18 @@ class Configuration {
|
|
|
913
879
|
|
|
914
880
|
/**
|
|
915
881
|
* @param {Object} arg - Arg object.
|
|
916
|
-
* @
|
|
917
|
-
*
|
|
918
|
-
* @
|
|
882
|
+
* @param {number} [arg.pageNo] - The page number to navigate through the
|
|
883
|
+
* given set of results. Default value is 1.
|
|
884
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
885
|
+
* page. Default value is 10.
|
|
886
|
+
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
887
|
+
* @returns {Promise<OrderingStores>} - Success response
|
|
888
|
+
* @summary: Get deployment stores
|
|
889
|
+
* @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
|
|
919
890
|
*/
|
|
920
|
-
async
|
|
921
|
-
const {
|
|
922
|
-
|
|
923
|
-
} = ConfigurationValidator.removeOrderingStoreCookie().validate(
|
|
924
|
-
{},
|
|
891
|
+
async getOrderingStores({ pageNo, pageSize, q } = {}) {
|
|
892
|
+
const { error } = ConfigurationValidator.getOrderingStores().validate(
|
|
893
|
+
{ pageNo, pageSize, q },
|
|
925
894
|
{ abortEarly: false, allowUnknown: true }
|
|
926
895
|
);
|
|
927
896
|
if (error) {
|
|
@@ -931,27 +900,30 @@ class Configuration {
|
|
|
931
900
|
// Showing warrnings if extra unknown parameters are found
|
|
932
901
|
const {
|
|
933
902
|
error: warrning,
|
|
934
|
-
} = ConfigurationValidator.
|
|
935
|
-
{},
|
|
903
|
+
} = ConfigurationValidator.getOrderingStores().validate(
|
|
904
|
+
{ pageNo, pageSize, q },
|
|
936
905
|
{ abortEarly: false, allowUnknown: false }
|
|
937
906
|
);
|
|
938
907
|
if (warrning) {
|
|
939
908
|
Logger({
|
|
940
909
|
level: "WARN",
|
|
941
|
-
message: "Parameter Validation warrnings for
|
|
910
|
+
message: "Parameter Validation warrnings for getOrderingStores",
|
|
942
911
|
});
|
|
943
912
|
Logger({ level: "WARN", message: warrning });
|
|
944
913
|
}
|
|
945
914
|
|
|
946
915
|
const query_params = {};
|
|
916
|
+
query_params["page_no"] = pageNo;
|
|
917
|
+
query_params["page_size"] = pageSize;
|
|
918
|
+
query_params["q"] = q;
|
|
947
919
|
|
|
948
920
|
const xHeaders = {};
|
|
949
921
|
|
|
950
922
|
const response = await APIClient.execute(
|
|
951
923
|
this._conf,
|
|
952
|
-
"
|
|
924
|
+
"get",
|
|
953
925
|
constructUrl({
|
|
954
|
-
url: this._urls["
|
|
926
|
+
url: this._urls["getOrderingStores"],
|
|
955
927
|
params: {},
|
|
956
928
|
}),
|
|
957
929
|
query_params,
|
|
@@ -961,7 +933,7 @@ class Configuration {
|
|
|
961
933
|
|
|
962
934
|
const {
|
|
963
935
|
error: res_error,
|
|
964
|
-
} = ConfigurationModel.
|
|
936
|
+
} = ConfigurationModel.OrderingStores().validate(response, {
|
|
965
937
|
abortEarly: false,
|
|
966
938
|
allowUnknown: false,
|
|
967
939
|
});
|
|
@@ -969,7 +941,7 @@ class Configuration {
|
|
|
969
941
|
if (res_error) {
|
|
970
942
|
Logger({
|
|
971
943
|
level: "WARN",
|
|
972
|
-
message: "Response Validation Warnnings for
|
|
944
|
+
message: "Response Validation Warnnings for getOrderingStores",
|
|
973
945
|
});
|
|
974
946
|
Logger({ level: "WARN", message: res_error });
|
|
975
947
|
}
|
|
@@ -979,27 +951,42 @@ class Configuration {
|
|
|
979
951
|
|
|
980
952
|
/**
|
|
981
953
|
* @param {Object} arg - Arg object.
|
|
982
|
-
* @param {number} [arg.
|
|
983
|
-
*
|
|
984
|
-
* @param {
|
|
985
|
-
*
|
|
986
|
-
* @
|
|
987
|
-
* retrieving staff members working at a particular ordering store.
|
|
988
|
-
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
989
|
-
* the details of a particular staff member.
|
|
990
|
-
* @returns {Promise<AppStaffListResponse>} - Success response
|
|
991
|
-
* @summary: Get a list of staff.
|
|
992
|
-
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
954
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
955
|
+
* page. Default value is 10.
|
|
956
|
+
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
957
|
+
* @summary: Get deployment stores
|
|
958
|
+
* @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
|
|
993
959
|
*/
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
960
|
+
getOrderingStoresPaginator({ pageSize, q } = {}) {
|
|
961
|
+
const paginator = new Paginator();
|
|
962
|
+
const callback = async () => {
|
|
963
|
+
const pageId = paginator.nextId;
|
|
964
|
+
const pageNo = paginator.pageNo;
|
|
965
|
+
const pageType = "number";
|
|
966
|
+
const data = await this.getOrderingStores({
|
|
967
|
+
pageNo: pageNo,
|
|
968
|
+
pageSize: pageSize,
|
|
969
|
+
q: q,
|
|
970
|
+
});
|
|
971
|
+
paginator.setPaginator({
|
|
972
|
+
hasNext: data.page.has_next ? true : false,
|
|
973
|
+
nextId: data.page.next_id,
|
|
974
|
+
});
|
|
975
|
+
return data;
|
|
976
|
+
};
|
|
977
|
+
paginator.setCallback(callback);
|
|
978
|
+
return paginator;
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* @param {Object} arg - Arg object.
|
|
983
|
+
* @returns {Promise<ApplicationAboutResponse>} - Success response
|
|
984
|
+
* @summary: Get application, owner and seller information
|
|
985
|
+
* @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
|
|
986
|
+
*/
|
|
987
|
+
async getOwnerInfo({} = {}) {
|
|
988
|
+
const { error } = ConfigurationValidator.getOwnerInfo().validate(
|
|
989
|
+
{},
|
|
1003
990
|
{ abortEarly: false, allowUnknown: true }
|
|
1004
991
|
);
|
|
1005
992
|
if (error) {
|
|
@@ -1007,26 +994,19 @@ class Configuration {
|
|
|
1007
994
|
}
|
|
1008
995
|
|
|
1009
996
|
// Showing warrnings if extra unknown parameters are found
|
|
1010
|
-
const {
|
|
1011
|
-
|
|
1012
|
-
} = ConfigurationValidator.getAppStaffList().validate(
|
|
1013
|
-
{ pageNo, pageSize, orderIncent, orderingStore, user },
|
|
997
|
+
const { error: warrning } = ConfigurationValidator.getOwnerInfo().validate(
|
|
998
|
+
{},
|
|
1014
999
|
{ abortEarly: false, allowUnknown: false }
|
|
1015
1000
|
);
|
|
1016
1001
|
if (warrning) {
|
|
1017
1002
|
Logger({
|
|
1018
1003
|
level: "WARN",
|
|
1019
|
-
message: "Parameter Validation warrnings for
|
|
1004
|
+
message: "Parameter Validation warrnings for getOwnerInfo",
|
|
1020
1005
|
});
|
|
1021
1006
|
Logger({ level: "WARN", message: warrning });
|
|
1022
1007
|
}
|
|
1023
1008
|
|
|
1024
1009
|
const query_params = {};
|
|
1025
|
-
query_params["page_no"] = pageNo;
|
|
1026
|
-
query_params["page_size"] = pageSize;
|
|
1027
|
-
query_params["order_incent"] = orderIncent;
|
|
1028
|
-
query_params["ordering_store"] = orderingStore;
|
|
1029
|
-
query_params["user"] = user;
|
|
1030
1010
|
|
|
1031
1011
|
const xHeaders = {};
|
|
1032
1012
|
|
|
@@ -1034,7 +1014,7 @@ class Configuration {
|
|
|
1034
1014
|
this._conf,
|
|
1035
1015
|
"get",
|
|
1036
1016
|
constructUrl({
|
|
1037
|
-
url: this._urls["
|
|
1017
|
+
url: this._urls["getOwnerInfo"],
|
|
1038
1018
|
params: {},
|
|
1039
1019
|
}),
|
|
1040
1020
|
query_params,
|
|
@@ -1044,7 +1024,7 @@ class Configuration {
|
|
|
1044
1024
|
|
|
1045
1025
|
const {
|
|
1046
1026
|
error: res_error,
|
|
1047
|
-
} = ConfigurationModel.
|
|
1027
|
+
} = ConfigurationModel.ApplicationAboutResponse().validate(response, {
|
|
1048
1028
|
abortEarly: false,
|
|
1049
1029
|
allowUnknown: false,
|
|
1050
1030
|
});
|
|
@@ -1052,7 +1032,7 @@ class Configuration {
|
|
|
1052
1032
|
if (res_error) {
|
|
1053
1033
|
Logger({
|
|
1054
1034
|
level: "WARN",
|
|
1055
|
-
message: "Response Validation Warnnings for
|
|
1035
|
+
message: "Response Validation Warnnings for getOwnerInfo",
|
|
1056
1036
|
});
|
|
1057
1037
|
Logger({ level: "WARN", message: res_error });
|
|
1058
1038
|
}
|
|
@@ -1062,59 +1042,80 @@ class Configuration {
|
|
|
1062
1042
|
|
|
1063
1043
|
/**
|
|
1064
1044
|
* @param {Object} arg - Arg object.
|
|
1065
|
-
* @param {number}
|
|
1066
|
-
* @
|
|
1067
|
-
*
|
|
1068
|
-
* @
|
|
1069
|
-
* retrieving staff members working at a particular ordering store.
|
|
1070
|
-
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
1071
|
-
* the details of a particular staff member.
|
|
1072
|
-
* @summary: Get a list of staff.
|
|
1073
|
-
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
1045
|
+
* @param {number} arg.storeId - Store uid
|
|
1046
|
+
* @returns {Promise<OrderingStore>} - Success response
|
|
1047
|
+
* @summary: Get ordering store details
|
|
1048
|
+
* @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
|
|
1074
1049
|
*/
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1050
|
+
async getStoreDetailById({ storeId } = {}) {
|
|
1051
|
+
const { error } = ConfigurationValidator.getStoreDetailById().validate(
|
|
1052
|
+
{ storeId },
|
|
1053
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1054
|
+
);
|
|
1055
|
+
if (error) {
|
|
1056
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1060
|
+
const {
|
|
1061
|
+
error: warrning,
|
|
1062
|
+
} = ConfigurationValidator.getStoreDetailById().validate(
|
|
1063
|
+
{ storeId },
|
|
1064
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1065
|
+
);
|
|
1066
|
+
if (warrning) {
|
|
1067
|
+
Logger({
|
|
1068
|
+
level: "WARN",
|
|
1069
|
+
message: "Parameter Validation warrnings for getStoreDetailById",
|
|
1092
1070
|
});
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1071
|
+
Logger({ level: "WARN", message: warrning });
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
const query_params = {};
|
|
1075
|
+
|
|
1076
|
+
const xHeaders = {};
|
|
1077
|
+
|
|
1078
|
+
const response = await APIClient.execute(
|
|
1079
|
+
this._conf,
|
|
1080
|
+
"get",
|
|
1081
|
+
constructUrl({
|
|
1082
|
+
url: this._urls["getStoreDetailById"],
|
|
1083
|
+
params: { storeId },
|
|
1084
|
+
}),
|
|
1085
|
+
query_params,
|
|
1086
|
+
undefined,
|
|
1087
|
+
xHeaders
|
|
1088
|
+
);
|
|
1089
|
+
|
|
1090
|
+
const {
|
|
1091
|
+
error: res_error,
|
|
1092
|
+
} = ConfigurationModel.OrderingStore().validate(response, {
|
|
1093
|
+
abortEarly: false,
|
|
1094
|
+
allowUnknown: false,
|
|
1095
|
+
});
|
|
1096
|
+
|
|
1097
|
+
if (res_error) {
|
|
1098
|
+
Logger({
|
|
1099
|
+
level: "WARN",
|
|
1100
|
+
message: "Response Validation Warnnings for getStoreDetailById",
|
|
1096
1101
|
});
|
|
1097
|
-
|
|
1098
|
-
}
|
|
1099
|
-
|
|
1100
|
-
return
|
|
1102
|
+
Logger({ level: "WARN", message: res_error });
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
return response;
|
|
1101
1106
|
}
|
|
1102
1107
|
|
|
1103
1108
|
/**
|
|
1104
1109
|
* @param {Object} arg - Arg object.
|
|
1105
|
-
* @
|
|
1106
|
-
*
|
|
1107
|
-
* @
|
|
1108
|
-
* retrieving staff members working at a particular ordering store.
|
|
1109
|
-
* @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
|
|
1110
|
-
* the details of a particular staff member.
|
|
1111
|
-
* @returns {Promise<AppStaffResponse>} - Success response
|
|
1112
|
-
* @summary: Get a list of staff.
|
|
1113
|
-
* @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
|
|
1110
|
+
* @returns {Promise<SuccessMessageResponse>} - Success response
|
|
1111
|
+
* @summary: Unset the Ordering Store signed cookie.
|
|
1112
|
+
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
|
|
1114
1113
|
*/
|
|
1115
|
-
async
|
|
1116
|
-
const {
|
|
1117
|
-
|
|
1114
|
+
async removeOrderingStoreCookie({} = {}) {
|
|
1115
|
+
const {
|
|
1116
|
+
error,
|
|
1117
|
+
} = ConfigurationValidator.removeOrderingStoreCookie().validate(
|
|
1118
|
+
{},
|
|
1118
1119
|
{ abortEarly: false, allowUnknown: true }
|
|
1119
1120
|
);
|
|
1120
1121
|
if (error) {
|
|
@@ -1122,30 +1123,29 @@ class Configuration {
|
|
|
1122
1123
|
}
|
|
1123
1124
|
|
|
1124
1125
|
// Showing warrnings if extra unknown parameters are found
|
|
1125
|
-
const {
|
|
1126
|
-
|
|
1126
|
+
const {
|
|
1127
|
+
error: warrning,
|
|
1128
|
+
} = ConfigurationValidator.removeOrderingStoreCookie().validate(
|
|
1129
|
+
{},
|
|
1127
1130
|
{ abortEarly: false, allowUnknown: false }
|
|
1128
1131
|
);
|
|
1129
1132
|
if (warrning) {
|
|
1130
1133
|
Logger({
|
|
1131
1134
|
level: "WARN",
|
|
1132
|
-
message: "Parameter Validation warrnings for
|
|
1135
|
+
message: "Parameter Validation warrnings for removeOrderingStoreCookie",
|
|
1133
1136
|
});
|
|
1134
1137
|
Logger({ level: "WARN", message: warrning });
|
|
1135
1138
|
}
|
|
1136
1139
|
|
|
1137
1140
|
const query_params = {};
|
|
1138
|
-
query_params["order_incent"] = orderIncent;
|
|
1139
|
-
query_params["ordering_store"] = orderingStore;
|
|
1140
|
-
query_params["user"] = user;
|
|
1141
1141
|
|
|
1142
1142
|
const xHeaders = {};
|
|
1143
1143
|
|
|
1144
1144
|
const response = await APIClient.execute(
|
|
1145
1145
|
this._conf,
|
|
1146
|
-
"
|
|
1146
|
+
"delete",
|
|
1147
1147
|
constructUrl({
|
|
1148
|
-
url: this._urls["
|
|
1148
|
+
url: this._urls["removeOrderingStoreCookie"],
|
|
1149
1149
|
params: {},
|
|
1150
1150
|
}),
|
|
1151
1151
|
query_params,
|
|
@@ -1155,7 +1155,7 @@ class Configuration {
|
|
|
1155
1155
|
|
|
1156
1156
|
const {
|
|
1157
1157
|
error: res_error,
|
|
1158
|
-
} = ConfigurationModel.
|
|
1158
|
+
} = ConfigurationModel.SuccessMessageResponse().validate(response, {
|
|
1159
1159
|
abortEarly: false,
|
|
1160
1160
|
allowUnknown: false,
|
|
1161
1161
|
});
|
|
@@ -1163,7 +1163,7 @@ class Configuration {
|
|
|
1163
1163
|
if (res_error) {
|
|
1164
1164
|
Logger({
|
|
1165
1165
|
level: "WARN",
|
|
1166
|
-
message: "Response Validation Warnnings for
|
|
1166
|
+
message: "Response Validation Warnnings for removeOrderingStoreCookie",
|
|
1167
1167
|
});
|
|
1168
1168
|
Logger({ level: "WARN", message: res_error });
|
|
1169
1169
|
}
|