@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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