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