@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.10

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