@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -1,6 +1,183 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* @typedef Asset
|
|
5
|
+
* @property {string} [aspect_ratio]
|
|
6
|
+
* @property {string} [id]
|
|
7
|
+
* @property {string} [secure_url]
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* @typedef CatalogueOrderRequest
|
|
12
|
+
* @property {RewardsArticle[]} [articles]
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @typedef CatalogueOrderResponse
|
|
17
|
+
* @property {RewardsArticle[]} [articles]
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* @typedef DiscountProperties
|
|
22
|
+
* @property {number} [absolute]
|
|
23
|
+
* @property {string} [currency]
|
|
24
|
+
* @property {string} [display_absolute]
|
|
25
|
+
* @property {string} [display_percent]
|
|
26
|
+
* @property {number} [percent]
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* @typedef Error
|
|
31
|
+
* @property {number} [code]
|
|
32
|
+
* @property {string} [exception]
|
|
33
|
+
* @property {string} [info]
|
|
34
|
+
* @property {string} [message]
|
|
35
|
+
*/
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* @typedef Offer
|
|
39
|
+
* @property {Schedule} [_schedule]
|
|
40
|
+
* @property {boolean} [active]
|
|
41
|
+
* @property {string} [application_id]
|
|
42
|
+
* @property {Asset} [banner_image]
|
|
43
|
+
* @property {string} [created_at]
|
|
44
|
+
* @property {string} [name]
|
|
45
|
+
* @property {Object} [rule]
|
|
46
|
+
* @property {ShareMessages} [share]
|
|
47
|
+
* @property {string} [sub_text]
|
|
48
|
+
* @property {string} [text]
|
|
49
|
+
* @property {string} [type]
|
|
50
|
+
* @property {string} [updated_at]
|
|
51
|
+
* @property {string} [updated_by]
|
|
52
|
+
* @property {string} [url]
|
|
53
|
+
*/
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* @typedef OrderDiscountRequest
|
|
57
|
+
* @property {string} [currency]
|
|
58
|
+
* @property {number} order_amount
|
|
59
|
+
*/
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @typedef OrderDiscountResponse
|
|
63
|
+
* @property {OrderDiscountRuleBucket} [applied_rule_bucket]
|
|
64
|
+
* @property {DiscountProperties} [base_discount]
|
|
65
|
+
* @property {DiscountProperties} [discount]
|
|
66
|
+
* @property {number} [order_amount]
|
|
67
|
+
* @property {number} [points]
|
|
68
|
+
*/
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @typedef OrderDiscountRuleBucket
|
|
72
|
+
* @property {number} [high]
|
|
73
|
+
* @property {number} [low]
|
|
74
|
+
* @property {number} [max]
|
|
75
|
+
* @property {number} [value]
|
|
76
|
+
* @property {string} [value_type]
|
|
77
|
+
*/
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* @typedef Page
|
|
81
|
+
* @property {number} [current]
|
|
82
|
+
* @property {boolean} [has_next]
|
|
83
|
+
* @property {boolean} [has_previous]
|
|
84
|
+
* @property {number} [item_total]
|
|
85
|
+
* @property {string} [next_id]
|
|
86
|
+
* @property {number} [size]
|
|
87
|
+
* @property {string} type
|
|
88
|
+
*/
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* @typedef PointsHistory
|
|
92
|
+
* @property {string} [_id]
|
|
93
|
+
* @property {string} [application_id]
|
|
94
|
+
* @property {boolean} [claimed]
|
|
95
|
+
* @property {string} [created_at]
|
|
96
|
+
* @property {string} [expires_on]
|
|
97
|
+
* @property {Object} [meta]
|
|
98
|
+
* @property {number} [points]
|
|
99
|
+
* @property {number} [remaining_points]
|
|
100
|
+
* @property {string} [text_1]
|
|
101
|
+
* @property {string} [text_2]
|
|
102
|
+
* @property {string} [text_3]
|
|
103
|
+
* @property {string} [txn_name]
|
|
104
|
+
* @property {string} [updated_at]
|
|
105
|
+
* @property {string} [user_id]
|
|
106
|
+
*/
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* @typedef PointsHistoryResponse
|
|
110
|
+
* @property {PointsHistory[]} [items] - History is the list of points transaction.
|
|
111
|
+
* @property {Page} [page]
|
|
112
|
+
*/
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* @typedef PointsResponse
|
|
116
|
+
* @property {number} [points] - Total points available
|
|
117
|
+
*/
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* @typedef RedeemReferralCodeRequest
|
|
121
|
+
* @property {string} [device_id]
|
|
122
|
+
* @property {string} [referral_code]
|
|
123
|
+
*/
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* @typedef RedeemReferralCodeResponse
|
|
127
|
+
* @property {string} [message]
|
|
128
|
+
* @property {number} [points]
|
|
129
|
+
* @property {boolean} [redeemed]
|
|
130
|
+
* @property {string} [referrer_id]
|
|
131
|
+
* @property {string} [referrer_info]
|
|
132
|
+
*/
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* @typedef ReferralDetailsResponse
|
|
136
|
+
* @property {Offer} [referral]
|
|
137
|
+
* @property {string} [referrer_info]
|
|
138
|
+
* @property {ShareMessages} [share]
|
|
139
|
+
* @property {string} [terms_conditions_link]
|
|
140
|
+
* @property {ReferralDetailsUser} [user]
|
|
141
|
+
*/
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* @typedef ReferralDetailsUser
|
|
145
|
+
* @property {boolean} [blocked]
|
|
146
|
+
* @property {number} [points]
|
|
147
|
+
* @property {boolean} [redeemed]
|
|
148
|
+
* @property {string} [referral_code]
|
|
149
|
+
*/
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* @typedef RewardsArticle
|
|
153
|
+
* @property {string} [id]
|
|
154
|
+
* @property {number} [points]
|
|
155
|
+
* @property {number} [price]
|
|
156
|
+
*/
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* @typedef Schedule
|
|
160
|
+
* @property {string} [cron]
|
|
161
|
+
* @property {number} [duration]
|
|
162
|
+
* @property {string} [end]
|
|
163
|
+
* @property {string} [start]
|
|
164
|
+
*/
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* @typedef ShareMessages
|
|
168
|
+
* @property {number} [email]
|
|
169
|
+
* @property {string} [facebook]
|
|
170
|
+
* @property {string} [fallback]
|
|
171
|
+
* @property {string} [message]
|
|
172
|
+
* @property {string} [messenger]
|
|
173
|
+
* @property {string} [sms]
|
|
174
|
+
* @property {string} [text]
|
|
175
|
+
* @property {string} [twitter]
|
|
176
|
+
* @property {string} [whatsapp]
|
|
177
|
+
*/
|
|
178
|
+
|
|
179
|
+
class RewardsApplicationModel {
|
|
180
|
+
/** @returns {Asset} */
|
|
4
181
|
static Asset() {
|
|
5
182
|
return Joi.object({
|
|
6
183
|
aspect_ratio: Joi.string().allow(""),
|
|
@@ -8,16 +185,22 @@ class RewardsModel {
|
|
|
8
185
|
secure_url: Joi.string().allow(""),
|
|
9
186
|
});
|
|
10
187
|
}
|
|
188
|
+
|
|
189
|
+
/** @returns {CatalogueOrderRequest} */
|
|
11
190
|
static CatalogueOrderRequest() {
|
|
12
191
|
return Joi.object({
|
|
13
|
-
articles: Joi.array().items(
|
|
192
|
+
articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
|
|
14
193
|
});
|
|
15
194
|
}
|
|
195
|
+
|
|
196
|
+
/** @returns {CatalogueOrderResponse} */
|
|
16
197
|
static CatalogueOrderResponse() {
|
|
17
198
|
return Joi.object({
|
|
18
|
-
articles: Joi.array().items(
|
|
199
|
+
articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
|
|
19
200
|
});
|
|
20
201
|
}
|
|
202
|
+
|
|
203
|
+
/** @returns {DiscountProperties} */
|
|
21
204
|
static DiscountProperties() {
|
|
22
205
|
return Joi.object({
|
|
23
206
|
absolute: Joi.number(),
|
|
@@ -27,6 +210,8 @@ class RewardsModel {
|
|
|
27
210
|
percent: Joi.number(),
|
|
28
211
|
});
|
|
29
212
|
}
|
|
213
|
+
|
|
214
|
+
/** @returns {Error} */
|
|
30
215
|
static Error() {
|
|
31
216
|
return Joi.object({
|
|
32
217
|
code: Joi.number(),
|
|
@@ -35,16 +220,18 @@ class RewardsModel {
|
|
|
35
220
|
message: Joi.string().allow(""),
|
|
36
221
|
});
|
|
37
222
|
}
|
|
223
|
+
|
|
224
|
+
/** @returns {Offer} */
|
|
38
225
|
static Offer() {
|
|
39
226
|
return Joi.object({
|
|
40
|
-
_schedule:
|
|
227
|
+
_schedule: RewardsApplicationModel.Schedule(),
|
|
41
228
|
active: Joi.boolean(),
|
|
42
229
|
application_id: Joi.string().allow(""),
|
|
43
|
-
banner_image:
|
|
230
|
+
banner_image: RewardsApplicationModel.Asset(),
|
|
44
231
|
created_at: Joi.string().allow(""),
|
|
45
232
|
name: Joi.string().allow(""),
|
|
46
233
|
rule: Joi.any(),
|
|
47
|
-
share:
|
|
234
|
+
share: RewardsApplicationModel.ShareMessages(),
|
|
48
235
|
sub_text: Joi.string().allow(""),
|
|
49
236
|
text: Joi.string().allow(""),
|
|
50
237
|
type: Joi.string().allow(""),
|
|
@@ -53,21 +240,27 @@ class RewardsModel {
|
|
|
53
240
|
url: Joi.string().allow(""),
|
|
54
241
|
});
|
|
55
242
|
}
|
|
243
|
+
|
|
244
|
+
/** @returns {OrderDiscountRequest} */
|
|
56
245
|
static OrderDiscountRequest() {
|
|
57
246
|
return Joi.object({
|
|
58
247
|
currency: Joi.string().allow(""),
|
|
59
248
|
order_amount: Joi.number().required(),
|
|
60
249
|
});
|
|
61
250
|
}
|
|
251
|
+
|
|
252
|
+
/** @returns {OrderDiscountResponse} */
|
|
62
253
|
static OrderDiscountResponse() {
|
|
63
254
|
return Joi.object({
|
|
64
|
-
applied_rule_bucket:
|
|
65
|
-
base_discount:
|
|
66
|
-
discount:
|
|
255
|
+
applied_rule_bucket: RewardsApplicationModel.OrderDiscountRuleBucket(),
|
|
256
|
+
base_discount: RewardsApplicationModel.DiscountProperties(),
|
|
257
|
+
discount: RewardsApplicationModel.DiscountProperties(),
|
|
67
258
|
order_amount: Joi.number(),
|
|
68
259
|
points: Joi.number(),
|
|
69
260
|
});
|
|
70
261
|
}
|
|
262
|
+
|
|
263
|
+
/** @returns {OrderDiscountRuleBucket} */
|
|
71
264
|
static OrderDiscountRuleBucket() {
|
|
72
265
|
return Joi.object({
|
|
73
266
|
high: Joi.number(),
|
|
@@ -77,6 +270,8 @@ class RewardsModel {
|
|
|
77
270
|
value_type: Joi.string().allow(""),
|
|
78
271
|
});
|
|
79
272
|
}
|
|
273
|
+
|
|
274
|
+
/** @returns {Page} */
|
|
80
275
|
static Page() {
|
|
81
276
|
return Joi.object({
|
|
82
277
|
current: Joi.number(),
|
|
@@ -88,6 +283,8 @@ class RewardsModel {
|
|
|
88
283
|
type: Joi.string().allow("").required(),
|
|
89
284
|
});
|
|
90
285
|
}
|
|
286
|
+
|
|
287
|
+
/** @returns {PointsHistory} */
|
|
91
288
|
static PointsHistory() {
|
|
92
289
|
return Joi.object({
|
|
93
290
|
_id: Joi.string().allow(""),
|
|
@@ -106,23 +303,31 @@ class RewardsModel {
|
|
|
106
303
|
user_id: Joi.string().allow(""),
|
|
107
304
|
});
|
|
108
305
|
}
|
|
306
|
+
|
|
307
|
+
/** @returns {PointsHistoryResponse} */
|
|
109
308
|
static PointsHistoryResponse() {
|
|
110
309
|
return Joi.object({
|
|
111
|
-
items: Joi.array().items(
|
|
112
|
-
page:
|
|
310
|
+
items: Joi.array().items(RewardsApplicationModel.PointsHistory()),
|
|
311
|
+
page: RewardsApplicationModel.Page(),
|
|
113
312
|
});
|
|
114
313
|
}
|
|
314
|
+
|
|
315
|
+
/** @returns {PointsResponse} */
|
|
115
316
|
static PointsResponse() {
|
|
116
317
|
return Joi.object({
|
|
117
318
|
points: Joi.number(),
|
|
118
319
|
});
|
|
119
320
|
}
|
|
321
|
+
|
|
322
|
+
/** @returns {RedeemReferralCodeRequest} */
|
|
120
323
|
static RedeemReferralCodeRequest() {
|
|
121
324
|
return Joi.object({
|
|
122
325
|
device_id: Joi.string().allow(""),
|
|
123
326
|
referral_code: Joi.string().allow(""),
|
|
124
327
|
});
|
|
125
328
|
}
|
|
329
|
+
|
|
330
|
+
/** @returns {RedeemReferralCodeResponse} */
|
|
126
331
|
static RedeemReferralCodeResponse() {
|
|
127
332
|
return Joi.object({
|
|
128
333
|
message: Joi.string().allow(""),
|
|
@@ -132,15 +337,19 @@ class RewardsModel {
|
|
|
132
337
|
referrer_info: Joi.string().allow(""),
|
|
133
338
|
});
|
|
134
339
|
}
|
|
340
|
+
|
|
341
|
+
/** @returns {ReferralDetailsResponse} */
|
|
135
342
|
static ReferralDetailsResponse() {
|
|
136
343
|
return Joi.object({
|
|
137
|
-
referral:
|
|
344
|
+
referral: RewardsApplicationModel.Offer(),
|
|
138
345
|
referrer_info: Joi.string().allow(""),
|
|
139
|
-
share:
|
|
346
|
+
share: RewardsApplicationModel.ShareMessages(),
|
|
140
347
|
terms_conditions_link: Joi.string().allow(""),
|
|
141
|
-
user:
|
|
348
|
+
user: RewardsApplicationModel.ReferralDetailsUser(),
|
|
142
349
|
});
|
|
143
350
|
}
|
|
351
|
+
|
|
352
|
+
/** @returns {ReferralDetailsUser} */
|
|
144
353
|
static ReferralDetailsUser() {
|
|
145
354
|
return Joi.object({
|
|
146
355
|
blocked: Joi.boolean(),
|
|
@@ -149,6 +358,8 @@ class RewardsModel {
|
|
|
149
358
|
referral_code: Joi.string().allow(""),
|
|
150
359
|
});
|
|
151
360
|
}
|
|
361
|
+
|
|
362
|
+
/** @returns {RewardsArticle} */
|
|
152
363
|
static RewardsArticle() {
|
|
153
364
|
return Joi.object({
|
|
154
365
|
id: Joi.string().allow(""),
|
|
@@ -156,6 +367,8 @@ class RewardsModel {
|
|
|
156
367
|
price: Joi.number(),
|
|
157
368
|
});
|
|
158
369
|
}
|
|
370
|
+
|
|
371
|
+
/** @returns {Schedule} */
|
|
159
372
|
static Schedule() {
|
|
160
373
|
return Joi.object({
|
|
161
374
|
cron: Joi.string().allow(""),
|
|
@@ -164,6 +377,8 @@ class RewardsModel {
|
|
|
164
377
|
start: Joi.string().allow(""),
|
|
165
378
|
});
|
|
166
379
|
}
|
|
380
|
+
|
|
381
|
+
/** @returns {ShareMessages} */
|
|
167
382
|
static ShareMessages() {
|
|
168
383
|
return Joi.object({
|
|
169
384
|
email: Joi.number(),
|
|
@@ -178,4 +393,4 @@ class RewardsModel {
|
|
|
178
393
|
});
|
|
179
394
|
}
|
|
180
395
|
}
|
|
181
|
-
module.exports =
|
|
396
|
+
module.exports = RewardsApplicationModel;
|
|
@@ -1,10 +1,73 @@
|
|
|
1
|
-
export =
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
export = RewardsApplicationValidator;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CatalogueOrderParam
|
|
4
|
+
* @property {RewardsApplicationModel.CatalogueOrderRequest} body
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* @typedef GetOfferByNameParam
|
|
8
|
+
* @property {string} name - The name given to the offer.
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* @typedef GetOrderDiscountParam
|
|
12
|
+
* @property {RewardsApplicationModel.OrderDiscountRequest} body
|
|
13
|
+
*/
|
|
14
|
+
/** @typedef GetUserPointsParam */
|
|
15
|
+
/**
|
|
16
|
+
* @typedef GetUserPointsHistoryParam
|
|
17
|
+
* @property {string} [pageId] - PageID is the ID of the requested page. For
|
|
18
|
+
* first request it should be kept empty.
|
|
19
|
+
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
20
|
+
*/
|
|
21
|
+
/** @typedef GetUserReferralDetailsParam */
|
|
22
|
+
/**
|
|
23
|
+
* @typedef RedeemReferralCodeParam
|
|
24
|
+
* @property {RewardsApplicationModel.RedeemReferralCodeRequest} body
|
|
25
|
+
*/
|
|
26
|
+
declare class RewardsApplicationValidator {
|
|
27
|
+
/** @returns {CatalogueOrderParam} */
|
|
28
|
+
static catalogueOrder(): CatalogueOrderParam;
|
|
29
|
+
/** @returns {GetOfferByNameParam} */
|
|
30
|
+
static getOfferByName(): GetOfferByNameParam;
|
|
31
|
+
/** @returns {GetOrderDiscountParam} */
|
|
32
|
+
static getOrderDiscount(): GetOrderDiscountParam;
|
|
33
|
+
/** @returns {GetUserPointsParam} */
|
|
6
34
|
static getUserPoints(): any;
|
|
7
|
-
|
|
35
|
+
/** @returns {GetUserPointsHistoryParam} */
|
|
36
|
+
static getUserPointsHistory(): GetUserPointsHistoryParam;
|
|
37
|
+
/** @returns {GetUserReferralDetailsParam} */
|
|
8
38
|
static getUserReferralDetails(): any;
|
|
9
|
-
|
|
39
|
+
/** @returns {RedeemReferralCodeParam} */
|
|
40
|
+
static redeemReferralCode(): RedeemReferralCodeParam;
|
|
10
41
|
}
|
|
42
|
+
declare namespace RewardsApplicationValidator {
|
|
43
|
+
export { CatalogueOrderParam, GetOfferByNameParam, GetOrderDiscountParam, GetUserPointsParam, GetUserPointsHistoryParam, GetUserReferralDetailsParam, RedeemReferralCodeParam };
|
|
44
|
+
}
|
|
45
|
+
type CatalogueOrderParam = {
|
|
46
|
+
body: RewardsApplicationModel.CatalogueOrderRequest;
|
|
47
|
+
};
|
|
48
|
+
type GetOfferByNameParam = {
|
|
49
|
+
/**
|
|
50
|
+
* - The name given to the offer.
|
|
51
|
+
*/
|
|
52
|
+
name: string;
|
|
53
|
+
};
|
|
54
|
+
type GetOrderDiscountParam = {
|
|
55
|
+
body: RewardsApplicationModel.OrderDiscountRequest;
|
|
56
|
+
};
|
|
57
|
+
type GetUserPointsHistoryParam = {
|
|
58
|
+
/**
|
|
59
|
+
* - PageID is the ID of the requested page. For
|
|
60
|
+
* first request it should be kept empty.
|
|
61
|
+
*/
|
|
62
|
+
pageId?: string;
|
|
63
|
+
/**
|
|
64
|
+
* - The number of items to retrieve in each page.
|
|
65
|
+
*/
|
|
66
|
+
pageSize?: number;
|
|
67
|
+
};
|
|
68
|
+
type RedeemReferralCodeParam = {
|
|
69
|
+
body: RewardsApplicationModel.RedeemReferralCodeRequest;
|
|
70
|
+
};
|
|
71
|
+
type GetUserPointsParam = any;
|
|
72
|
+
type GetUserReferralDetailsParam = any;
|
|
73
|
+
import RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
@@ -1,29 +1,66 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
-
const
|
|
4
|
-
|
|
3
|
+
const RewardsApplicationModel = require("./RewardsApplicationModel");
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* @typedef CatalogueOrderParam
|
|
7
|
+
* @property {RewardsApplicationModel.CatalogueOrderRequest} body
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* @typedef GetOfferByNameParam
|
|
12
|
+
* @property {string} name - The name given to the offer.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @typedef GetOrderDiscountParam
|
|
17
|
+
* @property {RewardsApplicationModel.OrderDiscountRequest} body
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
/** @typedef GetUserPointsParam */
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* @typedef GetUserPointsHistoryParam
|
|
24
|
+
* @property {string} [pageId] - PageID is the ID of the requested page. For
|
|
25
|
+
* first request it should be kept empty.
|
|
26
|
+
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
/** @typedef GetUserReferralDetailsParam */
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* @typedef RedeemReferralCodeParam
|
|
33
|
+
* @property {RewardsApplicationModel.RedeemReferralCodeRequest} body
|
|
34
|
+
*/
|
|
35
|
+
|
|
36
|
+
class RewardsApplicationValidator {
|
|
37
|
+
/** @returns {CatalogueOrderParam} */
|
|
5
38
|
static catalogueOrder() {
|
|
6
39
|
return Joi.object({
|
|
7
|
-
body:
|
|
40
|
+
body: RewardsApplicationModel.CatalogueOrderRequest().required(),
|
|
8
41
|
}).required();
|
|
9
42
|
}
|
|
10
43
|
|
|
44
|
+
/** @returns {GetOfferByNameParam} */
|
|
11
45
|
static getOfferByName() {
|
|
12
46
|
return Joi.object({
|
|
13
47
|
name: Joi.string().allow("").required(),
|
|
14
48
|
}).required();
|
|
15
49
|
}
|
|
16
50
|
|
|
51
|
+
/** @returns {GetOrderDiscountParam} */
|
|
17
52
|
static getOrderDiscount() {
|
|
18
53
|
return Joi.object({
|
|
19
|
-
body:
|
|
54
|
+
body: RewardsApplicationModel.OrderDiscountRequest().required(),
|
|
20
55
|
}).required();
|
|
21
56
|
}
|
|
22
57
|
|
|
58
|
+
/** @returns {GetUserPointsParam} */
|
|
23
59
|
static getUserPoints() {
|
|
24
60
|
return Joi.object({});
|
|
25
61
|
}
|
|
26
62
|
|
|
63
|
+
/** @returns {GetUserPointsHistoryParam} */
|
|
27
64
|
static getUserPointsHistory() {
|
|
28
65
|
return Joi.object({
|
|
29
66
|
pageId: Joi.string().allow(""),
|
|
@@ -31,15 +68,17 @@ class RewardsValidator {
|
|
|
31
68
|
});
|
|
32
69
|
}
|
|
33
70
|
|
|
71
|
+
/** @returns {GetUserReferralDetailsParam} */
|
|
34
72
|
static getUserReferralDetails() {
|
|
35
73
|
return Joi.object({});
|
|
36
74
|
}
|
|
37
75
|
|
|
76
|
+
/** @returns {RedeemReferralCodeParam} */
|
|
38
77
|
static redeemReferralCode() {
|
|
39
78
|
return Joi.object({
|
|
40
|
-
body:
|
|
79
|
+
body: RewardsApplicationModel.RedeemReferralCodeRequest().required(),
|
|
41
80
|
}).required();
|
|
42
81
|
}
|
|
43
82
|
}
|
|
44
83
|
|
|
45
|
-
module.exports =
|
|
84
|
+
module.exports = RewardsApplicationValidator;
|
|
@@ -14,74 +14,68 @@ declare class Share {
|
|
|
14
14
|
_urls: {};
|
|
15
15
|
updateUrls(urls: any): void;
|
|
16
16
|
/**
|
|
17
|
-
* @param {
|
|
18
|
-
* @param {
|
|
19
|
-
* @returns {Promise<ShortLinkRes>} - Success response
|
|
17
|
+
* @param {ShareApplicationValidator.CreateShortLinkParam} arg - Arg object.
|
|
18
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
19
|
+
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
20
|
+
* @name createShortLink
|
|
20
21
|
* @summary: Create a short link
|
|
21
|
-
* @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
|
|
22
|
+
* @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/createShortLink/).
|
|
22
23
|
*/
|
|
23
|
-
createShortLink({ body }?: {
|
|
24
|
-
body: ShortLinkReq;
|
|
25
|
-
}): Promise<ShortLinkRes>;
|
|
24
|
+
createShortLink({ body }?: ShareApplicationValidator.CreateShortLinkParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
26
25
|
/**
|
|
27
|
-
* @param {
|
|
28
|
-
* @returns {Promise<QRCodeResp>} - Success response
|
|
26
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
27
|
+
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
28
|
+
* @name getApplicationQRCode
|
|
29
29
|
* @summary: Create QR Code of an app
|
|
30
|
-
* @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
|
|
30
|
+
* @description: Use this API to create a QR code of an app for sharing it with users who want to use the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getApplicationQRCode/).
|
|
31
31
|
*/
|
|
32
|
-
getApplicationQRCode({}?:
|
|
32
|
+
getApplicationQRCode({ headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.QRCodeResp>;
|
|
33
33
|
/**
|
|
34
|
-
* @param {
|
|
35
|
-
* @param {
|
|
36
|
-
*
|
|
37
|
-
* @
|
|
34
|
+
* @param {ShareApplicationValidator.GetCollectionQRCodeBySlugParam} arg - Arg object.
|
|
35
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
36
|
+
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
37
|
+
* @name getCollectionQRCodeBySlug
|
|
38
38
|
* @summary: Create QR Code of a collection
|
|
39
|
-
* @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection.
|
|
39
|
+
* @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getCollectionQRCodeBySlug/).
|
|
40
40
|
*/
|
|
41
|
-
getCollectionQRCodeBySlug({ slug }?: {
|
|
42
|
-
slug: string;
|
|
43
|
-
}): Promise<QRCodeResp>;
|
|
41
|
+
getCollectionQRCodeBySlug({ slug }?: ShareApplicationValidator.GetCollectionQRCodeBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.QRCodeResp>;
|
|
44
42
|
/**
|
|
45
|
-
* @param {
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* @returns {Promise<ShortLinkRes>} - Success response
|
|
43
|
+
* @param {ShareApplicationValidator.GetOriginalShortLinkByHashParam} arg -
|
|
44
|
+
* Arg object.
|
|
45
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
46
|
+
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
47
|
+
* @name getOriginalShortLinkByHash
|
|
49
48
|
* @summary: Get original link by hash
|
|
50
|
-
* @description: Use this API to retrieve the original link from a short-link by using a hash value.
|
|
49
|
+
* @description: Use this API to retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getOriginalShortLinkByHash/).
|
|
51
50
|
*/
|
|
52
|
-
getOriginalShortLinkByHash({ hash }?: {
|
|
53
|
-
hash: string;
|
|
54
|
-
}): Promise<ShortLinkRes>;
|
|
51
|
+
getOriginalShortLinkByHash({ hash }?: ShareApplicationValidator.GetOriginalShortLinkByHashParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
55
52
|
/**
|
|
56
|
-
* @param {
|
|
57
|
-
* @param {
|
|
58
|
-
*
|
|
59
|
-
* @
|
|
53
|
+
* @param {ShareApplicationValidator.GetProductQRCodeBySlugParam} arg - Arg object.
|
|
54
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
|
+
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
56
|
+
* @name getProductQRCodeBySlug
|
|
60
57
|
* @summary: Create QR Code of a product
|
|
61
|
-
* @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
|
|
58
|
+
* @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getProductQRCodeBySlug/).
|
|
62
59
|
*/
|
|
63
|
-
getProductQRCodeBySlug({ slug }?: {
|
|
64
|
-
slug: string;
|
|
65
|
-
}): Promise<QRCodeResp>;
|
|
60
|
+
getProductQRCodeBySlug({ slug }?: ShareApplicationValidator.GetProductQRCodeBySlugParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.QRCodeResp>;
|
|
66
61
|
/**
|
|
67
|
-
* @param {
|
|
68
|
-
* @param {
|
|
69
|
-
*
|
|
70
|
-
* @
|
|
62
|
+
* @param {ShareApplicationValidator.GetShortLinkByHashParam} arg - Arg object.
|
|
63
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
|
+
* @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
|
|
65
|
+
* @name getShortLinkByHash
|
|
71
66
|
* @summary: Get short link by hash
|
|
72
|
-
* @description: Use this API to get a short link by using a hash value.
|
|
67
|
+
* @description: Use this API to get a short link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
|
|
73
68
|
*/
|
|
74
|
-
getShortLinkByHash({ hash }?: {
|
|
75
|
-
hash: string;
|
|
76
|
-
}): Promise<ShortLinkRes>;
|
|
69
|
+
getShortLinkByHash({ hash }?: ShareApplicationValidator.GetShortLinkByHashParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.ShortLinkRes>;
|
|
77
70
|
/**
|
|
78
|
-
* @param {
|
|
79
|
-
* @param {
|
|
80
|
-
* @returns {Promise<QRCodeResp>} - Success response
|
|
71
|
+
* @param {ShareApplicationValidator.GetUrlQRCodeParam} arg - Arg object.
|
|
72
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
73
|
+
* @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
|
|
74
|
+
* @name getUrlQRCode
|
|
81
75
|
* @summary: Create QR Code of a URL
|
|
82
|
-
* @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
|
|
76
|
+
* @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
|
|
83
77
|
*/
|
|
84
|
-
getUrlQRCode({ url }?: {
|
|
85
|
-
url: string;
|
|
86
|
-
}): Promise<QRCodeResp>;
|
|
78
|
+
getUrlQRCode({ url }?: ShareApplicationValidator.GetUrlQRCodeParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<ShareApplicationModel.QRCodeResp>;
|
|
87
79
|
}
|
|
80
|
+
import ShareApplicationValidator = require("./ShareApplicationValidator");
|
|
81
|
+
import ShareApplicationModel = require("./ShareApplicationModel");
|