@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,111 +1,2454 @@
|
|
|
1
|
-
export =
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
1
|
+
export = ConfigurationApplicationModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef Android
|
|
4
|
+
* @property {string} [api_key] - Firebase secret credential API key for Android
|
|
5
|
+
* @property {string} [application_id] - Alphanumeric ID allotted to a sales
|
|
6
|
+
* channel application created within a business account
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* @typedef AppCurrencyResponse
|
|
10
|
+
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
11
|
+
* (sales channel website) created within a business account
|
|
12
|
+
* @property {DefaultCurrency} [default_currency]
|
|
13
|
+
* @property {Currency[]} [supported_currency]
|
|
14
|
+
*/
|
|
15
|
+
/**
|
|
16
|
+
* @typedef AppFeature
|
|
17
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero
|
|
18
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
19
|
+
* for the sales channel features
|
|
20
|
+
* @property {string} [app] - Application ID of the sales channel
|
|
21
|
+
* @property {CartFeature} [cart]
|
|
22
|
+
* @property {CommonFeature} [common]
|
|
23
|
+
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
24
|
+
* the features were configured
|
|
25
|
+
* @property {HomePageFeature} [home_page]
|
|
26
|
+
* @property {LandingPageFeature} [landing_page]
|
|
27
|
+
* @property {OrderFeature} [order]
|
|
28
|
+
* @property {PcrFeature} [pcr]
|
|
29
|
+
* @property {ProductDetailFeature} [product_detail]
|
|
30
|
+
* @property {QrFeature} [qr]
|
|
31
|
+
* @property {RegistrationPageFeature} [registration_page]
|
|
32
|
+
* @property {string} [updated_at] - ISO 8601 timestamp of last known
|
|
33
|
+
* modifications to the sales channel feature configuration
|
|
34
|
+
*/
|
|
35
|
+
/**
|
|
36
|
+
* @typedef AppFeatureRequest
|
|
37
|
+
* @property {AppFeature} [feature]
|
|
38
|
+
*/
|
|
39
|
+
/**
|
|
40
|
+
* @typedef AppFeatureResponse
|
|
41
|
+
* @property {AppFeature} [feature]
|
|
42
|
+
*/
|
|
43
|
+
/**
|
|
44
|
+
* @typedef Application
|
|
45
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
46
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
47
|
+
* of the sales channel
|
|
48
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
49
|
+
* @property {ApplicationAuth} [auth]
|
|
50
|
+
* @property {SecureUrl} [banner]
|
|
51
|
+
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
52
|
+
* of seconds until the key expires
|
|
53
|
+
* @property {string} [channel_type] - It indicates different channel types like
|
|
54
|
+
* store, website-and-mobile-apps. Default value is store
|
|
55
|
+
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
56
|
+
* where the sales channel exists
|
|
57
|
+
* @property {ApplicationCors} [cors]
|
|
58
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
59
|
+
* @property {string} [description] - It contains detailed information about the
|
|
60
|
+
* sales channel.
|
|
61
|
+
* @property {Domain} [domain]
|
|
62
|
+
* @property {Domain[]} [domains]
|
|
63
|
+
* @property {SecureUrl} [favicon]
|
|
64
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
65
|
+
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
66
|
+
* internal or not
|
|
67
|
+
* @property {SecureUrl} [logo]
|
|
68
|
+
* @property {ApplicationMeta[]} [meta]
|
|
69
|
+
* @property {SecureUrl} [mobile_logo]
|
|
70
|
+
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
71
|
+
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
72
|
+
* of owner who owns the application
|
|
73
|
+
* @property {ApplicationRedirections[]} [redirections]
|
|
74
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
75
|
+
* channel. It is required and auto-generated.
|
|
76
|
+
* @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
|
|
77
|
+
* @property {ApplicationWebsite} [website]
|
|
78
|
+
*/
|
|
79
|
+
/**
|
|
80
|
+
* @typedef ApplicationAboutResponse
|
|
81
|
+
* @property {ApplicationInfo} [application_info]
|
|
82
|
+
* @property {CompanyInfo} [company_info]
|
|
83
|
+
* @property {OwnerInfo} [owner_info]
|
|
84
|
+
*/
|
|
85
|
+
/**
|
|
86
|
+
* @typedef ApplicationAuth
|
|
87
|
+
* @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
|
|
88
|
+
*/
|
|
89
|
+
/**
|
|
90
|
+
* @typedef ApplicationCors
|
|
91
|
+
* @property {string[]} [domains]
|
|
92
|
+
*/
|
|
93
|
+
/**
|
|
94
|
+
* @typedef ApplicationDetail
|
|
95
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
96
|
+
* for the sales channel details
|
|
97
|
+
* @property {SecureUrl} [banner]
|
|
98
|
+
* @property {string} [description] - It gives a detailed information about the
|
|
99
|
+
* sales channel. It is required.
|
|
100
|
+
* @property {Domain} [domain]
|
|
101
|
+
* @property {Domain[]} [domains]
|
|
102
|
+
* @property {SecureUrl} [favicon]
|
|
103
|
+
* @property {SecureUrl} [logo]
|
|
104
|
+
* @property {SecureUrl} [mobile_logo]
|
|
105
|
+
* @property {string} name - Name of the sales channel. It is required.
|
|
106
|
+
*/
|
|
107
|
+
/**
|
|
108
|
+
* @typedef ApplicationInfo
|
|
109
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
110
|
+
* of application information
|
|
111
|
+
* @property {SecureUrl} [banner]
|
|
112
|
+
* @property {ApplicationCors} [cors]
|
|
113
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel
|
|
114
|
+
* information creation
|
|
115
|
+
* @property {string} [description] - It contains details information about the
|
|
116
|
+
* sales channel
|
|
117
|
+
* @property {Domain} [domain]
|
|
118
|
+
* @property {boolean} [is_active] - Indicates whether sales channel is active
|
|
119
|
+
* or not active
|
|
120
|
+
* @property {SecureUrl} [logo]
|
|
121
|
+
* @property {ApplicationMeta} [meta]
|
|
122
|
+
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
123
|
+
* @property {string} [secret] - Random generated fix length string for sales
|
|
124
|
+
* channel. It is required and auto-generated.
|
|
125
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
126
|
+
* channel. It is required and auto-generated.
|
|
127
|
+
* @property {ApplicationWebsite} [website]
|
|
128
|
+
*/
|
|
129
|
+
/**
|
|
130
|
+
* @typedef ApplicationInformation
|
|
131
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
132
|
+
* @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
|
|
133
|
+
* the application information
|
|
134
|
+
* @property {InformationAddress} [address]
|
|
135
|
+
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
136
|
+
* channel application created within a business account
|
|
137
|
+
* @property {BusinessHighlights} [business_highlights]
|
|
138
|
+
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
139
|
+
* site's footer
|
|
140
|
+
* @property {string} [created_at] - ISO 8601 timestamp of creation of the
|
|
141
|
+
* application information
|
|
142
|
+
* @property {Links} [links]
|
|
143
|
+
* @property {SocialLinks} [social_links]
|
|
144
|
+
* @property {InformationSupport} [support]
|
|
145
|
+
* @property {string} [updated_at] - ISO 8601 timestamp of updation of the
|
|
146
|
+
* application information
|
|
147
|
+
*/
|
|
148
|
+
/**
|
|
149
|
+
* @typedef ApplicationMeta
|
|
150
|
+
* @property {string} [name] - Indicates to name of application meta
|
|
151
|
+
* @property {string} [value] - Value related to application meta name
|
|
152
|
+
*/
|
|
153
|
+
/**
|
|
154
|
+
* @typedef ApplicationRedirections
|
|
155
|
+
* @property {string} [redirect_from] - Old domain url of the sales channel
|
|
156
|
+
* @property {string} [redirect_to] - New domain URL of the sales channel. Users
|
|
157
|
+
* will be automatically redirected from old domain to new domain.
|
|
158
|
+
* @property {string} [type] - It shows domain redirection type. Permanent
|
|
159
|
+
* redirection is for long time period redirection, and temporary redirection
|
|
160
|
+
* for a short time period.
|
|
161
|
+
*/
|
|
162
|
+
/**
|
|
163
|
+
* @typedef ApplicationVersionRequest
|
|
164
|
+
* @property {string} [id]
|
|
165
|
+
* @property {string} name
|
|
166
|
+
* @property {string} [namespace]
|
|
167
|
+
* @property {string} [token]
|
|
168
|
+
* @property {string} version
|
|
169
|
+
*/
|
|
170
|
+
/**
|
|
171
|
+
* @typedef ApplicationWebsite
|
|
172
|
+
* @property {string} [basepath] - Base path for the current sales channel website
|
|
173
|
+
* @property {boolean} [enabled] - Shows whether sales channel website URL is
|
|
174
|
+
* enabled or not
|
|
175
|
+
*/
|
|
176
|
+
/**
|
|
177
|
+
* @typedef AppStaff
|
|
178
|
+
* @property {string} [_id] - The unique identifier for the sales channel staff member
|
|
179
|
+
* @property {string} [application] - The unique identifier (24-digit Mongo
|
|
180
|
+
* Object ID) of the current sales channel
|
|
181
|
+
* @property {string} [employee_code] - Employee code of sales channel staff
|
|
182
|
+
* member. It has unique value.
|
|
183
|
+
* @property {string} [first_name] - First name the staff member
|
|
184
|
+
* @property {string} [last_name] - Last name the staff member
|
|
185
|
+
* @property {boolean} [order_incent] - This is a boolean value. `true` to
|
|
186
|
+
* retrieve the staff members eligible for getting incentives on orders.
|
|
187
|
+
* @property {string} [profile_pic_url] - Profile image hosted url of the staff member
|
|
188
|
+
* @property {number[]} [stores]
|
|
189
|
+
* @property {string} [title] - Tittle for the staff member like owner, staff.
|
|
190
|
+
* @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
|
|
191
|
+
* details of a particular staff member.
|
|
192
|
+
*/
|
|
193
|
+
/**
|
|
194
|
+
* @typedef AppStaffListResponse
|
|
195
|
+
* @property {AppStaff[]} [items]
|
|
196
|
+
* @property {Page} [page]
|
|
197
|
+
*/
|
|
198
|
+
/**
|
|
199
|
+
* @typedef AppStaffResponse
|
|
200
|
+
* @property {AppStaff[]} [staff_users]
|
|
201
|
+
*/
|
|
202
|
+
/**
|
|
203
|
+
* @typedef AppTokenResponse
|
|
204
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
205
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
206
|
+
* of the token
|
|
207
|
+
* @property {string} [application] - Alphanumeric ID allotted to the current
|
|
208
|
+
* application created within the current business account
|
|
209
|
+
* @property {string} [created_at] - ISO 8601 timestamp of token creation
|
|
210
|
+
* @property {Tokens} [tokens]
|
|
211
|
+
* @property {string} [updated_at] - ISO 8601 timestamp of token updation
|
|
212
|
+
*/
|
|
213
|
+
/**
|
|
214
|
+
* @typedef AppVersionRequest
|
|
215
|
+
* @property {ApplicationVersionRequest} application
|
|
216
|
+
* @property {Device} device
|
|
217
|
+
* @property {string} [locale]
|
|
218
|
+
* @property {string} [timezone]
|
|
219
|
+
*/
|
|
220
|
+
/**
|
|
221
|
+
* @typedef ArticleAssignmentRule
|
|
222
|
+
* @property {StorePriorityRule} [store_priority]
|
|
223
|
+
*/
|
|
224
|
+
/**
|
|
225
|
+
* @typedef BlogLink
|
|
226
|
+
* @property {string} [icon] - Hosted URL of icon image shown on the website
|
|
227
|
+
* @property {string} [link] - Web URL of brand's blog page
|
|
228
|
+
* @property {string} [title] - Name of the brand's blog page
|
|
229
|
+
*/
|
|
230
|
+
/**
|
|
231
|
+
* @typedef BusinessHighlights
|
|
232
|
+
* @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
|
|
233
|
+
* the related business
|
|
234
|
+
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
235
|
+
* business highlight
|
|
236
|
+
* @property {string} [sub_title] - Detailed information about the highlight
|
|
237
|
+
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
|
|
238
|
+
*/
|
|
239
|
+
/**
|
|
240
|
+
* @typedef CartFeature
|
|
241
|
+
* @property {boolean} [google_map] - Allow adding of Google Maps. Default value is true.
|
|
242
|
+
* @property {boolean} [gst_input] - Shows whether customer is allowed to enter
|
|
243
|
+
* GST on the cart page for claiming input credits
|
|
244
|
+
* @property {boolean} [placing_for_customer] - Shows whether the staff is
|
|
245
|
+
* placing order on behalf of customer. Default value is true.
|
|
246
|
+
* @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits,
|
|
247
|
+
* together. Default value is false.
|
|
248
|
+
* @property {boolean} [staff_selection] - Shows whether staff selection is
|
|
249
|
+
* enabled on cart page
|
|
250
|
+
*/
|
|
251
|
+
/**
|
|
252
|
+
* @typedef CommonFeature
|
|
253
|
+
* @property {CommunicationOptinDialogFeature} [communication_optin_dialog]
|
|
254
|
+
* @property {CompareProductsFeature} [compare_products]
|
|
255
|
+
* @property {CurrencyFeature} [currency]
|
|
256
|
+
* @property {DeploymentStoreSelectionFeature} [deployment_store_selection]
|
|
257
|
+
* @property {FeedbackFeature} [feedback]
|
|
258
|
+
* @property {ListingPriceFeature} [listing_price]
|
|
259
|
+
* @property {RevenueEngineFeature} [revenue_engine]
|
|
260
|
+
* @property {RewardPointsConfig} [reward_points]
|
|
261
|
+
*/
|
|
262
|
+
/**
|
|
263
|
+
* @typedef CommunicationOptinDialogFeature
|
|
264
|
+
* @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled
|
|
265
|
+
*/
|
|
266
|
+
/**
|
|
267
|
+
* @typedef CompanyAboutAddress
|
|
268
|
+
* @property {string} [address_type] - Indicates different office types like
|
|
269
|
+
* office, registered, and home.
|
|
270
|
+
* @property {string} [address1] - Primary address line of the company
|
|
271
|
+
* @property {string} [address2] - Secondary address line of the company
|
|
272
|
+
* @property {string} [city] - City name, e.g. Mumbai
|
|
273
|
+
* @property {string} [country] - Country name, e.g. India
|
|
274
|
+
* @property {number} [pincode] - 6-digit PIN code of the city, e.g. 400001
|
|
275
|
+
* @property {string} [state] - State name, e.g. Maharashtra
|
|
276
|
+
*/
|
|
277
|
+
/**
|
|
278
|
+
* @typedef CompanyInfo
|
|
279
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
280
|
+
* of company information
|
|
281
|
+
* @property {CompanyAboutAddress[]} [addresses]
|
|
282
|
+
* @property {string} [created_on] - ISO 8601 timestamp of company information creation
|
|
283
|
+
* @property {boolean} [is_active] - Indicates company is active or not active
|
|
284
|
+
* @property {string} [name] - Name of the company, Reliance Retail Limited
|
|
285
|
+
* @property {string[]} [notification_emails]
|
|
286
|
+
* @property {number} [uid] - Company UID
|
|
287
|
+
*/
|
|
288
|
+
/**
|
|
289
|
+
* @typedef CompareProductsFeature
|
|
290
|
+
* @property {boolean} [enabled] - Shows whether product comparison feature is
|
|
291
|
+
* enabled on PDP
|
|
292
|
+
*/
|
|
293
|
+
/**
|
|
294
|
+
* @typedef Credentials
|
|
295
|
+
* @property {Android} [android]
|
|
296
|
+
* @property {string} [api_key] - An API key is a unique string that's used to
|
|
297
|
+
* route requests to your Firebase project when interacting with Firebase.
|
|
298
|
+
* @property {string} [application_id] - Alphanumeric ID allotted to the current
|
|
299
|
+
* application created within the current business account
|
|
300
|
+
* @property {string} [gcm_sender_id] - Google Cloud Manager's Sender ID for
|
|
301
|
+
* Firebase. It is a unique numerical value which is created when you
|
|
302
|
+
* configure your project in the Google Developers Console/Google Cloud Console.
|
|
303
|
+
* @property {Ios} [ios]
|
|
304
|
+
* @property {string} [project_id] - Project ID for Firebase integration.
|
|
305
|
+
* Project ID is a unique identifier for a project and is used only within the console.
|
|
306
|
+
*/
|
|
307
|
+
/**
|
|
308
|
+
* @typedef Credit
|
|
309
|
+
* @property {boolean} [enabled] - Shows whether reward points should be credited
|
|
310
|
+
*/
|
|
311
|
+
/**
|
|
312
|
+
* @typedef CurrenciesResponse
|
|
313
|
+
* @property {Currency[]} [items]
|
|
314
|
+
*/
|
|
315
|
+
/**
|
|
316
|
+
* @typedef Currency
|
|
317
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
318
|
+
* of the current sales channel supported currency
|
|
319
|
+
* @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
|
|
320
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel support
|
|
321
|
+
* currency creation
|
|
322
|
+
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
323
|
+
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
324
|
+
* value of a currency.
|
|
325
|
+
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
326
|
+
* sales channel
|
|
327
|
+
* @property {string} [name] - Name of the currency, e.g Indian Rupee
|
|
328
|
+
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
|
|
329
|
+
* @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
|
|
330
|
+
* currency updation
|
|
331
|
+
*/
|
|
332
|
+
/**
|
|
333
|
+
* @typedef CurrencyFeature
|
|
334
|
+
* @property {string} [default_currency] - 3-letter code of the default currency
|
|
335
|
+
* used in the application. Default vaule is 'INR'.
|
|
336
|
+
* @property {string} [type] - If 'explicit', currency formatting shows currency
|
|
337
|
+
* code with price. For explicit or all currency selection.
|
|
338
|
+
* @property {string[]} [value] - 3-letter currency code
|
|
339
|
+
*/
|
|
340
|
+
/**
|
|
341
|
+
* @typedef Debit
|
|
342
|
+
* @property {boolean} [auto_apply] - Allow automatic debit of reward points
|
|
343
|
+
* @property {boolean} [enabled] - Shows whether reward points are available for debit
|
|
344
|
+
* @property {string} [strategy_channel] - Strategy channel for debiting reward points
|
|
345
|
+
*/
|
|
346
|
+
/**
|
|
347
|
+
* @typedef DefaultCurrency
|
|
348
|
+
* @property {string} [code] - 3-character code of the default currency, e.g.
|
|
349
|
+
* INR, EUR, USD
|
|
350
|
+
* @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
|
|
351
|
+
* of the default currency
|
|
352
|
+
*/
|
|
353
|
+
/**
|
|
354
|
+
* @typedef DeploymentStoreSelectionFeature
|
|
355
|
+
* @property {boolean} [enabled] - Shows whether selection of store (for
|
|
356
|
+
* deploying the application) is permitted
|
|
357
|
+
* @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
|
|
358
|
+
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
359
|
+
* selection is optional.
|
|
360
|
+
*/
|
|
361
|
+
/**
|
|
362
|
+
* @typedef Device
|
|
363
|
+
* @property {number} [build]
|
|
364
|
+
* @property {string} [model]
|
|
365
|
+
* @property {OS} os
|
|
366
|
+
*/
|
|
367
|
+
/**
|
|
368
|
+
* @typedef Domain
|
|
369
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
370
|
+
* of the sales channel domain
|
|
371
|
+
* @property {boolean} [is_predefined] - Domain is hosting domain or not.
|
|
372
|
+
* @property {boolean} [is_primary] - Domain is primary or not. Primary domain
|
|
373
|
+
* is the default/main domain.
|
|
374
|
+
* @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
|
|
375
|
+
* @property {string} [name]
|
|
376
|
+
* @property {boolean} [verified] - Domain is verified or not. TXT and A records
|
|
377
|
+
* should propagate correctly.
|
|
378
|
+
*/
|
|
379
|
+
/**
|
|
380
|
+
* @typedef FacebookLink
|
|
381
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
382
|
+
* @property {string} [link] - Web URL of brand's Facebook page
|
|
383
|
+
* @property {string} [title] - Name of the social media platform, e.g. Facebook
|
|
384
|
+
*/
|
|
385
|
+
/**
|
|
386
|
+
* @typedef FeedbackFeature
|
|
387
|
+
* @property {boolean} [enabled] - Shows whether customer feedback is enabled on
|
|
388
|
+
* PDP. Default value is false.
|
|
389
|
+
*/
|
|
390
|
+
/**
|
|
391
|
+
* @typedef Firebase
|
|
392
|
+
* @property {Credentials} [credentials]
|
|
393
|
+
* @property {boolean} [enabled] - Shows whether Firebase integration is enabled
|
|
394
|
+
* or disabled for the sales channel
|
|
395
|
+
*/
|
|
396
|
+
/**
|
|
397
|
+
* @typedef Freshchat
|
|
398
|
+
* @property {FreshchatCredentials} [credentials]
|
|
399
|
+
* @property {boolean} [enabled] - Shows whether Freshchat integration is
|
|
400
|
+
* enabled or disabled for the sales channel
|
|
401
|
+
*/
|
|
402
|
+
/**
|
|
403
|
+
* @typedef FreshchatCredentials
|
|
404
|
+
* @property {string} [app_id] - The unique app_id of your Freshchat account for
|
|
405
|
+
* integrating Freshchat with your sales channel
|
|
406
|
+
* @property {string} [app_key] - The unique app_key of your Freshchat account
|
|
407
|
+
* for integrating Freshchat with your sales channel
|
|
408
|
+
* @property {string} [web_token] - Web token used for accessing the Freshchat APIs
|
|
409
|
+
*/
|
|
410
|
+
/**
|
|
411
|
+
* @typedef FyndRewards
|
|
412
|
+
* @property {FyndRewardsCredentials} [credentials]
|
|
413
|
+
*/
|
|
414
|
+
/**
|
|
415
|
+
* @typedef FyndRewardsCredentials
|
|
416
|
+
* @property {string} [public_key] - Public key for integrating with Fynd rewards.
|
|
417
|
+
*/
|
|
418
|
+
/**
|
|
419
|
+
* @typedef GoogleMap
|
|
420
|
+
* @property {GoogleMapCredentials} [credentials]
|
|
421
|
+
*/
|
|
422
|
+
/**
|
|
423
|
+
* @typedef GoogleMapCredentials
|
|
424
|
+
* @property {string} [api_key] - Secret API key for Google Maps. A unique
|
|
425
|
+
* identifier that authenticates requests made to Google Maps API.
|
|
426
|
+
*/
|
|
427
|
+
/**
|
|
428
|
+
* @typedef GooglePlusLink
|
|
429
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
430
|
+
* @property {string} [link] - Web URL of brand's Google+ account
|
|
431
|
+
* @property {string} [title] - Name of the social media platform, e.g. Google+
|
|
432
|
+
*/
|
|
433
|
+
/**
|
|
434
|
+
* @typedef Gtm
|
|
435
|
+
* @property {GtmCredentials} [credentials]
|
|
436
|
+
* @property {boolean} [enabled] - Shows whether GTM integration is enabled or
|
|
437
|
+
* disabled for the sales channel
|
|
438
|
+
*/
|
|
439
|
+
/**
|
|
440
|
+
* @typedef GtmCredentials
|
|
441
|
+
* @property {string} [api_key] - Secret credential API key for GTM
|
|
442
|
+
*/
|
|
443
|
+
/**
|
|
444
|
+
* @typedef HomePageFeature
|
|
445
|
+
* @property {boolean} [order_processing] - Shows whether order processing is
|
|
446
|
+
* enabled or not enabled
|
|
447
|
+
*/
|
|
448
|
+
/**
|
|
449
|
+
* @typedef InformationAddress
|
|
450
|
+
* @property {string[]} [address_line] - Contact address of the sales channel
|
|
451
|
+
* @property {string} [city] - Name of the city, e.g. Mumbai
|
|
452
|
+
* @property {string} [country] - Name of the country, e.g. India
|
|
453
|
+
* @property {string} [loc] - Co-ordinates of the location
|
|
454
|
+
* @property {InformationPhone} [phone]
|
|
455
|
+
* @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001
|
|
456
|
+
*/
|
|
457
|
+
/**
|
|
458
|
+
* @typedef InformationPhone
|
|
459
|
+
* @property {string} [code] - Country code for contact number, e.g. +91 (for India)
|
|
460
|
+
* @property {string} [number] - 10-digit mobile number
|
|
461
|
+
*/
|
|
462
|
+
/**
|
|
463
|
+
* @typedef InformationSupport
|
|
464
|
+
* @property {string[]} [email]
|
|
465
|
+
* @property {string[]} [phone]
|
|
466
|
+
* @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM
|
|
467
|
+
*/
|
|
468
|
+
/**
|
|
469
|
+
* @typedef InstagramLink
|
|
470
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
471
|
+
* @property {string} [link] - Web URL of brand's Instagram page
|
|
472
|
+
* @property {string} [title] - Name of the social media platform, e.g. Instagram
|
|
473
|
+
*/
|
|
474
|
+
/**
|
|
475
|
+
* @typedef InvalidPayloadRequest
|
|
476
|
+
* @property {string} [message] - Error message when request body payload is improper
|
|
477
|
+
*/
|
|
478
|
+
/**
|
|
479
|
+
* @typedef InventoryArticleAssignment
|
|
480
|
+
* @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
|
|
481
|
+
* @property {ArticleAssignmentRule} [rules]
|
|
482
|
+
*/
|
|
483
|
+
/**
|
|
484
|
+
* @typedef InventoryBrandRule
|
|
485
|
+
* @property {number[]} [brands]
|
|
486
|
+
* @property {string} [criteria] - Whether all brands are enabled, or explicitly
|
|
487
|
+
* few brands in the inventory
|
|
488
|
+
*/
|
|
489
|
+
/**
|
|
490
|
+
* @typedef InventoryPaymentConfig
|
|
491
|
+
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
492
|
+
* sales channel. It is required and default value is null.
|
|
493
|
+
* @property {string} [source] - Source of the payment mode for the inventory
|
|
494
|
+
* payment of sales channel. Default value is FYND.
|
|
495
|
+
*/
|
|
496
|
+
/**
|
|
497
|
+
* @typedef InventoryStoreRule
|
|
498
|
+
* @property {string} [criteria] - Whether all stores are enabled, or explicitly
|
|
499
|
+
* few stores in the inventory, or use brands and company filter.
|
|
500
|
+
* @property {StoreCriteriaRule[]} [rules] - List of rules with company and
|
|
501
|
+
* brands uids. Used when critera is `filter`.
|
|
502
|
+
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
503
|
+
*/
|
|
504
|
+
/**
|
|
505
|
+
* @typedef Ios
|
|
506
|
+
* @property {string} [api_key] - Firebase secret credential API key for IOS
|
|
507
|
+
* @property {string} [application_id] - Alphanumeric ID allotted to a sales
|
|
508
|
+
* channel application created within a business account
|
|
509
|
+
*/
|
|
510
|
+
/**
|
|
511
|
+
* @typedef LandingPageFeature
|
|
512
|
+
* @property {boolean} [continue_as_guest] - Shows whether a guest can checkout
|
|
513
|
+
* from cart without logging in
|
|
514
|
+
* @property {LaunchPage} [launch_page]
|
|
515
|
+
* @property {string} [login_btn_text] - Shows the text displayed over the login button
|
|
516
|
+
* @property {boolean} [show_domain_textbox] - Shows whether a textbox for
|
|
517
|
+
* entering domain is available
|
|
518
|
+
* @property {boolean} [show_register_btn] - Shows whether register button is
|
|
519
|
+
* available in the login/landing page
|
|
520
|
+
*/
|
|
521
|
+
/**
|
|
522
|
+
* @typedef LanguageResponse
|
|
523
|
+
* @property {SupportedLanguage[]} [items]
|
|
524
|
+
*/
|
|
525
|
+
/**
|
|
526
|
+
* @typedef LaunchPage
|
|
527
|
+
* @property {string} [page_type] - Type of the launch page
|
|
528
|
+
* @property {Object} [params] - Launch page params. It can be nullable.
|
|
529
|
+
* @property {Object} [query] - Query related to launch page. It can be nullable.
|
|
530
|
+
*/
|
|
531
|
+
/**
|
|
532
|
+
* @typedef LinkedInLink
|
|
533
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
534
|
+
* @property {string} [link] - Web URL of brand's LinkedIn channel
|
|
535
|
+
* @property {string} [title] - Name of the social media platform, e.g. LinkedIn
|
|
536
|
+
*/
|
|
537
|
+
/**
|
|
538
|
+
* @typedef Links
|
|
539
|
+
* @property {string} [link] - Web URL for redirecting to a related page
|
|
540
|
+
* @property {string} [title] - Name of the related page or link
|
|
541
|
+
*/
|
|
542
|
+
/**
|
|
543
|
+
* @typedef ListingPriceFeature
|
|
544
|
+
* @property {string} [sort] - Sorting of listing price with min or max value.
|
|
545
|
+
* Default value is min.
|
|
546
|
+
* @property {string} [value] - Shows which price to display on PLP if one
|
|
547
|
+
* product has multiple prices (for each size), valid values are 'min', 'max',
|
|
548
|
+
* 'range'. Default value is range.
|
|
549
|
+
*/
|
|
550
|
+
/**
|
|
551
|
+
* @typedef Moengage
|
|
552
|
+
* @property {MoengageCredentials} [credentials]
|
|
553
|
+
* @property {boolean} [enabled] - Shows whether MoEngage integation is enabled
|
|
554
|
+
* or disabled for the sales channel
|
|
555
|
+
*/
|
|
556
|
+
/**
|
|
557
|
+
* @typedef MoengageCredentials
|
|
558
|
+
* @property {string} [app_id] - APP ID provided by MoEngage to identify a
|
|
559
|
+
* specific app. The app_id for your MoEngage account is available on the
|
|
560
|
+
* MoEngage Dashboard.
|
|
561
|
+
*/
|
|
562
|
+
/**
|
|
563
|
+
* @typedef NotFound
|
|
564
|
+
* @property {string} [message] - Response message for not found
|
|
565
|
+
*/
|
|
566
|
+
/**
|
|
567
|
+
* @typedef OptedStoreAddress
|
|
568
|
+
* @property {string} [address1] - Address of the opted store
|
|
569
|
+
* @property {string} [address2] - Address of the opted store
|
|
570
|
+
* @property {string} [city] - City of the opted store, e.g. Mumbai
|
|
571
|
+
* @property {string} [country] - Country of the opted store, e.g. India
|
|
572
|
+
* @property {StoreLatLong} [lat_long]
|
|
573
|
+
* @property {number} [pincode] - 6-digit PIN code of the opted store location
|
|
574
|
+
* @property {string} [state] - State of the opted store, e.g. Maharashtra
|
|
575
|
+
*/
|
|
576
|
+
/**
|
|
577
|
+
* @typedef OrderFeature
|
|
578
|
+
* @property {boolean} [buy_again] - Allow buy again option for order. Default
|
|
579
|
+
* value is false.
|
|
580
|
+
*/
|
|
581
|
+
/**
|
|
582
|
+
* @typedef OrderingStore
|
|
583
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
584
|
+
* of the ordering store
|
|
585
|
+
* @property {OptedStoreAddress} [address]
|
|
586
|
+
* @property {string} [code] - Code of the ordering store (usually same as Store Code)
|
|
587
|
+
* @property {string} [display_name] - Display name of the ordering store
|
|
588
|
+
* @property {string} [name] - Store name of the ordering store
|
|
589
|
+
* @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
590
|
+
* @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
|
|
591
|
+
* @property {string} [store_type] - Store type of the ordering store, e.g.
|
|
592
|
+
* high_street, mall, warehouse
|
|
593
|
+
* @property {number} [uid] - Ordering store UID
|
|
594
|
+
*/
|
|
595
|
+
/**
|
|
596
|
+
* @typedef OrderingStores
|
|
597
|
+
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
598
|
+
* value is zero.
|
|
599
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
600
|
+
* of the ordering store
|
|
601
|
+
* @property {boolean} [all_stores] - Allow all stores of the ordering stores
|
|
602
|
+
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
603
|
+
* channel website) created within a business account
|
|
604
|
+
* @property {number[]} [deployed_stores]
|
|
605
|
+
* @property {boolean} [enabled] - Allow ordering stores for current sales channel
|
|
606
|
+
* @property {OrderingStore[]} [items]
|
|
607
|
+
* @property {Page} [page]
|
|
608
|
+
* @property {string} [type] - For hard type delivery, store selection is
|
|
609
|
+
* compulsory. For soft type, delivery store selection is optional.
|
|
610
|
+
*/
|
|
611
|
+
/**
|
|
612
|
+
* @typedef OrderingStoreSelect
|
|
613
|
+
* @property {number} uid - Ordering store unique uid. It is required.
|
|
614
|
+
*/
|
|
615
|
+
/**
|
|
616
|
+
* @typedef OrderingStoreSelectRequest
|
|
617
|
+
* @property {OrderingStoreSelect} ordering_store
|
|
618
|
+
*/
|
|
619
|
+
/**
|
|
620
|
+
* @typedef OrderingStoresResponse
|
|
621
|
+
* @property {OrderingStore[]} [items]
|
|
622
|
+
* @property {Page} [page]
|
|
623
|
+
*/
|
|
624
|
+
/**
|
|
625
|
+
* @typedef OS
|
|
626
|
+
* @property {string} name
|
|
627
|
+
* @property {string} [version]
|
|
628
|
+
*/
|
|
629
|
+
/**
|
|
630
|
+
* @typedef OwnerInfo
|
|
631
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
632
|
+
* of owner info
|
|
633
|
+
* @property {UserEmail[]} [emails]
|
|
634
|
+
* @property {string} [first_name] - First name of the owner
|
|
635
|
+
* @property {string} [last_name] - Last name of the owner
|
|
636
|
+
* @property {UserPhoneNumber[]} [phone_numbers]
|
|
637
|
+
* @property {string} [profile_pic] - Hosted URL of profile pic
|
|
638
|
+
*/
|
|
639
|
+
/**
|
|
640
|
+
* @typedef Page
|
|
641
|
+
* @property {number} [current]
|
|
642
|
+
* @property {boolean} [has_next]
|
|
643
|
+
* @property {boolean} [has_previous]
|
|
644
|
+
* @property {number} [item_total]
|
|
645
|
+
* @property {string} [next_id]
|
|
646
|
+
* @property {number} [size]
|
|
647
|
+
* @property {string} type
|
|
648
|
+
*/
|
|
649
|
+
/**
|
|
650
|
+
* @typedef PcrFeature
|
|
651
|
+
* @property {boolean} [staff_selection] - Allow staff selection. Default value is false.
|
|
652
|
+
*/
|
|
653
|
+
/**
|
|
654
|
+
* @typedef PinterestLink
|
|
655
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
656
|
+
* @property {string} [link] - Web URL of brand's Pinterest page
|
|
657
|
+
* @property {string} [title] - Name of the social media platform, e.g. Pinterest
|
|
658
|
+
*/
|
|
659
|
+
/**
|
|
660
|
+
* @typedef ProductDetailFeature
|
|
661
|
+
* @property {boolean} [request_product] - Indicates whether customers can
|
|
662
|
+
* request for a product. Default value is false.
|
|
663
|
+
* @property {boolean} [seller_selection] - Shows whether the customers can
|
|
664
|
+
* choose the seller on PDP
|
|
665
|
+
* @property {string[]} [similar] - Configuration to show similar products,
|
|
666
|
+
* other products from same seller, other products in same category, other
|
|
667
|
+
* products in same price range, etc.
|
|
668
|
+
* @property {boolean} [update_product_meta] - Allow user to update product
|
|
669
|
+
* meta. Default value is true.
|
|
670
|
+
*/
|
|
671
|
+
/**
|
|
672
|
+
* @typedef QrFeature
|
|
673
|
+
* @property {boolean} [application] - Shows whether sharing of mobile app via
|
|
674
|
+
* QR code is allowed. Default value is false.
|
|
675
|
+
* @property {boolean} [collections] - Shows whether sharing collection via QR
|
|
676
|
+
* code is allowed. Default value is false.
|
|
677
|
+
* @property {boolean} [products] - Shows whether sharing product via QR code is
|
|
678
|
+
* allowed. Default value is false.
|
|
679
|
+
*/
|
|
680
|
+
/**
|
|
681
|
+
* @typedef RegistrationPageFeature
|
|
682
|
+
* @property {boolean} [ask_store_address] - Shows whether a form to collect the
|
|
683
|
+
* address of the store, should be displayed upon visiting the website
|
|
684
|
+
*/
|
|
685
|
+
/**
|
|
686
|
+
* @typedef RevenueEngineFeature
|
|
687
|
+
* @property {boolean} [enabled] - Enable revenue engine. Default value is false.
|
|
688
|
+
*/
|
|
689
|
+
/**
|
|
690
|
+
* @typedef RewardPointsConfig
|
|
691
|
+
* @property {Credit} [credit]
|
|
692
|
+
* @property {Debit} [debit]
|
|
693
|
+
*/
|
|
694
|
+
/**
|
|
695
|
+
* @typedef Safetynet
|
|
696
|
+
* @property {SafetynetCredentials} [credentials]
|
|
697
|
+
* @property {boolean} [enabled] - Shows whether Safetynet integration is
|
|
698
|
+
* enabled or disabled for the sales channel
|
|
699
|
+
*/
|
|
700
|
+
/**
|
|
701
|
+
* @typedef SafetynetCredentials
|
|
702
|
+
* @property {string} [api_key] - Secret credential API key for Safetynet. This
|
|
703
|
+
* API key is used for calling the methods of Safetynet APIs.
|
|
704
|
+
*/
|
|
705
|
+
/**
|
|
706
|
+
* @typedef SecureUrl
|
|
707
|
+
* @property {string} [secure_url] - Hosted URL of the image
|
|
708
|
+
*/
|
|
709
|
+
/**
|
|
710
|
+
* @typedef Segment
|
|
711
|
+
* @property {SegmentCredentials} [credentials]
|
|
712
|
+
* @property {boolean} [enabled] - Shows whether Segment integration is enabled
|
|
713
|
+
* or disabled for the sales channel
|
|
714
|
+
*/
|
|
715
|
+
/**
|
|
716
|
+
* @typedef SegmentCredentials
|
|
717
|
+
* @property {string} [write_key] - The unique identifier for a source that
|
|
718
|
+
* tells Segment from which source data is coming from, to which workspace the
|
|
719
|
+
* data belongs, and which destinations should receive the data.
|
|
720
|
+
*/
|
|
721
|
+
/**
|
|
722
|
+
* @typedef SocialLinks
|
|
723
|
+
* @property {BlogLink} [blog_link]
|
|
724
|
+
* @property {FacebookLink} [facebook]
|
|
725
|
+
* @property {GooglePlusLink} [google_plus]
|
|
726
|
+
* @property {InstagramLink} [instagram]
|
|
727
|
+
* @property {LinkedInLink} [linked_in]
|
|
728
|
+
* @property {PinterestLink} [pinterest]
|
|
729
|
+
* @property {TwitterLink} [twitter]
|
|
730
|
+
* @property {VimeoLink} [vimeo]
|
|
731
|
+
* @property {YoutubeLink} [youtube]
|
|
732
|
+
*/
|
|
733
|
+
/**
|
|
734
|
+
* @typedef StoreCriteriaRule
|
|
735
|
+
* @property {number[]} [brands] - List of brand UID
|
|
736
|
+
* @property {number[]} [companies] - List of company UID
|
|
737
|
+
*/
|
|
738
|
+
/**
|
|
739
|
+
* @typedef StoreLatLong
|
|
740
|
+
* @property {number[]} [coordinates]
|
|
741
|
+
* @property {string} [type] - Coordinates type of the opted store
|
|
742
|
+
*/
|
|
743
|
+
/**
|
|
744
|
+
* @typedef StorePriorityRule
|
|
745
|
+
* @property {boolean} [enabled] - Shows store priority is enabled or not
|
|
746
|
+
* enabled for the article assignment.
|
|
747
|
+
* @property {string[]} [storetype_order]
|
|
748
|
+
*/
|
|
749
|
+
/**
|
|
750
|
+
* @typedef SuccessMessageResponse
|
|
751
|
+
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
752
|
+
*/
|
|
753
|
+
/**
|
|
754
|
+
* @typedef SupportedLanguage
|
|
755
|
+
* @property {string} [code] - Unique code of supported language, e.g. hi-IN
|
|
756
|
+
* @property {string} [name] - Name of the supported language, e.g. हिन्दी
|
|
757
|
+
*/
|
|
758
|
+
/**
|
|
759
|
+
* @typedef Tokens
|
|
760
|
+
* @property {Firebase} [firebase]
|
|
761
|
+
* @property {Freshchat} [freshchat]
|
|
762
|
+
* @property {FyndRewards} [fynd_rewards]
|
|
763
|
+
* @property {GoogleMap} [google_map]
|
|
764
|
+
* @property {Gtm} [gtm]
|
|
765
|
+
* @property {Moengage} [moengage]
|
|
766
|
+
* @property {Safetynet} [safetynet]
|
|
767
|
+
* @property {Segment} [segment]
|
|
768
|
+
*/
|
|
769
|
+
/**
|
|
770
|
+
* @typedef TwitterLink
|
|
771
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
772
|
+
* @property {string} [link] - Web URL of brand's Twitter account
|
|
773
|
+
* @property {string} [title] - Name of the social media platform, e.g. Twitter
|
|
774
|
+
*/
|
|
775
|
+
/**
|
|
776
|
+
* @typedef UnhandledError
|
|
777
|
+
* @property {string} [message]
|
|
778
|
+
*/
|
|
779
|
+
/**
|
|
780
|
+
* @typedef UpdateDialog
|
|
781
|
+
* @property {number} [interval]
|
|
782
|
+
* @property {string} [type]
|
|
783
|
+
*/
|
|
784
|
+
/**
|
|
785
|
+
* @typedef UserEmail
|
|
786
|
+
* @property {boolean} [active] - Current email is active or not active
|
|
787
|
+
* @property {string} [email] - Email address of the user
|
|
788
|
+
* @property {boolean} [primary] - Indicates current email is primay email or
|
|
789
|
+
* not primary email of user
|
|
790
|
+
* @property {boolean} [verified] - Indicates current email is verified email or
|
|
791
|
+
* not verified email
|
|
792
|
+
*/
|
|
793
|
+
/**
|
|
794
|
+
* @typedef UserPhoneNumber
|
|
795
|
+
* @property {boolean} [active] - Current phone number is active or not active
|
|
796
|
+
* @property {number} [country_code] - Country code, e.g. +91
|
|
797
|
+
* @property {string} [phone] - Phone number of the user
|
|
798
|
+
* @property {boolean} [primary] - Indicates current phone number is primay or
|
|
799
|
+
* not primary of user
|
|
800
|
+
* @property {boolean} [verified] - Indicates current phone number is verified
|
|
801
|
+
* or not verified
|
|
802
|
+
*/
|
|
803
|
+
/**
|
|
804
|
+
* @typedef VimeoLink
|
|
805
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
806
|
+
* @property {string} [link] - Web URL of brand's Vimeo channel
|
|
807
|
+
* @property {string} [title] - Name of the video hosting platform, e.g. Vimeo
|
|
808
|
+
*/
|
|
809
|
+
/**
|
|
810
|
+
* @typedef YoutubeLink
|
|
811
|
+
* @property {string} [icon] - Hosted URL of social icon image shown on the website
|
|
812
|
+
* @property {string} [link] - Web URL of brand's YouTube channel
|
|
813
|
+
* @property {string} [title] - Name of the social media platform, e.g. YouTube
|
|
814
|
+
*/
|
|
815
|
+
declare class ConfigurationApplicationModel {
|
|
111
816
|
}
|
|
817
|
+
declare namespace ConfigurationApplicationModel {
|
|
818
|
+
export { Android, AppCurrencyResponse, AppFeature, AppFeatureRequest, AppFeatureResponse, Application, ApplicationAboutResponse, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInfo, ApplicationInformation, ApplicationMeta, ApplicationRedirections, ApplicationVersionRequest, ApplicationWebsite, AppStaff, AppStaffListResponse, AppStaffResponse, AppTokenResponse, AppVersionRequest, ArticleAssignmentRule, BlogLink, BusinessHighlights, CartFeature, CommonFeature, CommunicationOptinDialogFeature, CompanyAboutAddress, CompanyInfo, CompareProductsFeature, Credentials, Credit, CurrenciesResponse, Currency, CurrencyFeature, Debit, DefaultCurrency, DeploymentStoreSelectionFeature, Device, Domain, FacebookLink, FeedbackFeature, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrandRule, InventoryPaymentConfig, InventoryStoreRule, Ios, LandingPageFeature, LanguageResponse, LaunchPage, LinkedInLink, Links, ListingPriceFeature, Moengage, MoengageCredentials, NotFound, OptedStoreAddress, OrderFeature, OrderingStore, OrderingStores, OrderingStoreSelect, OrderingStoreSelectRequest, OrderingStoresResponse, OS, OwnerInfo, Page, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, StoreCriteriaRule, StoreLatLong, StorePriorityRule, SuccessMessageResponse, SupportedLanguage, Tokens, TwitterLink, UnhandledError, UpdateDialog, UserEmail, UserPhoneNumber, VimeoLink, YoutubeLink };
|
|
819
|
+
}
|
|
820
|
+
/** @returns {Android} */
|
|
821
|
+
declare function Android(): Android;
|
|
822
|
+
type Android = {
|
|
823
|
+
/**
|
|
824
|
+
* - Firebase secret credential API key for Android
|
|
825
|
+
*/
|
|
826
|
+
api_key?: string;
|
|
827
|
+
/**
|
|
828
|
+
* - Alphanumeric ID allotted to a sales
|
|
829
|
+
* channel application created within a business account
|
|
830
|
+
*/
|
|
831
|
+
application_id?: string;
|
|
832
|
+
};
|
|
833
|
+
/** @returns {AppCurrencyResponse} */
|
|
834
|
+
declare function AppCurrencyResponse(): AppCurrencyResponse;
|
|
835
|
+
type AppCurrencyResponse = {
|
|
836
|
+
/**
|
|
837
|
+
* - Alphanumeric ID allotted to an application
|
|
838
|
+
* (sales channel website) created within a business account
|
|
839
|
+
*/
|
|
840
|
+
application?: string;
|
|
841
|
+
default_currency?: DefaultCurrency;
|
|
842
|
+
supported_currency?: Currency[];
|
|
843
|
+
};
|
|
844
|
+
/** @returns {AppFeature} */
|
|
845
|
+
declare function AppFeature(): AppFeature;
|
|
846
|
+
type AppFeature = {
|
|
847
|
+
/**
|
|
848
|
+
* - Version key for tracking revisions. Default value is zero
|
|
849
|
+
*/
|
|
850
|
+
__v?: number;
|
|
851
|
+
/**
|
|
852
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
853
|
+
* for the sales channel features
|
|
854
|
+
*/
|
|
855
|
+
_id?: string;
|
|
856
|
+
/**
|
|
857
|
+
* - Application ID of the sales channel
|
|
858
|
+
*/
|
|
859
|
+
app?: string;
|
|
860
|
+
cart?: CartFeature;
|
|
861
|
+
common?: CommonFeature;
|
|
862
|
+
/**
|
|
863
|
+
* - ISO 8601 timestamp showing the date when
|
|
864
|
+
* the features were configured
|
|
865
|
+
*/
|
|
866
|
+
created_at?: string;
|
|
867
|
+
home_page?: HomePageFeature;
|
|
868
|
+
landing_page?: LandingPageFeature;
|
|
869
|
+
order?: OrderFeature;
|
|
870
|
+
pcr?: PcrFeature;
|
|
871
|
+
product_detail?: ProductDetailFeature;
|
|
872
|
+
qr?: QrFeature;
|
|
873
|
+
registration_page?: RegistrationPageFeature;
|
|
874
|
+
/**
|
|
875
|
+
* - ISO 8601 timestamp of last known
|
|
876
|
+
* modifications to the sales channel feature configuration
|
|
877
|
+
*/
|
|
878
|
+
updated_at?: string;
|
|
879
|
+
};
|
|
880
|
+
/** @returns {AppFeatureRequest} */
|
|
881
|
+
declare function AppFeatureRequest(): AppFeatureRequest;
|
|
882
|
+
type AppFeatureRequest = {
|
|
883
|
+
feature?: AppFeature;
|
|
884
|
+
};
|
|
885
|
+
/** @returns {AppFeatureResponse} */
|
|
886
|
+
declare function AppFeatureResponse(): AppFeatureResponse;
|
|
887
|
+
type AppFeatureResponse = {
|
|
888
|
+
feature?: AppFeature;
|
|
889
|
+
};
|
|
890
|
+
/** @returns {Application} */
|
|
891
|
+
declare function Application(): Application;
|
|
892
|
+
type Application = {
|
|
893
|
+
/**
|
|
894
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
895
|
+
*/
|
|
896
|
+
__v?: number;
|
|
897
|
+
/**
|
|
898
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
899
|
+
* of the sales channel
|
|
900
|
+
*/
|
|
901
|
+
_id?: string;
|
|
902
|
+
/**
|
|
903
|
+
* - It shows application is live or in development mode.
|
|
904
|
+
*/
|
|
905
|
+
app_type?: string;
|
|
906
|
+
auth?: ApplicationAuth;
|
|
907
|
+
banner?: SecureUrl;
|
|
908
|
+
/**
|
|
909
|
+
* - An integer value that specifies the number
|
|
910
|
+
* of seconds until the key expires
|
|
911
|
+
*/
|
|
912
|
+
cache_ttl?: number;
|
|
913
|
+
/**
|
|
914
|
+
* - It indicates different channel types like
|
|
915
|
+
* store, website-and-mobile-apps. Default value is store
|
|
916
|
+
*/
|
|
917
|
+
channel_type?: string;
|
|
918
|
+
/**
|
|
919
|
+
* - Numeric ID allotted to a business account
|
|
920
|
+
* where the sales channel exists
|
|
921
|
+
*/
|
|
922
|
+
company_id?: number;
|
|
923
|
+
cors?: ApplicationCors;
|
|
924
|
+
/**
|
|
925
|
+
* - ISO 8601 timestamp of sales channel creation
|
|
926
|
+
*/
|
|
927
|
+
created_at?: string;
|
|
928
|
+
/**
|
|
929
|
+
* - It contains detailed information about the
|
|
930
|
+
* sales channel.
|
|
931
|
+
*/
|
|
932
|
+
description?: string;
|
|
933
|
+
domain?: Domain;
|
|
934
|
+
domains?: Domain[];
|
|
935
|
+
favicon?: SecureUrl;
|
|
936
|
+
/**
|
|
937
|
+
* - Indicates sales channel is active or not active
|
|
938
|
+
*/
|
|
939
|
+
is_active?: boolean;
|
|
940
|
+
/**
|
|
941
|
+
* - Indicates whether a sales channel is
|
|
942
|
+
* internal or not
|
|
943
|
+
*/
|
|
944
|
+
is_internal?: boolean;
|
|
945
|
+
logo?: SecureUrl;
|
|
946
|
+
meta?: ApplicationMeta[];
|
|
947
|
+
mobile_logo?: SecureUrl;
|
|
948
|
+
/**
|
|
949
|
+
* - Name of the sales channel, e.g. Zenz Fashion
|
|
950
|
+
*/
|
|
951
|
+
name?: string;
|
|
952
|
+
/**
|
|
953
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
954
|
+
* of owner who owns the application
|
|
955
|
+
*/
|
|
956
|
+
owner?: string;
|
|
957
|
+
redirections?: ApplicationRedirections[];
|
|
958
|
+
/**
|
|
959
|
+
* - Random generated fix length string for sales
|
|
960
|
+
* channel. It is required and auto-generated.
|
|
961
|
+
*/
|
|
962
|
+
token?: string;
|
|
963
|
+
/**
|
|
964
|
+
* - ISO 8601 timestamp of sales channel updation
|
|
965
|
+
*/
|
|
966
|
+
updated_at?: string;
|
|
967
|
+
website?: ApplicationWebsite;
|
|
968
|
+
};
|
|
969
|
+
/** @returns {ApplicationAboutResponse} */
|
|
970
|
+
declare function ApplicationAboutResponse(): ApplicationAboutResponse;
|
|
971
|
+
type ApplicationAboutResponse = {
|
|
972
|
+
application_info?: ApplicationInfo;
|
|
973
|
+
company_info?: CompanyInfo;
|
|
974
|
+
owner_info?: OwnerInfo;
|
|
975
|
+
};
|
|
976
|
+
/** @returns {ApplicationAuth} */
|
|
977
|
+
declare function ApplicationAuth(): ApplicationAuth;
|
|
978
|
+
type ApplicationAuth = {
|
|
979
|
+
/**
|
|
980
|
+
* - Shows sales channel auth is enabled or not enabled.
|
|
981
|
+
*/
|
|
982
|
+
enabled?: boolean;
|
|
983
|
+
};
|
|
984
|
+
/** @returns {ApplicationCors} */
|
|
985
|
+
declare function ApplicationCors(): ApplicationCors;
|
|
986
|
+
type ApplicationCors = {
|
|
987
|
+
domains?: string[];
|
|
988
|
+
};
|
|
989
|
+
/** @returns {ApplicationDetail} */
|
|
990
|
+
declare function ApplicationDetail(): ApplicationDetail;
|
|
991
|
+
type ApplicationDetail = {
|
|
992
|
+
/**
|
|
993
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
994
|
+
* for the sales channel details
|
|
995
|
+
*/
|
|
996
|
+
_id?: string;
|
|
997
|
+
banner?: SecureUrl;
|
|
998
|
+
/**
|
|
999
|
+
* - It gives a detailed information about the
|
|
1000
|
+
* sales channel. It is required.
|
|
1001
|
+
*/
|
|
1002
|
+
description?: string;
|
|
1003
|
+
domain?: Domain;
|
|
1004
|
+
domains?: Domain[];
|
|
1005
|
+
favicon?: SecureUrl;
|
|
1006
|
+
logo?: SecureUrl;
|
|
1007
|
+
mobile_logo?: SecureUrl;
|
|
1008
|
+
/**
|
|
1009
|
+
* - Name of the sales channel. It is required.
|
|
1010
|
+
*/
|
|
1011
|
+
name: string;
|
|
1012
|
+
};
|
|
1013
|
+
/** @returns {ApplicationInfo} */
|
|
1014
|
+
declare function ApplicationInfo(): ApplicationInfo;
|
|
1015
|
+
type ApplicationInfo = {
|
|
1016
|
+
/**
|
|
1017
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1018
|
+
* of application information
|
|
1019
|
+
*/
|
|
1020
|
+
_id?: string;
|
|
1021
|
+
banner?: SecureUrl;
|
|
1022
|
+
cors?: ApplicationCors;
|
|
1023
|
+
/**
|
|
1024
|
+
* - ISO 8601 timestamp of sales channel
|
|
1025
|
+
* information creation
|
|
1026
|
+
*/
|
|
1027
|
+
created_at?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* - It contains details information about the
|
|
1030
|
+
* sales channel
|
|
1031
|
+
*/
|
|
1032
|
+
description?: string;
|
|
1033
|
+
domain?: Domain;
|
|
1034
|
+
/**
|
|
1035
|
+
* - Indicates whether sales channel is active
|
|
1036
|
+
* or not active
|
|
1037
|
+
*/
|
|
1038
|
+
is_active?: boolean;
|
|
1039
|
+
logo?: SecureUrl;
|
|
1040
|
+
meta?: ApplicationMeta;
|
|
1041
|
+
/**
|
|
1042
|
+
* - Name of the sales channel, e.g. Zenz Fashion
|
|
1043
|
+
*/
|
|
1044
|
+
name?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* - Random generated fix length string for sales
|
|
1047
|
+
* channel. It is required and auto-generated.
|
|
1048
|
+
*/
|
|
1049
|
+
secret?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* - Random generated fix length string for sales
|
|
1052
|
+
* channel. It is required and auto-generated.
|
|
1053
|
+
*/
|
|
1054
|
+
token?: string;
|
|
1055
|
+
website?: ApplicationWebsite;
|
|
1056
|
+
};
|
|
1057
|
+
/** @returns {ApplicationInformation} */
|
|
1058
|
+
declare function ApplicationInformation(): ApplicationInformation;
|
|
1059
|
+
type ApplicationInformation = {
|
|
1060
|
+
/**
|
|
1061
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
1062
|
+
*/
|
|
1063
|
+
__v?: number;
|
|
1064
|
+
/**
|
|
1065
|
+
* - Unique identifier (24-digit Mongo Object ID) of
|
|
1066
|
+
* the application information
|
|
1067
|
+
*/
|
|
1068
|
+
_id?: string;
|
|
1069
|
+
address?: InformationAddress;
|
|
1070
|
+
/**
|
|
1071
|
+
* - Alphanumeric ID allotted to a sales
|
|
1072
|
+
* channel application created within a business account
|
|
1073
|
+
*/
|
|
1074
|
+
application?: string;
|
|
1075
|
+
business_highlights?: BusinessHighlights;
|
|
1076
|
+
/**
|
|
1077
|
+
* - Copyright statement usually seen at the
|
|
1078
|
+
* site's footer
|
|
1079
|
+
*/
|
|
1080
|
+
copyright_text?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* - ISO 8601 timestamp of creation of the
|
|
1083
|
+
* application information
|
|
1084
|
+
*/
|
|
1085
|
+
created_at?: string;
|
|
1086
|
+
links?: Links;
|
|
1087
|
+
social_links?: SocialLinks;
|
|
1088
|
+
support?: InformationSupport;
|
|
1089
|
+
/**
|
|
1090
|
+
* - ISO 8601 timestamp of updation of the
|
|
1091
|
+
* application information
|
|
1092
|
+
*/
|
|
1093
|
+
updated_at?: string;
|
|
1094
|
+
};
|
|
1095
|
+
/** @returns {ApplicationMeta} */
|
|
1096
|
+
declare function ApplicationMeta(): ApplicationMeta;
|
|
1097
|
+
type ApplicationMeta = {
|
|
1098
|
+
/**
|
|
1099
|
+
* - Indicates to name of application meta
|
|
1100
|
+
*/
|
|
1101
|
+
name?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* - Value related to application meta name
|
|
1104
|
+
*/
|
|
1105
|
+
value?: string;
|
|
1106
|
+
};
|
|
1107
|
+
/** @returns {ApplicationRedirections} */
|
|
1108
|
+
declare function ApplicationRedirections(): ApplicationRedirections;
|
|
1109
|
+
type ApplicationRedirections = {
|
|
1110
|
+
/**
|
|
1111
|
+
* - Old domain url of the sales channel
|
|
1112
|
+
*/
|
|
1113
|
+
redirect_from?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* - New domain URL of the sales channel. Users
|
|
1116
|
+
* will be automatically redirected from old domain to new domain.
|
|
1117
|
+
*/
|
|
1118
|
+
redirect_to?: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* - It shows domain redirection type. Permanent
|
|
1121
|
+
* redirection is for long time period redirection, and temporary redirection
|
|
1122
|
+
* for a short time period.
|
|
1123
|
+
*/
|
|
1124
|
+
type?: string;
|
|
1125
|
+
};
|
|
1126
|
+
/** @returns {ApplicationVersionRequest} */
|
|
1127
|
+
declare function ApplicationVersionRequest(): ApplicationVersionRequest;
|
|
1128
|
+
type ApplicationVersionRequest = {
|
|
1129
|
+
id?: string;
|
|
1130
|
+
name: string;
|
|
1131
|
+
namespace?: string;
|
|
1132
|
+
token?: string;
|
|
1133
|
+
version: string;
|
|
1134
|
+
};
|
|
1135
|
+
/** @returns {ApplicationWebsite} */
|
|
1136
|
+
declare function ApplicationWebsite(): ApplicationWebsite;
|
|
1137
|
+
type ApplicationWebsite = {
|
|
1138
|
+
/**
|
|
1139
|
+
* - Base path for the current sales channel website
|
|
1140
|
+
*/
|
|
1141
|
+
basepath?: string;
|
|
1142
|
+
/**
|
|
1143
|
+
* - Shows whether sales channel website URL is
|
|
1144
|
+
* enabled or not
|
|
1145
|
+
*/
|
|
1146
|
+
enabled?: boolean;
|
|
1147
|
+
};
|
|
1148
|
+
/** @returns {AppStaff} */
|
|
1149
|
+
declare function AppStaff(): AppStaff;
|
|
1150
|
+
type AppStaff = {
|
|
1151
|
+
/**
|
|
1152
|
+
* - The unique identifier for the sales channel staff member
|
|
1153
|
+
*/
|
|
1154
|
+
_id?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* - The unique identifier (24-digit Mongo
|
|
1157
|
+
* Object ID) of the current sales channel
|
|
1158
|
+
*/
|
|
1159
|
+
application?: string;
|
|
1160
|
+
/**
|
|
1161
|
+
* - Employee code of sales channel staff
|
|
1162
|
+
* member. It has unique value.
|
|
1163
|
+
*/
|
|
1164
|
+
employee_code?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* - First name the staff member
|
|
1167
|
+
*/
|
|
1168
|
+
first_name?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* - Last name the staff member
|
|
1171
|
+
*/
|
|
1172
|
+
last_name?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* - This is a boolean value. `true` to
|
|
1175
|
+
* retrieve the staff members eligible for getting incentives on orders.
|
|
1176
|
+
*/
|
|
1177
|
+
order_incent?: boolean;
|
|
1178
|
+
/**
|
|
1179
|
+
* - Profile image hosted url of the staff member
|
|
1180
|
+
*/
|
|
1181
|
+
profile_pic_url?: string;
|
|
1182
|
+
stores?: number[];
|
|
1183
|
+
/**
|
|
1184
|
+
* - Tittle for the staff member like owner, staff.
|
|
1185
|
+
*/
|
|
1186
|
+
title?: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* - Mongo ID of the staff. Helps in retrieving the
|
|
1189
|
+
* details of a particular staff member.
|
|
1190
|
+
*/
|
|
1191
|
+
user?: string;
|
|
1192
|
+
};
|
|
1193
|
+
/** @returns {AppStaffListResponse} */
|
|
1194
|
+
declare function AppStaffListResponse(): AppStaffListResponse;
|
|
1195
|
+
type AppStaffListResponse = {
|
|
1196
|
+
items?: AppStaff[];
|
|
1197
|
+
page?: Page;
|
|
1198
|
+
};
|
|
1199
|
+
/** @returns {AppStaffResponse} */
|
|
1200
|
+
declare function AppStaffResponse(): AppStaffResponse;
|
|
1201
|
+
type AppStaffResponse = {
|
|
1202
|
+
staff_users?: AppStaff[];
|
|
1203
|
+
};
|
|
1204
|
+
/** @returns {AppTokenResponse} */
|
|
1205
|
+
declare function AppTokenResponse(): AppTokenResponse;
|
|
1206
|
+
type AppTokenResponse = {
|
|
1207
|
+
/**
|
|
1208
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
1209
|
+
*/
|
|
1210
|
+
__v?: number;
|
|
1211
|
+
/**
|
|
1212
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1213
|
+
* of the token
|
|
1214
|
+
*/
|
|
1215
|
+
_id?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* - Alphanumeric ID allotted to the current
|
|
1218
|
+
* application created within the current business account
|
|
1219
|
+
*/
|
|
1220
|
+
application?: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* - ISO 8601 timestamp of token creation
|
|
1223
|
+
*/
|
|
1224
|
+
created_at?: string;
|
|
1225
|
+
tokens?: Tokens;
|
|
1226
|
+
/**
|
|
1227
|
+
* - ISO 8601 timestamp of token updation
|
|
1228
|
+
*/
|
|
1229
|
+
updated_at?: string;
|
|
1230
|
+
};
|
|
1231
|
+
/** @returns {AppVersionRequest} */
|
|
1232
|
+
declare function AppVersionRequest(): AppVersionRequest;
|
|
1233
|
+
type AppVersionRequest = {
|
|
1234
|
+
application: ApplicationVersionRequest;
|
|
1235
|
+
device: Device;
|
|
1236
|
+
locale?: string;
|
|
1237
|
+
timezone?: string;
|
|
1238
|
+
};
|
|
1239
|
+
/** @returns {ArticleAssignmentRule} */
|
|
1240
|
+
declare function ArticleAssignmentRule(): ArticleAssignmentRule;
|
|
1241
|
+
type ArticleAssignmentRule = {
|
|
1242
|
+
store_priority?: StorePriorityRule;
|
|
1243
|
+
};
|
|
1244
|
+
/** @returns {BlogLink} */
|
|
1245
|
+
declare function BlogLink(): BlogLink;
|
|
1246
|
+
type BlogLink = {
|
|
1247
|
+
/**
|
|
1248
|
+
* - Hosted URL of icon image shown on the website
|
|
1249
|
+
*/
|
|
1250
|
+
icon?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* - Web URL of brand's blog page
|
|
1253
|
+
*/
|
|
1254
|
+
link?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* - Name of the brand's blog page
|
|
1257
|
+
*/
|
|
1258
|
+
title?: string;
|
|
1259
|
+
};
|
|
1260
|
+
/** @returns {BusinessHighlights} */
|
|
1261
|
+
declare function BusinessHighlights(): BusinessHighlights;
|
|
1262
|
+
type BusinessHighlights = {
|
|
1263
|
+
/**
|
|
1264
|
+
* - Unique identifier (24-digit Mongo Object ID) of
|
|
1265
|
+
* the related business
|
|
1266
|
+
*/
|
|
1267
|
+
_id?: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* - Hosted URL of icon image representing the
|
|
1270
|
+
* business highlight
|
|
1271
|
+
*/
|
|
1272
|
+
icon?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* - Detailed information about the highlight
|
|
1275
|
+
*/
|
|
1276
|
+
sub_title?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* - Title of the business highlight, e.g. Superfast Delivery
|
|
1279
|
+
*/
|
|
1280
|
+
title?: string;
|
|
1281
|
+
};
|
|
1282
|
+
/** @returns {CartFeature} */
|
|
1283
|
+
declare function CartFeature(): CartFeature;
|
|
1284
|
+
type CartFeature = {
|
|
1285
|
+
/**
|
|
1286
|
+
* - Allow adding of Google Maps. Default value is true.
|
|
1287
|
+
*/
|
|
1288
|
+
google_map?: boolean;
|
|
1289
|
+
/**
|
|
1290
|
+
* - Shows whether customer is allowed to enter
|
|
1291
|
+
* GST on the cart page for claiming input credits
|
|
1292
|
+
*/
|
|
1293
|
+
gst_input?: boolean;
|
|
1294
|
+
/**
|
|
1295
|
+
* - Shows whether the staff is
|
|
1296
|
+
* placing order on behalf of customer. Default value is true.
|
|
1297
|
+
*/
|
|
1298
|
+
placing_for_customer?: boolean;
|
|
1299
|
+
/**
|
|
1300
|
+
* - Allow coupon apply and credits,
|
|
1301
|
+
* together. Default value is false.
|
|
1302
|
+
*/
|
|
1303
|
+
revenue_engine_coupon?: boolean;
|
|
1304
|
+
/**
|
|
1305
|
+
* - Shows whether staff selection is
|
|
1306
|
+
* enabled on cart page
|
|
1307
|
+
*/
|
|
1308
|
+
staff_selection?: boolean;
|
|
1309
|
+
};
|
|
1310
|
+
/** @returns {CommonFeature} */
|
|
1311
|
+
declare function CommonFeature(): CommonFeature;
|
|
1312
|
+
type CommonFeature = {
|
|
1313
|
+
communication_optin_dialog?: CommunicationOptinDialogFeature;
|
|
1314
|
+
compare_products?: CompareProductsFeature;
|
|
1315
|
+
currency?: CurrencyFeature;
|
|
1316
|
+
deployment_store_selection?: DeploymentStoreSelectionFeature;
|
|
1317
|
+
feedback?: FeedbackFeature;
|
|
1318
|
+
listing_price?: ListingPriceFeature;
|
|
1319
|
+
revenue_engine?: RevenueEngineFeature;
|
|
1320
|
+
reward_points?: RewardPointsConfig;
|
|
1321
|
+
};
|
|
1322
|
+
/** @returns {CommunicationOptinDialogFeature} */
|
|
1323
|
+
declare function CommunicationOptinDialogFeature(): CommunicationOptinDialogFeature;
|
|
1324
|
+
type CommunicationOptinDialogFeature = {
|
|
1325
|
+
/**
|
|
1326
|
+
* - Shows whether WhatsApp communication is enabled
|
|
1327
|
+
*/
|
|
1328
|
+
visibility?: boolean;
|
|
1329
|
+
};
|
|
1330
|
+
/** @returns {CompanyAboutAddress} */
|
|
1331
|
+
declare function CompanyAboutAddress(): CompanyAboutAddress;
|
|
1332
|
+
type CompanyAboutAddress = {
|
|
1333
|
+
/**
|
|
1334
|
+
* - Indicates different office types like
|
|
1335
|
+
* office, registered, and home.
|
|
1336
|
+
*/
|
|
1337
|
+
address_type?: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* - Primary address line of the company
|
|
1340
|
+
*/
|
|
1341
|
+
address1?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* - Secondary address line of the company
|
|
1344
|
+
*/
|
|
1345
|
+
address2?: string;
|
|
1346
|
+
/**
|
|
1347
|
+
* - City name, e.g. Mumbai
|
|
1348
|
+
*/
|
|
1349
|
+
city?: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* - Country name, e.g. India
|
|
1352
|
+
*/
|
|
1353
|
+
country?: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* - 6-digit PIN code of the city, e.g. 400001
|
|
1356
|
+
*/
|
|
1357
|
+
pincode?: number;
|
|
1358
|
+
/**
|
|
1359
|
+
* - State name, e.g. Maharashtra
|
|
1360
|
+
*/
|
|
1361
|
+
state?: string;
|
|
1362
|
+
};
|
|
1363
|
+
/** @returns {CompanyInfo} */
|
|
1364
|
+
declare function CompanyInfo(): CompanyInfo;
|
|
1365
|
+
type CompanyInfo = {
|
|
1366
|
+
/**
|
|
1367
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1368
|
+
* of company information
|
|
1369
|
+
*/
|
|
1370
|
+
_id?: string;
|
|
1371
|
+
addresses?: CompanyAboutAddress[];
|
|
1372
|
+
/**
|
|
1373
|
+
* - ISO 8601 timestamp of company information creation
|
|
1374
|
+
*/
|
|
1375
|
+
created_on?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* - Indicates company is active or not active
|
|
1378
|
+
*/
|
|
1379
|
+
is_active?: boolean;
|
|
1380
|
+
/**
|
|
1381
|
+
* - Name of the company, Reliance Retail Limited
|
|
1382
|
+
*/
|
|
1383
|
+
name?: string;
|
|
1384
|
+
notification_emails?: string[];
|
|
1385
|
+
/**
|
|
1386
|
+
* - Company UID
|
|
1387
|
+
*/
|
|
1388
|
+
uid?: number;
|
|
1389
|
+
};
|
|
1390
|
+
/** @returns {CompareProductsFeature} */
|
|
1391
|
+
declare function CompareProductsFeature(): CompareProductsFeature;
|
|
1392
|
+
type CompareProductsFeature = {
|
|
1393
|
+
/**
|
|
1394
|
+
* - Shows whether product comparison feature is
|
|
1395
|
+
* enabled on PDP
|
|
1396
|
+
*/
|
|
1397
|
+
enabled?: boolean;
|
|
1398
|
+
};
|
|
1399
|
+
/** @returns {Credentials} */
|
|
1400
|
+
declare function Credentials(): Credentials;
|
|
1401
|
+
type Credentials = {
|
|
1402
|
+
android?: Android;
|
|
1403
|
+
/**
|
|
1404
|
+
* - An API key is a unique string that's used to
|
|
1405
|
+
* route requests to your Firebase project when interacting with Firebase.
|
|
1406
|
+
*/
|
|
1407
|
+
api_key?: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* - Alphanumeric ID allotted to the current
|
|
1410
|
+
* application created within the current business account
|
|
1411
|
+
*/
|
|
1412
|
+
application_id?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* - Google Cloud Manager's Sender ID for
|
|
1415
|
+
* Firebase. It is a unique numerical value which is created when you
|
|
1416
|
+
* configure your project in the Google Developers Console/Google Cloud Console.
|
|
1417
|
+
*/
|
|
1418
|
+
gcm_sender_id?: string;
|
|
1419
|
+
ios?: Ios;
|
|
1420
|
+
/**
|
|
1421
|
+
* - Project ID for Firebase integration.
|
|
1422
|
+
* Project ID is a unique identifier for a project and is used only within the console.
|
|
1423
|
+
*/
|
|
1424
|
+
project_id?: string;
|
|
1425
|
+
};
|
|
1426
|
+
/** @returns {Credit} */
|
|
1427
|
+
declare function Credit(): Credit;
|
|
1428
|
+
type Credit = {
|
|
1429
|
+
/**
|
|
1430
|
+
* - Shows whether reward points should be credited
|
|
1431
|
+
*/
|
|
1432
|
+
enabled?: boolean;
|
|
1433
|
+
};
|
|
1434
|
+
/** @returns {CurrenciesResponse} */
|
|
1435
|
+
declare function CurrenciesResponse(): CurrenciesResponse;
|
|
1436
|
+
type CurrenciesResponse = {
|
|
1437
|
+
items?: Currency[];
|
|
1438
|
+
};
|
|
1439
|
+
/** @returns {Currency} */
|
|
1440
|
+
declare function Currency(): Currency;
|
|
1441
|
+
type Currency = {
|
|
1442
|
+
/**
|
|
1443
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1444
|
+
* of the current sales channel supported currency
|
|
1445
|
+
*/
|
|
1446
|
+
_id?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* - 3-character currency code, e.g. INR, USD, EUR.
|
|
1449
|
+
*/
|
|
1450
|
+
code?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
* - ISO 8601 timestamp of sales channel support
|
|
1453
|
+
* currency creation
|
|
1454
|
+
*/
|
|
1455
|
+
created_at?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* - Acceptable decimal limits for a given
|
|
1458
|
+
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
1459
|
+
* value of a currency.
|
|
1460
|
+
*/
|
|
1461
|
+
decimal_digits?: number;
|
|
1462
|
+
/**
|
|
1463
|
+
* - Shows currency is enabled or not in current
|
|
1464
|
+
* sales channel
|
|
1465
|
+
*/
|
|
1466
|
+
is_active?: boolean;
|
|
1467
|
+
/**
|
|
1468
|
+
* - Name of the currency, e.g Indian Rupee
|
|
1469
|
+
*/
|
|
1470
|
+
name?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* - Unique symbol for identifying the currency, e.g. ₹
|
|
1473
|
+
*/
|
|
1474
|
+
symbol?: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* - ISO 8601 timestamp of sales channel support
|
|
1477
|
+
* currency updation
|
|
1478
|
+
*/
|
|
1479
|
+
updated_at?: string;
|
|
1480
|
+
};
|
|
1481
|
+
/** @returns {CurrencyFeature} */
|
|
1482
|
+
declare function CurrencyFeature(): CurrencyFeature;
|
|
1483
|
+
type CurrencyFeature = {
|
|
1484
|
+
/**
|
|
1485
|
+
* - 3-letter code of the default currency
|
|
1486
|
+
* used in the application. Default vaule is 'INR'.
|
|
1487
|
+
*/
|
|
1488
|
+
default_currency?: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* - If 'explicit', currency formatting shows currency
|
|
1491
|
+
* code with price. For explicit or all currency selection.
|
|
1492
|
+
*/
|
|
1493
|
+
type?: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* - 3-letter currency code
|
|
1496
|
+
*/
|
|
1497
|
+
value?: string[];
|
|
1498
|
+
};
|
|
1499
|
+
/** @returns {Debit} */
|
|
1500
|
+
declare function Debit(): Debit;
|
|
1501
|
+
type Debit = {
|
|
1502
|
+
/**
|
|
1503
|
+
* - Allow automatic debit of reward points
|
|
1504
|
+
*/
|
|
1505
|
+
auto_apply?: boolean;
|
|
1506
|
+
/**
|
|
1507
|
+
* - Shows whether reward points are available for debit
|
|
1508
|
+
*/
|
|
1509
|
+
enabled?: boolean;
|
|
1510
|
+
/**
|
|
1511
|
+
* - Strategy channel for debiting reward points
|
|
1512
|
+
*/
|
|
1513
|
+
strategy_channel?: string;
|
|
1514
|
+
};
|
|
1515
|
+
/** @returns {DefaultCurrency} */
|
|
1516
|
+
declare function DefaultCurrency(): DefaultCurrency;
|
|
1517
|
+
type DefaultCurrency = {
|
|
1518
|
+
/**
|
|
1519
|
+
* - 3-character code of the default currency, e.g.
|
|
1520
|
+
* INR, EUR, USD
|
|
1521
|
+
*/
|
|
1522
|
+
code?: string;
|
|
1523
|
+
/**
|
|
1524
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1525
|
+
* of the default currency
|
|
1526
|
+
*/
|
|
1527
|
+
ref?: string;
|
|
1528
|
+
};
|
|
1529
|
+
/** @returns {DeploymentStoreSelectionFeature} */
|
|
1530
|
+
declare function DeploymentStoreSelectionFeature(): DeploymentStoreSelectionFeature;
|
|
1531
|
+
type DeploymentStoreSelectionFeature = {
|
|
1532
|
+
/**
|
|
1533
|
+
* - Shows whether selection of store (for
|
|
1534
|
+
* deploying the application) is permitted
|
|
1535
|
+
*/
|
|
1536
|
+
enabled?: boolean;
|
|
1537
|
+
/**
|
|
1538
|
+
* - Permitted values are 'hard' and 'soft'. For hard
|
|
1539
|
+
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
1540
|
+
* selection is optional.
|
|
1541
|
+
*/
|
|
1542
|
+
type?: string;
|
|
1543
|
+
};
|
|
1544
|
+
/** @returns {Device} */
|
|
1545
|
+
declare function Device(): Device;
|
|
1546
|
+
type Device = {
|
|
1547
|
+
build?: number;
|
|
1548
|
+
model?: string;
|
|
1549
|
+
os: OS;
|
|
1550
|
+
};
|
|
1551
|
+
/** @returns {Domain} */
|
|
1552
|
+
declare function Domain(): Domain;
|
|
1553
|
+
type Domain = {
|
|
1554
|
+
/**
|
|
1555
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
1556
|
+
* of the sales channel domain
|
|
1557
|
+
*/
|
|
1558
|
+
_id?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* - Domain is hosting domain or not.
|
|
1561
|
+
*/
|
|
1562
|
+
is_predefined?: boolean;
|
|
1563
|
+
/**
|
|
1564
|
+
* - Domain is primary or not. Primary domain
|
|
1565
|
+
* is the default/main domain.
|
|
1566
|
+
*/
|
|
1567
|
+
is_primary?: boolean;
|
|
1568
|
+
/**
|
|
1569
|
+
* - Shortlink is present or not for the domain
|
|
1570
|
+
*/
|
|
1571
|
+
is_shortlink?: boolean;
|
|
1572
|
+
name?: string;
|
|
1573
|
+
/**
|
|
1574
|
+
* - Domain is verified or not. TXT and A records
|
|
1575
|
+
* should propagate correctly.
|
|
1576
|
+
*/
|
|
1577
|
+
verified?: boolean;
|
|
1578
|
+
};
|
|
1579
|
+
/** @returns {FacebookLink} */
|
|
1580
|
+
declare function FacebookLink(): FacebookLink;
|
|
1581
|
+
type FacebookLink = {
|
|
1582
|
+
/**
|
|
1583
|
+
* - Hosted URL of social icon image shown on the website
|
|
1584
|
+
*/
|
|
1585
|
+
icon?: string;
|
|
1586
|
+
/**
|
|
1587
|
+
* - Web URL of brand's Facebook page
|
|
1588
|
+
*/
|
|
1589
|
+
link?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* - Name of the social media platform, e.g. Facebook
|
|
1592
|
+
*/
|
|
1593
|
+
title?: string;
|
|
1594
|
+
};
|
|
1595
|
+
/** @returns {FeedbackFeature} */
|
|
1596
|
+
declare function FeedbackFeature(): FeedbackFeature;
|
|
1597
|
+
type FeedbackFeature = {
|
|
1598
|
+
/**
|
|
1599
|
+
* - Shows whether customer feedback is enabled on
|
|
1600
|
+
* PDP. Default value is false.
|
|
1601
|
+
*/
|
|
1602
|
+
enabled?: boolean;
|
|
1603
|
+
};
|
|
1604
|
+
/** @returns {Firebase} */
|
|
1605
|
+
declare function Firebase(): Firebase;
|
|
1606
|
+
type Firebase = {
|
|
1607
|
+
credentials?: Credentials;
|
|
1608
|
+
/**
|
|
1609
|
+
* - Shows whether Firebase integration is enabled
|
|
1610
|
+
* or disabled for the sales channel
|
|
1611
|
+
*/
|
|
1612
|
+
enabled?: boolean;
|
|
1613
|
+
};
|
|
1614
|
+
/** @returns {Freshchat} */
|
|
1615
|
+
declare function Freshchat(): Freshchat;
|
|
1616
|
+
type Freshchat = {
|
|
1617
|
+
credentials?: FreshchatCredentials;
|
|
1618
|
+
/**
|
|
1619
|
+
* - Shows whether Freshchat integration is
|
|
1620
|
+
* enabled or disabled for the sales channel
|
|
1621
|
+
*/
|
|
1622
|
+
enabled?: boolean;
|
|
1623
|
+
};
|
|
1624
|
+
/** @returns {FreshchatCredentials} */
|
|
1625
|
+
declare function FreshchatCredentials(): FreshchatCredentials;
|
|
1626
|
+
type FreshchatCredentials = {
|
|
1627
|
+
/**
|
|
1628
|
+
* - The unique app_id of your Freshchat account for
|
|
1629
|
+
* integrating Freshchat with your sales channel
|
|
1630
|
+
*/
|
|
1631
|
+
app_id?: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* - The unique app_key of your Freshchat account
|
|
1634
|
+
* for integrating Freshchat with your sales channel
|
|
1635
|
+
*/
|
|
1636
|
+
app_key?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* - Web token used for accessing the Freshchat APIs
|
|
1639
|
+
*/
|
|
1640
|
+
web_token?: string;
|
|
1641
|
+
};
|
|
1642
|
+
/** @returns {FyndRewards} */
|
|
1643
|
+
declare function FyndRewards(): FyndRewards;
|
|
1644
|
+
type FyndRewards = {
|
|
1645
|
+
credentials?: FyndRewardsCredentials;
|
|
1646
|
+
};
|
|
1647
|
+
/** @returns {FyndRewardsCredentials} */
|
|
1648
|
+
declare function FyndRewardsCredentials(): FyndRewardsCredentials;
|
|
1649
|
+
type FyndRewardsCredentials = {
|
|
1650
|
+
/**
|
|
1651
|
+
* - Public key for integrating with Fynd rewards.
|
|
1652
|
+
*/
|
|
1653
|
+
public_key?: string;
|
|
1654
|
+
};
|
|
1655
|
+
/** @returns {GoogleMap} */
|
|
1656
|
+
declare function GoogleMap(): GoogleMap;
|
|
1657
|
+
type GoogleMap = {
|
|
1658
|
+
credentials?: GoogleMapCredentials;
|
|
1659
|
+
};
|
|
1660
|
+
/** @returns {GoogleMapCredentials} */
|
|
1661
|
+
declare function GoogleMapCredentials(): GoogleMapCredentials;
|
|
1662
|
+
type GoogleMapCredentials = {
|
|
1663
|
+
/**
|
|
1664
|
+
* - Secret API key for Google Maps. A unique
|
|
1665
|
+
* identifier that authenticates requests made to Google Maps API.
|
|
1666
|
+
*/
|
|
1667
|
+
api_key?: string;
|
|
1668
|
+
};
|
|
1669
|
+
/** @returns {GooglePlusLink} */
|
|
1670
|
+
declare function GooglePlusLink(): GooglePlusLink;
|
|
1671
|
+
type GooglePlusLink = {
|
|
1672
|
+
/**
|
|
1673
|
+
* - Hosted URL of social icon image shown on the website
|
|
1674
|
+
*/
|
|
1675
|
+
icon?: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* - Web URL of brand's Google+ account
|
|
1678
|
+
*/
|
|
1679
|
+
link?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* - Name of the social media platform, e.g. Google+
|
|
1682
|
+
*/
|
|
1683
|
+
title?: string;
|
|
1684
|
+
};
|
|
1685
|
+
/** @returns {Gtm} */
|
|
1686
|
+
declare function Gtm(): Gtm;
|
|
1687
|
+
type Gtm = {
|
|
1688
|
+
credentials?: GtmCredentials;
|
|
1689
|
+
/**
|
|
1690
|
+
* - Shows whether GTM integration is enabled or
|
|
1691
|
+
* disabled for the sales channel
|
|
1692
|
+
*/
|
|
1693
|
+
enabled?: boolean;
|
|
1694
|
+
};
|
|
1695
|
+
/** @returns {GtmCredentials} */
|
|
1696
|
+
declare function GtmCredentials(): GtmCredentials;
|
|
1697
|
+
type GtmCredentials = {
|
|
1698
|
+
/**
|
|
1699
|
+
* - Secret credential API key for GTM
|
|
1700
|
+
*/
|
|
1701
|
+
api_key?: string;
|
|
1702
|
+
};
|
|
1703
|
+
/** @returns {HomePageFeature} */
|
|
1704
|
+
declare function HomePageFeature(): HomePageFeature;
|
|
1705
|
+
type HomePageFeature = {
|
|
1706
|
+
/**
|
|
1707
|
+
* - Shows whether order processing is
|
|
1708
|
+
* enabled or not enabled
|
|
1709
|
+
*/
|
|
1710
|
+
order_processing?: boolean;
|
|
1711
|
+
};
|
|
1712
|
+
/** @returns {InformationAddress} */
|
|
1713
|
+
declare function InformationAddress(): InformationAddress;
|
|
1714
|
+
type InformationAddress = {
|
|
1715
|
+
/**
|
|
1716
|
+
* - Contact address of the sales channel
|
|
1717
|
+
*/
|
|
1718
|
+
address_line?: string[];
|
|
1719
|
+
/**
|
|
1720
|
+
* - Name of the city, e.g. Mumbai
|
|
1721
|
+
*/
|
|
1722
|
+
city?: string;
|
|
1723
|
+
/**
|
|
1724
|
+
* - Name of the country, e.g. India
|
|
1725
|
+
*/
|
|
1726
|
+
country?: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* - Co-ordinates of the location
|
|
1729
|
+
*/
|
|
1730
|
+
loc?: string;
|
|
1731
|
+
phone?: InformationPhone;
|
|
1732
|
+
/**
|
|
1733
|
+
* - 6-digit PIN Code of the city, e.g. 400001
|
|
1734
|
+
*/
|
|
1735
|
+
pincode?: number;
|
|
1736
|
+
};
|
|
1737
|
+
/** @returns {InformationPhone} */
|
|
1738
|
+
declare function InformationPhone(): InformationPhone;
|
|
1739
|
+
type InformationPhone = {
|
|
1740
|
+
/**
|
|
1741
|
+
* - Country code for contact number, e.g. +91 (for India)
|
|
1742
|
+
*/
|
|
1743
|
+
code?: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* - 10-digit mobile number
|
|
1746
|
+
*/
|
|
1747
|
+
number?: string;
|
|
1748
|
+
};
|
|
1749
|
+
/** @returns {InformationSupport} */
|
|
1750
|
+
declare function InformationSupport(): InformationSupport;
|
|
1751
|
+
type InformationSupport = {
|
|
1752
|
+
email?: string[];
|
|
1753
|
+
phone?: string[];
|
|
1754
|
+
/**
|
|
1755
|
+
* - Working hours of support team, e.g. 9 AM to 9 PM
|
|
1756
|
+
*/
|
|
1757
|
+
timing?: string;
|
|
1758
|
+
};
|
|
1759
|
+
/** @returns {InstagramLink} */
|
|
1760
|
+
declare function InstagramLink(): InstagramLink;
|
|
1761
|
+
type InstagramLink = {
|
|
1762
|
+
/**
|
|
1763
|
+
* - Hosted URL of social icon image shown on the website
|
|
1764
|
+
*/
|
|
1765
|
+
icon?: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* - Web URL of brand's Instagram page
|
|
1768
|
+
*/
|
|
1769
|
+
link?: string;
|
|
1770
|
+
/**
|
|
1771
|
+
* - Name of the social media platform, e.g. Instagram
|
|
1772
|
+
*/
|
|
1773
|
+
title?: string;
|
|
1774
|
+
};
|
|
1775
|
+
/** @returns {InvalidPayloadRequest} */
|
|
1776
|
+
declare function InvalidPayloadRequest(): InvalidPayloadRequest;
|
|
1777
|
+
type InvalidPayloadRequest = {
|
|
1778
|
+
/**
|
|
1779
|
+
* - Error message when request body payload is improper
|
|
1780
|
+
*/
|
|
1781
|
+
message?: string;
|
|
1782
|
+
};
|
|
1783
|
+
/** @returns {InventoryArticleAssignment} */
|
|
1784
|
+
declare function InventoryArticleAssignment(): InventoryArticleAssignment;
|
|
1785
|
+
type InventoryArticleAssignment = {
|
|
1786
|
+
/**
|
|
1787
|
+
* - Allow post order reassigment of article
|
|
1788
|
+
*/
|
|
1789
|
+
post_order_reassignment?: boolean;
|
|
1790
|
+
rules?: ArticleAssignmentRule;
|
|
1791
|
+
};
|
|
1792
|
+
/** @returns {InventoryBrandRule} */
|
|
1793
|
+
declare function InventoryBrandRule(): InventoryBrandRule;
|
|
1794
|
+
type InventoryBrandRule = {
|
|
1795
|
+
brands?: number[];
|
|
1796
|
+
/**
|
|
1797
|
+
* - Whether all brands are enabled, or explicitly
|
|
1798
|
+
* few brands in the inventory
|
|
1799
|
+
*/
|
|
1800
|
+
criteria?: string;
|
|
1801
|
+
};
|
|
1802
|
+
/** @returns {InventoryPaymentConfig} */
|
|
1803
|
+
declare function InventoryPaymentConfig(): InventoryPaymentConfig;
|
|
1804
|
+
type InventoryPaymentConfig = {
|
|
1805
|
+
/**
|
|
1806
|
+
* - Mode of payment for the inventory of
|
|
1807
|
+
* sales channel. It is required and default value is null.
|
|
1808
|
+
*/
|
|
1809
|
+
mode_of_payment?: string;
|
|
1810
|
+
/**
|
|
1811
|
+
* - Source of the payment mode for the inventory
|
|
1812
|
+
* payment of sales channel. Default value is FYND.
|
|
1813
|
+
*/
|
|
1814
|
+
source?: string;
|
|
1815
|
+
};
|
|
1816
|
+
/** @returns {InventoryStoreRule} */
|
|
1817
|
+
declare function InventoryStoreRule(): InventoryStoreRule;
|
|
1818
|
+
type InventoryStoreRule = {
|
|
1819
|
+
/**
|
|
1820
|
+
* - Whether all stores are enabled, or explicitly
|
|
1821
|
+
* few stores in the inventory, or use brands and company filter.
|
|
1822
|
+
*/
|
|
1823
|
+
criteria?: string;
|
|
1824
|
+
/**
|
|
1825
|
+
* - List of rules with company and
|
|
1826
|
+
* brands uids. Used when critera is `filter`.
|
|
1827
|
+
*/
|
|
1828
|
+
rules?: StoreCriteriaRule[];
|
|
1829
|
+
/**
|
|
1830
|
+
* - List of store uids. Used when critera is `explicit`.
|
|
1831
|
+
*/
|
|
1832
|
+
stores?: number[];
|
|
1833
|
+
};
|
|
1834
|
+
/** @returns {Ios} */
|
|
1835
|
+
declare function Ios(): Ios;
|
|
1836
|
+
type Ios = {
|
|
1837
|
+
/**
|
|
1838
|
+
* - Firebase secret credential API key for IOS
|
|
1839
|
+
*/
|
|
1840
|
+
api_key?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* - Alphanumeric ID allotted to a sales
|
|
1843
|
+
* channel application created within a business account
|
|
1844
|
+
*/
|
|
1845
|
+
application_id?: string;
|
|
1846
|
+
};
|
|
1847
|
+
/** @returns {LandingPageFeature} */
|
|
1848
|
+
declare function LandingPageFeature(): LandingPageFeature;
|
|
1849
|
+
type LandingPageFeature = {
|
|
1850
|
+
/**
|
|
1851
|
+
* - Shows whether a guest can checkout
|
|
1852
|
+
* from cart without logging in
|
|
1853
|
+
*/
|
|
1854
|
+
continue_as_guest?: boolean;
|
|
1855
|
+
launch_page?: LaunchPage;
|
|
1856
|
+
/**
|
|
1857
|
+
* - Shows the text displayed over the login button
|
|
1858
|
+
*/
|
|
1859
|
+
login_btn_text?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* - Shows whether a textbox for
|
|
1862
|
+
* entering domain is available
|
|
1863
|
+
*/
|
|
1864
|
+
show_domain_textbox?: boolean;
|
|
1865
|
+
/**
|
|
1866
|
+
* - Shows whether register button is
|
|
1867
|
+
* available in the login/landing page
|
|
1868
|
+
*/
|
|
1869
|
+
show_register_btn?: boolean;
|
|
1870
|
+
};
|
|
1871
|
+
/** @returns {LanguageResponse} */
|
|
1872
|
+
declare function LanguageResponse(): LanguageResponse;
|
|
1873
|
+
type LanguageResponse = {
|
|
1874
|
+
items?: SupportedLanguage[];
|
|
1875
|
+
};
|
|
1876
|
+
/** @returns {LaunchPage} */
|
|
1877
|
+
declare function LaunchPage(): LaunchPage;
|
|
1878
|
+
type LaunchPage = {
|
|
1879
|
+
/**
|
|
1880
|
+
* - Type of the launch page
|
|
1881
|
+
*/
|
|
1882
|
+
page_type?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* - Launch page params. It can be nullable.
|
|
1885
|
+
*/
|
|
1886
|
+
params?: any;
|
|
1887
|
+
/**
|
|
1888
|
+
* - Query related to launch page. It can be nullable.
|
|
1889
|
+
*/
|
|
1890
|
+
query?: any;
|
|
1891
|
+
};
|
|
1892
|
+
/** @returns {LinkedInLink} */
|
|
1893
|
+
declare function LinkedInLink(): LinkedInLink;
|
|
1894
|
+
type LinkedInLink = {
|
|
1895
|
+
/**
|
|
1896
|
+
* - Hosted URL of social icon image shown on the website
|
|
1897
|
+
*/
|
|
1898
|
+
icon?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* - Web URL of brand's LinkedIn channel
|
|
1901
|
+
*/
|
|
1902
|
+
link?: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* - Name of the social media platform, e.g. LinkedIn
|
|
1905
|
+
*/
|
|
1906
|
+
title?: string;
|
|
1907
|
+
};
|
|
1908
|
+
/** @returns {Links} */
|
|
1909
|
+
declare function Links(): Links;
|
|
1910
|
+
type Links = {
|
|
1911
|
+
/**
|
|
1912
|
+
* - Web URL for redirecting to a related page
|
|
1913
|
+
*/
|
|
1914
|
+
link?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* - Name of the related page or link
|
|
1917
|
+
*/
|
|
1918
|
+
title?: string;
|
|
1919
|
+
};
|
|
1920
|
+
/** @returns {ListingPriceFeature} */
|
|
1921
|
+
declare function ListingPriceFeature(): ListingPriceFeature;
|
|
1922
|
+
type ListingPriceFeature = {
|
|
1923
|
+
/**
|
|
1924
|
+
* - Sorting of listing price with min or max value.
|
|
1925
|
+
* Default value is min.
|
|
1926
|
+
*/
|
|
1927
|
+
sort?: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* - Shows which price to display on PLP if one
|
|
1930
|
+
* product has multiple prices (for each size), valid values are 'min', 'max',
|
|
1931
|
+
* 'range'. Default value is range.
|
|
1932
|
+
*/
|
|
1933
|
+
value?: string;
|
|
1934
|
+
};
|
|
1935
|
+
/** @returns {Moengage} */
|
|
1936
|
+
declare function Moengage(): Moengage;
|
|
1937
|
+
type Moengage = {
|
|
1938
|
+
credentials?: MoengageCredentials;
|
|
1939
|
+
/**
|
|
1940
|
+
* - Shows whether MoEngage integation is enabled
|
|
1941
|
+
* or disabled for the sales channel
|
|
1942
|
+
*/
|
|
1943
|
+
enabled?: boolean;
|
|
1944
|
+
};
|
|
1945
|
+
/** @returns {MoengageCredentials} */
|
|
1946
|
+
declare function MoengageCredentials(): MoengageCredentials;
|
|
1947
|
+
type MoengageCredentials = {
|
|
1948
|
+
/**
|
|
1949
|
+
* - APP ID provided by MoEngage to identify a
|
|
1950
|
+
* specific app. The app_id for your MoEngage account is available on the
|
|
1951
|
+
* MoEngage Dashboard.
|
|
1952
|
+
*/
|
|
1953
|
+
app_id?: string;
|
|
1954
|
+
};
|
|
1955
|
+
/** @returns {NotFound} */
|
|
1956
|
+
declare function NotFound(): NotFound;
|
|
1957
|
+
type NotFound = {
|
|
1958
|
+
/**
|
|
1959
|
+
* - Response message for not found
|
|
1960
|
+
*/
|
|
1961
|
+
message?: string;
|
|
1962
|
+
};
|
|
1963
|
+
/** @returns {OptedStoreAddress} */
|
|
1964
|
+
declare function OptedStoreAddress(): OptedStoreAddress;
|
|
1965
|
+
type OptedStoreAddress = {
|
|
1966
|
+
/**
|
|
1967
|
+
* - Address of the opted store
|
|
1968
|
+
*/
|
|
1969
|
+
address1?: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* - Address of the opted store
|
|
1972
|
+
*/
|
|
1973
|
+
address2?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* - City of the opted store, e.g. Mumbai
|
|
1976
|
+
*/
|
|
1977
|
+
city?: string;
|
|
1978
|
+
/**
|
|
1979
|
+
* - Country of the opted store, e.g. India
|
|
1980
|
+
*/
|
|
1981
|
+
country?: string;
|
|
1982
|
+
lat_long?: StoreLatLong;
|
|
1983
|
+
/**
|
|
1984
|
+
* - 6-digit PIN code of the opted store location
|
|
1985
|
+
*/
|
|
1986
|
+
pincode?: number;
|
|
1987
|
+
/**
|
|
1988
|
+
* - State of the opted store, e.g. Maharashtra
|
|
1989
|
+
*/
|
|
1990
|
+
state?: string;
|
|
1991
|
+
};
|
|
1992
|
+
/** @returns {OrderFeature} */
|
|
1993
|
+
declare function OrderFeature(): OrderFeature;
|
|
1994
|
+
type OrderFeature = {
|
|
1995
|
+
/**
|
|
1996
|
+
* - Allow buy again option for order. Default
|
|
1997
|
+
* value is false.
|
|
1998
|
+
*/
|
|
1999
|
+
buy_again?: boolean;
|
|
2000
|
+
};
|
|
2001
|
+
/** @returns {OrderingStore} */
|
|
2002
|
+
declare function OrderingStore(): OrderingStore;
|
|
2003
|
+
type OrderingStore = {
|
|
2004
|
+
/**
|
|
2005
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2006
|
+
* of the ordering store
|
|
2007
|
+
*/
|
|
2008
|
+
_id?: string;
|
|
2009
|
+
address?: OptedStoreAddress;
|
|
2010
|
+
/**
|
|
2011
|
+
* - Code of the ordering store (usually same as Store Code)
|
|
2012
|
+
*/
|
|
2013
|
+
code?: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* - Display name of the ordering store
|
|
2016
|
+
*/
|
|
2017
|
+
display_name?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* - Store name of the ordering store
|
|
2020
|
+
*/
|
|
2021
|
+
name?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
2024
|
+
*/
|
|
2025
|
+
pincode?: number;
|
|
2026
|
+
/**
|
|
2027
|
+
* - Store code of the ordering store, e.g. MUM-102
|
|
2028
|
+
*/
|
|
2029
|
+
store_code?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* - Store type of the ordering store, e.g.
|
|
2032
|
+
* high_street, mall, warehouse
|
|
2033
|
+
*/
|
|
2034
|
+
store_type?: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* - Ordering store UID
|
|
2037
|
+
*/
|
|
2038
|
+
uid?: number;
|
|
2039
|
+
};
|
|
2040
|
+
/** @returns {OrderingStores} */
|
|
2041
|
+
declare function OrderingStores(): OrderingStores;
|
|
2042
|
+
type OrderingStores = {
|
|
2043
|
+
/**
|
|
2044
|
+
* - Version key for tracking ordering stores. Default
|
|
2045
|
+
* value is zero.
|
|
2046
|
+
*/
|
|
2047
|
+
__v?: number;
|
|
2048
|
+
/**
|
|
2049
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2050
|
+
* of the ordering store
|
|
2051
|
+
*/
|
|
2052
|
+
_id?: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* - Allow all stores of the ordering stores
|
|
2055
|
+
*/
|
|
2056
|
+
all_stores?: boolean;
|
|
2057
|
+
/**
|
|
2058
|
+
* - Alphanumeric ID allotted to an application (sales
|
|
2059
|
+
* channel website) created within a business account
|
|
2060
|
+
*/
|
|
2061
|
+
app?: string;
|
|
2062
|
+
deployed_stores?: number[];
|
|
2063
|
+
/**
|
|
2064
|
+
* - Allow ordering stores for current sales channel
|
|
2065
|
+
*/
|
|
2066
|
+
enabled?: boolean;
|
|
2067
|
+
items?: OrderingStore[];
|
|
2068
|
+
page?: Page;
|
|
2069
|
+
/**
|
|
2070
|
+
* - For hard type delivery, store selection is
|
|
2071
|
+
* compulsory. For soft type, delivery store selection is optional.
|
|
2072
|
+
*/
|
|
2073
|
+
type?: string;
|
|
2074
|
+
};
|
|
2075
|
+
/** @returns {OrderingStoreSelect} */
|
|
2076
|
+
declare function OrderingStoreSelect(): OrderingStoreSelect;
|
|
2077
|
+
type OrderingStoreSelect = {
|
|
2078
|
+
/**
|
|
2079
|
+
* - Ordering store unique uid. It is required.
|
|
2080
|
+
*/
|
|
2081
|
+
uid: number;
|
|
2082
|
+
};
|
|
2083
|
+
/** @returns {OrderingStoreSelectRequest} */
|
|
2084
|
+
declare function OrderingStoreSelectRequest(): OrderingStoreSelectRequest;
|
|
2085
|
+
type OrderingStoreSelectRequest = {
|
|
2086
|
+
ordering_store: OrderingStoreSelect;
|
|
2087
|
+
};
|
|
2088
|
+
/** @returns {OrderingStoresResponse} */
|
|
2089
|
+
declare function OrderingStoresResponse(): OrderingStoresResponse;
|
|
2090
|
+
type OrderingStoresResponse = {
|
|
2091
|
+
items?: OrderingStore[];
|
|
2092
|
+
page?: Page;
|
|
2093
|
+
};
|
|
2094
|
+
/** @returns {OS} */
|
|
2095
|
+
declare function OS(): OS;
|
|
2096
|
+
type OS = {
|
|
2097
|
+
name: string;
|
|
2098
|
+
version?: string;
|
|
2099
|
+
};
|
|
2100
|
+
/** @returns {OwnerInfo} */
|
|
2101
|
+
declare function OwnerInfo(): OwnerInfo;
|
|
2102
|
+
type OwnerInfo = {
|
|
2103
|
+
/**
|
|
2104
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2105
|
+
* of owner info
|
|
2106
|
+
*/
|
|
2107
|
+
_id?: string;
|
|
2108
|
+
emails?: UserEmail[];
|
|
2109
|
+
/**
|
|
2110
|
+
* - First name of the owner
|
|
2111
|
+
*/
|
|
2112
|
+
first_name?: string;
|
|
2113
|
+
/**
|
|
2114
|
+
* - Last name of the owner
|
|
2115
|
+
*/
|
|
2116
|
+
last_name?: string;
|
|
2117
|
+
phone_numbers?: UserPhoneNumber[];
|
|
2118
|
+
/**
|
|
2119
|
+
* - Hosted URL of profile pic
|
|
2120
|
+
*/
|
|
2121
|
+
profile_pic?: string;
|
|
2122
|
+
};
|
|
2123
|
+
/** @returns {Page} */
|
|
2124
|
+
declare function Page(): Page;
|
|
2125
|
+
type Page = {
|
|
2126
|
+
current?: number;
|
|
2127
|
+
has_next?: boolean;
|
|
2128
|
+
has_previous?: boolean;
|
|
2129
|
+
item_total?: number;
|
|
2130
|
+
next_id?: string;
|
|
2131
|
+
size?: number;
|
|
2132
|
+
type: string;
|
|
2133
|
+
};
|
|
2134
|
+
/** @returns {PcrFeature} */
|
|
2135
|
+
declare function PcrFeature(): PcrFeature;
|
|
2136
|
+
type PcrFeature = {
|
|
2137
|
+
/**
|
|
2138
|
+
* - Allow staff selection. Default value is false.
|
|
2139
|
+
*/
|
|
2140
|
+
staff_selection?: boolean;
|
|
2141
|
+
};
|
|
2142
|
+
/** @returns {PinterestLink} */
|
|
2143
|
+
declare function PinterestLink(): PinterestLink;
|
|
2144
|
+
type PinterestLink = {
|
|
2145
|
+
/**
|
|
2146
|
+
* - Hosted URL of social icon image shown on the website
|
|
2147
|
+
*/
|
|
2148
|
+
icon?: string;
|
|
2149
|
+
/**
|
|
2150
|
+
* - Web URL of brand's Pinterest page
|
|
2151
|
+
*/
|
|
2152
|
+
link?: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* - Name of the social media platform, e.g. Pinterest
|
|
2155
|
+
*/
|
|
2156
|
+
title?: string;
|
|
2157
|
+
};
|
|
2158
|
+
/** @returns {ProductDetailFeature} */
|
|
2159
|
+
declare function ProductDetailFeature(): ProductDetailFeature;
|
|
2160
|
+
type ProductDetailFeature = {
|
|
2161
|
+
/**
|
|
2162
|
+
* - Indicates whether customers can
|
|
2163
|
+
* request for a product. Default value is false.
|
|
2164
|
+
*/
|
|
2165
|
+
request_product?: boolean;
|
|
2166
|
+
/**
|
|
2167
|
+
* - Shows whether the customers can
|
|
2168
|
+
* choose the seller on PDP
|
|
2169
|
+
*/
|
|
2170
|
+
seller_selection?: boolean;
|
|
2171
|
+
/**
|
|
2172
|
+
* - Configuration to show similar products,
|
|
2173
|
+
* other products from same seller, other products in same category, other
|
|
2174
|
+
* products in same price range, etc.
|
|
2175
|
+
*/
|
|
2176
|
+
similar?: string[];
|
|
2177
|
+
/**
|
|
2178
|
+
* - Allow user to update product
|
|
2179
|
+
* meta. Default value is true.
|
|
2180
|
+
*/
|
|
2181
|
+
update_product_meta?: boolean;
|
|
2182
|
+
};
|
|
2183
|
+
/** @returns {QrFeature} */
|
|
2184
|
+
declare function QrFeature(): QrFeature;
|
|
2185
|
+
type QrFeature = {
|
|
2186
|
+
/**
|
|
2187
|
+
* - Shows whether sharing of mobile app via
|
|
2188
|
+
* QR code is allowed. Default value is false.
|
|
2189
|
+
*/
|
|
2190
|
+
application?: boolean;
|
|
2191
|
+
/**
|
|
2192
|
+
* - Shows whether sharing collection via QR
|
|
2193
|
+
* code is allowed. Default value is false.
|
|
2194
|
+
*/
|
|
2195
|
+
collections?: boolean;
|
|
2196
|
+
/**
|
|
2197
|
+
* - Shows whether sharing product via QR code is
|
|
2198
|
+
* allowed. Default value is false.
|
|
2199
|
+
*/
|
|
2200
|
+
products?: boolean;
|
|
2201
|
+
};
|
|
2202
|
+
/** @returns {RegistrationPageFeature} */
|
|
2203
|
+
declare function RegistrationPageFeature(): RegistrationPageFeature;
|
|
2204
|
+
type RegistrationPageFeature = {
|
|
2205
|
+
/**
|
|
2206
|
+
* - Shows whether a form to collect the
|
|
2207
|
+
* address of the store, should be displayed upon visiting the website
|
|
2208
|
+
*/
|
|
2209
|
+
ask_store_address?: boolean;
|
|
2210
|
+
};
|
|
2211
|
+
/** @returns {RevenueEngineFeature} */
|
|
2212
|
+
declare function RevenueEngineFeature(): RevenueEngineFeature;
|
|
2213
|
+
type RevenueEngineFeature = {
|
|
2214
|
+
/**
|
|
2215
|
+
* - Enable revenue engine. Default value is false.
|
|
2216
|
+
*/
|
|
2217
|
+
enabled?: boolean;
|
|
2218
|
+
};
|
|
2219
|
+
/** @returns {RewardPointsConfig} */
|
|
2220
|
+
declare function RewardPointsConfig(): RewardPointsConfig;
|
|
2221
|
+
type RewardPointsConfig = {
|
|
2222
|
+
credit?: Credit;
|
|
2223
|
+
debit?: Debit;
|
|
2224
|
+
};
|
|
2225
|
+
/** @returns {Safetynet} */
|
|
2226
|
+
declare function Safetynet(): Safetynet;
|
|
2227
|
+
type Safetynet = {
|
|
2228
|
+
credentials?: SafetynetCredentials;
|
|
2229
|
+
/**
|
|
2230
|
+
* - Shows whether Safetynet integration is
|
|
2231
|
+
* enabled or disabled for the sales channel
|
|
2232
|
+
*/
|
|
2233
|
+
enabled?: boolean;
|
|
2234
|
+
};
|
|
2235
|
+
/** @returns {SafetynetCredentials} */
|
|
2236
|
+
declare function SafetynetCredentials(): SafetynetCredentials;
|
|
2237
|
+
type SafetynetCredentials = {
|
|
2238
|
+
/**
|
|
2239
|
+
* - Secret credential API key for Safetynet. This
|
|
2240
|
+
* API key is used for calling the methods of Safetynet APIs.
|
|
2241
|
+
*/
|
|
2242
|
+
api_key?: string;
|
|
2243
|
+
};
|
|
2244
|
+
/** @returns {SecureUrl} */
|
|
2245
|
+
declare function SecureUrl(): SecureUrl;
|
|
2246
|
+
type SecureUrl = {
|
|
2247
|
+
/**
|
|
2248
|
+
* - Hosted URL of the image
|
|
2249
|
+
*/
|
|
2250
|
+
secure_url?: string;
|
|
2251
|
+
};
|
|
2252
|
+
/** @returns {Segment} */
|
|
2253
|
+
declare function Segment(): Segment;
|
|
2254
|
+
type Segment = {
|
|
2255
|
+
credentials?: SegmentCredentials;
|
|
2256
|
+
/**
|
|
2257
|
+
* - Shows whether Segment integration is enabled
|
|
2258
|
+
* or disabled for the sales channel
|
|
2259
|
+
*/
|
|
2260
|
+
enabled?: boolean;
|
|
2261
|
+
};
|
|
2262
|
+
/** @returns {SegmentCredentials} */
|
|
2263
|
+
declare function SegmentCredentials(): SegmentCredentials;
|
|
2264
|
+
type SegmentCredentials = {
|
|
2265
|
+
/**
|
|
2266
|
+
* - The unique identifier for a source that
|
|
2267
|
+
* tells Segment from which source data is coming from, to which workspace the
|
|
2268
|
+
* data belongs, and which destinations should receive the data.
|
|
2269
|
+
*/
|
|
2270
|
+
write_key?: string;
|
|
2271
|
+
};
|
|
2272
|
+
/** @returns {SocialLinks} */
|
|
2273
|
+
declare function SocialLinks(): SocialLinks;
|
|
2274
|
+
type SocialLinks = {
|
|
2275
|
+
blog_link?: BlogLink;
|
|
2276
|
+
facebook?: FacebookLink;
|
|
2277
|
+
google_plus?: GooglePlusLink;
|
|
2278
|
+
instagram?: InstagramLink;
|
|
2279
|
+
linked_in?: LinkedInLink;
|
|
2280
|
+
pinterest?: PinterestLink;
|
|
2281
|
+
twitter?: TwitterLink;
|
|
2282
|
+
vimeo?: VimeoLink;
|
|
2283
|
+
youtube?: YoutubeLink;
|
|
2284
|
+
};
|
|
2285
|
+
/** @returns {StoreCriteriaRule} */
|
|
2286
|
+
declare function StoreCriteriaRule(): StoreCriteriaRule;
|
|
2287
|
+
type StoreCriteriaRule = {
|
|
2288
|
+
/**
|
|
2289
|
+
* - List of brand UID
|
|
2290
|
+
*/
|
|
2291
|
+
brands?: number[];
|
|
2292
|
+
/**
|
|
2293
|
+
* - List of company UID
|
|
2294
|
+
*/
|
|
2295
|
+
companies?: number[];
|
|
2296
|
+
};
|
|
2297
|
+
/** @returns {StoreLatLong} */
|
|
2298
|
+
declare function StoreLatLong(): StoreLatLong;
|
|
2299
|
+
type StoreLatLong = {
|
|
2300
|
+
coordinates?: number[];
|
|
2301
|
+
/**
|
|
2302
|
+
* - Coordinates type of the opted store
|
|
2303
|
+
*/
|
|
2304
|
+
type?: string;
|
|
2305
|
+
};
|
|
2306
|
+
/** @returns {StorePriorityRule} */
|
|
2307
|
+
declare function StorePriorityRule(): StorePriorityRule;
|
|
2308
|
+
type StorePriorityRule = {
|
|
2309
|
+
/**
|
|
2310
|
+
* - Shows store priority is enabled or not
|
|
2311
|
+
* enabled for the article assignment.
|
|
2312
|
+
*/
|
|
2313
|
+
enabled?: boolean;
|
|
2314
|
+
storetype_order?: string[];
|
|
2315
|
+
};
|
|
2316
|
+
/** @returns {SuccessMessageResponse} */
|
|
2317
|
+
declare function SuccessMessageResponse(): SuccessMessageResponse;
|
|
2318
|
+
type SuccessMessageResponse = {
|
|
2319
|
+
/**
|
|
2320
|
+
* - Success message shown to the user (in a string format)
|
|
2321
|
+
*/
|
|
2322
|
+
message?: string;
|
|
2323
|
+
};
|
|
2324
|
+
/** @returns {SupportedLanguage} */
|
|
2325
|
+
declare function SupportedLanguage(): SupportedLanguage;
|
|
2326
|
+
type SupportedLanguage = {
|
|
2327
|
+
/**
|
|
2328
|
+
* - Unique code of supported language, e.g. hi-IN
|
|
2329
|
+
*/
|
|
2330
|
+
code?: string;
|
|
2331
|
+
/**
|
|
2332
|
+
* - Name of the supported language, e.g. हिन्दी
|
|
2333
|
+
*/
|
|
2334
|
+
name?: string;
|
|
2335
|
+
};
|
|
2336
|
+
/** @returns {Tokens} */
|
|
2337
|
+
declare function Tokens(): Tokens;
|
|
2338
|
+
type Tokens = {
|
|
2339
|
+
firebase?: Firebase;
|
|
2340
|
+
freshchat?: Freshchat;
|
|
2341
|
+
fynd_rewards?: FyndRewards;
|
|
2342
|
+
google_map?: GoogleMap;
|
|
2343
|
+
gtm?: Gtm;
|
|
2344
|
+
moengage?: Moengage;
|
|
2345
|
+
safetynet?: Safetynet;
|
|
2346
|
+
segment?: Segment;
|
|
2347
|
+
};
|
|
2348
|
+
/** @returns {TwitterLink} */
|
|
2349
|
+
declare function TwitterLink(): TwitterLink;
|
|
2350
|
+
type TwitterLink = {
|
|
2351
|
+
/**
|
|
2352
|
+
* - Hosted URL of social icon image shown on the website
|
|
2353
|
+
*/
|
|
2354
|
+
icon?: string;
|
|
2355
|
+
/**
|
|
2356
|
+
* - Web URL of brand's Twitter account
|
|
2357
|
+
*/
|
|
2358
|
+
link?: string;
|
|
2359
|
+
/**
|
|
2360
|
+
* - Name of the social media platform, e.g. Twitter
|
|
2361
|
+
*/
|
|
2362
|
+
title?: string;
|
|
2363
|
+
};
|
|
2364
|
+
/** @returns {UnhandledError} */
|
|
2365
|
+
declare function UnhandledError(): UnhandledError;
|
|
2366
|
+
type UnhandledError = {
|
|
2367
|
+
message?: string;
|
|
2368
|
+
};
|
|
2369
|
+
/** @returns {UpdateDialog} */
|
|
2370
|
+
declare function UpdateDialog(): UpdateDialog;
|
|
2371
|
+
type UpdateDialog = {
|
|
2372
|
+
interval?: number;
|
|
2373
|
+
type?: string;
|
|
2374
|
+
};
|
|
2375
|
+
/** @returns {UserEmail} */
|
|
2376
|
+
declare function UserEmail(): UserEmail;
|
|
2377
|
+
type UserEmail = {
|
|
2378
|
+
/**
|
|
2379
|
+
* - Current email is active or not active
|
|
2380
|
+
*/
|
|
2381
|
+
active?: boolean;
|
|
2382
|
+
/**
|
|
2383
|
+
* - Email address of the user
|
|
2384
|
+
*/
|
|
2385
|
+
email?: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* - Indicates current email is primay email or
|
|
2388
|
+
* not primary email of user
|
|
2389
|
+
*/
|
|
2390
|
+
primary?: boolean;
|
|
2391
|
+
/**
|
|
2392
|
+
* - Indicates current email is verified email or
|
|
2393
|
+
* not verified email
|
|
2394
|
+
*/
|
|
2395
|
+
verified?: boolean;
|
|
2396
|
+
};
|
|
2397
|
+
/** @returns {UserPhoneNumber} */
|
|
2398
|
+
declare function UserPhoneNumber(): UserPhoneNumber;
|
|
2399
|
+
type UserPhoneNumber = {
|
|
2400
|
+
/**
|
|
2401
|
+
* - Current phone number is active or not active
|
|
2402
|
+
*/
|
|
2403
|
+
active?: boolean;
|
|
2404
|
+
/**
|
|
2405
|
+
* - Country code, e.g. +91
|
|
2406
|
+
*/
|
|
2407
|
+
country_code?: number;
|
|
2408
|
+
/**
|
|
2409
|
+
* - Phone number of the user
|
|
2410
|
+
*/
|
|
2411
|
+
phone?: string;
|
|
2412
|
+
/**
|
|
2413
|
+
* - Indicates current phone number is primay or
|
|
2414
|
+
* not primary of user
|
|
2415
|
+
*/
|
|
2416
|
+
primary?: boolean;
|
|
2417
|
+
/**
|
|
2418
|
+
* - Indicates current phone number is verified
|
|
2419
|
+
* or not verified
|
|
2420
|
+
*/
|
|
2421
|
+
verified?: boolean;
|
|
2422
|
+
};
|
|
2423
|
+
/** @returns {VimeoLink} */
|
|
2424
|
+
declare function VimeoLink(): VimeoLink;
|
|
2425
|
+
type VimeoLink = {
|
|
2426
|
+
/**
|
|
2427
|
+
* - Hosted URL of social icon image shown on the website
|
|
2428
|
+
*/
|
|
2429
|
+
icon?: string;
|
|
2430
|
+
/**
|
|
2431
|
+
* - Web URL of brand's Vimeo channel
|
|
2432
|
+
*/
|
|
2433
|
+
link?: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* - Name of the video hosting platform, e.g. Vimeo
|
|
2436
|
+
*/
|
|
2437
|
+
title?: string;
|
|
2438
|
+
};
|
|
2439
|
+
/** @returns {YoutubeLink} */
|
|
2440
|
+
declare function YoutubeLink(): YoutubeLink;
|
|
2441
|
+
type YoutubeLink = {
|
|
2442
|
+
/**
|
|
2443
|
+
* - Hosted URL of social icon image shown on the website
|
|
2444
|
+
*/
|
|
2445
|
+
icon?: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* - Web URL of brand's YouTube channel
|
|
2448
|
+
*/
|
|
2449
|
+
link?: string;
|
|
2450
|
+
/**
|
|
2451
|
+
* - Name of the social media platform, e.g. YouTube
|
|
2452
|
+
*/
|
|
2453
|
+
title?: string;
|
|
2454
|
+
};
|