@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3

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