@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -1,189 +1,4505 @@
1
- export = ConfigurationModel;
2
- declare class ConfigurationModel {
3
- static Android(): any;
4
- static App(): any;
5
- static AppCartConfig(): any;
6
- static AppCurrencyResponse(): any;
7
- static AppDomain(): any;
8
- static AppFeature(): any;
9
- static AppFeatureRequest(): any;
10
- static AppFeatureResponse(): any;
11
- static AppInventory(): any;
12
- static AppInventoryCompanies(): any;
13
- static AppInventoryConfig(): any;
14
- static AppInventoryPartialUpdate(): any;
15
- static AppInventoryStores(): any;
16
- static Application(): any;
17
- static ApplicationAuth(): any;
18
- static ApplicationCors(): any;
19
- static ApplicationDetail(): any;
20
- static ApplicationInformation(): any;
21
- static ApplicationInventory(): any;
22
- static ApplicationMeta(): any;
23
- static ApplicationRedirections(): any;
24
- static ApplicationsResponse(): any;
25
- static ApplicationWebsite(): any;
26
- static AppLogisticsConfig(): any;
27
- static AppOrderConfig(): any;
28
- static AppPaymentConfig(): any;
29
- static AppStoreRules(): any;
30
- static AppSupportedCurrency(): any;
31
- static ArticleAssignmentConfig(): any;
32
- static ArticleAssignmentRule(): any;
33
- static ArticleAssignmentRules(): any;
34
- static AuthenticationConfig(): any;
35
- static BlogLink(): any;
36
- static BrandCompanyInfo(): any;
37
- static BrandsByCompanyResponse(): any;
38
- static BrandStoreInfo(): any;
39
- static BuildVersion(): any;
40
- static BuildVersionHistory(): any;
41
- static BusinessHighlights(): any;
42
- static CallbackUrl(): any;
43
- static CartFeature(): any;
44
- static Charges(): any;
45
- static CommonFeature(): any;
46
- static CommsConfig(): any;
47
- static CommunicationConfig(): any;
48
- static CommunicationOptinDialogFeature(): any;
49
- static CompaniesResponse(): any;
50
- static CompanyAboutAddress(): any;
51
- static CompanyBrandInfo(): any;
52
- static CompanyByBrandsRequest(): any;
53
- static CompanyByBrandsResponse(): any;
54
- static CompanyValidator(): any;
55
- static CompareProductsFeature(): any;
56
- static CreateApplicationRequest(): any;
57
- static CreateAppResponse(): any;
58
- static Credentials(): any;
59
- static Credit(): any;
60
- static CurrenciesResponse(): any;
61
- static Currency(): any;
62
- static CurrencyConfig(): any;
63
- static CurrencyFeature(): any;
64
- static Debit(): any;
65
- static DefaultCurrency(): any;
66
- static DeliveryCharges(): any;
67
- static DeploymentMeta(): any;
68
- static DeploymentStoreSelectionFeature(): any;
69
- static Domain(): any;
70
- static DomainAdd(): any;
71
- static DomainAddRequest(): any;
72
- static DomainsResponse(): any;
73
- static DomainStatus(): any;
74
- static DomainStatusRequest(): any;
75
- static DomainStatusResponse(): any;
76
- static DomainSuggestion(): any;
77
- static DomainSuggestionsRequest(): any;
78
- static DomainSuggestionsResponse(): any;
79
- static FacebookLink(): any;
80
- static FeedbackFeature(): any;
81
- static FilterOrderingStoreRequest(): any;
82
- static Firebase(): any;
83
- static Freshchat(): any;
84
- static FreshchatCredentials(): any;
85
- static FyndRewards(): any;
86
- static FyndRewardsCredentials(): any;
87
- static GetIntegrationsOptInsResponse(): any;
88
- static GoogleMap(): any;
89
- static GoogleMapCredentials(): any;
90
- static GooglePlusLink(): any;
91
- static Gtm(): any;
92
- static GtmCredentials(): any;
93
- static HomePageFeature(): any;
94
- static InformationAddress(): any;
95
- static InformationPhone(): any;
96
- static InformationSupport(): any;
97
- static InstagramLink(): any;
98
- static Integration(): any;
99
- static IntegrationConfigResponse(): any;
100
- static IntegrationLevel(): any;
101
- static IntegrationMeta(): any;
102
- static IntegrationOptIn(): any;
103
- static InvalidPayloadRequest(): any;
104
- static InventoryArticleAssignment(): any;
105
- static InventoryBrand(): any;
106
- static InventoryBrandRule(): any;
107
- static InventoryCategory(): any;
108
- static InventoryDiscount(): any;
109
- static InventoryPaymentConfig(): any;
110
- static InventoryPrice(): any;
111
- static InventoryStore(): any;
112
- static InventoryStoreRule(): any;
113
- static InventoryValidator(): any;
114
- static Ios(): any;
115
- static JsonSchema(): any;
116
- static LandingImage(): any;
117
- static LandingPageFeature(): any;
118
- static LastPatch(): any;
119
- static LaunchPage(): any;
120
- static LinkedInLink(): any;
121
- static Links(): any;
122
- static ListingPriceFeature(): any;
123
- static LoyaltyPointsConfig(): any;
124
- static Methods(): any;
125
- static MobileAppConfigRequest(): any;
126
- static MobileAppConfiguration(): any;
127
- static Moengage(): any;
128
- static MoengageCredentials(): any;
129
- static NotFound(): any;
130
- static OptedApplicationResponse(): any;
131
- static OptedCompany(): any;
132
- static OptedInventory(): any;
133
- static OptedStore(): any;
134
- static OptedStoreAddress(): any;
135
- static OptedStoreIntegration(): any;
136
- static OptOutInventory(): any;
137
- static OptType(): any;
138
- static OrderFeature(): any;
139
- static OrderingStore(): any;
140
- static OrderingStoreConfig(): any;
141
- static OrderingStores(): any;
142
- static OrderingStoresResponse(): any;
143
- static OrderValidator(): any;
144
- static OtherEntity(): any;
145
- static OtherEntityData(): any;
146
- static OtherSellerApplication(): any;
147
- static OtherSellerApplications(): any;
148
- static OtherSellerCompany(): any;
149
- static Page(): any;
150
- static PanCardConfig(): any;
151
- static PaymentModeConfig(): any;
152
- static PaymentSelectionLock(): any;
153
- static PcrFeature(): any;
154
- static PinterestLink(): any;
155
- static ProductDetailFeature(): any;
156
- static QrFeature(): any;
157
- static RegistrationPageFeature(): any;
158
- static RevenueEngineFeature(): any;
159
- static RewardPointsConfig(): any;
160
- static Safetynet(): any;
161
- static SafetynetCredentials(): any;
162
- static SecureUrl(): any;
163
- static Segment(): any;
164
- static SegmentCredentials(): any;
165
- static SocialLinks(): any;
166
- static SplashImage(): any;
167
- static StoreByBrandsRequest(): any;
168
- static StoreByBrandsResponse(): any;
169
- static StoreCriteriaRule(): any;
170
- static StoreLatLong(): any;
171
- static StorePriority(): any;
172
- static StorePriorityRule(): any;
173
- static StoresResponse(): any;
174
- static StoreValidator(): any;
175
- static SuccessMessageResponse(): any;
176
- static TokenResponse(): any;
177
- static Tokens(): any;
178
- static TwitterLink(): any;
179
- static UnhandledError(): any;
180
- static UpdateDomain(): any;
181
- static UpdateDomainTypeRequest(): any;
182
- static UpdateIntegrationLevelRequest(): any;
183
- static UserEmail(): any;
184
- static UserPhoneNumber(): any;
185
- static ValidationFailedResponse(): any;
186
- static Validators(): any;
187
- static VimeoLink(): any;
188
- static YoutubeLink(): any;
1
+ export = ConfigurationPlatformModel;
2
+ /**
3
+ * @typedef Android
4
+ * @property {string} [api_key] - Firebase secret credential API key for Android
5
+ * @property {string} [application_id] - Alphanumeric ID allotted to a sales
6
+ * channel application created within a business account
7
+ */
8
+ /**
9
+ * @typedef App
10
+ * @property {ApplicationAuth} [auth]
11
+ * @property {string} [channel_type] - It indicates different channel types like
12
+ * store, website-and-mobile-apps. Default value is store
13
+ * @property {string} [company_id] - Numeric ID allotted to a business account
14
+ * on Fynd Platform.
15
+ * @property {string} [desc] - Detailed description about the sales channel
16
+ * @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion
17
+ */
18
+ /**
19
+ * @typedef AppCartConfig
20
+ * @property {boolean} [bulk_coupons] - Allow creation of bulk coupons
21
+ * @property {DeliveryCharges} [delivery_charges]
22
+ * @property {boolean} [enabled] - Shows whether cart configuration is enabled or not
23
+ * @property {number} [max_cart_items] - Maximum number of items that can be
24
+ * added to cart by the customer
25
+ * @property {number} [min_cart_value] - Minimum cart value below which customer
26
+ * cannot place an order
27
+ * @property {PanCardConfig} [pan_card]
28
+ * @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits
29
+ * together. Default value is false.
30
+ */
31
+ /**
32
+ * @typedef AppCurrencyResponse
33
+ * @property {string} [application] - Alphanumeric ID allotted to an application
34
+ * (sales channel website) created within a business account
35
+ * @property {DefaultCurrency} [default_currency]
36
+ * @property {Currency[]} [supported_currency]
37
+ */
38
+ /**
39
+ * @typedef AppDomain
40
+ * @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
41
+ */
42
+ /**
43
+ * @typedef AppFeature
44
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero
45
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
46
+ * for the sales channel features
47
+ * @property {string} [app] - Application ID of the sales channel
48
+ * @property {CartFeature} [cart]
49
+ * @property {CommonFeature} [common]
50
+ * @property {string} [created_at] - ISO 8601 timestamp showing the date when
51
+ * the features were configured
52
+ * @property {HomePageFeature} [home_page]
53
+ * @property {LandingPageFeature} [landing_page]
54
+ * @property {OrderFeature} [order]
55
+ * @property {PcrFeature} [pcr]
56
+ * @property {ProductDetailFeature} [product_detail]
57
+ * @property {QrFeature} [qr]
58
+ * @property {RegistrationPageFeature} [registration_page]
59
+ * @property {string} [updated_at] - ISO 8601 timestamp of last known
60
+ * modifications to the sales channel feature configuration
61
+ */
62
+ /**
63
+ * @typedef AppFeatureRequest
64
+ * @property {AppFeature} [feature]
65
+ */
66
+ /**
67
+ * @typedef AppFeatureResponse
68
+ * @property {AppFeature} [feature]
69
+ */
70
+ /**
71
+ * @typedef AppInventory
72
+ * @property {InventoryArticleAssignment} [article_assignment]
73
+ * @property {InventoryBrandRule} [brand]
74
+ * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
75
+ * to consume the current sales channel's inventory and sell products
76
+ * @property {string[]} [image]
77
+ * @property {boolean} [only_verified_products] - Show only verified products
78
+ * (the ones whose data have been verified by the admin)
79
+ * @property {boolean} [out_of_stock] - Indicates whether out of stock products
80
+ * are allowed to show up on the website.
81
+ * @property {InventoryPaymentConfig} [payment]
82
+ * @property {InventoryStoreRule} [store]
83
+ */
84
+ /**
85
+ * @typedef AppInventoryCompanies
86
+ * @property {string} [company_type] - Indicates the type of the company, e.g.
87
+ * franchisee, distributor, etc.
88
+ * @property {string} [name] - Name of the company, e.g. Newton Traders
89
+ * @property {number} [uid] - UID of the company, e.g. 108
90
+ */
91
+ /**
92
+ * @typedef AppInventoryConfig
93
+ * @property {InventoryBrand} [brand]
94
+ * @property {InventoryCategory} [category]
95
+ * @property {Object[]} [company_store] - List of selling locations whose
96
+ * inventory is available to the sales channel for displaying on the website
97
+ * @property {InventoryDiscount} [discount]
98
+ * @property {Object[]} [exclude_category] - List of excluded brands category
99
+ * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
100
+ * to consume the current sales channel's inventory and sell products
101
+ * @property {string[]} [image]
102
+ * @property {boolean} [only_verified_products] - Show only verified products
103
+ * (the ones whose data has been verified by the admin)
104
+ * @property {boolean} [out_of_stock] - Indicates whether out of stock products
105
+ * are allowed to show up on the website
106
+ * @property {InventoryPrice} [price]
107
+ * @property {InventoryStore} [store]
108
+ */
109
+ /**
110
+ * @typedef AppInventoryPartialUpdate
111
+ * @property {AppCartConfig} [cart]
112
+ * @property {boolean} [comms_enabled] - Shows communication (comms) is enabled
113
+ * or not for sales channel partial inventory update
114
+ * @property {CommunicationConfig} [communication]
115
+ * @property {LoyaltyPointsConfig} [loyalty_points]
116
+ * @property {AppPaymentConfig} [payment]
117
+ * @property {RewardPointsConfig} [reward_points]
118
+ */
119
+ /**
120
+ * @typedef AppInventoryStores
121
+ * @property {string} [_id] - The unique identifier of the store (24-digit Mongo
122
+ * Object ID) in the sales channel inventory
123
+ * @property {number} [company_id] - Company ID of the selling location (store)
124
+ * added to the sales channel's inventory
125
+ * @property {string} [display_name] - Display name of the sales channel
126
+ * inventory store (can be different than the actual store name), e.g. Reebok MUM
127
+ * @property {string} [modified_on] - ISO 8601 timestamp of last known updation
128
+ * to the stores in sales channel inventory
129
+ * @property {string} [name] - Name of the store in the sales channel inventory,
130
+ * e.g. Reebok Mumbai
131
+ * @property {string} [store_code] - Store code of the enabled inventory store,
132
+ * e.g. HS-c9bac. It is unique for every store.
133
+ * @property {string} [store_type] - Store type of the sales channel inventory
134
+ * store, such as mall, warehouse, high_street
135
+ * @property {number} [uid] - Sales channel inventory store UID
136
+ */
137
+ /**
138
+ * @typedef Application
139
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
140
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
141
+ * of the sales channel
142
+ * @property {string} [app_type] - It shows application is live or in development mode.
143
+ * @property {ApplicationAuth} [auth]
144
+ * @property {SecureUrl} [banner]
145
+ * @property {number} [cache_ttl] - An integer value that specifies the number
146
+ * of seconds until the key expires
147
+ * @property {string} [channel_type] - It indicates different channel types like
148
+ * store, website-and-mobile-apps. Default value is store
149
+ * @property {number} [company_id] - Numeric ID allotted to a business account
150
+ * where the sales channel exists
151
+ * @property {ApplicationCors} [cors]
152
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
153
+ * @property {string} [description] - It contains detailed information about the
154
+ * sales channel.
155
+ * @property {Domain} [domain]
156
+ * @property {Domain[]} [domains]
157
+ * @property {SecureUrl} [favicon]
158
+ * @property {boolean} [is_active] - Indicates sales channel is active or not active
159
+ * @property {boolean} [is_internal] - Indicates whether a sales channel is
160
+ * internal or not
161
+ * @property {SecureUrl} [logo]
162
+ * @property {ApplicationMeta[]} [meta]
163
+ * @property {SecureUrl} [mobile_logo]
164
+ * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
165
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
166
+ * of owner who owns the application
167
+ * @property {ApplicationRedirections[]} [redirections]
168
+ * @property {string} [slug]
169
+ * @property {string} [token] - Random generated fix length string for sales
170
+ * channel. It is required and auto-generated.
171
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
172
+ * @property {ApplicationWebsite} [website]
173
+ */
174
+ /**
175
+ * @typedef ApplicationAuth
176
+ * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
177
+ */
178
+ /**
179
+ * @typedef ApplicationCors
180
+ * @property {string[]} [domains]
181
+ */
182
+ /**
183
+ * @typedef ApplicationDetail
184
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
185
+ * for the sales channel details
186
+ * @property {SecureUrl} [banner]
187
+ * @property {string} [description] - It gives a detailed information about the
188
+ * sales channel. It is required.
189
+ * @property {Domain} [domain]
190
+ * @property {Domain[]} [domains]
191
+ * @property {SecureUrl} [favicon]
192
+ * @property {SecureUrl} [logo]
193
+ * @property {SecureUrl} [mobile_logo]
194
+ * @property {string} name - Name of the sales channel. It is required.
195
+ */
196
+ /**
197
+ * @typedef ApplicationInformation
198
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
199
+ * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
200
+ * the application information
201
+ * @property {InformationAddress} [address]
202
+ * @property {string} [application] - Alphanumeric ID allotted to a sales
203
+ * channel application created within a business account
204
+ * @property {BusinessHighlights} [business_highlights]
205
+ * @property {string} [copyright_text] - Copyright statement usually seen at the
206
+ * site's footer
207
+ * @property {string} [created_at] - ISO 8601 timestamp of creation of the
208
+ * application information
209
+ * @property {Links[]} [links]
210
+ * @property {SocialLinks} [social_links]
211
+ * @property {InformationSupport} [support]
212
+ * @property {string} [updated_at] - ISO 8601 timestamp of updation of the
213
+ * application information
214
+ */
215
+ /**
216
+ * @typedef ApplicationInventory
217
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
218
+ * of the sales channel inventory
219
+ * @property {string} [app] - Current sales channel ID
220
+ * @property {ArticleAssignmentConfig} [article_assignment]
221
+ * @property {AuthenticationConfig} [authentication]
222
+ * @property {string} [business] - Indicates the business type for sales channel
223
+ * e.g. retail or wholesale
224
+ * @property {AppCartConfig} [cart]
225
+ * @property {boolean} [comms_enabled] - Shows communication(comms) is enabled
226
+ * or not for sales channel inventory
227
+ * @property {CommunicationConfig} [communication]
228
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel
229
+ * inventory creation
230
+ * @property {AppInventoryConfig} [inventory]
231
+ * @property {AppLogisticsConfig} [logistics]
232
+ * @property {LoyaltyPointsConfig} [loyalty_points]
233
+ * @property {string} [modified_by] - User ID of the person who made the latest
234
+ * changes in the sales channel inventory
235
+ * @property {AppOrderConfig} [order]
236
+ * @property {AppPaymentConfig} [payment]
237
+ * @property {string[]} [platforms]
238
+ * @property {RewardPointsConfig} [reward_points]
239
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel
240
+ * inventory updation
241
+ */
242
+ /**
243
+ * @typedef ApplicationMeta
244
+ * @property {string} [name] - Indicates to name of application meta
245
+ * @property {string} [value] - Value related to application meta name
246
+ */
247
+ /**
248
+ * @typedef ApplicationRedirections
249
+ * @property {string} [redirect_from] - Old domain url of the sales channel
250
+ * @property {string} [redirect_to] - New domain URL of the sales channel. Users
251
+ * will be automatically redirected from old domain to new domain.
252
+ * @property {string} [type] - It shows domain redirection type. Permanent
253
+ * redirection is for long time period redirection, and temporary redirection
254
+ * for a short time period.
255
+ */
256
+ /**
257
+ * @typedef ApplicationsResponse
258
+ * @property {Application[]} [items]
259
+ * @property {Page} [page]
260
+ */
261
+ /**
262
+ * @typedef ApplicationWebsite
263
+ * @property {string} [basepath] - Base path for the current sales channel website
264
+ * @property {boolean} [enabled] - Shows whether sales channel website URL is
265
+ * enabled or not
266
+ */
267
+ /**
268
+ * @typedef AppLogisticsConfig
269
+ * @property {boolean} [dp_assignment]
270
+ * @property {boolean} [logistics_by_seller]
271
+ * @property {boolean} [same_day_delivery]
272
+ * @property {boolean} [serviceability_check]
273
+ */
274
+ /**
275
+ * @typedef AppOrderConfig
276
+ * @property {boolean} [enabled] - Allow orders to be accepted from the sales channel
277
+ * @property {boolean} [force_reassignment] - Allow force reassigning of an order
278
+ * @property {string} [message] - Reason for reassigning an order
279
+ */
280
+ /**
281
+ * @typedef AppPaymentConfig
282
+ * @property {boolean} [anonymous_cod] - Allow cash on delivery for anonymous user
283
+ * @property {CallbackUrl} [callback_url]
284
+ * @property {number} [cod_amount_limit] - Maximum amount allowed for COD order.
285
+ * Beyond this, customer cannot opt for COD.
286
+ * @property {number} [cod_charges] - Extra charge applicable for COD orders
287
+ * @property {boolean} [enabled] - Allow payment option within sales channel
288
+ * @property {Methods} [methods]
289
+ * @property {string} [mode_of_payment] - Mode of payment for sales channel
290
+ * payment, e.g. 'ECOMM'.
291
+ * @property {PaymentSelectionLock} [payment_selection_lock]
292
+ * @property {string} [source] - Source of the payment mode, e.g. 'ECOMM'.
293
+ * Default value is FYND.
294
+ */
295
+ /**
296
+ * @typedef AppStoreRules
297
+ * @property {Object[]} [brands] - List of brands whose products will be shown
298
+ * on the website
299
+ * @property {number[]} [companies] - List of companies whose inventory is
300
+ * available to the sales channel for displaying on the website
301
+ */
302
+ /**
303
+ * @typedef AppSupportedCurrency
304
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
305
+ * of the currency configuration supported by the application
306
+ * @property {string} [application] - Alphanumeric ID allotted to an application
307
+ * (sales channel website) created within a business account.
308
+ * @property {string} [created_at] - ISO 8601 timestamp when currency was added
309
+ * in the list of currencies supported by the sales channel
310
+ * @property {DefaultCurrency} [default_currency]
311
+ * @property {string[]} [supported_currency]
312
+ * @property {string} [updated_at] - ISO 8601 timestamp when currency was
313
+ * updated in the list of currencies supported by the sales channel
314
+ */
315
+ /**
316
+ * @typedef ArticleAssignmentConfig
317
+ * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
318
+ * @property {ArticleAssignmentRules} [rules]
319
+ */
320
+ /**
321
+ * @typedef ArticleAssignmentRule
322
+ * @property {StorePriorityRule} [store_priority]
323
+ */
324
+ /**
325
+ * @typedef ArticleAssignmentRules
326
+ * @property {StorePriority} [store_priority]
327
+ */
328
+ /**
329
+ * @typedef AuthenticationConfig
330
+ * @property {string} [provider] - Shows inventory authentication provider
331
+ * @property {boolean} [required] - Shows sales channel inventory authentication
332
+ * is required or not
333
+ */
334
+ /**
335
+ * @typedef BlogLink
336
+ * @property {string} [icon] - Hosted URL of icon image shown on the website
337
+ * @property {string} [link] - Web URL of brand's blog page
338
+ * @property {string} [title] - Name of the brand's blog page
339
+ */
340
+ /**
341
+ * @typedef BrandCompanyInfo
342
+ * @property {number} [company_id] - Numeric ID allotted to a business account
343
+ * @property {string} [company_name] - Name of the company dealing with the brand
344
+ */
345
+ /**
346
+ * @typedef BrandsByCompanyResponse
347
+ * @property {CompanyBrandInfo} [brands]
348
+ */
349
+ /**
350
+ * @typedef BrandStoreInfo
351
+ * @property {OptedCompany} [company]
352
+ * @property {OptedStoreAddress} [store_address]
353
+ * @property {string} [store_code] - Store code of the brand. It is unique for
354
+ * every brand store.
355
+ * @property {number} [store_id] - The unique identifier of the selling location (store)
356
+ * @property {string} [store_name] - Name of the selling location (store)
357
+ * @property {string} [store_type] - Store type of the brand like warehouse,
358
+ * high_street, mall
359
+ */
360
+ /**
361
+ * @typedef BuildVersion
362
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
363
+ * @property {string} [_id] - 24-digit Mongo Object ID
364
+ * @property {string} [application] - Application ID of the sales channel
365
+ * @property {string} [build_status] - Current progress of the mobile build,
366
+ * e.g. pending, cancelled, failed, success
367
+ * @property {string} [created_at] - ISO 8601 timestamp of app creation
368
+ * @property {string} [platform_type] - Device platform for which the mobile app
369
+ * was built, e.g. android, ios.
370
+ * @property {string} [updated_at] - ISO 8601 timestamp of last known
371
+ * modifications to the app build
372
+ * @property {number} [version_code] - A positive integer used as an internal
373
+ * version number
374
+ * @property {string} [version_name] - Version number of the mobile build, in
375
+ * dot-decimal notation
376
+ */
377
+ /**
378
+ * @typedef BuildVersionHistory
379
+ * @property {string} [latest_available_version_name] - Latest version number of
380
+ * the mobile build, in dot-decimal notation
381
+ * @property {BuildVersion} [versions]
382
+ */
383
+ /**
384
+ * @typedef BusinessHighlights
385
+ * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
386
+ * the related business
387
+ * @property {string} [icon] - Hosted URL of icon image representing the
388
+ * business highlight
389
+ * @property {string} [sub_title] - Detailed information about the highlight
390
+ * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
391
+ */
392
+ /**
393
+ * @typedef CallbackUrl
394
+ * @property {string} [app] - Payment callback url for app
395
+ * @property {string} [web] - Payment callback url for web
396
+ */
397
+ /**
398
+ * @typedef CartFeature
399
+ * @property {boolean} [google_map] - Allow adding of Google Maps. Default value is true.
400
+ * @property {boolean} [gst_input] - Shows whether customer is allowed to enter
401
+ * GST on the cart page for claiming input credits
402
+ * @property {boolean} [placing_for_customer] - Shows whether the staff is
403
+ * placing order on behalf of customer. Default value is true.
404
+ * @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits,
405
+ * together. Default value is false.
406
+ * @property {boolean} [staff_selection] - Shows whether staff selection is
407
+ * enabled on cart page
408
+ */
409
+ /**
410
+ * @typedef Charges
411
+ * @property {number} [charges] - Delivery amount to be charged when order value
412
+ * is below the defined threshold value
413
+ * @property {number} [threshold] - The order value below which an extra
414
+ * delivery fee will be applicable
415
+ */
416
+ /**
417
+ * @typedef CommonFeature
418
+ * @property {CommunicationOptinDialogFeature} [communication_optin_dialog]
419
+ * @property {CompareProductsFeature} [compare_products]
420
+ * @property {CurrencyFeature} [currency]
421
+ * @property {DeploymentStoreSelectionFeature} [deployment_store_selection]
422
+ * @property {FeedbackFeature} [feedback]
423
+ * @property {ListingPriceFeature} [listing_price]
424
+ * @property {RevenueEngineFeature} [revenue_engine]
425
+ * @property {RewardPointsConfig} [reward_points]
426
+ */
427
+ /**
428
+ * @typedef CommsConfig
429
+ * @property {boolean} [enabled] - Check current communication channel is enabled
430
+ */
431
+ /**
432
+ * @typedef CommunicationConfig
433
+ * @property {CommsConfig} [email]
434
+ * @property {CommsConfig} [sms]
435
+ * @property {CommsConfig} [voice]
436
+ */
437
+ /**
438
+ * @typedef CommunicationOptinDialogFeature
439
+ * @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled
440
+ */
441
+ /**
442
+ * @typedef CompaniesResponse
443
+ * @property {AppInventoryCompanies} [items]
444
+ * @property {Page} [page]
445
+ */
446
+ /**
447
+ * @typedef CompanyAboutAddress
448
+ * @property {string} [address_type] - Indicates different office types like
449
+ * office, registered, and home.
450
+ * @property {string} [address1] - Primary address line of the company
451
+ * @property {string} [address2] - Secondary address line of the company
452
+ * @property {string} [city] - City name, e.g. Mumbai
453
+ * @property {string} [country] - Country name, e.g. India
454
+ * @property {number} [pincode] - 6-digit PIN code of the city, e.g. 400001
455
+ * @property {string} [state] - State name, e.g. Maharashtra
456
+ */
457
+ /**
458
+ * @typedef CompanyBrandInfo
459
+ * @property {string} [brand_banner_portrait_url] - Hosted URL of the brand's
460
+ * portrait banner
461
+ * @property {string} [brand_banner_url] - Hosted URL of the brand's banner image
462
+ * @property {string} [brand_logo_url] - Hosted URL of the brand's logo
463
+ * @property {string} [name] - Brand name, e.g. Raymonds
464
+ * @property {number} [value] - Brand UID for identifying the brand
465
+ */
466
+ /**
467
+ * @typedef CompanyByBrandsRequest
468
+ * @property {number} brands - Brand UID
469
+ * @property {string} [search_text] - A search field for finding a company by its name
470
+ */
471
+ /**
472
+ * @typedef CompanyByBrandsResponse
473
+ * @property {BrandCompanyInfo[]} [items]
474
+ * @property {Page} [page]
475
+ */
476
+ /**
477
+ * @typedef CompanyValidator
478
+ * @property {string} [browser_script] - Browser script for the company validator
479
+ * @property {JsonSchema[]} [json_schema]
480
+ */
481
+ /**
482
+ * @typedef CompareProductsFeature
483
+ * @property {boolean} [enabled] - Shows whether product comparison feature is
484
+ * enabled on PDP
485
+ */
486
+ /**
487
+ * @typedef CreateApplicationRequest
488
+ * @property {App} [app]
489
+ * @property {AppInventory} [configuration]
490
+ * @property {AppDomain} [domain]
491
+ */
492
+ /**
493
+ * @typedef CreateAppResponse
494
+ * @property {Application} [app]
495
+ * @property {ApplicationInventory} [configuration]
496
+ */
497
+ /**
498
+ * @typedef Credentials
499
+ * @property {Android} [android]
500
+ * @property {string} [api_key] - An API key is a unique string that's used to
501
+ * route requests to your Firebase project when interacting with Firebase.
502
+ * @property {string} [application_id] - Alphanumeric ID allotted to the current
503
+ * application created within the current business account
504
+ * @property {string} [gcm_sender_id] - Google Cloud Manager's Sender ID for
505
+ * Firebase. It is a unique numerical value which is created when you
506
+ * configure your project in the Google Developers Console/Google Cloud Console.
507
+ * @property {Ios} [ios]
508
+ * @property {string} [project_id] - Project ID for Firebase integration.
509
+ * Project ID is a unique identifier for a project and is used only within the console.
510
+ */
511
+ /**
512
+ * @typedef Credit
513
+ * @property {boolean} [enabled] - Shows whether reward points should be credited
514
+ */
515
+ /**
516
+ * @typedef CurrenciesResponse
517
+ * @property {Currency[]} [items]
518
+ */
519
+ /**
520
+ * @typedef Currency
521
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
522
+ * of the current sales channel supported currency
523
+ * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
524
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
525
+ * currency creation
526
+ * @property {number} [decimal_digits] - Acceptable decimal limits for a given
527
+ * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
528
+ * value of a currency.
529
+ * @property {boolean} [is_active] - Shows currency is enabled or not in current
530
+ * sales channel
531
+ * @property {string} [name] - Name of the currency, e.g Indian Rupee
532
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
533
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
534
+ * currency updation
535
+ */
536
+ /**
537
+ * @typedef CurrencyConfig
538
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
539
+ * of all the currency configuration
540
+ * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
541
+ * @property {string} [created_at] - ISO 8601 timestamp of a given currency creation
542
+ * @property {number} [decimal_digits] - Acceptable decimal limits for a given
543
+ * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
544
+ * value of a currency.
545
+ * @property {boolean} [is_active] - Currency is enabled or not for the current
546
+ * sales channel
547
+ * @property {string} [name] - Name of the currency, e.g Indian Rupee
548
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
549
+ * @property {string} [updated_at] - ISO 8601 timestamp of a given currency updation
550
+ */
551
+ /**
552
+ * @typedef CurrencyFeature
553
+ * @property {string} [default_currency] - 3-letter code of the default currency
554
+ * used in the application. Default vaule is 'INR'.
555
+ * @property {string} [type] - If 'explicit', currency formatting shows currency
556
+ * code with price. For explicit or all currency selection.
557
+ * @property {string[]} [value] - 3-letter currency code
558
+ */
559
+ /**
560
+ * @typedef Debit
561
+ * @property {boolean} [auto_apply] - Allow automatic debit of reward points
562
+ * @property {boolean} [enabled] - Shows whether reward points are available for debit
563
+ * @property {string} [strategy_channel] - Strategy channel for debiting reward points
564
+ */
565
+ /**
566
+ * @typedef DefaultCurrency
567
+ * @property {string} [code] - 3-character code of the default currency, e.g.
568
+ * INR, EUR, USD
569
+ * @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
570
+ * of the default currency
571
+ */
572
+ /**
573
+ * @typedef DeliveryCharges
574
+ * @property {Charges} [charges]
575
+ * @property {boolean} [enabled] - Allow delivery charges
576
+ */
577
+ /**
578
+ * @typedef DeploymentMeta
579
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
580
+ * of the ordering stores
581
+ * @property {boolean} [all_stores] - Allow all stores from the ordering store
582
+ * @property {string} [app] - Alphanumeric ID allotted to an application (sales
583
+ * channel website) created within a business account
584
+ * @property {number[]} [deployed_stores]
585
+ * @property {boolean} [enabled] - Allow ordering stores for current sales channel
586
+ * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
587
+ * type delivery, store selection is compulsory. For soft type, delivery store
588
+ * selection is optional.
589
+ */
590
+ /**
591
+ * @typedef DeploymentStoreSelectionFeature
592
+ * @property {boolean} [enabled] - Shows whether selection of store (for
593
+ * deploying the application) is permitted
594
+ * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
595
+ * type delivery, store selection is compulsory. For soft type, delivery store
596
+ * selection is optional.
597
+ */
598
+ /**
599
+ * @typedef Domain
600
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
601
+ * of the sales channel domain
602
+ * @property {boolean} [is_predefined] - Domain is hosting domain or not.
603
+ * @property {boolean} [is_primary] - Domain is primary or not. Primary domain
604
+ * is the default/main domain.
605
+ * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
606
+ * @property {string} [name] - Full domain name, e.g. newton.com
607
+ * @property {boolean} [verified] - Domain is verified or not. TXT and A records
608
+ * should propagate correctly.
609
+ */
610
+ /**
611
+ * @typedef DomainAdd
612
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
613
+ * of the domain
614
+ * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
615
+ * domain has been made the main URL of the sales channel)
616
+ * @property {boolean} [is_shortlink] - Indicates if the domain is a short link
617
+ * domain (short URL e.g. bitly)
618
+ * @property {string} [message] - Shows the message shown after adding a domain
619
+ * successfully, e.g. 'New domain added successfully'
620
+ * @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
621
+ * @property {string[]} [txt_records]
622
+ * @property {boolean} [verified] - Domain is verified or not (indicates if A
623
+ * records and TXT records are correct)
624
+ */
625
+ /**
626
+ * @typedef DomainAddRequest
627
+ * @property {DomainAdd} [domain]
628
+ */
629
+ /**
630
+ * @typedef DomainsResponse
631
+ * @property {Domain[]} [domains]
632
+ */
633
+ /**
634
+ * @typedef DomainStatus
635
+ * @property {string} [display] - Shows TXT record and A records for the domain
636
+ * @property {boolean} [status] - Shows whether TXT record or A records for the
637
+ * domain are correctly propagating via DNS servers
638
+ */
639
+ /**
640
+ * @typedef DomainStatusRequest
641
+ * @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
642
+ */
643
+ /**
644
+ * @typedef DomainStatusResponse
645
+ * @property {boolean} [connected] - Check if domain is live and mapped to
646
+ * appropriate IP of Fynd Servers
647
+ * @property {DomainStatus[]} [status]
648
+ */
649
+ /**
650
+ * @typedef DomainSuggestion
651
+ * @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
652
+ * @property {boolean} is_available - Shows whether the custom domain of your
653
+ * choice is available or not available
654
+ * @property {string} name - URL of the custom domain
655
+ * @property {number} [price] - Cost of purchasing a custom domain. Not present
656
+ * for Fynd domains.
657
+ * @property {boolean} [unsupported] - Shows whether TLD domain is supported or not
658
+ */
659
+ /**
660
+ * @typedef DomainSuggestionsRequest
661
+ * @property {boolean} [custom] - Get suggestions for custom domains or Fynd domains
662
+ * @property {string} [domain_url] - Domain url
663
+ */
664
+ /**
665
+ * @typedef DomainSuggestionsResponse
666
+ * @property {DomainSuggestion[]} [domains] - Domain URL
667
+ */
668
+ /**
669
+ * @typedef FacebookLink
670
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
671
+ * @property {string} [link] - Web URL of brand's Facebook page
672
+ * @property {string} [title] - Name of the social media platform, e.g. Facebook
673
+ */
674
+ /**
675
+ * @typedef FeedbackFeature
676
+ * @property {boolean} [enabled] - Shows whether customer feedback is enabled on
677
+ * PDP. Default value is false.
678
+ */
679
+ /**
680
+ * @typedef FilterOrderingStoreRequest
681
+ * @property {boolean} [all_stores] - Allow all stores from the ordering stores
682
+ * @property {number[]} [deployed_stores]
683
+ * @property {string} [q] - Store code or name of the ordering store
684
+ */
685
+ /**
686
+ * @typedef Firebase
687
+ * @property {Credentials} [credentials]
688
+ * @property {boolean} [enabled] - Shows whether Firebase integration is enabled
689
+ * or disabled for the sales channel
690
+ */
691
+ /**
692
+ * @typedef Freshchat
693
+ * @property {FreshchatCredentials} [credentials]
694
+ * @property {boolean} [enabled] - Shows whether Freshchat integration is
695
+ * enabled or disabled for the sales channel
696
+ */
697
+ /**
698
+ * @typedef FreshchatCredentials
699
+ * @property {string} [app_id] - The unique app_id of your Freshchat account for
700
+ * integrating Freshchat with your sales channel
701
+ * @property {string} [app_key] - The unique app_key of your Freshchat account
702
+ * for integrating Freshchat with your sales channel
703
+ * @property {string} [web_token] - Web token used for accessing the Freshchat APIs
704
+ */
705
+ /**
706
+ * @typedef FyndRewards
707
+ * @property {FyndRewardsCredentials} [credentials]
708
+ */
709
+ /**
710
+ * @typedef FyndRewardsCredentials
711
+ * @property {string} [public_key] - Public key for integrating with Fynd rewards.
712
+ */
713
+ /**
714
+ * @typedef GetIntegrationsOptInsResponse
715
+ * @property {IntegrationOptIn[]} [items]
716
+ * @property {Page} [page]
717
+ */
718
+ /**
719
+ * @typedef GoogleMap
720
+ * @property {GoogleMapCredentials} [credentials]
721
+ */
722
+ /**
723
+ * @typedef GoogleMapCredentials
724
+ * @property {string} [api_key] - Secret API key for Google Maps. A unique
725
+ * identifier that authenticates requests made to Google Maps API.
726
+ */
727
+ /**
728
+ * @typedef GooglePlusLink
729
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
730
+ * @property {string} [link] - Web URL of brand's Google+ account
731
+ * @property {string} [title] - Name of the social media platform, e.g. Google+
732
+ */
733
+ /**
734
+ * @typedef Gtm
735
+ * @property {GtmCredentials} [credentials]
736
+ * @property {boolean} [enabled] - Shows whether GTM integration is enabled or
737
+ * disabled for the sales channel
738
+ */
739
+ /**
740
+ * @typedef GtmCredentials
741
+ * @property {string} [api_key] - Secret credential API key for GTM
742
+ */
743
+ /**
744
+ * @typedef HomePageFeature
745
+ * @property {boolean} [order_processing] - Shows whether order processing is
746
+ * enabled or not enabled
747
+ */
748
+ /**
749
+ * @typedef InformationAddress
750
+ * @property {string[]} [address_line] - Contact address of the sales channel
751
+ * @property {string} [city] - Name of the city, e.g. Mumbai
752
+ * @property {string} [country] - Name of the country, e.g. India
753
+ * @property {string} [loc] - Co-ordinates of the location
754
+ * @property {InformationPhone[]} [phone]
755
+ * @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001
756
+ */
757
+ /**
758
+ * @typedef InformationPhone
759
+ * @property {string} [code] - Country code for contact number, e.g. +91 (for India)
760
+ * @property {string} [number] - 10-digit mobile number
761
+ */
762
+ /**
763
+ * @typedef InformationSupport
764
+ * @property {string[]} [email]
765
+ * @property {string[]} [phone]
766
+ * @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM
767
+ */
768
+ /**
769
+ * @typedef InstagramLink
770
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
771
+ * @property {string} [link] - Web URL of brand's Instagram page
772
+ * @property {string} [title] - Name of the social media platform, e.g. Instagram
773
+ */
774
+ /**
775
+ * @typedef Integration
776
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
777
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
778
+ * of the integration
779
+ * @property {Object[]} [companies]
780
+ * @property {Object} [constants]
781
+ * @property {string} [created_at] - ISO 8601 timestamp of integration creation
782
+ * @property {string} [description] - Basic description about the integration
783
+ * @property {string} [description_html] - Basic HTML description about the integration
784
+ * @property {string} [icon] - Hosted URL of the icon image
785
+ * @property {IntegrationMeta[]} [meta]
786
+ * @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
787
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
788
+ * of the user who created the integration
789
+ * @property {string} [secret] - Randomly generated fixed-length string for
790
+ * opted integration. It is auto-generated. It would never change once it is generated.
791
+ * @property {string[]} [support]
792
+ * @property {string} [token] - Randomly generated fixed-length string for opted
793
+ * integration. It is auto-generated. It would never change once it is generated.
794
+ * @property {string} [updated_at] - ISO 8601 timestamp of integration updation
795
+ * @property {Validators} [validators]
796
+ */
797
+ /**
798
+ * @typedef IntegrationConfigResponse
799
+ * @property {IntegrationLevel[]} [items]
800
+ */
801
+ /**
802
+ * @typedef IntegrationLevel
803
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
804
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
805
+ * of the integration config
806
+ * @property {string} [created_at] - ISO 8601 timestamp of integration config creation
807
+ * @property {Object} [data] - Schema data of the integration stored in key-value pairs
808
+ * @property {string} [integration] - Integration id. Shows which integration
809
+ * you are enabling.
810
+ * @property {LastPatch[]} [last_patch]
811
+ * @property {string} [level] - Shows for what level the integration is set up.
812
+ * It can be company level or store level.
813
+ * @property {IntegrationMeta[]} [meta]
814
+ * @property {boolean} [opted] - Shows this integration is opted or not opted
815
+ * for the current company
816
+ * @property {Object[]} [permissions]
817
+ * @property {string} [token] - Randomly generated fixed-length string for opted
818
+ * integration. It is auto-generated. It would never change once it is generated.
819
+ * @property {number} [uid] - It can be store uid or company uid. Depends on the
820
+ * level of integration.
821
+ * @property {string} [updated_at] - ISO 8601 timestamp of integration config updation
822
+ */
823
+ /**
824
+ * @typedef IntegrationMeta
825
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
826
+ * of the integration meta
827
+ * @property {boolean} [is_public]
828
+ * @property {string} [name] - Nmae of integration meta, e.g. price_level
829
+ * @property {string} [value] - Value related to integration meta name, e.g. store
830
+ */
831
+ /**
832
+ * @typedef IntegrationOptIn
833
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
834
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
835
+ * of the opted integration
836
+ * @property {Object[]} [companies]
837
+ * @property {string} [constants]
838
+ * @property {string} [created_at] - ISO 8601 timestamp of integration creation
839
+ * @property {string} [description] - Basic description about the opted integration
840
+ * @property {string} [description_html] - Basic HTML description about the
841
+ * opted integration
842
+ * @property {string} [icon] - Hosted URL of the icon image
843
+ * @property {IntegrationMeta[]} [meta]
844
+ * @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
845
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
846
+ * of the user who created the integration
847
+ * @property {string} [secret] - Randomly generated fixed-length string for
848
+ * opted integration. It is auto-generated. It would never change once it is generated.
849
+ * @property {string[]} [support]
850
+ * @property {string} [token] - Randomly generated fixed-length string for opted
851
+ * integration. It is auto-generated. It would never change once it is generated.
852
+ * @property {string} [updated_at] - ISO 8601 timestamp of integration updation
853
+ * @property {Validators} [validators]
854
+ */
855
+ /**
856
+ * @typedef InvalidPayloadRequest
857
+ * @property {string} [message] - Error message when request body payload is improper
858
+ */
859
+ /**
860
+ * @typedef InventoryArticleAssignment
861
+ * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
862
+ * @property {ArticleAssignmentRule} [rules]
863
+ */
864
+ /**
865
+ * @typedef InventoryBrand
866
+ * @property {Object[]} [brands] - List of brands
867
+ * @property {string} [criteria] - All brands or specific (explicit) brands to
868
+ * be shown on the website
869
+ */
870
+ /**
871
+ * @typedef InventoryBrandRule
872
+ * @property {number[]} [brands]
873
+ * @property {string} [criteria] - Whether all brands are enabled, or explicitly
874
+ * few brands in the inventory
875
+ */
876
+ /**
877
+ * @typedef InventoryCategory
878
+ * @property {Object[]} [categories] - List of categories whose products will be
879
+ * shown on the website
880
+ * @property {string} [criteria]
881
+ */
882
+ /**
883
+ * @typedef InventoryDiscount
884
+ * @property {number} [max] - Maximum inventory discount
885
+ * @property {number} [min] - Minimum inventory discount
886
+ */
887
+ /**
888
+ * @typedef InventoryPaymentConfig
889
+ * @property {string} [mode_of_payment] - Mode of payment for the inventory of
890
+ * sales channel. It is required and default value is null.
891
+ * @property {string} [source] - Source of the payment mode for the inventory
892
+ * payment of sales channel. Default value is FYND.
893
+ */
894
+ /**
895
+ * @typedef InventoryPrice
896
+ * @property {number} [max] - Maximum inventory price
897
+ * @property {number} [min] - Minimum inventory price
898
+ */
899
+ /**
900
+ * @typedef InventoryStore
901
+ * @property {string} [criteria] - All stores or specific (explicit) stores to
902
+ * be shown on the website
903
+ * @property {AppStoreRules} [rules]
904
+ * @property {Object[]} [stores] - List of stores
905
+ */
906
+ /**
907
+ * @typedef InventoryStoreRule
908
+ * @property {string} [criteria] - Whether all stores are enabled, or explicitly
909
+ * few stores in the inventory, or use brands and company filter.
910
+ * @property {StoreCriteriaRule[]} [rules] - List of rules with company and
911
+ * brands uids. Used when critera is `filter`.
912
+ * @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
913
+ */
914
+ /**
915
+ * @typedef InventoryValidator
916
+ * @property {string} [browser_script] - Browser script for the inventory validator
917
+ * @property {JsonSchema[]} [json_schema]
918
+ */
919
+ /**
920
+ * @typedef Ios
921
+ * @property {string} [api_key] - Firebase secret credential API key for IOS
922
+ * @property {string} [application_id] - Alphanumeric ID allotted to a sales
923
+ * channel application created within a business account
924
+ */
925
+ /**
926
+ * @typedef JsonSchema
927
+ * @property {string} [display] - Display text of the validator JSON schema. It
928
+ * will show in the UI.
929
+ * @property {string} [key] - Key related to the display text of the validator JSON schema
930
+ * @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
931
+ * schema. It will show in the UI.
932
+ * @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
933
+ */
934
+ /**
935
+ * @typedef LandingImage
936
+ * @property {string} [aspect_ratio] - Width-to-height ratio of landing image
937
+ * @property {string} [secure_url] - URL where the landing image is hosted
938
+ */
939
+ /**
940
+ * @typedef LandingPageFeature
941
+ * @property {boolean} [continue_as_guest] - Shows whether a guest can checkout
942
+ * from cart without logging in
943
+ * @property {LaunchPage} [launch_page]
944
+ * @property {string} [login_btn_text] - Shows the text displayed over the login button
945
+ * @property {boolean} [show_domain_textbox] - Shows whether a textbox for
946
+ * entering domain is available
947
+ * @property {boolean} [show_register_btn] - Shows whether register button is
948
+ * available in the login/landing page
949
+ */
950
+ /**
951
+ * @typedef LastPatch
952
+ * @property {string} [op]
953
+ * @property {string} [path]
954
+ * @property {string} [value] - It can be inventory level or order level
955
+ */
956
+ /**
957
+ * @typedef LaunchPage
958
+ * @property {string} [page_type] - Type of the launch page
959
+ * @property {Object} [params] - Launch page params. It can be nullable.
960
+ * @property {Object} [query] - Query related to launch page. It can be nullable.
961
+ */
962
+ /**
963
+ * @typedef LinkedInLink
964
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
965
+ * @property {string} [link] - Web URL of brand's LinkedIn channel
966
+ * @property {string} [title] - Name of the social media platform, e.g. LinkedIn
967
+ */
968
+ /**
969
+ * @typedef Links
970
+ * @property {string} [link] - Web URL for redirecting to a related page
971
+ * @property {string} [title] - Name of the related page or link
972
+ */
973
+ /**
974
+ * @typedef ListingPriceFeature
975
+ * @property {string} [sort] - Sorting of listing price with min or max value.
976
+ * Default value is min.
977
+ * @property {string} [value] - Shows which price to display on PLP if one
978
+ * product has multiple prices (for each size), valid values are 'min', 'max',
979
+ * 'range'. Default value is range.
980
+ */
981
+ /**
982
+ * @typedef LoyaltyPointsConfig
983
+ * @property {boolean} [auto_apply] - Allow auto apply of loyalty points
984
+ * @property {boolean} [enabled] - Shows loyalty points is enabled or not enabled
985
+ */
986
+ /**
987
+ * @typedef Methods
988
+ * @property {PaymentModeConfig} [card]
989
+ * @property {PaymentModeConfig} [cod]
990
+ * @property {PaymentModeConfig} [fc]
991
+ * @property {PaymentModeConfig} [jiopp]
992
+ * @property {PaymentModeConfig} [jp]
993
+ * @property {PaymentModeConfig} [juspaypg]
994
+ * @property {PaymentModeConfig} [nb]
995
+ * @property {PaymentModeConfig} [pac]
996
+ * @property {PaymentModeConfig} [payubizpg]
997
+ * @property {PaymentModeConfig} [payumoneypg]
998
+ * @property {PaymentModeConfig} [pl]
999
+ * @property {PaymentModeConfig} [pp]
1000
+ * @property {PaymentModeConfig} [ps]
1001
+ * @property {PaymentModeConfig} [qr]
1002
+ * @property {PaymentModeConfig} [rupifipg]
1003
+ * @property {PaymentModeConfig} [simpl]
1004
+ * @property {PaymentModeConfig} [stripepg]
1005
+ * @property {PaymentModeConfig} [upi]
1006
+ * @property {PaymentModeConfig} [wl]
1007
+ */
1008
+ /**
1009
+ * @typedef MobileAppConfigRequest
1010
+ * @property {string} [app_name] - Name of the mobile app
1011
+ * @property {boolean} [is_active] - Shows update in mobile app config is active or not
1012
+ * @property {LandingImage} [landing_image]
1013
+ * @property {SplashImage} [splash_image]
1014
+ */
1015
+ /**
1016
+ * @typedef MobileAppConfiguration
1017
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
1018
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1019
+ * for mobile application configuration
1020
+ * @property {string} [app_name] - Name of the mobile app
1021
+ * @property {string} [application] - Application ID of the current sales channel
1022
+ * @property {string} [created_at] - ISO 8601 timestamp of application
1023
+ * configuration creation
1024
+ * @property {boolean} [is_active] - Indicates the availability of the mobile build
1025
+ * @property {LandingImage} [landing_image]
1026
+ * @property {string} [package_name] - Shows bundle identifier if device
1027
+ * platform is iOS, and directory of the app if device platform is Android
1028
+ * @property {string} [platform_type] - Device platform for which the mobile app
1029
+ * was built, e.g. android, ios.
1030
+ * @property {SplashImage} [splash_image]
1031
+ * @property {string} [updated_at] - ISO 8601 timestamp of last known
1032
+ * modifications to the app build
1033
+ */
1034
+ /**
1035
+ * @typedef Moengage
1036
+ * @property {MoengageCredentials} [credentials]
1037
+ * @property {boolean} [enabled] - Shows whether MoEngage integation is enabled
1038
+ * or disabled for the sales channel
1039
+ */
1040
+ /**
1041
+ * @typedef MoengageCredentials
1042
+ * @property {string} [app_id] - APP ID provided by MoEngage to identify a
1043
+ * specific app. The app_id for your MoEngage account is available on the
1044
+ * MoEngage Dashboard.
1045
+ */
1046
+ /**
1047
+ * @typedef NotFound
1048
+ * @property {string} [message] - Response message for not found
1049
+ */
1050
+ /**
1051
+ * @typedef OptedApplicationResponse
1052
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1053
+ * of the other seller's sales channel
1054
+ * @property {OptedCompany} [company]
1055
+ * @property {string} [description] - Basic details about the other seller's sales channel
1056
+ * @property {string} [domain] - Domain URL of the other seller's sales channel
1057
+ * @property {string} [name] - Name of the other seller's sales channel
1058
+ * @property {OptOutInventory} [opt_out_inventory]
1059
+ * @property {OptedInventory} [opted_inventory]
1060
+ */
1061
+ /**
1062
+ * @typedef OptedCompany
1063
+ * @property {string} [name] - Name of the company opted by the other seller's
1064
+ * sales channel in its inventory
1065
+ * @property {number} [uid] - Company UID opted by the other seller's sales
1066
+ * channel in its inventory. It has unique value for the company.
1067
+ */
1068
+ /**
1069
+ * @typedef OptedInventory
1070
+ * @property {Object} [items]
1071
+ * @property {OptType} [opt_type]
1072
+ */
1073
+ /**
1074
+ * @typedef OptedStore
1075
+ * @property {string} [_id] - The unique identifier of the opted inventory store
1076
+ * @property {OptedStoreAddress} [address]
1077
+ * @property {number} [company_id] - Company ID of the opted inventory store
1078
+ * @property {string} [display_name] - Display name of the opted inventory store
1079
+ * @property {string} [modified_on] - ISO 8601 timestamp of opted inventory store creation
1080
+ * @property {string} [name] - Name of the inventory store opted by other
1081
+ * seller's application
1082
+ * @property {string} [store_code] - Store code of the opted inventory store. It
1083
+ * is unique for every store.
1084
+ * @property {string} [store_type] - Store type of the opted inventory store
1085
+ * like warehouse, high_street, mall.
1086
+ * @property {number} [uid] - UID of opted inventory store
1087
+ */
1088
+ /**
1089
+ * @typedef OptedStoreAddress
1090
+ * @property {string} [address1] - Address of the opted store
1091
+ * @property {string} [address2] - Address of the opted store
1092
+ * @property {string} [city] - City of the opted store, e.g. Mumbai
1093
+ * @property {string} [country] - Country of the opted store, e.g. India
1094
+ * @property {StoreLatLong} [lat_long]
1095
+ * @property {number} [pincode] - 6-digit PIN code of the opted store location
1096
+ * @property {string} [state] - State of the opted store, e.g. Maharashtra
1097
+ */
1098
+ /**
1099
+ * @typedef OptedStoreIntegration
1100
+ * @property {OtherEntity} [other_entity]
1101
+ * @property {IntegrationOptIn} [other_integration]
1102
+ * @property {boolean} [other_opted] - Allow user to opt same store in other integration
1103
+ */
1104
+ /**
1105
+ * @typedef OptOutInventory
1106
+ * @property {number[]} company - List of companies opted out from the inventory
1107
+ * of other seller's application
1108
+ * @property {number[]} store - List of selling locations (stores) opted out
1109
+ * from the inventory of other seller's application
1110
+ */
1111
+ /**
1112
+ * @typedef OptType
1113
+ * @property {string} [display] - Display text of opted type for inventory store
1114
+ * @property {string} [key] - Opted type of inventory store. It can be store or company.
1115
+ */
1116
+ /**
1117
+ * @typedef OrderFeature
1118
+ * @property {boolean} [buy_again] - Allow buy again option for order. Default
1119
+ * value is false.
1120
+ */
1121
+ /**
1122
+ * @typedef OrderingStore
1123
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1124
+ * of the ordering store
1125
+ * @property {OptedStoreAddress} [address]
1126
+ * @property {string} [code] - Code of the ordering store (usually same as Store Code)
1127
+ * @property {string} [display_name] - Display name of the ordering store
1128
+ * @property {string} [name] - Store name of the ordering store
1129
+ * @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
1130
+ * @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
1131
+ * @property {string} [store_type] - Store type of the ordering store, e.g.
1132
+ * high_street, mall, warehouse
1133
+ * @property {number} [uid] - Ordering store UID
1134
+ */
1135
+ /**
1136
+ * @typedef OrderingStoreConfig
1137
+ * @property {DeploymentMeta} [deployment_meta]
1138
+ */
1139
+ /**
1140
+ * @typedef OrderingStores
1141
+ * @property {number} [__v] - Version key for tracking ordering stores. Default
1142
+ * value is zero.
1143
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1144
+ * of the ordering store
1145
+ * @property {boolean} [all_stores] - Allow all stores of the ordering stores
1146
+ * @property {string} [app] - Alphanumeric ID allotted to an application (sales
1147
+ * channel website) created within a business account
1148
+ * @property {number[]} [deployed_stores]
1149
+ * @property {boolean} [enabled] - Allow ordering stores for current sales channel
1150
+ * @property {OrderingStore[]} [items]
1151
+ * @property {Page} [page]
1152
+ * @property {string} [type] - For hard type delivery, store selection is
1153
+ * compulsory. For soft type, delivery store selection is optional.
1154
+ */
1155
+ /**
1156
+ * @typedef OrderingStoresResponse
1157
+ * @property {OrderingStore[]} [items]
1158
+ * @property {Page} [page]
1159
+ */
1160
+ /**
1161
+ * @typedef OrderValidator
1162
+ * @property {string} [browser_script] - Browser script for the order validator
1163
+ * @property {JsonSchema[]} [json_schema]
1164
+ */
1165
+ /**
1166
+ * @typedef OtherEntity
1167
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
1168
+ * @property {string} [_id] - The unique identifier of the other entity for
1169
+ * opted store integration
1170
+ * @property {string} [created_at] - ISO 8601 timestamp of other entity creation
1171
+ * for opted store integration
1172
+ * @property {OtherEntityData} [data]
1173
+ * @property {string} [integration] - Integration ID. Shows which integration
1174
+ * you are enabling.
1175
+ * @property {LastPatch[]} [last_patch]
1176
+ * @property {string} [level] - Indicates integration level. It can be company
1177
+ * level or store level.
1178
+ * @property {Object[]} [meta]
1179
+ * @property {boolean} [opted] - Allow other entity opted in integration
1180
+ * @property {string[]} [permissions]
1181
+ * @property {string} [token] - Randomly generated fixed-length string for opted
1182
+ * integration. It is auto-generated. It would never change once it is generated.
1183
+ * @property {number} [uid] - It can be store uid or company uid. Depends on the
1184
+ * level of integration.
1185
+ * @property {string} [updated_at] - ISO 8601 timestamp of other entity updation
1186
+ * for opted store integration
1187
+ */
1188
+ /**
1189
+ * @typedef OtherEntityData
1190
+ * @property {string} [article_identifier]
1191
+ */
1192
+ /**
1193
+ * @typedef OtherSellerApplication
1194
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1195
+ * of the other seller's sales channel
1196
+ * @property {OtherSellerCompany} [company]
1197
+ * @property {string} [description] - Basic details about the other seller's sales channel
1198
+ * @property {string} [domain] - Domain URL of the other seller's sales channel
1199
+ * @property {string} [name] - Name of the other seller's sales channel
1200
+ * @property {string} [opt_type] - Inventory opted by the other seller's sales
1201
+ * channel. It can be the current company or stores in the current company.
1202
+ */
1203
+ /**
1204
+ * @typedef OtherSellerApplications
1205
+ * @property {OtherSellerApplication[]} [items]
1206
+ * @property {Page} [page]
1207
+ */
1208
+ /**
1209
+ * @typedef OtherSellerCompany
1210
+ * @property {string} [name] - Name of the seller company
1211
+ * @property {number} [uid] - Uid of the seller company
1212
+ */
1213
+ /**
1214
+ * @typedef Page
1215
+ * @property {number} [current]
1216
+ * @property {boolean} [has_next]
1217
+ * @property {boolean} [has_previous]
1218
+ * @property {number} [item_total]
1219
+ * @property {string} [next_id]
1220
+ * @property {number} [size]
1221
+ * @property {string} type
1222
+ */
1223
+ /**
1224
+ * @typedef PanCardConfig
1225
+ * @property {number} [cod_threshold_amount] - On which COD order amount pan
1226
+ * card number is expected from customer for order
1227
+ * @property {boolean} [enabled] - If pan card accepting is enabled on cart
1228
+ * @property {number} [online_threshold_amount] - On which online payment order
1229
+ * amount pan card number is expected from customer for order
1230
+ */
1231
+ /**
1232
+ * @typedef PaymentModeConfig
1233
+ * @property {boolean} [enabled] - Shows if a given payment method is enabled or
1234
+ * not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
1235
+ */
1236
+ /**
1237
+ * @typedef PaymentSelectionLock
1238
+ * @property {string} [default_options] - Shows default payment method, e.g. COD
1239
+ * @property {boolean} [enabled] - Shows whether payment mode is restricted to a
1240
+ * specific option, e.g. 'HDFC Netbanking'
1241
+ * @property {string} [payment_identifier] - Payment method chosen from default
1242
+ * options, e.g. COD
1243
+ */
1244
+ /**
1245
+ * @typedef PcrFeature
1246
+ * @property {boolean} [staff_selection] - Allow staff selection. Default value is false.
1247
+ */
1248
+ /**
1249
+ * @typedef PinterestLink
1250
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
1251
+ * @property {string} [link] - Web URL of brand's Pinterest page
1252
+ * @property {string} [title] - Name of the social media platform, e.g. Pinterest
1253
+ */
1254
+ /**
1255
+ * @typedef ProductDetailFeature
1256
+ * @property {boolean} [request_product] - Indicates whether customers can
1257
+ * request for a product. Default value is false.
1258
+ * @property {boolean} [seller_selection] - Shows whether the customers can
1259
+ * choose the seller on PDP
1260
+ * @property {string[]} [similar] - Configuration to show similar products,
1261
+ * other products from same seller, other products in same category, other
1262
+ * products in same price range, etc.
1263
+ * @property {boolean} [update_product_meta] - Allow user to update product
1264
+ * meta. Default value is true.
1265
+ */
1266
+ /**
1267
+ * @typedef QrFeature
1268
+ * @property {boolean} [application] - Shows whether sharing of mobile app via
1269
+ * QR code is allowed. Default value is false.
1270
+ * @property {boolean} [collections] - Shows whether sharing collection via QR
1271
+ * code is allowed. Default value is false.
1272
+ * @property {boolean} [products] - Shows whether sharing product via QR code is
1273
+ * allowed. Default value is false.
1274
+ */
1275
+ /**
1276
+ * @typedef RegistrationPageFeature
1277
+ * @property {boolean} [ask_store_address] - Shows whether a form to collect the
1278
+ * address of the store, should be displayed upon visiting the website
1279
+ */
1280
+ /**
1281
+ * @typedef RevenueEngineFeature
1282
+ * @property {boolean} [enabled] - Enable revenue engine. Default value is false.
1283
+ */
1284
+ /**
1285
+ * @typedef RewardPointsConfig
1286
+ * @property {Credit} [credit]
1287
+ * @property {Debit} [debit]
1288
+ */
1289
+ /**
1290
+ * @typedef Safetynet
1291
+ * @property {SafetynetCredentials} [credentials]
1292
+ * @property {boolean} [enabled] - Shows whether Safetynet integration is
1293
+ * enabled or disabled for the sales channel
1294
+ */
1295
+ /**
1296
+ * @typedef SafetynetCredentials
1297
+ * @property {string} [api_key] - Secret credential API key for Safetynet. This
1298
+ * API key is used for calling the methods of Safetynet APIs.
1299
+ */
1300
+ /**
1301
+ * @typedef SecureUrl
1302
+ * @property {string} [secure_url] - Hosted URL of the image
1303
+ */
1304
+ /**
1305
+ * @typedef Segment
1306
+ * @property {SegmentCredentials} [credentials]
1307
+ * @property {boolean} [enabled] - Shows whether Segment integration is enabled
1308
+ * or disabled for the sales channel
1309
+ */
1310
+ /**
1311
+ * @typedef SegmentCredentials
1312
+ * @property {string} [write_key] - The unique identifier for a source that
1313
+ * tells Segment from which source data is coming from, to which workspace the
1314
+ * data belongs, and which destinations should receive the data.
1315
+ */
1316
+ /**
1317
+ * @typedef SocialLinks
1318
+ * @property {BlogLink} [blog_link]
1319
+ * @property {FacebookLink} [facebook]
1320
+ * @property {GooglePlusLink} [google_plus]
1321
+ * @property {InstagramLink} [instagram]
1322
+ * @property {LinkedInLink} [linked_in]
1323
+ * @property {PinterestLink} [pinterest]
1324
+ * @property {TwitterLink} [twitter]
1325
+ * @property {VimeoLink} [vimeo]
1326
+ * @property {YoutubeLink} [youtube]
1327
+ */
1328
+ /**
1329
+ * @typedef SplashImage
1330
+ * @property {string} [aspect_ratio] - Width-to-height ratio of splash image
1331
+ * @property {string} [secure_url] - URL where the splash image is hosted
1332
+ */
1333
+ /**
1334
+ * @typedef StoreByBrandsRequest
1335
+ * @property {number} brands - Brand UID
1336
+ * @property {number} [company_id] - Current company ID for current company
1337
+ * stores only. Don't send in case cross-selling (franchise) is enabled.
1338
+ * @property {string} [search_text] - Search store by its name or store code
1339
+ */
1340
+ /**
1341
+ * @typedef StoreByBrandsResponse
1342
+ * @property {BrandStoreInfo[]} [items]
1343
+ * @property {Page} [page]
1344
+ */
1345
+ /**
1346
+ * @typedef StoreCriteriaRule
1347
+ * @property {number[]} [brands] - List of brand UID
1348
+ * @property {number[]} [companies] - List of company UID
1349
+ */
1350
+ /**
1351
+ * @typedef StoreLatLong
1352
+ * @property {number[]} [coordinates]
1353
+ * @property {string} [type] - Coordinates type of the opted store
1354
+ */
1355
+ /**
1356
+ * @typedef StorePriority
1357
+ * @property {boolean} [enabled] - Shows store priority is enabled or disabled
1358
+ * for assignment of article
1359
+ * @property {Object[]} [storetype_order] - List of store types for article
1360
+ * assignment e.g. warehouse, mall, highstreet
1361
+ */
1362
+ /**
1363
+ * @typedef StorePriorityRule
1364
+ * @property {boolean} [enabled] - Shows store priority is enabled or not
1365
+ * enabled for the article assignment.
1366
+ * @property {string[]} [storetype_order]
1367
+ */
1368
+ /**
1369
+ * @typedef StoresResponse
1370
+ * @property {AppInventoryStores} [items]
1371
+ * @property {Page} [page]
1372
+ */
1373
+ /**
1374
+ * @typedef StoreValidator
1375
+ * @property {string} [browser_script] - Browser script for the store validator
1376
+ * @property {JsonSchema[]} [json_schema]
1377
+ */
1378
+ /**
1379
+ * @typedef SuccessMessageResponse
1380
+ * @property {string} [message] - Success message shown to the user (in a string format)
1381
+ * @property {boolean} [success] - Shows whether domain was deleted successfully
1382
+ */
1383
+ /**
1384
+ * @typedef TokenResponse
1385
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
1386
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1387
+ * of the token
1388
+ * @property {string} [application] - Alphanumeric ID allotted to the current
1389
+ * application created within the current business account
1390
+ * @property {string} [created_at] - ISO 8601 timestamp of token creation
1391
+ * @property {Tokens} [tokens]
1392
+ * @property {string} [updated_at] - ISO 8601 timestamp of token updation
1393
+ */
1394
+ /**
1395
+ * @typedef Tokens
1396
+ * @property {Firebase} [firebase]
1397
+ * @property {Freshchat} [freshchat]
1398
+ * @property {FyndRewards} [fynd_rewards]
1399
+ * @property {GoogleMap} [google_map]
1400
+ * @property {Gtm} [gtm]
1401
+ * @property {Moengage} [moengage]
1402
+ * @property {Safetynet} [safetynet]
1403
+ * @property {Segment} [segment]
1404
+ */
1405
+ /**
1406
+ * @typedef TwitterLink
1407
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
1408
+ * @property {string} [link] - Web URL of brand's Twitter account
1409
+ * @property {string} [title] - Name of the social media platform, e.g. Twitter
1410
+ */
1411
+ /**
1412
+ * @typedef UnhandledError
1413
+ * @property {string} [message]
1414
+ */
1415
+ /**
1416
+ * @typedef UpdateDomain
1417
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1418
+ * of the domain
1419
+ * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
1420
+ * domain has been made the main URL of the sales channel)
1421
+ * @property {boolean} [is_shortlink] - Indicates if the domain is a short link
1422
+ * domain (short URL e.g. bit.ly)
1423
+ * @property {string} [name] - Full domain name, e.g. zenz.com
1424
+ * @property {boolean} [verified] - Domain is verified or not (indicates if A
1425
+ * records and TXT records are correct)
1426
+ */
1427
+ /**
1428
+ * @typedef UpdateDomainTypeRequest
1429
+ * @property {string} [action] - Shows domain is made primary domain for the
1430
+ * sales channel or shorlink is created for the sales channel domain
1431
+ * @property {UpdateDomain} [domain]
1432
+ */
1433
+ /**
1434
+ * @typedef UpdateIntegrationLevelRequest
1435
+ * @property {IntegrationLevel[]} [items]
1436
+ */
1437
+ /**
1438
+ * @typedef UserEmail
1439
+ * @property {boolean} [active] - Current email is active or not active
1440
+ * @property {string} [email] - Email address of the user
1441
+ * @property {boolean} [primary] - Indicates current email is primay email or
1442
+ * not primary email of user
1443
+ * @property {boolean} [verified] - Indicates current email is verified email or
1444
+ * not verified email
1445
+ */
1446
+ /**
1447
+ * @typedef UserPhoneNumber
1448
+ * @property {boolean} [active] - Current phone number is active or not active
1449
+ * @property {number} [country_code] - Country code, e.g. +91
1450
+ * @property {string} [phone] - Phone number of the user
1451
+ * @property {boolean} [primary] - Indicates current phone number is primay or
1452
+ * not primary of user
1453
+ * @property {boolean} [verified] - Indicates current phone number is verified
1454
+ * or not verified
1455
+ */
1456
+ /**
1457
+ * @typedef ValidationFailedResponse
1458
+ * @property {string} [message] - Response message for failed validation
1459
+ */
1460
+ /**
1461
+ * @typedef Validators
1462
+ * @property {CompanyValidator} [company]
1463
+ * @property {InventoryValidator} [inventory]
1464
+ * @property {OrderValidator} [order]
1465
+ * @property {StoreValidator} [store]
1466
+ */
1467
+ /**
1468
+ * @typedef VimeoLink
1469
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
1470
+ * @property {string} [link] - Web URL of brand's Vimeo channel
1471
+ * @property {string} [title] - Name of the video hosting platform, e.g. Vimeo
1472
+ */
1473
+ /**
1474
+ * @typedef YoutubeLink
1475
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website
1476
+ * @property {string} [link] - Web URL of brand's YouTube channel
1477
+ * @property {string} [title] - Name of the social media platform, e.g. YouTube
1478
+ */
1479
+ declare class ConfigurationPlatformModel {
189
1480
  }
1481
+ declare namespace ConfigurationPlatformModel {
1482
+ export { Android, App, AppCartConfig, AppCurrencyResponse, AppDomain, AppFeature, AppFeatureRequest, AppFeatureResponse, AppInventory, AppInventoryCompanies, AppInventoryConfig, AppInventoryPartialUpdate, AppInventoryStores, Application, ApplicationAuth, ApplicationCors, ApplicationDetail, ApplicationInformation, ApplicationInventory, ApplicationMeta, ApplicationRedirections, ApplicationsResponse, ApplicationWebsite, AppLogisticsConfig, AppOrderConfig, AppPaymentConfig, AppStoreRules, AppSupportedCurrency, ArticleAssignmentConfig, ArticleAssignmentRule, ArticleAssignmentRules, AuthenticationConfig, BlogLink, BrandCompanyInfo, BrandsByCompanyResponse, BrandStoreInfo, BuildVersion, BuildVersionHistory, BusinessHighlights, CallbackUrl, CartFeature, Charges, CommonFeature, CommsConfig, CommunicationConfig, CommunicationOptinDialogFeature, CompaniesResponse, CompanyAboutAddress, CompanyBrandInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, CompanyValidator, CompareProductsFeature, CreateApplicationRequest, CreateAppResponse, Credentials, Credit, CurrenciesResponse, Currency, CurrencyConfig, CurrencyFeature, Debit, DefaultCurrency, DeliveryCharges, DeploymentMeta, DeploymentStoreSelectionFeature, Domain, DomainAdd, DomainAddRequest, DomainsResponse, DomainStatus, DomainStatusRequest, DomainStatusResponse, DomainSuggestion, DomainSuggestionsRequest, DomainSuggestionsResponse, FacebookLink, FeedbackFeature, FilterOrderingStoreRequest, Firebase, Freshchat, FreshchatCredentials, FyndRewards, FyndRewardsCredentials, GetIntegrationsOptInsResponse, GoogleMap, GoogleMapCredentials, GooglePlusLink, Gtm, GtmCredentials, HomePageFeature, InformationAddress, InformationPhone, InformationSupport, InstagramLink, Integration, IntegrationConfigResponse, IntegrationLevel, IntegrationMeta, IntegrationOptIn, InvalidPayloadRequest, InventoryArticleAssignment, InventoryBrand, InventoryBrandRule, InventoryCategory, InventoryDiscount, InventoryPaymentConfig, InventoryPrice, InventoryStore, InventoryStoreRule, InventoryValidator, Ios, JsonSchema, LandingImage, LandingPageFeature, LastPatch, LaunchPage, LinkedInLink, Links, ListingPriceFeature, LoyaltyPointsConfig, Methods, MobileAppConfigRequest, MobileAppConfiguration, Moengage, MoengageCredentials, NotFound, OptedApplicationResponse, OptedCompany, OptedInventory, OptedStore, OptedStoreAddress, OptedStoreIntegration, OptOutInventory, OptType, OrderFeature, OrderingStore, OrderingStoreConfig, OrderingStores, OrderingStoresResponse, OrderValidator, OtherEntity, OtherEntityData, OtherSellerApplication, OtherSellerApplications, OtherSellerCompany, Page, PanCardConfig, PaymentModeConfig, PaymentSelectionLock, PcrFeature, PinterestLink, ProductDetailFeature, QrFeature, RegistrationPageFeature, RevenueEngineFeature, RewardPointsConfig, Safetynet, SafetynetCredentials, SecureUrl, Segment, SegmentCredentials, SocialLinks, SplashImage, StoreByBrandsRequest, StoreByBrandsResponse, StoreCriteriaRule, StoreLatLong, StorePriority, StorePriorityRule, StoresResponse, StoreValidator, SuccessMessageResponse, TokenResponse, Tokens, TwitterLink, UnhandledError, UpdateDomain, UpdateDomainTypeRequest, UpdateIntegrationLevelRequest, UserEmail, UserPhoneNumber, ValidationFailedResponse, Validators, VimeoLink, YoutubeLink };
1483
+ }
1484
+ /** @returns {Android} */
1485
+ declare function Android(): Android;
1486
+ type Android = {
1487
+ /**
1488
+ * - Firebase secret credential API key for Android
1489
+ */
1490
+ api_key?: string;
1491
+ /**
1492
+ * - Alphanumeric ID allotted to a sales
1493
+ * channel application created within a business account
1494
+ */
1495
+ application_id?: string;
1496
+ };
1497
+ /** @returns {App} */
1498
+ declare function App(): App;
1499
+ type App = {
1500
+ auth?: ApplicationAuth;
1501
+ /**
1502
+ * - It indicates different channel types like
1503
+ * store, website-and-mobile-apps. Default value is store
1504
+ */
1505
+ channel_type?: string;
1506
+ /**
1507
+ * - Numeric ID allotted to a business account
1508
+ * on Fynd Platform.
1509
+ */
1510
+ company_id?: string;
1511
+ /**
1512
+ * - Detailed description about the sales channel
1513
+ */
1514
+ desc?: string;
1515
+ /**
1516
+ * - User-friendly name for sales channel, e.g. Zenz Fashion
1517
+ */
1518
+ name?: string;
1519
+ };
1520
+ /** @returns {AppCartConfig} */
1521
+ declare function AppCartConfig(): AppCartConfig;
1522
+ type AppCartConfig = {
1523
+ /**
1524
+ * - Allow creation of bulk coupons
1525
+ */
1526
+ bulk_coupons?: boolean;
1527
+ delivery_charges?: DeliveryCharges;
1528
+ /**
1529
+ * - Shows whether cart configuration is enabled or not
1530
+ */
1531
+ enabled?: boolean;
1532
+ /**
1533
+ * - Maximum number of items that can be
1534
+ * added to cart by the customer
1535
+ */
1536
+ max_cart_items?: number;
1537
+ /**
1538
+ * - Minimum cart value below which customer
1539
+ * cannot place an order
1540
+ */
1541
+ min_cart_value?: number;
1542
+ pan_card?: PanCardConfig;
1543
+ /**
1544
+ * - Allow coupon apply and credits
1545
+ * together. Default value is false.
1546
+ */
1547
+ revenue_engine_coupon?: boolean;
1548
+ };
1549
+ /** @returns {AppCurrencyResponse} */
1550
+ declare function AppCurrencyResponse(): AppCurrencyResponse;
1551
+ type AppCurrencyResponse = {
1552
+ /**
1553
+ * - Alphanumeric ID allotted to an application
1554
+ * (sales channel website) created within a business account
1555
+ */
1556
+ application?: string;
1557
+ default_currency?: DefaultCurrency;
1558
+ supported_currency?: Currency[];
1559
+ };
1560
+ /** @returns {AppDomain} */
1561
+ declare function AppDomain(): AppDomain;
1562
+ type AppDomain = {
1563
+ /**
1564
+ * - Domain URL of current sales channel, e.g. zenz.com
1565
+ */
1566
+ name?: string;
1567
+ };
1568
+ /** @returns {AppFeature} */
1569
+ declare function AppFeature(): AppFeature;
1570
+ type AppFeature = {
1571
+ /**
1572
+ * - Version key for tracking revisions. Default value is zero
1573
+ */
1574
+ __v?: number;
1575
+ /**
1576
+ * - The unique identifier (24-digit Mongo Object ID)
1577
+ * for the sales channel features
1578
+ */
1579
+ _id?: string;
1580
+ /**
1581
+ * - Application ID of the sales channel
1582
+ */
1583
+ app?: string;
1584
+ cart?: CartFeature;
1585
+ common?: CommonFeature;
1586
+ /**
1587
+ * - ISO 8601 timestamp showing the date when
1588
+ * the features were configured
1589
+ */
1590
+ created_at?: string;
1591
+ home_page?: HomePageFeature;
1592
+ landing_page?: LandingPageFeature;
1593
+ order?: OrderFeature;
1594
+ pcr?: PcrFeature;
1595
+ product_detail?: ProductDetailFeature;
1596
+ qr?: QrFeature;
1597
+ registration_page?: RegistrationPageFeature;
1598
+ /**
1599
+ * - ISO 8601 timestamp of last known
1600
+ * modifications to the sales channel feature configuration
1601
+ */
1602
+ updated_at?: string;
1603
+ };
1604
+ /** @returns {AppFeatureRequest} */
1605
+ declare function AppFeatureRequest(): AppFeatureRequest;
1606
+ type AppFeatureRequest = {
1607
+ feature?: AppFeature;
1608
+ };
1609
+ /** @returns {AppFeatureResponse} */
1610
+ declare function AppFeatureResponse(): AppFeatureResponse;
1611
+ type AppFeatureResponse = {
1612
+ feature?: AppFeature;
1613
+ };
1614
+ /** @returns {AppInventory} */
1615
+ declare function AppInventory(): AppInventory;
1616
+ type AppInventory = {
1617
+ article_assignment?: InventoryArticleAssignment;
1618
+ brand?: InventoryBrandRule;
1619
+ /**
1620
+ * - Allow other businesses (companies)
1621
+ * to consume the current sales channel's inventory and sell products
1622
+ */
1623
+ franchise_enabled?: boolean;
1624
+ image?: string[];
1625
+ /**
1626
+ * - Show only verified products
1627
+ * (the ones whose data have been verified by the admin)
1628
+ */
1629
+ only_verified_products?: boolean;
1630
+ /**
1631
+ * - Indicates whether out of stock products
1632
+ * are allowed to show up on the website.
1633
+ */
1634
+ out_of_stock?: boolean;
1635
+ payment?: InventoryPaymentConfig;
1636
+ store?: InventoryStoreRule;
1637
+ };
1638
+ /** @returns {AppInventoryCompanies} */
1639
+ declare function AppInventoryCompanies(): AppInventoryCompanies;
1640
+ type AppInventoryCompanies = {
1641
+ /**
1642
+ * - Indicates the type of the company, e.g.
1643
+ * franchisee, distributor, etc.
1644
+ */
1645
+ company_type?: string;
1646
+ /**
1647
+ * - Name of the company, e.g. Newton Traders
1648
+ */
1649
+ name?: string;
1650
+ /**
1651
+ * - UID of the company, e.g. 108
1652
+ */
1653
+ uid?: number;
1654
+ };
1655
+ /** @returns {AppInventoryConfig} */
1656
+ declare function AppInventoryConfig(): AppInventoryConfig;
1657
+ type AppInventoryConfig = {
1658
+ brand?: InventoryBrand;
1659
+ category?: InventoryCategory;
1660
+ /**
1661
+ * - List of selling locations whose
1662
+ * inventory is available to the sales channel for displaying on the website
1663
+ */
1664
+ company_store?: any[];
1665
+ discount?: InventoryDiscount;
1666
+ /**
1667
+ * - List of excluded brands category
1668
+ */
1669
+ exclude_category?: any[];
1670
+ /**
1671
+ * - Allow other businesses (companies)
1672
+ * to consume the current sales channel's inventory and sell products
1673
+ */
1674
+ franchise_enabled?: boolean;
1675
+ image?: string[];
1676
+ /**
1677
+ * - Show only verified products
1678
+ * (the ones whose data has been verified by the admin)
1679
+ */
1680
+ only_verified_products?: boolean;
1681
+ /**
1682
+ * - Indicates whether out of stock products
1683
+ * are allowed to show up on the website
1684
+ */
1685
+ out_of_stock?: boolean;
1686
+ price?: InventoryPrice;
1687
+ store?: InventoryStore;
1688
+ };
1689
+ /** @returns {AppInventoryPartialUpdate} */
1690
+ declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
1691
+ type AppInventoryPartialUpdate = {
1692
+ cart?: AppCartConfig;
1693
+ /**
1694
+ * - Shows communication (comms) is enabled
1695
+ * or not for sales channel partial inventory update
1696
+ */
1697
+ comms_enabled?: boolean;
1698
+ communication?: CommunicationConfig;
1699
+ loyalty_points?: LoyaltyPointsConfig;
1700
+ payment?: AppPaymentConfig;
1701
+ reward_points?: RewardPointsConfig;
1702
+ };
1703
+ /** @returns {AppInventoryStores} */
1704
+ declare function AppInventoryStores(): AppInventoryStores;
1705
+ type AppInventoryStores = {
1706
+ /**
1707
+ * - The unique identifier of the store (24-digit Mongo
1708
+ * Object ID) in the sales channel inventory
1709
+ */
1710
+ _id?: string;
1711
+ /**
1712
+ * - Company ID of the selling location (store)
1713
+ * added to the sales channel's inventory
1714
+ */
1715
+ company_id?: number;
1716
+ /**
1717
+ * - Display name of the sales channel
1718
+ * inventory store (can be different than the actual store name), e.g. Reebok MUM
1719
+ */
1720
+ display_name?: string;
1721
+ /**
1722
+ * - ISO 8601 timestamp of last known updation
1723
+ * to the stores in sales channel inventory
1724
+ */
1725
+ modified_on?: string;
1726
+ /**
1727
+ * - Name of the store in the sales channel inventory,
1728
+ * e.g. Reebok Mumbai
1729
+ */
1730
+ name?: string;
1731
+ /**
1732
+ * - Store code of the enabled inventory store,
1733
+ * e.g. HS-c9bac. It is unique for every store.
1734
+ */
1735
+ store_code?: string;
1736
+ /**
1737
+ * - Store type of the sales channel inventory
1738
+ * store, such as mall, warehouse, high_street
1739
+ */
1740
+ store_type?: string;
1741
+ /**
1742
+ * - Sales channel inventory store UID
1743
+ */
1744
+ uid?: number;
1745
+ };
1746
+ /** @returns {Application} */
1747
+ declare function Application(): Application;
1748
+ type Application = {
1749
+ /**
1750
+ * - Version key for tracking revisions. Default value is zero.
1751
+ */
1752
+ __v?: number;
1753
+ /**
1754
+ * - The unique identifier (24-digit Mongo Object ID)
1755
+ * of the sales channel
1756
+ */
1757
+ _id?: string;
1758
+ /**
1759
+ * - It shows application is live or in development mode.
1760
+ */
1761
+ app_type?: string;
1762
+ auth?: ApplicationAuth;
1763
+ banner?: SecureUrl;
1764
+ /**
1765
+ * - An integer value that specifies the number
1766
+ * of seconds until the key expires
1767
+ */
1768
+ cache_ttl?: number;
1769
+ /**
1770
+ * - It indicates different channel types like
1771
+ * store, website-and-mobile-apps. Default value is store
1772
+ */
1773
+ channel_type?: string;
1774
+ /**
1775
+ * - Numeric ID allotted to a business account
1776
+ * where the sales channel exists
1777
+ */
1778
+ company_id?: number;
1779
+ cors?: ApplicationCors;
1780
+ /**
1781
+ * - ISO 8601 timestamp of sales channel creation
1782
+ */
1783
+ created_at?: string;
1784
+ /**
1785
+ * - It contains detailed information about the
1786
+ * sales channel.
1787
+ */
1788
+ description?: string;
1789
+ domain?: Domain;
1790
+ domains?: Domain[];
1791
+ favicon?: SecureUrl;
1792
+ /**
1793
+ * - Indicates sales channel is active or not active
1794
+ */
1795
+ is_active?: boolean;
1796
+ /**
1797
+ * - Indicates whether a sales channel is
1798
+ * internal or not
1799
+ */
1800
+ is_internal?: boolean;
1801
+ logo?: SecureUrl;
1802
+ meta?: ApplicationMeta[];
1803
+ mobile_logo?: SecureUrl;
1804
+ /**
1805
+ * - Name of the sales channel, e.g. Zenz Fashion
1806
+ */
1807
+ name?: string;
1808
+ /**
1809
+ * - The unique identifier (24-digit Mongo Object ID)
1810
+ * of owner who owns the application
1811
+ */
1812
+ owner?: string;
1813
+ redirections?: ApplicationRedirections[];
1814
+ slug?: string;
1815
+ /**
1816
+ * - Random generated fix length string for sales
1817
+ * channel. It is required and auto-generated.
1818
+ */
1819
+ token?: string;
1820
+ /**
1821
+ * - ISO 8601 timestamp of sales channel updation
1822
+ */
1823
+ updated_at?: string;
1824
+ website?: ApplicationWebsite;
1825
+ };
1826
+ /** @returns {ApplicationAuth} */
1827
+ declare function ApplicationAuth(): ApplicationAuth;
1828
+ type ApplicationAuth = {
1829
+ /**
1830
+ * - Shows sales channel auth is enabled or not enabled.
1831
+ */
1832
+ enabled?: boolean;
1833
+ };
1834
+ /** @returns {ApplicationCors} */
1835
+ declare function ApplicationCors(): ApplicationCors;
1836
+ type ApplicationCors = {
1837
+ domains?: string[];
1838
+ };
1839
+ /** @returns {ApplicationDetail} */
1840
+ declare function ApplicationDetail(): ApplicationDetail;
1841
+ type ApplicationDetail = {
1842
+ /**
1843
+ * - The unique identifier (24-digit Mongo Object ID)
1844
+ * for the sales channel details
1845
+ */
1846
+ _id?: string;
1847
+ banner?: SecureUrl;
1848
+ /**
1849
+ * - It gives a detailed information about the
1850
+ * sales channel. It is required.
1851
+ */
1852
+ description?: string;
1853
+ domain?: Domain;
1854
+ domains?: Domain[];
1855
+ favicon?: SecureUrl;
1856
+ logo?: SecureUrl;
1857
+ mobile_logo?: SecureUrl;
1858
+ /**
1859
+ * - Name of the sales channel. It is required.
1860
+ */
1861
+ name: string;
1862
+ };
1863
+ /** @returns {ApplicationInformation} */
1864
+ declare function ApplicationInformation(): ApplicationInformation;
1865
+ type ApplicationInformation = {
1866
+ /**
1867
+ * - Version key for tracking revisions. Default value is zero.
1868
+ */
1869
+ __v?: number;
1870
+ /**
1871
+ * - Unique identifier (24-digit Mongo Object ID) of
1872
+ * the application information
1873
+ */
1874
+ _id?: string;
1875
+ address?: InformationAddress;
1876
+ /**
1877
+ * - Alphanumeric ID allotted to a sales
1878
+ * channel application created within a business account
1879
+ */
1880
+ application?: string;
1881
+ business_highlights?: BusinessHighlights;
1882
+ /**
1883
+ * - Copyright statement usually seen at the
1884
+ * site's footer
1885
+ */
1886
+ copyright_text?: string;
1887
+ /**
1888
+ * - ISO 8601 timestamp of creation of the
1889
+ * application information
1890
+ */
1891
+ created_at?: string;
1892
+ links?: Links[];
1893
+ social_links?: SocialLinks;
1894
+ support?: InformationSupport;
1895
+ /**
1896
+ * - ISO 8601 timestamp of updation of the
1897
+ * application information
1898
+ */
1899
+ updated_at?: string;
1900
+ };
1901
+ /** @returns {ApplicationInventory} */
1902
+ declare function ApplicationInventory(): ApplicationInventory;
1903
+ type ApplicationInventory = {
1904
+ /**
1905
+ * - The unique identifier (24-digit Mongo Object ID)
1906
+ * of the sales channel inventory
1907
+ */
1908
+ _id?: string;
1909
+ /**
1910
+ * - Current sales channel ID
1911
+ */
1912
+ app?: string;
1913
+ article_assignment?: ArticleAssignmentConfig;
1914
+ authentication?: AuthenticationConfig;
1915
+ /**
1916
+ * - Indicates the business type for sales channel
1917
+ * e.g. retail or wholesale
1918
+ */
1919
+ business?: string;
1920
+ cart?: AppCartConfig;
1921
+ /**
1922
+ * - Shows communication(comms) is enabled
1923
+ * or not for sales channel inventory
1924
+ */
1925
+ comms_enabled?: boolean;
1926
+ communication?: CommunicationConfig;
1927
+ /**
1928
+ * - ISO 8601 timestamp of sales channel
1929
+ * inventory creation
1930
+ */
1931
+ created_at?: string;
1932
+ inventory?: AppInventoryConfig;
1933
+ logistics?: AppLogisticsConfig;
1934
+ loyalty_points?: LoyaltyPointsConfig;
1935
+ /**
1936
+ * - User ID of the person who made the latest
1937
+ * changes in the sales channel inventory
1938
+ */
1939
+ modified_by?: string;
1940
+ order?: AppOrderConfig;
1941
+ payment?: AppPaymentConfig;
1942
+ platforms?: string[];
1943
+ reward_points?: RewardPointsConfig;
1944
+ /**
1945
+ * - ISO 8601 timestamp of sales channel
1946
+ * inventory updation
1947
+ */
1948
+ updated_at?: string;
1949
+ };
1950
+ /** @returns {ApplicationMeta} */
1951
+ declare function ApplicationMeta(): ApplicationMeta;
1952
+ type ApplicationMeta = {
1953
+ /**
1954
+ * - Indicates to name of application meta
1955
+ */
1956
+ name?: string;
1957
+ /**
1958
+ * - Value related to application meta name
1959
+ */
1960
+ value?: string;
1961
+ };
1962
+ /** @returns {ApplicationRedirections} */
1963
+ declare function ApplicationRedirections(): ApplicationRedirections;
1964
+ type ApplicationRedirections = {
1965
+ /**
1966
+ * - Old domain url of the sales channel
1967
+ */
1968
+ redirect_from?: string;
1969
+ /**
1970
+ * - New domain URL of the sales channel. Users
1971
+ * will be automatically redirected from old domain to new domain.
1972
+ */
1973
+ redirect_to?: string;
1974
+ /**
1975
+ * - It shows domain redirection type. Permanent
1976
+ * redirection is for long time period redirection, and temporary redirection
1977
+ * for a short time period.
1978
+ */
1979
+ type?: string;
1980
+ };
1981
+ /** @returns {ApplicationsResponse} */
1982
+ declare function ApplicationsResponse(): ApplicationsResponse;
1983
+ type ApplicationsResponse = {
1984
+ items?: Application[];
1985
+ page?: Page;
1986
+ };
1987
+ /** @returns {ApplicationWebsite} */
1988
+ declare function ApplicationWebsite(): ApplicationWebsite;
1989
+ type ApplicationWebsite = {
1990
+ /**
1991
+ * - Base path for the current sales channel website
1992
+ */
1993
+ basepath?: string;
1994
+ /**
1995
+ * - Shows whether sales channel website URL is
1996
+ * enabled or not
1997
+ */
1998
+ enabled?: boolean;
1999
+ };
2000
+ /** @returns {AppLogisticsConfig} */
2001
+ declare function AppLogisticsConfig(): AppLogisticsConfig;
2002
+ type AppLogisticsConfig = {
2003
+ dp_assignment?: boolean;
2004
+ logistics_by_seller?: boolean;
2005
+ same_day_delivery?: boolean;
2006
+ serviceability_check?: boolean;
2007
+ };
2008
+ /** @returns {AppOrderConfig} */
2009
+ declare function AppOrderConfig(): AppOrderConfig;
2010
+ type AppOrderConfig = {
2011
+ /**
2012
+ * - Allow orders to be accepted from the sales channel
2013
+ */
2014
+ enabled?: boolean;
2015
+ /**
2016
+ * - Allow force reassigning of an order
2017
+ */
2018
+ force_reassignment?: boolean;
2019
+ /**
2020
+ * - Reason for reassigning an order
2021
+ */
2022
+ message?: string;
2023
+ };
2024
+ /** @returns {AppPaymentConfig} */
2025
+ declare function AppPaymentConfig(): AppPaymentConfig;
2026
+ type AppPaymentConfig = {
2027
+ /**
2028
+ * - Allow cash on delivery for anonymous user
2029
+ */
2030
+ anonymous_cod?: boolean;
2031
+ callback_url?: CallbackUrl;
2032
+ /**
2033
+ * - Maximum amount allowed for COD order.
2034
+ * Beyond this, customer cannot opt for COD.
2035
+ */
2036
+ cod_amount_limit?: number;
2037
+ /**
2038
+ * - Extra charge applicable for COD orders
2039
+ */
2040
+ cod_charges?: number;
2041
+ /**
2042
+ * - Allow payment option within sales channel
2043
+ */
2044
+ enabled?: boolean;
2045
+ methods?: Methods;
2046
+ /**
2047
+ * - Mode of payment for sales channel
2048
+ * payment, e.g. 'ECOMM'.
2049
+ */
2050
+ mode_of_payment?: string;
2051
+ payment_selection_lock?: PaymentSelectionLock;
2052
+ /**
2053
+ * - Source of the payment mode, e.g. 'ECOMM'.
2054
+ * Default value is FYND.
2055
+ */
2056
+ source?: string;
2057
+ };
2058
+ /** @returns {AppStoreRules} */
2059
+ declare function AppStoreRules(): AppStoreRules;
2060
+ type AppStoreRules = {
2061
+ /**
2062
+ * - List of brands whose products will be shown
2063
+ * on the website
2064
+ */
2065
+ brands?: any[];
2066
+ /**
2067
+ * - List of companies whose inventory is
2068
+ * available to the sales channel for displaying on the website
2069
+ */
2070
+ companies?: number[];
2071
+ };
2072
+ /** @returns {AppSupportedCurrency} */
2073
+ declare function AppSupportedCurrency(): AppSupportedCurrency;
2074
+ type AppSupportedCurrency = {
2075
+ /**
2076
+ * - The unique identifier (24-digit Mongo Object ID)
2077
+ * of the currency configuration supported by the application
2078
+ */
2079
+ _id?: string;
2080
+ /**
2081
+ * - Alphanumeric ID allotted to an application
2082
+ * (sales channel website) created within a business account.
2083
+ */
2084
+ application?: string;
2085
+ /**
2086
+ * - ISO 8601 timestamp when currency was added
2087
+ * in the list of currencies supported by the sales channel
2088
+ */
2089
+ created_at?: string;
2090
+ default_currency?: DefaultCurrency;
2091
+ supported_currency?: string[];
2092
+ /**
2093
+ * - ISO 8601 timestamp when currency was
2094
+ * updated in the list of currencies supported by the sales channel
2095
+ */
2096
+ updated_at?: string;
2097
+ };
2098
+ /** @returns {ArticleAssignmentConfig} */
2099
+ declare function ArticleAssignmentConfig(): ArticleAssignmentConfig;
2100
+ type ArticleAssignmentConfig = {
2101
+ /**
2102
+ * - Allow post order reassigment of article
2103
+ */
2104
+ post_order_reassignment?: boolean;
2105
+ rules?: ArticleAssignmentRules;
2106
+ };
2107
+ /** @returns {ArticleAssignmentRule} */
2108
+ declare function ArticleAssignmentRule(): ArticleAssignmentRule;
2109
+ type ArticleAssignmentRule = {
2110
+ store_priority?: StorePriorityRule;
2111
+ };
2112
+ /** @returns {ArticleAssignmentRules} */
2113
+ declare function ArticleAssignmentRules(): ArticleAssignmentRules;
2114
+ type ArticleAssignmentRules = {
2115
+ store_priority?: StorePriority;
2116
+ };
2117
+ /** @returns {AuthenticationConfig} */
2118
+ declare function AuthenticationConfig(): AuthenticationConfig;
2119
+ type AuthenticationConfig = {
2120
+ /**
2121
+ * - Shows inventory authentication provider
2122
+ */
2123
+ provider?: string;
2124
+ /**
2125
+ * - Shows sales channel inventory authentication
2126
+ * is required or not
2127
+ */
2128
+ required?: boolean;
2129
+ };
2130
+ /** @returns {BlogLink} */
2131
+ declare function BlogLink(): BlogLink;
2132
+ type BlogLink = {
2133
+ /**
2134
+ * - Hosted URL of icon image shown on the website
2135
+ */
2136
+ icon?: string;
2137
+ /**
2138
+ * - Web URL of brand's blog page
2139
+ */
2140
+ link?: string;
2141
+ /**
2142
+ * - Name of the brand's blog page
2143
+ */
2144
+ title?: string;
2145
+ };
2146
+ /** @returns {BrandCompanyInfo} */
2147
+ declare function BrandCompanyInfo(): BrandCompanyInfo;
2148
+ type BrandCompanyInfo = {
2149
+ /**
2150
+ * - Numeric ID allotted to a business account
2151
+ */
2152
+ company_id?: number;
2153
+ /**
2154
+ * - Name of the company dealing with the brand
2155
+ */
2156
+ company_name?: string;
2157
+ };
2158
+ /** @returns {BrandsByCompanyResponse} */
2159
+ declare function BrandsByCompanyResponse(): BrandsByCompanyResponse;
2160
+ type BrandsByCompanyResponse = {
2161
+ brands?: CompanyBrandInfo;
2162
+ };
2163
+ /** @returns {BrandStoreInfo} */
2164
+ declare function BrandStoreInfo(): BrandStoreInfo;
2165
+ type BrandStoreInfo = {
2166
+ company?: OptedCompany;
2167
+ store_address?: OptedStoreAddress;
2168
+ /**
2169
+ * - Store code of the brand. It is unique for
2170
+ * every brand store.
2171
+ */
2172
+ store_code?: string;
2173
+ /**
2174
+ * - The unique identifier of the selling location (store)
2175
+ */
2176
+ store_id?: number;
2177
+ /**
2178
+ * - Name of the selling location (store)
2179
+ */
2180
+ store_name?: string;
2181
+ /**
2182
+ * - Store type of the brand like warehouse,
2183
+ * high_street, mall
2184
+ */
2185
+ store_type?: string;
2186
+ };
2187
+ /** @returns {BuildVersion} */
2188
+ declare function BuildVersion(): BuildVersion;
2189
+ type BuildVersion = {
2190
+ /**
2191
+ * - Version key for tracking revisions. Default value is zero.
2192
+ */
2193
+ __v?: number;
2194
+ /**
2195
+ * - 24-digit Mongo Object ID
2196
+ */
2197
+ _id?: string;
2198
+ /**
2199
+ * - Application ID of the sales channel
2200
+ */
2201
+ application?: string;
2202
+ /**
2203
+ * - Current progress of the mobile build,
2204
+ * e.g. pending, cancelled, failed, success
2205
+ */
2206
+ build_status?: string;
2207
+ /**
2208
+ * - ISO 8601 timestamp of app creation
2209
+ */
2210
+ created_at?: string;
2211
+ /**
2212
+ * - Device platform for which the mobile app
2213
+ * was built, e.g. android, ios.
2214
+ */
2215
+ platform_type?: string;
2216
+ /**
2217
+ * - ISO 8601 timestamp of last known
2218
+ * modifications to the app build
2219
+ */
2220
+ updated_at?: string;
2221
+ /**
2222
+ * - A positive integer used as an internal
2223
+ * version number
2224
+ */
2225
+ version_code?: number;
2226
+ /**
2227
+ * - Version number of the mobile build, in
2228
+ * dot-decimal notation
2229
+ */
2230
+ version_name?: string;
2231
+ };
2232
+ /** @returns {BuildVersionHistory} */
2233
+ declare function BuildVersionHistory(): BuildVersionHistory;
2234
+ type BuildVersionHistory = {
2235
+ /**
2236
+ * - Latest version number of
2237
+ * the mobile build, in dot-decimal notation
2238
+ */
2239
+ latest_available_version_name?: string;
2240
+ versions?: BuildVersion;
2241
+ };
2242
+ /** @returns {BusinessHighlights} */
2243
+ declare function BusinessHighlights(): BusinessHighlights;
2244
+ type BusinessHighlights = {
2245
+ /**
2246
+ * - Unique identifier (24-digit Mongo Object ID) of
2247
+ * the related business
2248
+ */
2249
+ _id?: string;
2250
+ /**
2251
+ * - Hosted URL of icon image representing the
2252
+ * business highlight
2253
+ */
2254
+ icon?: string;
2255
+ /**
2256
+ * - Detailed information about the highlight
2257
+ */
2258
+ sub_title?: string;
2259
+ /**
2260
+ * - Title of the business highlight, e.g. Superfast Delivery
2261
+ */
2262
+ title?: string;
2263
+ };
2264
+ /** @returns {CallbackUrl} */
2265
+ declare function CallbackUrl(): CallbackUrl;
2266
+ type CallbackUrl = {
2267
+ /**
2268
+ * - Payment callback url for app
2269
+ */
2270
+ app?: string;
2271
+ /**
2272
+ * - Payment callback url for web
2273
+ */
2274
+ web?: string;
2275
+ };
2276
+ /** @returns {CartFeature} */
2277
+ declare function CartFeature(): CartFeature;
2278
+ type CartFeature = {
2279
+ /**
2280
+ * - Allow adding of Google Maps. Default value is true.
2281
+ */
2282
+ google_map?: boolean;
2283
+ /**
2284
+ * - Shows whether customer is allowed to enter
2285
+ * GST on the cart page for claiming input credits
2286
+ */
2287
+ gst_input?: boolean;
2288
+ /**
2289
+ * - Shows whether the staff is
2290
+ * placing order on behalf of customer. Default value is true.
2291
+ */
2292
+ placing_for_customer?: boolean;
2293
+ /**
2294
+ * - Allow coupon apply and credits,
2295
+ * together. Default value is false.
2296
+ */
2297
+ revenue_engine_coupon?: boolean;
2298
+ /**
2299
+ * - Shows whether staff selection is
2300
+ * enabled on cart page
2301
+ */
2302
+ staff_selection?: boolean;
2303
+ };
2304
+ /** @returns {Charges} */
2305
+ declare function Charges(): Charges;
2306
+ type Charges = {
2307
+ /**
2308
+ * - Delivery amount to be charged when order value
2309
+ * is below the defined threshold value
2310
+ */
2311
+ charges?: number;
2312
+ /**
2313
+ * - The order value below which an extra
2314
+ * delivery fee will be applicable
2315
+ */
2316
+ threshold?: number;
2317
+ };
2318
+ /** @returns {CommonFeature} */
2319
+ declare function CommonFeature(): CommonFeature;
2320
+ type CommonFeature = {
2321
+ communication_optin_dialog?: CommunicationOptinDialogFeature;
2322
+ compare_products?: CompareProductsFeature;
2323
+ currency?: CurrencyFeature;
2324
+ deployment_store_selection?: DeploymentStoreSelectionFeature;
2325
+ feedback?: FeedbackFeature;
2326
+ listing_price?: ListingPriceFeature;
2327
+ revenue_engine?: RevenueEngineFeature;
2328
+ reward_points?: RewardPointsConfig;
2329
+ };
2330
+ /** @returns {CommsConfig} */
2331
+ declare function CommsConfig(): CommsConfig;
2332
+ type CommsConfig = {
2333
+ /**
2334
+ * - Check current communication channel is enabled
2335
+ */
2336
+ enabled?: boolean;
2337
+ };
2338
+ /** @returns {CommunicationConfig} */
2339
+ declare function CommunicationConfig(): CommunicationConfig;
2340
+ type CommunicationConfig = {
2341
+ email?: CommsConfig;
2342
+ sms?: CommsConfig;
2343
+ voice?: CommsConfig;
2344
+ };
2345
+ /** @returns {CommunicationOptinDialogFeature} */
2346
+ declare function CommunicationOptinDialogFeature(): CommunicationOptinDialogFeature;
2347
+ type CommunicationOptinDialogFeature = {
2348
+ /**
2349
+ * - Shows whether WhatsApp communication is enabled
2350
+ */
2351
+ visibility?: boolean;
2352
+ };
2353
+ /** @returns {CompaniesResponse} */
2354
+ declare function CompaniesResponse(): CompaniesResponse;
2355
+ type CompaniesResponse = {
2356
+ items?: AppInventoryCompanies;
2357
+ page?: Page;
2358
+ };
2359
+ /** @returns {CompanyAboutAddress} */
2360
+ declare function CompanyAboutAddress(): CompanyAboutAddress;
2361
+ type CompanyAboutAddress = {
2362
+ /**
2363
+ * - Indicates different office types like
2364
+ * office, registered, and home.
2365
+ */
2366
+ address_type?: string;
2367
+ /**
2368
+ * - Primary address line of the company
2369
+ */
2370
+ address1?: string;
2371
+ /**
2372
+ * - Secondary address line of the company
2373
+ */
2374
+ address2?: string;
2375
+ /**
2376
+ * - City name, e.g. Mumbai
2377
+ */
2378
+ city?: string;
2379
+ /**
2380
+ * - Country name, e.g. India
2381
+ */
2382
+ country?: string;
2383
+ /**
2384
+ * - 6-digit PIN code of the city, e.g. 400001
2385
+ */
2386
+ pincode?: number;
2387
+ /**
2388
+ * - State name, e.g. Maharashtra
2389
+ */
2390
+ state?: string;
2391
+ };
2392
+ /** @returns {CompanyBrandInfo} */
2393
+ declare function CompanyBrandInfo(): CompanyBrandInfo;
2394
+ type CompanyBrandInfo = {
2395
+ /**
2396
+ * - Hosted URL of the brand's
2397
+ * portrait banner
2398
+ */
2399
+ brand_banner_portrait_url?: string;
2400
+ /**
2401
+ * - Hosted URL of the brand's banner image
2402
+ */
2403
+ brand_banner_url?: string;
2404
+ /**
2405
+ * - Hosted URL of the brand's logo
2406
+ */
2407
+ brand_logo_url?: string;
2408
+ /**
2409
+ * - Brand name, e.g. Raymonds
2410
+ */
2411
+ name?: string;
2412
+ /**
2413
+ * - Brand UID for identifying the brand
2414
+ */
2415
+ value?: number;
2416
+ };
2417
+ /** @returns {CompanyByBrandsRequest} */
2418
+ declare function CompanyByBrandsRequest(): CompanyByBrandsRequest;
2419
+ type CompanyByBrandsRequest = {
2420
+ /**
2421
+ * - Brand UID
2422
+ */
2423
+ brands: number;
2424
+ /**
2425
+ * - A search field for finding a company by its name
2426
+ */
2427
+ search_text?: string;
2428
+ };
2429
+ /** @returns {CompanyByBrandsResponse} */
2430
+ declare function CompanyByBrandsResponse(): CompanyByBrandsResponse;
2431
+ type CompanyByBrandsResponse = {
2432
+ items?: BrandCompanyInfo[];
2433
+ page?: Page;
2434
+ };
2435
+ /** @returns {CompanyValidator} */
2436
+ declare function CompanyValidator(): CompanyValidator;
2437
+ type CompanyValidator = {
2438
+ /**
2439
+ * - Browser script for the company validator
2440
+ */
2441
+ browser_script?: string;
2442
+ json_schema?: JsonSchema[];
2443
+ };
2444
+ /** @returns {CompareProductsFeature} */
2445
+ declare function CompareProductsFeature(): CompareProductsFeature;
2446
+ type CompareProductsFeature = {
2447
+ /**
2448
+ * - Shows whether product comparison feature is
2449
+ * enabled on PDP
2450
+ */
2451
+ enabled?: boolean;
2452
+ };
2453
+ /** @returns {CreateApplicationRequest} */
2454
+ declare function CreateApplicationRequest(): CreateApplicationRequest;
2455
+ type CreateApplicationRequest = {
2456
+ app?: App;
2457
+ configuration?: AppInventory;
2458
+ domain?: AppDomain;
2459
+ };
2460
+ /** @returns {CreateAppResponse} */
2461
+ declare function CreateAppResponse(): CreateAppResponse;
2462
+ type CreateAppResponse = {
2463
+ app?: Application;
2464
+ configuration?: ApplicationInventory;
2465
+ };
2466
+ /** @returns {Credentials} */
2467
+ declare function Credentials(): Credentials;
2468
+ type Credentials = {
2469
+ android?: Android;
2470
+ /**
2471
+ * - An API key is a unique string that's used to
2472
+ * route requests to your Firebase project when interacting with Firebase.
2473
+ */
2474
+ api_key?: string;
2475
+ /**
2476
+ * - Alphanumeric ID allotted to the current
2477
+ * application created within the current business account
2478
+ */
2479
+ application_id?: string;
2480
+ /**
2481
+ * - Google Cloud Manager's Sender ID for
2482
+ * Firebase. It is a unique numerical value which is created when you
2483
+ * configure your project in the Google Developers Console/Google Cloud Console.
2484
+ */
2485
+ gcm_sender_id?: string;
2486
+ ios?: Ios;
2487
+ /**
2488
+ * - Project ID for Firebase integration.
2489
+ * Project ID is a unique identifier for a project and is used only within the console.
2490
+ */
2491
+ project_id?: string;
2492
+ };
2493
+ /** @returns {Credit} */
2494
+ declare function Credit(): Credit;
2495
+ type Credit = {
2496
+ /**
2497
+ * - Shows whether reward points should be credited
2498
+ */
2499
+ enabled?: boolean;
2500
+ };
2501
+ /** @returns {CurrenciesResponse} */
2502
+ declare function CurrenciesResponse(): CurrenciesResponse;
2503
+ type CurrenciesResponse = {
2504
+ items?: Currency[];
2505
+ };
2506
+ /** @returns {Currency} */
2507
+ declare function Currency(): Currency;
2508
+ type Currency = {
2509
+ /**
2510
+ * - The unique identifier (24-digit Mongo Object ID)
2511
+ * of the current sales channel supported currency
2512
+ */
2513
+ _id?: string;
2514
+ /**
2515
+ * - 3-character currency code, e.g. INR, USD, EUR.
2516
+ */
2517
+ code?: string;
2518
+ /**
2519
+ * - ISO 8601 timestamp of sales channel support
2520
+ * currency creation
2521
+ */
2522
+ created_at?: string;
2523
+ /**
2524
+ * - Acceptable decimal limits for a given
2525
+ * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
2526
+ * value of a currency.
2527
+ */
2528
+ decimal_digits?: number;
2529
+ /**
2530
+ * - Shows currency is enabled or not in current
2531
+ * sales channel
2532
+ */
2533
+ is_active?: boolean;
2534
+ /**
2535
+ * - Name of the currency, e.g Indian Rupee
2536
+ */
2537
+ name?: string;
2538
+ /**
2539
+ * - Unique symbol for identifying the currency, e.g. ₹
2540
+ */
2541
+ symbol?: string;
2542
+ /**
2543
+ * - ISO 8601 timestamp of sales channel support
2544
+ * currency updation
2545
+ */
2546
+ updated_at?: string;
2547
+ };
2548
+ /** @returns {CurrencyConfig} */
2549
+ declare function CurrencyConfig(): CurrencyConfig;
2550
+ type CurrencyConfig = {
2551
+ /**
2552
+ * - The unique identifier (24-digit Mongo Object ID)
2553
+ * of all the currency configuration
2554
+ */
2555
+ _id?: string;
2556
+ /**
2557
+ * - 3-character currency code, e.g. INR, USD, EUR.
2558
+ */
2559
+ code?: string;
2560
+ /**
2561
+ * - ISO 8601 timestamp of a given currency creation
2562
+ */
2563
+ created_at?: string;
2564
+ /**
2565
+ * - Acceptable decimal limits for a given
2566
+ * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
2567
+ * value of a currency.
2568
+ */
2569
+ decimal_digits?: number;
2570
+ /**
2571
+ * - Currency is enabled or not for the current
2572
+ * sales channel
2573
+ */
2574
+ is_active?: boolean;
2575
+ /**
2576
+ * - Name of the currency, e.g Indian Rupee
2577
+ */
2578
+ name?: string;
2579
+ /**
2580
+ * - Unique symbol for identifying the currency, e.g. ₹
2581
+ */
2582
+ symbol?: string;
2583
+ /**
2584
+ * - ISO 8601 timestamp of a given currency updation
2585
+ */
2586
+ updated_at?: string;
2587
+ };
2588
+ /** @returns {CurrencyFeature} */
2589
+ declare function CurrencyFeature(): CurrencyFeature;
2590
+ type CurrencyFeature = {
2591
+ /**
2592
+ * - 3-letter code of the default currency
2593
+ * used in the application. Default vaule is 'INR'.
2594
+ */
2595
+ default_currency?: string;
2596
+ /**
2597
+ * - If 'explicit', currency formatting shows currency
2598
+ * code with price. For explicit or all currency selection.
2599
+ */
2600
+ type?: string;
2601
+ /**
2602
+ * - 3-letter currency code
2603
+ */
2604
+ value?: string[];
2605
+ };
2606
+ /** @returns {Debit} */
2607
+ declare function Debit(): Debit;
2608
+ type Debit = {
2609
+ /**
2610
+ * - Allow automatic debit of reward points
2611
+ */
2612
+ auto_apply?: boolean;
2613
+ /**
2614
+ * - Shows whether reward points are available for debit
2615
+ */
2616
+ enabled?: boolean;
2617
+ /**
2618
+ * - Strategy channel for debiting reward points
2619
+ */
2620
+ strategy_channel?: string;
2621
+ };
2622
+ /** @returns {DefaultCurrency} */
2623
+ declare function DefaultCurrency(): DefaultCurrency;
2624
+ type DefaultCurrency = {
2625
+ /**
2626
+ * - 3-character code of the default currency, e.g.
2627
+ * INR, EUR, USD
2628
+ */
2629
+ code?: string;
2630
+ /**
2631
+ * - The unique identifier (24-digit Mongo Object ID)
2632
+ * of the default currency
2633
+ */
2634
+ ref?: string;
2635
+ };
2636
+ /** @returns {DeliveryCharges} */
2637
+ declare function DeliveryCharges(): DeliveryCharges;
2638
+ type DeliveryCharges = {
2639
+ charges?: Charges;
2640
+ /**
2641
+ * - Allow delivery charges
2642
+ */
2643
+ enabled?: boolean;
2644
+ };
2645
+ /** @returns {DeploymentMeta} */
2646
+ declare function DeploymentMeta(): DeploymentMeta;
2647
+ type DeploymentMeta = {
2648
+ /**
2649
+ * - The unique identifier (24-digit Mongo Object ID)
2650
+ * of the ordering stores
2651
+ */
2652
+ _id?: string;
2653
+ /**
2654
+ * - Allow all stores from the ordering store
2655
+ */
2656
+ all_stores?: boolean;
2657
+ /**
2658
+ * - Alphanumeric ID allotted to an application (sales
2659
+ * channel website) created within a business account
2660
+ */
2661
+ app?: string;
2662
+ deployed_stores?: number[];
2663
+ /**
2664
+ * - Allow ordering stores for current sales channel
2665
+ */
2666
+ enabled?: boolean;
2667
+ /**
2668
+ * - Permitted values are 'hard' and 'soft'. For hard
2669
+ * type delivery, store selection is compulsory. For soft type, delivery store
2670
+ * selection is optional.
2671
+ */
2672
+ type?: string;
2673
+ };
2674
+ /** @returns {DeploymentStoreSelectionFeature} */
2675
+ declare function DeploymentStoreSelectionFeature(): DeploymentStoreSelectionFeature;
2676
+ type DeploymentStoreSelectionFeature = {
2677
+ /**
2678
+ * - Shows whether selection of store (for
2679
+ * deploying the application) is permitted
2680
+ */
2681
+ enabled?: boolean;
2682
+ /**
2683
+ * - Permitted values are 'hard' and 'soft'. For hard
2684
+ * type delivery, store selection is compulsory. For soft type, delivery store
2685
+ * selection is optional.
2686
+ */
2687
+ type?: string;
2688
+ };
2689
+ /** @returns {Domain} */
2690
+ declare function Domain(): Domain;
2691
+ type Domain = {
2692
+ /**
2693
+ * - The unique identifier (24-digit Mongo Object ID)
2694
+ * of the sales channel domain
2695
+ */
2696
+ _id?: string;
2697
+ /**
2698
+ * - Domain is hosting domain or not.
2699
+ */
2700
+ is_predefined?: boolean;
2701
+ /**
2702
+ * - Domain is primary or not. Primary domain
2703
+ * is the default/main domain.
2704
+ */
2705
+ is_primary?: boolean;
2706
+ /**
2707
+ * - Shortlink is present or not for the domain
2708
+ */
2709
+ is_shortlink?: boolean;
2710
+ /**
2711
+ * - Full domain name, e.g. newton.com
2712
+ */
2713
+ name?: string;
2714
+ /**
2715
+ * - Domain is verified or not. TXT and A records
2716
+ * should propagate correctly.
2717
+ */
2718
+ verified?: boolean;
2719
+ };
2720
+ /** @returns {DomainAdd} */
2721
+ declare function DomainAdd(): DomainAdd;
2722
+ type DomainAdd = {
2723
+ /**
2724
+ * - The unique identifier (24-digit Mongo Object ID)
2725
+ * of the domain
2726
+ */
2727
+ _id?: string;
2728
+ /**
2729
+ * - Domain is primary or not (indicates if the
2730
+ * domain has been made the main URL of the sales channel)
2731
+ */
2732
+ is_primary?: boolean;
2733
+ /**
2734
+ * - Indicates if the domain is a short link
2735
+ * domain (short URL e.g. bitly)
2736
+ */
2737
+ is_shortlink?: boolean;
2738
+ /**
2739
+ * - Shows the message shown after adding a domain
2740
+ * successfully, e.g. 'New domain added successfully'
2741
+ */
2742
+ message?: string;
2743
+ /**
2744
+ * - Full domain name, e.g. uniket.hostx0.de
2745
+ */
2746
+ name?: string;
2747
+ txt_records?: string[];
2748
+ /**
2749
+ * - Domain is verified or not (indicates if A
2750
+ * records and TXT records are correct)
2751
+ */
2752
+ verified?: boolean;
2753
+ };
2754
+ /** @returns {DomainAddRequest} */
2755
+ declare function DomainAddRequest(): DomainAddRequest;
2756
+ type DomainAddRequest = {
2757
+ domain?: DomainAdd;
2758
+ };
2759
+ /** @returns {DomainsResponse} */
2760
+ declare function DomainsResponse(): DomainsResponse;
2761
+ type DomainsResponse = {
2762
+ domains?: Domain[];
2763
+ };
2764
+ /** @returns {DomainStatus} */
2765
+ declare function DomainStatus(): DomainStatus;
2766
+ type DomainStatus = {
2767
+ /**
2768
+ * - Shows TXT record and A records for the domain
2769
+ */
2770
+ display?: string;
2771
+ /**
2772
+ * - Shows whether TXT record or A records for the
2773
+ * domain are correctly propagating via DNS servers
2774
+ */
2775
+ status?: boolean;
2776
+ };
2777
+ /** @returns {DomainStatusRequest} */
2778
+ declare function DomainStatusRequest(): DomainStatusRequest;
2779
+ type DomainStatusRequest = {
2780
+ /**
2781
+ * - URL of the domain, e.g. uniket.hostx0.de
2782
+ */
2783
+ domain_url?: string;
2784
+ };
2785
+ /** @returns {DomainStatusResponse} */
2786
+ declare function DomainStatusResponse(): DomainStatusResponse;
2787
+ type DomainStatusResponse = {
2788
+ /**
2789
+ * - Check if domain is live and mapped to
2790
+ * appropriate IP of Fynd Servers
2791
+ */
2792
+ connected?: boolean;
2793
+ status?: DomainStatus[];
2794
+ };
2795
+ /** @returns {DomainSuggestion} */
2796
+ declare function DomainSuggestion(): DomainSuggestion;
2797
+ type DomainSuggestion = {
2798
+ /**
2799
+ * - Custom domain currency. Not present for Fynd domains.
2800
+ */
2801
+ currency?: string;
2802
+ /**
2803
+ * - Shows whether the custom domain of your
2804
+ * choice is available or not available
2805
+ */
2806
+ is_available: boolean;
2807
+ /**
2808
+ * - URL of the custom domain
2809
+ */
2810
+ name: string;
2811
+ /**
2812
+ * - Cost of purchasing a custom domain. Not present
2813
+ * for Fynd domains.
2814
+ */
2815
+ price?: number;
2816
+ /**
2817
+ * - Shows whether TLD domain is supported or not
2818
+ */
2819
+ unsupported?: boolean;
2820
+ };
2821
+ /** @returns {DomainSuggestionsRequest} */
2822
+ declare function DomainSuggestionsRequest(): DomainSuggestionsRequest;
2823
+ type DomainSuggestionsRequest = {
2824
+ /**
2825
+ * - Get suggestions for custom domains or Fynd domains
2826
+ */
2827
+ custom?: boolean;
2828
+ /**
2829
+ * - Domain url
2830
+ */
2831
+ domain_url?: string;
2832
+ };
2833
+ /** @returns {DomainSuggestionsResponse} */
2834
+ declare function DomainSuggestionsResponse(): DomainSuggestionsResponse;
2835
+ type DomainSuggestionsResponse = {
2836
+ /**
2837
+ * - Domain URL
2838
+ */
2839
+ domains?: DomainSuggestion[];
2840
+ };
2841
+ /** @returns {FacebookLink} */
2842
+ declare function FacebookLink(): FacebookLink;
2843
+ type FacebookLink = {
2844
+ /**
2845
+ * - Hosted URL of social icon image shown on the website
2846
+ */
2847
+ icon?: string;
2848
+ /**
2849
+ * - Web URL of brand's Facebook page
2850
+ */
2851
+ link?: string;
2852
+ /**
2853
+ * - Name of the social media platform, e.g. Facebook
2854
+ */
2855
+ title?: string;
2856
+ };
2857
+ /** @returns {FeedbackFeature} */
2858
+ declare function FeedbackFeature(): FeedbackFeature;
2859
+ type FeedbackFeature = {
2860
+ /**
2861
+ * - Shows whether customer feedback is enabled on
2862
+ * PDP. Default value is false.
2863
+ */
2864
+ enabled?: boolean;
2865
+ };
2866
+ /** @returns {FilterOrderingStoreRequest} */
2867
+ declare function FilterOrderingStoreRequest(): FilterOrderingStoreRequest;
2868
+ type FilterOrderingStoreRequest = {
2869
+ /**
2870
+ * - Allow all stores from the ordering stores
2871
+ */
2872
+ all_stores?: boolean;
2873
+ deployed_stores?: number[];
2874
+ /**
2875
+ * - Store code or name of the ordering store
2876
+ */
2877
+ q?: string;
2878
+ };
2879
+ /** @returns {Firebase} */
2880
+ declare function Firebase(): Firebase;
2881
+ type Firebase = {
2882
+ credentials?: Credentials;
2883
+ /**
2884
+ * - Shows whether Firebase integration is enabled
2885
+ * or disabled for the sales channel
2886
+ */
2887
+ enabled?: boolean;
2888
+ };
2889
+ /** @returns {Freshchat} */
2890
+ declare function Freshchat(): Freshchat;
2891
+ type Freshchat = {
2892
+ credentials?: FreshchatCredentials;
2893
+ /**
2894
+ * - Shows whether Freshchat integration is
2895
+ * enabled or disabled for the sales channel
2896
+ */
2897
+ enabled?: boolean;
2898
+ };
2899
+ /** @returns {FreshchatCredentials} */
2900
+ declare function FreshchatCredentials(): FreshchatCredentials;
2901
+ type FreshchatCredentials = {
2902
+ /**
2903
+ * - The unique app_id of your Freshchat account for
2904
+ * integrating Freshchat with your sales channel
2905
+ */
2906
+ app_id?: string;
2907
+ /**
2908
+ * - The unique app_key of your Freshchat account
2909
+ * for integrating Freshchat with your sales channel
2910
+ */
2911
+ app_key?: string;
2912
+ /**
2913
+ * - Web token used for accessing the Freshchat APIs
2914
+ */
2915
+ web_token?: string;
2916
+ };
2917
+ /** @returns {FyndRewards} */
2918
+ declare function FyndRewards(): FyndRewards;
2919
+ type FyndRewards = {
2920
+ credentials?: FyndRewardsCredentials;
2921
+ };
2922
+ /** @returns {FyndRewardsCredentials} */
2923
+ declare function FyndRewardsCredentials(): FyndRewardsCredentials;
2924
+ type FyndRewardsCredentials = {
2925
+ /**
2926
+ * - Public key for integrating with Fynd rewards.
2927
+ */
2928
+ public_key?: string;
2929
+ };
2930
+ /** @returns {GetIntegrationsOptInsResponse} */
2931
+ declare function GetIntegrationsOptInsResponse(): GetIntegrationsOptInsResponse;
2932
+ type GetIntegrationsOptInsResponse = {
2933
+ items?: IntegrationOptIn[];
2934
+ page?: Page;
2935
+ };
2936
+ /** @returns {GoogleMap} */
2937
+ declare function GoogleMap(): GoogleMap;
2938
+ type GoogleMap = {
2939
+ credentials?: GoogleMapCredentials;
2940
+ };
2941
+ /** @returns {GoogleMapCredentials} */
2942
+ declare function GoogleMapCredentials(): GoogleMapCredentials;
2943
+ type GoogleMapCredentials = {
2944
+ /**
2945
+ * - Secret API key for Google Maps. A unique
2946
+ * identifier that authenticates requests made to Google Maps API.
2947
+ */
2948
+ api_key?: string;
2949
+ };
2950
+ /** @returns {GooglePlusLink} */
2951
+ declare function GooglePlusLink(): GooglePlusLink;
2952
+ type GooglePlusLink = {
2953
+ /**
2954
+ * - Hosted URL of social icon image shown on the website
2955
+ */
2956
+ icon?: string;
2957
+ /**
2958
+ * - Web URL of brand's Google+ account
2959
+ */
2960
+ link?: string;
2961
+ /**
2962
+ * - Name of the social media platform, e.g. Google+
2963
+ */
2964
+ title?: string;
2965
+ };
2966
+ /** @returns {Gtm} */
2967
+ declare function Gtm(): Gtm;
2968
+ type Gtm = {
2969
+ credentials?: GtmCredentials;
2970
+ /**
2971
+ * - Shows whether GTM integration is enabled or
2972
+ * disabled for the sales channel
2973
+ */
2974
+ enabled?: boolean;
2975
+ };
2976
+ /** @returns {GtmCredentials} */
2977
+ declare function GtmCredentials(): GtmCredentials;
2978
+ type GtmCredentials = {
2979
+ /**
2980
+ * - Secret credential API key for GTM
2981
+ */
2982
+ api_key?: string;
2983
+ };
2984
+ /** @returns {HomePageFeature} */
2985
+ declare function HomePageFeature(): HomePageFeature;
2986
+ type HomePageFeature = {
2987
+ /**
2988
+ * - Shows whether order processing is
2989
+ * enabled or not enabled
2990
+ */
2991
+ order_processing?: boolean;
2992
+ };
2993
+ /** @returns {InformationAddress} */
2994
+ declare function InformationAddress(): InformationAddress;
2995
+ type InformationAddress = {
2996
+ /**
2997
+ * - Contact address of the sales channel
2998
+ */
2999
+ address_line?: string[];
3000
+ /**
3001
+ * - Name of the city, e.g. Mumbai
3002
+ */
3003
+ city?: string;
3004
+ /**
3005
+ * - Name of the country, e.g. India
3006
+ */
3007
+ country?: string;
3008
+ /**
3009
+ * - Co-ordinates of the location
3010
+ */
3011
+ loc?: string;
3012
+ phone?: InformationPhone[];
3013
+ /**
3014
+ * - 6-digit PIN Code of the city, e.g. 400001
3015
+ */
3016
+ pincode?: number;
3017
+ };
3018
+ /** @returns {InformationPhone} */
3019
+ declare function InformationPhone(): InformationPhone;
3020
+ type InformationPhone = {
3021
+ /**
3022
+ * - Country code for contact number, e.g. +91 (for India)
3023
+ */
3024
+ code?: string;
3025
+ /**
3026
+ * - 10-digit mobile number
3027
+ */
3028
+ number?: string;
3029
+ };
3030
+ /** @returns {InformationSupport} */
3031
+ declare function InformationSupport(): InformationSupport;
3032
+ type InformationSupport = {
3033
+ email?: string[];
3034
+ phone?: string[];
3035
+ /**
3036
+ * - Working hours of support team, e.g. 9 AM to 9 PM
3037
+ */
3038
+ timing?: string;
3039
+ };
3040
+ /** @returns {InstagramLink} */
3041
+ declare function InstagramLink(): InstagramLink;
3042
+ type InstagramLink = {
3043
+ /**
3044
+ * - Hosted URL of social icon image shown on the website
3045
+ */
3046
+ icon?: string;
3047
+ /**
3048
+ * - Web URL of brand's Instagram page
3049
+ */
3050
+ link?: string;
3051
+ /**
3052
+ * - Name of the social media platform, e.g. Instagram
3053
+ */
3054
+ title?: string;
3055
+ };
3056
+ /** @returns {Integration} */
3057
+ declare function Integration(): Integration;
3058
+ type Integration = {
3059
+ /**
3060
+ * - Version key for tracking revisions. Default value is zero.
3061
+ */
3062
+ __v?: number;
3063
+ /**
3064
+ * - The unique identifier (24-digit Mongo Object ID)
3065
+ * of the integration
3066
+ */
3067
+ _id?: string;
3068
+ companies?: any[];
3069
+ constants?: any;
3070
+ /**
3071
+ * - ISO 8601 timestamp of integration creation
3072
+ */
3073
+ created_at?: string;
3074
+ /**
3075
+ * - Basic description about the integration
3076
+ */
3077
+ description?: string;
3078
+ /**
3079
+ * - Basic HTML description about the integration
3080
+ */
3081
+ description_html?: string;
3082
+ /**
3083
+ * - Hosted URL of the icon image
3084
+ */
3085
+ icon?: string;
3086
+ meta?: IntegrationMeta[];
3087
+ /**
3088
+ * - Name of the integration, e.g. SAP RBL Integration
3089
+ */
3090
+ name?: string;
3091
+ /**
3092
+ * - The unique identifier (24-digit Mongo Object ID)
3093
+ * of the user who created the integration
3094
+ */
3095
+ owner?: string;
3096
+ /**
3097
+ * - Randomly generated fixed-length string for
3098
+ * opted integration. It is auto-generated. It would never change once it is generated.
3099
+ */
3100
+ secret?: string;
3101
+ support?: string[];
3102
+ /**
3103
+ * - Randomly generated fixed-length string for opted
3104
+ * integration. It is auto-generated. It would never change once it is generated.
3105
+ */
3106
+ token?: string;
3107
+ /**
3108
+ * - ISO 8601 timestamp of integration updation
3109
+ */
3110
+ updated_at?: string;
3111
+ validators?: Validators;
3112
+ };
3113
+ /** @returns {IntegrationConfigResponse} */
3114
+ declare function IntegrationConfigResponse(): IntegrationConfigResponse;
3115
+ type IntegrationConfigResponse = {
3116
+ items?: IntegrationLevel[];
3117
+ };
3118
+ /** @returns {IntegrationLevel} */
3119
+ declare function IntegrationLevel(): IntegrationLevel;
3120
+ type IntegrationLevel = {
3121
+ /**
3122
+ * - Version key for tracking revisions. Default value is zero.
3123
+ */
3124
+ __v?: number;
3125
+ /**
3126
+ * - The unique identifier (24-digit Mongo Object ID)
3127
+ * of the integration config
3128
+ */
3129
+ _id?: string;
3130
+ /**
3131
+ * - ISO 8601 timestamp of integration config creation
3132
+ */
3133
+ created_at?: string;
3134
+ /**
3135
+ * - Schema data of the integration stored in key-value pairs
3136
+ */
3137
+ data?: any;
3138
+ /**
3139
+ * - Integration id. Shows which integration
3140
+ * you are enabling.
3141
+ */
3142
+ integration?: string;
3143
+ last_patch?: LastPatch[];
3144
+ /**
3145
+ * - Shows for what level the integration is set up.
3146
+ * It can be company level or store level.
3147
+ */
3148
+ level?: string;
3149
+ meta?: IntegrationMeta[];
3150
+ /**
3151
+ * - Shows this integration is opted or not opted
3152
+ * for the current company
3153
+ */
3154
+ opted?: boolean;
3155
+ permissions?: any[];
3156
+ /**
3157
+ * - Randomly generated fixed-length string for opted
3158
+ * integration. It is auto-generated. It would never change once it is generated.
3159
+ */
3160
+ token?: string;
3161
+ /**
3162
+ * - It can be store uid or company uid. Depends on the
3163
+ * level of integration.
3164
+ */
3165
+ uid?: number;
3166
+ /**
3167
+ * - ISO 8601 timestamp of integration config updation
3168
+ */
3169
+ updated_at?: string;
3170
+ };
3171
+ /** @returns {IntegrationMeta} */
3172
+ declare function IntegrationMeta(): IntegrationMeta;
3173
+ type IntegrationMeta = {
3174
+ /**
3175
+ * - The unique identifier (24-digit Mongo Object ID)
3176
+ * of the integration meta
3177
+ */
3178
+ _id?: string;
3179
+ is_public?: boolean;
3180
+ /**
3181
+ * - Nmae of integration meta, e.g. price_level
3182
+ */
3183
+ name?: string;
3184
+ /**
3185
+ * - Value related to integration meta name, e.g. store
3186
+ */
3187
+ value?: string;
3188
+ };
3189
+ /** @returns {IntegrationOptIn} */
3190
+ declare function IntegrationOptIn(): IntegrationOptIn;
3191
+ type IntegrationOptIn = {
3192
+ /**
3193
+ * - Version key for tracking revisions. Default value is zero.
3194
+ */
3195
+ __v?: number;
3196
+ /**
3197
+ * - The unique identifier (24-digit Mongo Object ID)
3198
+ * of the opted integration
3199
+ */
3200
+ _id?: string;
3201
+ companies?: any[];
3202
+ constants?: string;
3203
+ /**
3204
+ * - ISO 8601 timestamp of integration creation
3205
+ */
3206
+ created_at?: string;
3207
+ /**
3208
+ * - Basic description about the opted integration
3209
+ */
3210
+ description?: string;
3211
+ /**
3212
+ * - Basic HTML description about the
3213
+ * opted integration
3214
+ */
3215
+ description_html?: string;
3216
+ /**
3217
+ * - Hosted URL of the icon image
3218
+ */
3219
+ icon?: string;
3220
+ meta?: IntegrationMeta[];
3221
+ /**
3222
+ * - Nmae of the opted integration, e.g. SAP RBL Integration
3223
+ */
3224
+ name?: string;
3225
+ /**
3226
+ * - The unique identifier (24-digit Mongo Object ID)
3227
+ * of the user who created the integration
3228
+ */
3229
+ owner?: string;
3230
+ /**
3231
+ * - Randomly generated fixed-length string for
3232
+ * opted integration. It is auto-generated. It would never change once it is generated.
3233
+ */
3234
+ secret?: string;
3235
+ support?: string[];
3236
+ /**
3237
+ * - Randomly generated fixed-length string for opted
3238
+ * integration. It is auto-generated. It would never change once it is generated.
3239
+ */
3240
+ token?: string;
3241
+ /**
3242
+ * - ISO 8601 timestamp of integration updation
3243
+ */
3244
+ updated_at?: string;
3245
+ validators?: Validators;
3246
+ };
3247
+ /** @returns {InvalidPayloadRequest} */
3248
+ declare function InvalidPayloadRequest(): InvalidPayloadRequest;
3249
+ type InvalidPayloadRequest = {
3250
+ /**
3251
+ * - Error message when request body payload is improper
3252
+ */
3253
+ message?: string;
3254
+ };
3255
+ /** @returns {InventoryArticleAssignment} */
3256
+ declare function InventoryArticleAssignment(): InventoryArticleAssignment;
3257
+ type InventoryArticleAssignment = {
3258
+ /**
3259
+ * - Allow post order reassigment of article
3260
+ */
3261
+ post_order_reassignment?: boolean;
3262
+ rules?: ArticleAssignmentRule;
3263
+ };
3264
+ /** @returns {InventoryBrand} */
3265
+ declare function InventoryBrand(): InventoryBrand;
3266
+ type InventoryBrand = {
3267
+ /**
3268
+ * - List of brands
3269
+ */
3270
+ brands?: any[];
3271
+ /**
3272
+ * - All brands or specific (explicit) brands to
3273
+ * be shown on the website
3274
+ */
3275
+ criteria?: string;
3276
+ };
3277
+ /** @returns {InventoryBrandRule} */
3278
+ declare function InventoryBrandRule(): InventoryBrandRule;
3279
+ type InventoryBrandRule = {
3280
+ brands?: number[];
3281
+ /**
3282
+ * - Whether all brands are enabled, or explicitly
3283
+ * few brands in the inventory
3284
+ */
3285
+ criteria?: string;
3286
+ };
3287
+ /** @returns {InventoryCategory} */
3288
+ declare function InventoryCategory(): InventoryCategory;
3289
+ type InventoryCategory = {
3290
+ /**
3291
+ * - List of categories whose products will be
3292
+ * shown on the website
3293
+ */
3294
+ categories?: any[];
3295
+ criteria?: string;
3296
+ };
3297
+ /** @returns {InventoryDiscount} */
3298
+ declare function InventoryDiscount(): InventoryDiscount;
3299
+ type InventoryDiscount = {
3300
+ /**
3301
+ * - Maximum inventory discount
3302
+ */
3303
+ max?: number;
3304
+ /**
3305
+ * - Minimum inventory discount
3306
+ */
3307
+ min?: number;
3308
+ };
3309
+ /** @returns {InventoryPaymentConfig} */
3310
+ declare function InventoryPaymentConfig(): InventoryPaymentConfig;
3311
+ type InventoryPaymentConfig = {
3312
+ /**
3313
+ * - Mode of payment for the inventory of
3314
+ * sales channel. It is required and default value is null.
3315
+ */
3316
+ mode_of_payment?: string;
3317
+ /**
3318
+ * - Source of the payment mode for the inventory
3319
+ * payment of sales channel. Default value is FYND.
3320
+ */
3321
+ source?: string;
3322
+ };
3323
+ /** @returns {InventoryPrice} */
3324
+ declare function InventoryPrice(): InventoryPrice;
3325
+ type InventoryPrice = {
3326
+ /**
3327
+ * - Maximum inventory price
3328
+ */
3329
+ max?: number;
3330
+ /**
3331
+ * - Minimum inventory price
3332
+ */
3333
+ min?: number;
3334
+ };
3335
+ /** @returns {InventoryStore} */
3336
+ declare function InventoryStore(): InventoryStore;
3337
+ type InventoryStore = {
3338
+ /**
3339
+ * - All stores or specific (explicit) stores to
3340
+ * be shown on the website
3341
+ */
3342
+ criteria?: string;
3343
+ rules?: AppStoreRules;
3344
+ /**
3345
+ * - List of stores
3346
+ */
3347
+ stores?: any[];
3348
+ };
3349
+ /** @returns {InventoryStoreRule} */
3350
+ declare function InventoryStoreRule(): InventoryStoreRule;
3351
+ type InventoryStoreRule = {
3352
+ /**
3353
+ * - Whether all stores are enabled, or explicitly
3354
+ * few stores in the inventory, or use brands and company filter.
3355
+ */
3356
+ criteria?: string;
3357
+ /**
3358
+ * - List of rules with company and
3359
+ * brands uids. Used when critera is `filter`.
3360
+ */
3361
+ rules?: StoreCriteriaRule[];
3362
+ /**
3363
+ * - List of store uids. Used when critera is `explicit`.
3364
+ */
3365
+ stores?: number[];
3366
+ };
3367
+ /** @returns {InventoryValidator} */
3368
+ declare function InventoryValidator(): InventoryValidator;
3369
+ type InventoryValidator = {
3370
+ /**
3371
+ * - Browser script for the inventory validator
3372
+ */
3373
+ browser_script?: string;
3374
+ json_schema?: JsonSchema[];
3375
+ };
3376
+ /** @returns {Ios} */
3377
+ declare function Ios(): Ios;
3378
+ type Ios = {
3379
+ /**
3380
+ * - Firebase secret credential API key for IOS
3381
+ */
3382
+ api_key?: string;
3383
+ /**
3384
+ * - Alphanumeric ID allotted to a sales
3385
+ * channel application created within a business account
3386
+ */
3387
+ application_id?: string;
3388
+ };
3389
+ /** @returns {JsonSchema} */
3390
+ declare function JsonSchema(): JsonSchema;
3391
+ type JsonSchema = {
3392
+ /**
3393
+ * - Display text of the validator JSON schema. It
3394
+ * will show in the UI.
3395
+ */
3396
+ display?: string;
3397
+ /**
3398
+ * - Key related to the display text of the validator JSON schema
3399
+ */
3400
+ key?: string;
3401
+ /**
3402
+ * - Tooltip text for the UI of the validator JSON
3403
+ * schema. It will show in the UI.
3404
+ */
3405
+ tooltip?: string;
3406
+ /**
3407
+ * - Indicates the type of form field, e.g. Text, Dropdown.
3408
+ */
3409
+ type?: string;
3410
+ };
3411
+ /** @returns {LandingImage} */
3412
+ declare function LandingImage(): LandingImage;
3413
+ type LandingImage = {
3414
+ /**
3415
+ * - Width-to-height ratio of landing image
3416
+ */
3417
+ aspect_ratio?: string;
3418
+ /**
3419
+ * - URL where the landing image is hosted
3420
+ */
3421
+ secure_url?: string;
3422
+ };
3423
+ /** @returns {LandingPageFeature} */
3424
+ declare function LandingPageFeature(): LandingPageFeature;
3425
+ type LandingPageFeature = {
3426
+ /**
3427
+ * - Shows whether a guest can checkout
3428
+ * from cart without logging in
3429
+ */
3430
+ continue_as_guest?: boolean;
3431
+ launch_page?: LaunchPage;
3432
+ /**
3433
+ * - Shows the text displayed over the login button
3434
+ */
3435
+ login_btn_text?: string;
3436
+ /**
3437
+ * - Shows whether a textbox for
3438
+ * entering domain is available
3439
+ */
3440
+ show_domain_textbox?: boolean;
3441
+ /**
3442
+ * - Shows whether register button is
3443
+ * available in the login/landing page
3444
+ */
3445
+ show_register_btn?: boolean;
3446
+ };
3447
+ /** @returns {LastPatch} */
3448
+ declare function LastPatch(): LastPatch;
3449
+ type LastPatch = {
3450
+ op?: string;
3451
+ path?: string;
3452
+ /**
3453
+ * - It can be inventory level or order level
3454
+ */
3455
+ value?: string;
3456
+ };
3457
+ /** @returns {LaunchPage} */
3458
+ declare function LaunchPage(): LaunchPage;
3459
+ type LaunchPage = {
3460
+ /**
3461
+ * - Type of the launch page
3462
+ */
3463
+ page_type?: string;
3464
+ /**
3465
+ * - Launch page params. It can be nullable.
3466
+ */
3467
+ params?: any;
3468
+ /**
3469
+ * - Query related to launch page. It can be nullable.
3470
+ */
3471
+ query?: any;
3472
+ };
3473
+ /** @returns {LinkedInLink} */
3474
+ declare function LinkedInLink(): LinkedInLink;
3475
+ type LinkedInLink = {
3476
+ /**
3477
+ * - Hosted URL of social icon image shown on the website
3478
+ */
3479
+ icon?: string;
3480
+ /**
3481
+ * - Web URL of brand's LinkedIn channel
3482
+ */
3483
+ link?: string;
3484
+ /**
3485
+ * - Name of the social media platform, e.g. LinkedIn
3486
+ */
3487
+ title?: string;
3488
+ };
3489
+ /** @returns {Links} */
3490
+ declare function Links(): Links;
3491
+ type Links = {
3492
+ /**
3493
+ * - Web URL for redirecting to a related page
3494
+ */
3495
+ link?: string;
3496
+ /**
3497
+ * - Name of the related page or link
3498
+ */
3499
+ title?: string;
3500
+ };
3501
+ /** @returns {ListingPriceFeature} */
3502
+ declare function ListingPriceFeature(): ListingPriceFeature;
3503
+ type ListingPriceFeature = {
3504
+ /**
3505
+ * - Sorting of listing price with min or max value.
3506
+ * Default value is min.
3507
+ */
3508
+ sort?: string;
3509
+ /**
3510
+ * - Shows which price to display on PLP if one
3511
+ * product has multiple prices (for each size), valid values are 'min', 'max',
3512
+ * 'range'. Default value is range.
3513
+ */
3514
+ value?: string;
3515
+ };
3516
+ /** @returns {LoyaltyPointsConfig} */
3517
+ declare function LoyaltyPointsConfig(): LoyaltyPointsConfig;
3518
+ type LoyaltyPointsConfig = {
3519
+ /**
3520
+ * - Allow auto apply of loyalty points
3521
+ */
3522
+ auto_apply?: boolean;
3523
+ /**
3524
+ * - Shows loyalty points is enabled or not enabled
3525
+ */
3526
+ enabled?: boolean;
3527
+ };
3528
+ /** @returns {Methods} */
3529
+ declare function Methods(): Methods;
3530
+ type Methods = {
3531
+ card?: PaymentModeConfig;
3532
+ cod?: PaymentModeConfig;
3533
+ fc?: PaymentModeConfig;
3534
+ jiopp?: PaymentModeConfig;
3535
+ jp?: PaymentModeConfig;
3536
+ juspaypg?: PaymentModeConfig;
3537
+ nb?: PaymentModeConfig;
3538
+ pac?: PaymentModeConfig;
3539
+ payubizpg?: PaymentModeConfig;
3540
+ payumoneypg?: PaymentModeConfig;
3541
+ pl?: PaymentModeConfig;
3542
+ pp?: PaymentModeConfig;
3543
+ ps?: PaymentModeConfig;
3544
+ qr?: PaymentModeConfig;
3545
+ rupifipg?: PaymentModeConfig;
3546
+ simpl?: PaymentModeConfig;
3547
+ stripepg?: PaymentModeConfig;
3548
+ upi?: PaymentModeConfig;
3549
+ wl?: PaymentModeConfig;
3550
+ };
3551
+ /** @returns {MobileAppConfigRequest} */
3552
+ declare function MobileAppConfigRequest(): MobileAppConfigRequest;
3553
+ type MobileAppConfigRequest = {
3554
+ /**
3555
+ * - Name of the mobile app
3556
+ */
3557
+ app_name?: string;
3558
+ /**
3559
+ * - Shows update in mobile app config is active or not
3560
+ */
3561
+ is_active?: boolean;
3562
+ landing_image?: LandingImage;
3563
+ splash_image?: SplashImage;
3564
+ };
3565
+ /** @returns {MobileAppConfiguration} */
3566
+ declare function MobileAppConfiguration(): MobileAppConfiguration;
3567
+ type MobileAppConfiguration = {
3568
+ /**
3569
+ * - Version key for tracking revisions. Default value is zero.
3570
+ */
3571
+ __v?: number;
3572
+ /**
3573
+ * - The unique identifier (24-digit Mongo Object ID)
3574
+ * for mobile application configuration
3575
+ */
3576
+ _id?: string;
3577
+ /**
3578
+ * - Name of the mobile app
3579
+ */
3580
+ app_name?: string;
3581
+ /**
3582
+ * - Application ID of the current sales channel
3583
+ */
3584
+ application?: string;
3585
+ /**
3586
+ * - ISO 8601 timestamp of application
3587
+ * configuration creation
3588
+ */
3589
+ created_at?: string;
3590
+ /**
3591
+ * - Indicates the availability of the mobile build
3592
+ */
3593
+ is_active?: boolean;
3594
+ landing_image?: LandingImage;
3595
+ /**
3596
+ * - Shows bundle identifier if device
3597
+ * platform is iOS, and directory of the app if device platform is Android
3598
+ */
3599
+ package_name?: string;
3600
+ /**
3601
+ * - Device platform for which the mobile app
3602
+ * was built, e.g. android, ios.
3603
+ */
3604
+ platform_type?: string;
3605
+ splash_image?: SplashImage;
3606
+ /**
3607
+ * - ISO 8601 timestamp of last known
3608
+ * modifications to the app build
3609
+ */
3610
+ updated_at?: string;
3611
+ };
3612
+ /** @returns {Moengage} */
3613
+ declare function Moengage(): Moengage;
3614
+ type Moengage = {
3615
+ credentials?: MoengageCredentials;
3616
+ /**
3617
+ * - Shows whether MoEngage integation is enabled
3618
+ * or disabled for the sales channel
3619
+ */
3620
+ enabled?: boolean;
3621
+ };
3622
+ /** @returns {MoengageCredentials} */
3623
+ declare function MoengageCredentials(): MoengageCredentials;
3624
+ type MoengageCredentials = {
3625
+ /**
3626
+ * - APP ID provided by MoEngage to identify a
3627
+ * specific app. The app_id for your MoEngage account is available on the
3628
+ * MoEngage Dashboard.
3629
+ */
3630
+ app_id?: string;
3631
+ };
3632
+ /** @returns {NotFound} */
3633
+ declare function NotFound(): NotFound;
3634
+ type NotFound = {
3635
+ /**
3636
+ * - Response message for not found
3637
+ */
3638
+ message?: string;
3639
+ };
3640
+ /** @returns {OptedApplicationResponse} */
3641
+ declare function OptedApplicationResponse(): OptedApplicationResponse;
3642
+ type OptedApplicationResponse = {
3643
+ /**
3644
+ * - The unique identifier (24-digit Mongo Object ID)
3645
+ * of the other seller's sales channel
3646
+ */
3647
+ _id?: string;
3648
+ company?: OptedCompany;
3649
+ /**
3650
+ * - Basic details about the other seller's sales channel
3651
+ */
3652
+ description?: string;
3653
+ /**
3654
+ * - Domain URL of the other seller's sales channel
3655
+ */
3656
+ domain?: string;
3657
+ /**
3658
+ * - Name of the other seller's sales channel
3659
+ */
3660
+ name?: string;
3661
+ opt_out_inventory?: OptOutInventory;
3662
+ opted_inventory?: OptedInventory;
3663
+ };
3664
+ /** @returns {OptedCompany} */
3665
+ declare function OptedCompany(): OptedCompany;
3666
+ type OptedCompany = {
3667
+ /**
3668
+ * - Name of the company opted by the other seller's
3669
+ * sales channel in its inventory
3670
+ */
3671
+ name?: string;
3672
+ /**
3673
+ * - Company UID opted by the other seller's sales
3674
+ * channel in its inventory. It has unique value for the company.
3675
+ */
3676
+ uid?: number;
3677
+ };
3678
+ /** @returns {OptedInventory} */
3679
+ declare function OptedInventory(): OptedInventory;
3680
+ type OptedInventory = {
3681
+ items?: any;
3682
+ opt_type?: OptType;
3683
+ };
3684
+ /** @returns {OptedStore} */
3685
+ declare function OptedStore(): OptedStore;
3686
+ type OptedStore = {
3687
+ /**
3688
+ * - The unique identifier of the opted inventory store
3689
+ */
3690
+ _id?: string;
3691
+ address?: OptedStoreAddress;
3692
+ /**
3693
+ * - Company ID of the opted inventory store
3694
+ */
3695
+ company_id?: number;
3696
+ /**
3697
+ * - Display name of the opted inventory store
3698
+ */
3699
+ display_name?: string;
3700
+ /**
3701
+ * - ISO 8601 timestamp of opted inventory store creation
3702
+ */
3703
+ modified_on?: string;
3704
+ /**
3705
+ * - Name of the inventory store opted by other
3706
+ * seller's application
3707
+ */
3708
+ name?: string;
3709
+ /**
3710
+ * - Store code of the opted inventory store. It
3711
+ * is unique for every store.
3712
+ */
3713
+ store_code?: string;
3714
+ /**
3715
+ * - Store type of the opted inventory store
3716
+ * like warehouse, high_street, mall.
3717
+ */
3718
+ store_type?: string;
3719
+ /**
3720
+ * - UID of opted inventory store
3721
+ */
3722
+ uid?: number;
3723
+ };
3724
+ /** @returns {OptedStoreAddress} */
3725
+ declare function OptedStoreAddress(): OptedStoreAddress;
3726
+ type OptedStoreAddress = {
3727
+ /**
3728
+ * - Address of the opted store
3729
+ */
3730
+ address1?: string;
3731
+ /**
3732
+ * - Address of the opted store
3733
+ */
3734
+ address2?: string;
3735
+ /**
3736
+ * - City of the opted store, e.g. Mumbai
3737
+ */
3738
+ city?: string;
3739
+ /**
3740
+ * - Country of the opted store, e.g. India
3741
+ */
3742
+ country?: string;
3743
+ lat_long?: StoreLatLong;
3744
+ /**
3745
+ * - 6-digit PIN code of the opted store location
3746
+ */
3747
+ pincode?: number;
3748
+ /**
3749
+ * - State of the opted store, e.g. Maharashtra
3750
+ */
3751
+ state?: string;
3752
+ };
3753
+ /** @returns {OptedStoreIntegration} */
3754
+ declare function OptedStoreIntegration(): OptedStoreIntegration;
3755
+ type OptedStoreIntegration = {
3756
+ other_entity?: OtherEntity;
3757
+ other_integration?: IntegrationOptIn;
3758
+ /**
3759
+ * - Allow user to opt same store in other integration
3760
+ */
3761
+ other_opted?: boolean;
3762
+ };
3763
+ /** @returns {OptOutInventory} */
3764
+ declare function OptOutInventory(): OptOutInventory;
3765
+ type OptOutInventory = {
3766
+ /**
3767
+ * - List of companies opted out from the inventory
3768
+ * of other seller's application
3769
+ */
3770
+ company: number[];
3771
+ /**
3772
+ * - List of selling locations (stores) opted out
3773
+ * from the inventory of other seller's application
3774
+ */
3775
+ store: number[];
3776
+ };
3777
+ /** @returns {OptType} */
3778
+ declare function OptType(): OptType;
3779
+ type OptType = {
3780
+ /**
3781
+ * - Display text of opted type for inventory store
3782
+ */
3783
+ display?: string;
3784
+ /**
3785
+ * - Opted type of inventory store. It can be store or company.
3786
+ */
3787
+ key?: string;
3788
+ };
3789
+ /** @returns {OrderFeature} */
3790
+ declare function OrderFeature(): OrderFeature;
3791
+ type OrderFeature = {
3792
+ /**
3793
+ * - Allow buy again option for order. Default
3794
+ * value is false.
3795
+ */
3796
+ buy_again?: boolean;
3797
+ };
3798
+ /** @returns {OrderingStore} */
3799
+ declare function OrderingStore(): OrderingStore;
3800
+ type OrderingStore = {
3801
+ /**
3802
+ * - The unique identifier (24-digit Mongo Object ID)
3803
+ * of the ordering store
3804
+ */
3805
+ _id?: string;
3806
+ address?: OptedStoreAddress;
3807
+ /**
3808
+ * - Code of the ordering store (usually same as Store Code)
3809
+ */
3810
+ code?: string;
3811
+ /**
3812
+ * - Display name of the ordering store
3813
+ */
3814
+ display_name?: string;
3815
+ /**
3816
+ * - Store name of the ordering store
3817
+ */
3818
+ name?: string;
3819
+ /**
3820
+ * - 6-digit PIN Code of the ordering store, e.g. 400001
3821
+ */
3822
+ pincode?: number;
3823
+ /**
3824
+ * - Store code of the ordering store, e.g. MUM-102
3825
+ */
3826
+ store_code?: string;
3827
+ /**
3828
+ * - Store type of the ordering store, e.g.
3829
+ * high_street, mall, warehouse
3830
+ */
3831
+ store_type?: string;
3832
+ /**
3833
+ * - Ordering store UID
3834
+ */
3835
+ uid?: number;
3836
+ };
3837
+ /** @returns {OrderingStoreConfig} */
3838
+ declare function OrderingStoreConfig(): OrderingStoreConfig;
3839
+ type OrderingStoreConfig = {
3840
+ deployment_meta?: DeploymentMeta;
3841
+ };
3842
+ /** @returns {OrderingStores} */
3843
+ declare function OrderingStores(): OrderingStores;
3844
+ type OrderingStores = {
3845
+ /**
3846
+ * - Version key for tracking ordering stores. Default
3847
+ * value is zero.
3848
+ */
3849
+ __v?: number;
3850
+ /**
3851
+ * - The unique identifier (24-digit Mongo Object ID)
3852
+ * of the ordering store
3853
+ */
3854
+ _id?: string;
3855
+ /**
3856
+ * - Allow all stores of the ordering stores
3857
+ */
3858
+ all_stores?: boolean;
3859
+ /**
3860
+ * - Alphanumeric ID allotted to an application (sales
3861
+ * channel website) created within a business account
3862
+ */
3863
+ app?: string;
3864
+ deployed_stores?: number[];
3865
+ /**
3866
+ * - Allow ordering stores for current sales channel
3867
+ */
3868
+ enabled?: boolean;
3869
+ items?: OrderingStore[];
3870
+ page?: Page;
3871
+ /**
3872
+ * - For hard type delivery, store selection is
3873
+ * compulsory. For soft type, delivery store selection is optional.
3874
+ */
3875
+ type?: string;
3876
+ };
3877
+ /** @returns {OrderingStoresResponse} */
3878
+ declare function OrderingStoresResponse(): OrderingStoresResponse;
3879
+ type OrderingStoresResponse = {
3880
+ items?: OrderingStore[];
3881
+ page?: Page;
3882
+ };
3883
+ /** @returns {OrderValidator} */
3884
+ declare function OrderValidator(): OrderValidator;
3885
+ type OrderValidator = {
3886
+ /**
3887
+ * - Browser script for the order validator
3888
+ */
3889
+ browser_script?: string;
3890
+ json_schema?: JsonSchema[];
3891
+ };
3892
+ /** @returns {OtherEntity} */
3893
+ declare function OtherEntity(): OtherEntity;
3894
+ type OtherEntity = {
3895
+ /**
3896
+ * - Version key for tracking revisions. Default value is zero.
3897
+ */
3898
+ __v?: number;
3899
+ /**
3900
+ * - The unique identifier of the other entity for
3901
+ * opted store integration
3902
+ */
3903
+ _id?: string;
3904
+ /**
3905
+ * - ISO 8601 timestamp of other entity creation
3906
+ * for opted store integration
3907
+ */
3908
+ created_at?: string;
3909
+ data?: OtherEntityData;
3910
+ /**
3911
+ * - Integration ID. Shows which integration
3912
+ * you are enabling.
3913
+ */
3914
+ integration?: string;
3915
+ last_patch?: LastPatch[];
3916
+ /**
3917
+ * - Indicates integration level. It can be company
3918
+ * level or store level.
3919
+ */
3920
+ level?: string;
3921
+ meta?: any[];
3922
+ /**
3923
+ * - Allow other entity opted in integration
3924
+ */
3925
+ opted?: boolean;
3926
+ permissions?: string[];
3927
+ /**
3928
+ * - Randomly generated fixed-length string for opted
3929
+ * integration. It is auto-generated. It would never change once it is generated.
3930
+ */
3931
+ token?: string;
3932
+ /**
3933
+ * - It can be store uid or company uid. Depends on the
3934
+ * level of integration.
3935
+ */
3936
+ uid?: number;
3937
+ /**
3938
+ * - ISO 8601 timestamp of other entity updation
3939
+ * for opted store integration
3940
+ */
3941
+ updated_at?: string;
3942
+ };
3943
+ /** @returns {OtherEntityData} */
3944
+ declare function OtherEntityData(): OtherEntityData;
3945
+ type OtherEntityData = {
3946
+ article_identifier?: string;
3947
+ };
3948
+ /** @returns {OtherSellerApplication} */
3949
+ declare function OtherSellerApplication(): OtherSellerApplication;
3950
+ type OtherSellerApplication = {
3951
+ /**
3952
+ * - The unique identifier (24-digit Mongo Object ID)
3953
+ * of the other seller's sales channel
3954
+ */
3955
+ _id?: string;
3956
+ company?: OtherSellerCompany;
3957
+ /**
3958
+ * - Basic details about the other seller's sales channel
3959
+ */
3960
+ description?: string;
3961
+ /**
3962
+ * - Domain URL of the other seller's sales channel
3963
+ */
3964
+ domain?: string;
3965
+ /**
3966
+ * - Name of the other seller's sales channel
3967
+ */
3968
+ name?: string;
3969
+ /**
3970
+ * - Inventory opted by the other seller's sales
3971
+ * channel. It can be the current company or stores in the current company.
3972
+ */
3973
+ opt_type?: string;
3974
+ };
3975
+ /** @returns {OtherSellerApplications} */
3976
+ declare function OtherSellerApplications(): OtherSellerApplications;
3977
+ type OtherSellerApplications = {
3978
+ items?: OtherSellerApplication[];
3979
+ page?: Page;
3980
+ };
3981
+ /** @returns {OtherSellerCompany} */
3982
+ declare function OtherSellerCompany(): OtherSellerCompany;
3983
+ type OtherSellerCompany = {
3984
+ /**
3985
+ * - Name of the seller company
3986
+ */
3987
+ name?: string;
3988
+ /**
3989
+ * - Uid of the seller company
3990
+ */
3991
+ uid?: number;
3992
+ };
3993
+ /** @returns {Page} */
3994
+ declare function Page(): Page;
3995
+ type Page = {
3996
+ current?: number;
3997
+ has_next?: boolean;
3998
+ has_previous?: boolean;
3999
+ item_total?: number;
4000
+ next_id?: string;
4001
+ size?: number;
4002
+ type: string;
4003
+ };
4004
+ /** @returns {PanCardConfig} */
4005
+ declare function PanCardConfig(): PanCardConfig;
4006
+ type PanCardConfig = {
4007
+ /**
4008
+ * - On which COD order amount pan
4009
+ * card number is expected from customer for order
4010
+ */
4011
+ cod_threshold_amount?: number;
4012
+ /**
4013
+ * - If pan card accepting is enabled on cart
4014
+ */
4015
+ enabled?: boolean;
4016
+ /**
4017
+ * - On which online payment order
4018
+ * amount pan card number is expected from customer for order
4019
+ */
4020
+ online_threshold_amount?: number;
4021
+ };
4022
+ /** @returns {PaymentModeConfig} */
4023
+ declare function PaymentModeConfig(): PaymentModeConfig;
4024
+ type PaymentModeConfig = {
4025
+ /**
4026
+ * - Shows if a given payment method is enabled or
4027
+ * not, e.g. if 'nb' is enabled, customer can use NetBanking for payment.
4028
+ */
4029
+ enabled?: boolean;
4030
+ };
4031
+ /** @returns {PaymentSelectionLock} */
4032
+ declare function PaymentSelectionLock(): PaymentSelectionLock;
4033
+ type PaymentSelectionLock = {
4034
+ /**
4035
+ * - Shows default payment method, e.g. COD
4036
+ */
4037
+ default_options?: string;
4038
+ /**
4039
+ * - Shows whether payment mode is restricted to a
4040
+ * specific option, e.g. 'HDFC Netbanking'
4041
+ */
4042
+ enabled?: boolean;
4043
+ /**
4044
+ * - Payment method chosen from default
4045
+ * options, e.g. COD
4046
+ */
4047
+ payment_identifier?: string;
4048
+ };
4049
+ /** @returns {PcrFeature} */
4050
+ declare function PcrFeature(): PcrFeature;
4051
+ type PcrFeature = {
4052
+ /**
4053
+ * - Allow staff selection. Default value is false.
4054
+ */
4055
+ staff_selection?: boolean;
4056
+ };
4057
+ /** @returns {PinterestLink} */
4058
+ declare function PinterestLink(): PinterestLink;
4059
+ type PinterestLink = {
4060
+ /**
4061
+ * - Hosted URL of social icon image shown on the website
4062
+ */
4063
+ icon?: string;
4064
+ /**
4065
+ * - Web URL of brand's Pinterest page
4066
+ */
4067
+ link?: string;
4068
+ /**
4069
+ * - Name of the social media platform, e.g. Pinterest
4070
+ */
4071
+ title?: string;
4072
+ };
4073
+ /** @returns {ProductDetailFeature} */
4074
+ declare function ProductDetailFeature(): ProductDetailFeature;
4075
+ type ProductDetailFeature = {
4076
+ /**
4077
+ * - Indicates whether customers can
4078
+ * request for a product. Default value is false.
4079
+ */
4080
+ request_product?: boolean;
4081
+ /**
4082
+ * - Shows whether the customers can
4083
+ * choose the seller on PDP
4084
+ */
4085
+ seller_selection?: boolean;
4086
+ /**
4087
+ * - Configuration to show similar products,
4088
+ * other products from same seller, other products in same category, other
4089
+ * products in same price range, etc.
4090
+ */
4091
+ similar?: string[];
4092
+ /**
4093
+ * - Allow user to update product
4094
+ * meta. Default value is true.
4095
+ */
4096
+ update_product_meta?: boolean;
4097
+ };
4098
+ /** @returns {QrFeature} */
4099
+ declare function QrFeature(): QrFeature;
4100
+ type QrFeature = {
4101
+ /**
4102
+ * - Shows whether sharing of mobile app via
4103
+ * QR code is allowed. Default value is false.
4104
+ */
4105
+ application?: boolean;
4106
+ /**
4107
+ * - Shows whether sharing collection via QR
4108
+ * code is allowed. Default value is false.
4109
+ */
4110
+ collections?: boolean;
4111
+ /**
4112
+ * - Shows whether sharing product via QR code is
4113
+ * allowed. Default value is false.
4114
+ */
4115
+ products?: boolean;
4116
+ };
4117
+ /** @returns {RegistrationPageFeature} */
4118
+ declare function RegistrationPageFeature(): RegistrationPageFeature;
4119
+ type RegistrationPageFeature = {
4120
+ /**
4121
+ * - Shows whether a form to collect the
4122
+ * address of the store, should be displayed upon visiting the website
4123
+ */
4124
+ ask_store_address?: boolean;
4125
+ };
4126
+ /** @returns {RevenueEngineFeature} */
4127
+ declare function RevenueEngineFeature(): RevenueEngineFeature;
4128
+ type RevenueEngineFeature = {
4129
+ /**
4130
+ * - Enable revenue engine. Default value is false.
4131
+ */
4132
+ enabled?: boolean;
4133
+ };
4134
+ /** @returns {RewardPointsConfig} */
4135
+ declare function RewardPointsConfig(): RewardPointsConfig;
4136
+ type RewardPointsConfig = {
4137
+ credit?: Credit;
4138
+ debit?: Debit;
4139
+ };
4140
+ /** @returns {Safetynet} */
4141
+ declare function Safetynet(): Safetynet;
4142
+ type Safetynet = {
4143
+ credentials?: SafetynetCredentials;
4144
+ /**
4145
+ * - Shows whether Safetynet integration is
4146
+ * enabled or disabled for the sales channel
4147
+ */
4148
+ enabled?: boolean;
4149
+ };
4150
+ /** @returns {SafetynetCredentials} */
4151
+ declare function SafetynetCredentials(): SafetynetCredentials;
4152
+ type SafetynetCredentials = {
4153
+ /**
4154
+ * - Secret credential API key for Safetynet. This
4155
+ * API key is used for calling the methods of Safetynet APIs.
4156
+ */
4157
+ api_key?: string;
4158
+ };
4159
+ /** @returns {SecureUrl} */
4160
+ declare function SecureUrl(): SecureUrl;
4161
+ type SecureUrl = {
4162
+ /**
4163
+ * - Hosted URL of the image
4164
+ */
4165
+ secure_url?: string;
4166
+ };
4167
+ /** @returns {Segment} */
4168
+ declare function Segment(): Segment;
4169
+ type Segment = {
4170
+ credentials?: SegmentCredentials;
4171
+ /**
4172
+ * - Shows whether Segment integration is enabled
4173
+ * or disabled for the sales channel
4174
+ */
4175
+ enabled?: boolean;
4176
+ };
4177
+ /** @returns {SegmentCredentials} */
4178
+ declare function SegmentCredentials(): SegmentCredentials;
4179
+ type SegmentCredentials = {
4180
+ /**
4181
+ * - The unique identifier for a source that
4182
+ * tells Segment from which source data is coming from, to which workspace the
4183
+ * data belongs, and which destinations should receive the data.
4184
+ */
4185
+ write_key?: string;
4186
+ };
4187
+ /** @returns {SocialLinks} */
4188
+ declare function SocialLinks(): SocialLinks;
4189
+ type SocialLinks = {
4190
+ blog_link?: BlogLink;
4191
+ facebook?: FacebookLink;
4192
+ google_plus?: GooglePlusLink;
4193
+ instagram?: InstagramLink;
4194
+ linked_in?: LinkedInLink;
4195
+ pinterest?: PinterestLink;
4196
+ twitter?: TwitterLink;
4197
+ vimeo?: VimeoLink;
4198
+ youtube?: YoutubeLink;
4199
+ };
4200
+ /** @returns {SplashImage} */
4201
+ declare function SplashImage(): SplashImage;
4202
+ type SplashImage = {
4203
+ /**
4204
+ * - Width-to-height ratio of splash image
4205
+ */
4206
+ aspect_ratio?: string;
4207
+ /**
4208
+ * - URL where the splash image is hosted
4209
+ */
4210
+ secure_url?: string;
4211
+ };
4212
+ /** @returns {StoreByBrandsRequest} */
4213
+ declare function StoreByBrandsRequest(): StoreByBrandsRequest;
4214
+ type StoreByBrandsRequest = {
4215
+ /**
4216
+ * - Brand UID
4217
+ */
4218
+ brands: number;
4219
+ /**
4220
+ * - Current company ID for current company
4221
+ * stores only. Don't send in case cross-selling (franchise) is enabled.
4222
+ */
4223
+ company_id?: number;
4224
+ /**
4225
+ * - Search store by its name or store code
4226
+ */
4227
+ search_text?: string;
4228
+ };
4229
+ /** @returns {StoreByBrandsResponse} */
4230
+ declare function StoreByBrandsResponse(): StoreByBrandsResponse;
4231
+ type StoreByBrandsResponse = {
4232
+ items?: BrandStoreInfo[];
4233
+ page?: Page;
4234
+ };
4235
+ /** @returns {StoreCriteriaRule} */
4236
+ declare function StoreCriteriaRule(): StoreCriteriaRule;
4237
+ type StoreCriteriaRule = {
4238
+ /**
4239
+ * - List of brand UID
4240
+ */
4241
+ brands?: number[];
4242
+ /**
4243
+ * - List of company UID
4244
+ */
4245
+ companies?: number[];
4246
+ };
4247
+ /** @returns {StoreLatLong} */
4248
+ declare function StoreLatLong(): StoreLatLong;
4249
+ type StoreLatLong = {
4250
+ coordinates?: number[];
4251
+ /**
4252
+ * - Coordinates type of the opted store
4253
+ */
4254
+ type?: string;
4255
+ };
4256
+ /** @returns {StorePriority} */
4257
+ declare function StorePriority(): StorePriority;
4258
+ type StorePriority = {
4259
+ /**
4260
+ * - Shows store priority is enabled or disabled
4261
+ * for assignment of article
4262
+ */
4263
+ enabled?: boolean;
4264
+ /**
4265
+ * - List of store types for article
4266
+ * assignment e.g. warehouse, mall, highstreet
4267
+ */
4268
+ storetype_order?: any[];
4269
+ };
4270
+ /** @returns {StorePriorityRule} */
4271
+ declare function StorePriorityRule(): StorePriorityRule;
4272
+ type StorePriorityRule = {
4273
+ /**
4274
+ * - Shows store priority is enabled or not
4275
+ * enabled for the article assignment.
4276
+ */
4277
+ enabled?: boolean;
4278
+ storetype_order?: string[];
4279
+ };
4280
+ /** @returns {StoresResponse} */
4281
+ declare function StoresResponse(): StoresResponse;
4282
+ type StoresResponse = {
4283
+ items?: AppInventoryStores;
4284
+ page?: Page;
4285
+ };
4286
+ /** @returns {StoreValidator} */
4287
+ declare function StoreValidator(): StoreValidator;
4288
+ type StoreValidator = {
4289
+ /**
4290
+ * - Browser script for the store validator
4291
+ */
4292
+ browser_script?: string;
4293
+ json_schema?: JsonSchema[];
4294
+ };
4295
+ /** @returns {SuccessMessageResponse} */
4296
+ declare function SuccessMessageResponse(): SuccessMessageResponse;
4297
+ type SuccessMessageResponse = {
4298
+ /**
4299
+ * - Success message shown to the user (in a string format)
4300
+ */
4301
+ message?: string;
4302
+ /**
4303
+ * - Shows whether domain was deleted successfully
4304
+ */
4305
+ success?: boolean;
4306
+ };
4307
+ /** @returns {TokenResponse} */
4308
+ declare function TokenResponse(): TokenResponse;
4309
+ type TokenResponse = {
4310
+ /**
4311
+ * - Version key for tracking revisions. Default value is zero.
4312
+ */
4313
+ __v?: number;
4314
+ /**
4315
+ * - The unique identifier (24-digit Mongo Object ID)
4316
+ * of the token
4317
+ */
4318
+ _id?: string;
4319
+ /**
4320
+ * - Alphanumeric ID allotted to the current
4321
+ * application created within the current business account
4322
+ */
4323
+ application?: string;
4324
+ /**
4325
+ * - ISO 8601 timestamp of token creation
4326
+ */
4327
+ created_at?: string;
4328
+ tokens?: Tokens;
4329
+ /**
4330
+ * - ISO 8601 timestamp of token updation
4331
+ */
4332
+ updated_at?: string;
4333
+ };
4334
+ /** @returns {Tokens} */
4335
+ declare function Tokens(): Tokens;
4336
+ type Tokens = {
4337
+ firebase?: Firebase;
4338
+ freshchat?: Freshchat;
4339
+ fynd_rewards?: FyndRewards;
4340
+ google_map?: GoogleMap;
4341
+ gtm?: Gtm;
4342
+ moengage?: Moengage;
4343
+ safetynet?: Safetynet;
4344
+ segment?: Segment;
4345
+ };
4346
+ /** @returns {TwitterLink} */
4347
+ declare function TwitterLink(): TwitterLink;
4348
+ type TwitterLink = {
4349
+ /**
4350
+ * - Hosted URL of social icon image shown on the website
4351
+ */
4352
+ icon?: string;
4353
+ /**
4354
+ * - Web URL of brand's Twitter account
4355
+ */
4356
+ link?: string;
4357
+ /**
4358
+ * - Name of the social media platform, e.g. Twitter
4359
+ */
4360
+ title?: string;
4361
+ };
4362
+ /** @returns {UnhandledError} */
4363
+ declare function UnhandledError(): UnhandledError;
4364
+ type UnhandledError = {
4365
+ message?: string;
4366
+ };
4367
+ /** @returns {UpdateDomain} */
4368
+ declare function UpdateDomain(): UpdateDomain;
4369
+ type UpdateDomain = {
4370
+ /**
4371
+ * - The unique identifier (24-digit Mongo Object ID)
4372
+ * of the domain
4373
+ */
4374
+ _id?: string;
4375
+ /**
4376
+ * - Domain is primary or not (indicates if the
4377
+ * domain has been made the main URL of the sales channel)
4378
+ */
4379
+ is_primary?: boolean;
4380
+ /**
4381
+ * - Indicates if the domain is a short link
4382
+ * domain (short URL e.g. bit.ly)
4383
+ */
4384
+ is_shortlink?: boolean;
4385
+ /**
4386
+ * - Full domain name, e.g. zenz.com
4387
+ */
4388
+ name?: string;
4389
+ /**
4390
+ * - Domain is verified or not (indicates if A
4391
+ * records and TXT records are correct)
4392
+ */
4393
+ verified?: boolean;
4394
+ };
4395
+ /** @returns {UpdateDomainTypeRequest} */
4396
+ declare function UpdateDomainTypeRequest(): UpdateDomainTypeRequest;
4397
+ type UpdateDomainTypeRequest = {
4398
+ /**
4399
+ * - Shows domain is made primary domain for the
4400
+ * sales channel or shorlink is created for the sales channel domain
4401
+ */
4402
+ action?: string;
4403
+ domain?: UpdateDomain;
4404
+ };
4405
+ /** @returns {UpdateIntegrationLevelRequest} */
4406
+ declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
4407
+ type UpdateIntegrationLevelRequest = {
4408
+ items?: IntegrationLevel[];
4409
+ };
4410
+ /** @returns {UserEmail} */
4411
+ declare function UserEmail(): UserEmail;
4412
+ type UserEmail = {
4413
+ /**
4414
+ * - Current email is active or not active
4415
+ */
4416
+ active?: boolean;
4417
+ /**
4418
+ * - Email address of the user
4419
+ */
4420
+ email?: string;
4421
+ /**
4422
+ * - Indicates current email is primay email or
4423
+ * not primary email of user
4424
+ */
4425
+ primary?: boolean;
4426
+ /**
4427
+ * - Indicates current email is verified email or
4428
+ * not verified email
4429
+ */
4430
+ verified?: boolean;
4431
+ };
4432
+ /** @returns {UserPhoneNumber} */
4433
+ declare function UserPhoneNumber(): UserPhoneNumber;
4434
+ type UserPhoneNumber = {
4435
+ /**
4436
+ * - Current phone number is active or not active
4437
+ */
4438
+ active?: boolean;
4439
+ /**
4440
+ * - Country code, e.g. +91
4441
+ */
4442
+ country_code?: number;
4443
+ /**
4444
+ * - Phone number of the user
4445
+ */
4446
+ phone?: string;
4447
+ /**
4448
+ * - Indicates current phone number is primay or
4449
+ * not primary of user
4450
+ */
4451
+ primary?: boolean;
4452
+ /**
4453
+ * - Indicates current phone number is verified
4454
+ * or not verified
4455
+ */
4456
+ verified?: boolean;
4457
+ };
4458
+ /** @returns {ValidationFailedResponse} */
4459
+ declare function ValidationFailedResponse(): ValidationFailedResponse;
4460
+ type ValidationFailedResponse = {
4461
+ /**
4462
+ * - Response message for failed validation
4463
+ */
4464
+ message?: string;
4465
+ };
4466
+ /** @returns {Validators} */
4467
+ declare function Validators(): Validators;
4468
+ type Validators = {
4469
+ company?: CompanyValidator;
4470
+ inventory?: InventoryValidator;
4471
+ order?: OrderValidator;
4472
+ store?: StoreValidator;
4473
+ };
4474
+ /** @returns {VimeoLink} */
4475
+ declare function VimeoLink(): VimeoLink;
4476
+ type VimeoLink = {
4477
+ /**
4478
+ * - Hosted URL of social icon image shown on the website
4479
+ */
4480
+ icon?: string;
4481
+ /**
4482
+ * - Web URL of brand's Vimeo channel
4483
+ */
4484
+ link?: string;
4485
+ /**
4486
+ * - Name of the video hosting platform, e.g. Vimeo
4487
+ */
4488
+ title?: string;
4489
+ };
4490
+ /** @returns {YoutubeLink} */
4491
+ declare function YoutubeLink(): YoutubeLink;
4492
+ type YoutubeLink = {
4493
+ /**
4494
+ * - Hosted URL of social icon image shown on the website
4495
+ */
4496
+ icon?: string;
4497
+ /**
4498
+ * - Web URL of brand's YouTube channel
4499
+ */
4500
+ link?: string;
4501
+ /**
4502
+ * - Name of the social media platform, e.g. YouTube
4503
+ */
4504
+ title?: string;
4505
+ };