@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

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 (290) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
  6. package/sdk/application/Cart/CartApplicationClient.js +257 -126
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +250 -36
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  18. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  22. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  24. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  28. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  30. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  31. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  32. package/sdk/application/User/UserApplicationClient.js +9 -57
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  36. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  37. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  41. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  42. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  43. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  44. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  45. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  46. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  47. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
  48. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
  49. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
  50. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
  51. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  52. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
  53. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  55. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  56. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  57. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  58. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  60. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  62. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  64. package/sdk/partner/PartnerClient.d.ts +6 -0
  65. package/sdk/partner/PartnerClient.js +9 -0
  66. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  67. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  68. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  69. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  70. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  71. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  72. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  73. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  74. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  75. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  76. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  77. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  78. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  79. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  80. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  81. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  82. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  83. package/sdk/partner/index.d.ts +3 -0
  84. package/sdk/partner/index.js +6 -0
  85. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  86. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  88. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  90. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  95. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  96. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  97. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  98. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  99. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  100. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  101. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
  103. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  105. package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
  106. package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
  108. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
  111. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
  112. package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
  113. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
  114. package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
  115. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
  116. package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
  117. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  118. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  119. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  120. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  121. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
  122. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  125. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  126. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  127. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
  128. package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
  129. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  130. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
  137. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  138. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  141. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  142. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  143. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
  144. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
  145. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  146. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  147. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
  148. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
  149. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  150. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  151. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  152. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  153. package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
  154. package/sdk/platform/Content/ContentPlatformModel.js +940 -599
  155. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  156. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  157. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  158. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  159. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  160. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  161. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  162. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  163. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  164. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  167. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  168. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  169. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  170. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  171. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  172. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  173. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  174. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  175. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  176. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  177. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  178. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  179. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  180. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  181. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  182. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  183. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  184. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  185. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  186. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  187. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  188. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  189. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  190. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  191. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  192. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  193. package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
  194. package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
  195. package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
  196. package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
  197. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  198. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  199. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  200. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  201. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  203. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  204. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  205. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  206. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  207. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  208. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  209. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
  210. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
  211. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  212. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  213. package/sdk/platform/PlatformClient.d.ts +2 -0
  214. package/sdk/platform/PlatformClient.js +4 -0
  215. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  216. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  220. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  221. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  222. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
  231. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  232. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  233. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  234. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  235. package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
  236. package/sdk/platform/Share/SharePlatformModel.js +5 -43
  237. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
  238. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
  239. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
  240. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
  241. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  242. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  243. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  244. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  245. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  246. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  247. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  248. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  249. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  250. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  251. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  252. package/sdk/platform/User/UserPlatformModel.js +209 -216
  253. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  254. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  255. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  256. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  257. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  258. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  259. package/sdk/platform/index.d.ts +1 -0
  260. package/sdk/platform/index.js +2 -0
  261. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  262. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  263. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  264. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  265. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  266. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  267. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  268. package/sdk/public/Content/ContentPublicClient.js +183 -0
  269. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  270. package/sdk/public/Content/ContentPublicModel.js +47 -1
  271. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  272. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  273. package/sdk/public/PublicClient.d.ts +0 -2
  274. package/sdk/public/PublicClient.js +0 -4
  275. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  276. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  277. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  278. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  279. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  280. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  281. package/sdk/public/index.d.ts +0 -1
  282. package/sdk/public/index.js +0 -2
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  285. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  286. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  287. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  288. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  289. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  290. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -1,28 +1,6 @@
1
1
  export = ConfigurationPlatformModel;
2
- /**
3
- * @typedef CurrencyExchangeResponseV2
4
- * @property {string} base - The 3-letter ISO 4217 code representing the base currency.
5
- * @property {string} base_currency_name - The name of the base currency.
6
- * @property {number} ttl_seconds - Time in seconds for which the exchange rates
7
- * are valid.
8
- * @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
9
- * @property {number} total - Total number of currency exchange items.
10
- */
11
- /**
12
- * @typedef CurrencyExchangeItem
13
- * @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
14
- * @property {string} name - Name of the exchange currency
15
- * @property {number} rate - Exchange rate of the currency with respect to the
16
- * base currency.
17
- * @property {string} country_code - ISO 3166 country code.
18
- * @property {string} country_name - Name of the country using this currency.
19
- * @property {string} subunit - The name of the subunit for the currency.
20
- * @property {number} decimal_digits - Number of decimal digits the currency supports.
21
- * @property {string} symbol - The symbol of the currency.
22
- */
23
2
  /**
24
3
  * @typedef ApplicationInventory
25
- * @property {SearchConfig} [search]
26
4
  * @property {AppInventoryConfig} [inventory]
27
5
  * @property {AuthenticationConfig} [authentication]
28
6
  * @property {ArticleAssignmentConfig} [article_assignment]
@@ -56,20 +34,12 @@ export = ConfigurationPlatformModel;
56
34
  * @property {boolean} [enabled]
57
35
  */
58
36
  /**
59
- * @typedef FstIdentification
60
- * @property {boolean} [enabled] - Indicates whether FST identification is
61
- * enabled for the application.
62
- */
63
- /**
64
- * @typedef QuerySuggestions
65
- * @property {boolean} [enabled] - Indicates whether query suggestions are enabled.
66
- * @property {number} [max_limit] - Specifies the maximum number of query
67
- * suggestions that can be returned.
37
+ * @typedef OwnerAppInventoryConfig
38
+ * @property {PricingStrategy} [pricing_strategy]
68
39
  */
69
40
  /**
70
- * @typedef SearchConfig
71
- * @property {FstIdentification} [fst_identification]
72
- * @property {QuerySuggestions} [query_suggestions]
41
+ * @typedef OwnerAppConfig
42
+ * @property {OwnerAppInventoryConfig} [inventory]
73
43
  */
74
44
  /**
75
45
  * @typedef AppInventoryConfig
@@ -78,15 +48,16 @@ export = ConfigurationPlatformModel;
78
48
  * @property {InventoryCategory} [category]
79
49
  * @property {InventoryPrice} [price]
80
50
  * @property {InventoryDiscount} [discount]
51
+ * @property {PricingStrategy} [pricing_strategy]
81
52
  * @property {boolean} [out_of_stock] - Indicates whether out of stock products
82
53
  * are allowed to show up on the website
83
54
  * @property {boolean} [only_verified_products] - Show only verified products
84
55
  * (the ones whose data has been verified by the admin)
85
56
  * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
86
57
  * to consume the current sales channel's inventory and sell products
87
- * @property {Object[]} [exclude_category] - List of excluded brands category
58
+ * @property {number[]} [exclude_category] - List of excluded brands category
88
59
  * @property {string[]} [image]
89
- * @property {Object[]} [company_store] - List of selling locations whose
60
+ * @property {number[]} [company_store] - List of selling locations whose
90
61
  * inventory is available to the sales channel for displaying on the website
91
62
  * @property {number} [company_id]
92
63
  */
@@ -100,7 +71,7 @@ export = ConfigurationPlatformModel;
100
71
  * @typedef InventoryStore
101
72
  * @property {string} [criteria] - All stores or specific (explicit) stores to
102
73
  * be shown on the website
103
- * @property {Object[]} [stores] - List of stores
74
+ * @property {number[]} [stores] - List of stores
104
75
  * @property {AppStoreRules[]} [rules] - Rules to show which brands or companies
105
76
  * products should be listed on sales channel.
106
77
  */
@@ -114,7 +85,7 @@ export = ConfigurationPlatformModel;
114
85
  /**
115
86
  * @typedef InventoryCategory
116
87
  * @property {string} [criteria]
117
- * @property {Object[]} [categories] - List of categories whose products will be
88
+ * @property {number[]} [categories] - List of categories whose products will be
118
89
  * shown on the website
119
90
  */
120
91
  /**
@@ -147,7 +118,7 @@ export = ConfigurationPlatformModel;
147
118
  * @typedef StorePriority
148
119
  * @property {boolean} [enabled] - Shows store priority is enabled or disabled
149
120
  * for assignment of article
150
- * @property {Object[]} [storetype_order] - List of store types for article
121
+ * @property {number[]} [storetype_order] - List of store types for article
151
122
  * assignment e.g. warehouse, mall, highstreet
152
123
  */
153
124
  /**
@@ -257,7 +228,6 @@ export = ConfigurationPlatformModel;
257
228
  */
258
229
  /**
259
230
  * @typedef AppInventoryPartialUpdate
260
- * @property {SearchConfig} [search]
261
231
  * @property {RewardPointsConfig} [reward_points]
262
232
  * @property {AppCartConfig} [cart]
263
233
  * @property {AppPaymentConfig} [payment]
@@ -272,24 +242,24 @@ export = ConfigurationPlatformModel;
272
242
  * @property {number} [company_id] - Numeric ID allotted to a business account
273
243
  */
274
244
  /**
275
- * @typedef CompanyByBrandsRequestSchema
245
+ * @typedef CompanyByBrandsRequest
276
246
  * @property {number} brands - Brand UID
277
247
  * @property {string} [search_text] - A search field for finding a company by its name
278
248
  */
279
249
  /**
280
- * @typedef CompanyByBrandsResponseSchema
250
+ * @typedef CompanyByBrandsResponse
281
251
  * @property {BrandCompanyInfo[]} [items]
282
252
  * @property {Page} [page]
283
253
  */
284
254
  /**
285
- * @typedef StoreByBrandsRequestSchema
255
+ * @typedef StoreByBrandsRequest
286
256
  * @property {number} [company_id] - Current company ID for current company
287
257
  * stores only. Don't send in case cross-selling (franchise) is enabled.
288
258
  * @property {number} brands - Brand UID
289
259
  * @property {string} [search_text] - Search store by its name or store code
290
260
  */
291
261
  /**
292
- * @typedef StoreByBrandsResponseSchema
262
+ * @typedef StoreByBrandsResponse
293
263
  * @property {BrandStoreInfo[]} [items]
294
264
  * @property {Page} [page]
295
265
  */
@@ -314,16 +284,19 @@ export = ConfigurationPlatformModel;
314
284
  * portrait banner
315
285
  */
316
286
  /**
317
- * @typedef BrandsByCompanyResponseSchema
287
+ * @typedef BrandsByCompanyResponse
318
288
  * @property {CompanyBrandInfo[]} [brands]
319
289
  */
320
290
  /**
321
- * @typedef ValidationFailedResponseSchema
291
+ * @typedef ValidationFailedResponse
322
292
  * @property {string} [message] - Response message for failed validation
293
+ * @property {Object[]} [errors] - Response message for failed validation
323
294
  */
324
295
  /**
325
296
  * @typedef NotFound
326
297
  * @property {string} [message] - Response message for not found
298
+ * @property {string} [error] - Error message for not found
299
+ * @property {string} [code] - Unique code for each error
327
300
  * @property {boolean} [success] - Flag for required not successfull.
328
301
  */
329
302
  /**
@@ -345,18 +318,18 @@ export = ConfigurationPlatformModel;
345
318
  * amount pan card number is expected from customer for order
346
319
  */
347
320
  /**
348
- * @typedef CreateApplicationRequestSchema
321
+ * @typedef CreateApplicationRequest
349
322
  * @property {App} [app]
350
323
  * @property {ApplicationInventory} [configuration]
351
324
  * @property {AppDomain} [domain]
352
325
  */
353
326
  /**
354
- * @typedef CreateAppResponseSchema
327
+ * @typedef CreateAppResponse
355
328
  * @property {Application} [app]
356
329
  * @property {ApplicationInventory} [configuration]
357
330
  */
358
331
  /**
359
- * @typedef ApplicationsResponseSchema
332
+ * @typedef ApplicationsResponse
360
333
  * @property {Application[]} [items]
361
334
  * @property {Page} [page]
362
335
  */
@@ -390,7 +363,7 @@ export = ConfigurationPlatformModel;
390
363
  * @property {string} [secure_url] - URL where the splash image is hosted
391
364
  */
392
365
  /**
393
- * @typedef MobileAppConfigRequestSchema
366
+ * @typedef MobileAppConfigRequest
394
367
  * @property {string} [app_name] - Name of the mobile app
395
368
  * @property {LandingImage} [landing_image]
396
369
  * @property {SplashImage} [splash_image]
@@ -456,7 +429,7 @@ export = ConfigurationPlatformModel;
456
429
  * @property {string[]} [txt_records]
457
430
  */
458
431
  /**
459
- * @typedef DomainAddRequestSchema
432
+ * @typedef DomainAddRequest
460
433
  * @property {DomainAdd} [domain]
461
434
  */
462
435
  /**
@@ -473,7 +446,7 @@ export = ConfigurationPlatformModel;
473
446
  * @property {string} [message]
474
447
  */
475
448
  /**
476
- * @typedef DomainsResponseSchema
449
+ * @typedef DomainsResponse
477
450
  * @property {Domain[]} [domains]
478
451
  */
479
452
  /**
@@ -489,13 +462,13 @@ export = ConfigurationPlatformModel;
489
462
  * domain (short URL e.g. bit.ly)
490
463
  */
491
464
  /**
492
- * @typedef UpdateDomainTypeRequestSchema
465
+ * @typedef UpdateDomainTypeRequest
493
466
  * @property {UpdateDomain} [domain]
494
467
  * @property {string} [action] - Shows domain is made primary domain for the
495
468
  * sales channel or shorlink is created for the sales channel domain
496
469
  */
497
470
  /**
498
- * @typedef DomainStatusRequestSchema
471
+ * @typedef DomainStatusRequest
499
472
  * @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
500
473
  */
501
474
  /**
@@ -505,16 +478,14 @@ export = ConfigurationPlatformModel;
505
478
  * domain are correctly propagating via DNS servers
506
479
  */
507
480
  /**
508
- * @typedef DomainStatusResponseSchema
481
+ * @typedef DomainStatusResponse
509
482
  * @property {boolean} [connected] - Check if domain is live and mapped to
510
483
  * appropriate IP of Fynd Servers
511
484
  * @property {DomainStatus[]} [status]
512
485
  */
513
486
  /**
514
- * @typedef DomainSuggestionsRequestSchema
487
+ * @typedef DomainSuggestionsRequest
515
488
  * @property {string} [domain_url] - Domain url
516
- * @property {boolean} [custom_domain] - Get suggestions for custom domains or
517
- * Fynd domains
518
489
  */
519
490
  /**
520
491
  * @typedef DomainSuggestion
@@ -527,14 +498,186 @@ export = ConfigurationPlatformModel;
527
498
  * @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
528
499
  */
529
500
  /**
530
- * @typedef DomainSuggestionsResponseSchema
501
+ * @typedef DomainSuggestionsResponse
531
502
  * @property {DomainSuggestion[]} [domains] - Domain URL
532
503
  */
533
504
  /**
534
- * @typedef SuccessMessageResponseSchema
505
+ * @typedef SuccessMessageResponse
535
506
  * @property {boolean} [success] - Shows whether domain was deleted successfully
536
507
  * @property {string} [message] - Success message shown to the user (in a string format)
537
508
  */
509
+ /**
510
+ * @typedef GetIntegrationsOptInsResponse
511
+ * @property {IntegrationOptIn[]} [items]
512
+ * @property {Page} [page]
513
+ */
514
+ /**
515
+ * @typedef IntegrationOptIn
516
+ * @property {Validators} [validators]
517
+ * @property {string} [description] - Basic description about the opted integration
518
+ * @property {string} [description_html] - Basic HTML description about the
519
+ * opted integration
520
+ * @property {string} [constants]
521
+ * @property {string[]} [companies]
522
+ * @property {string[]} [support]
523
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
524
+ * of the opted integration
525
+ * @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
526
+ * @property {string} [slug] - Slug of the opted integration, e.g. ginesys
527
+ * @property {boolean} [hidden]
528
+ * @property {IntegrationMeta[]} [meta]
529
+ * @property {string} [icon] - Hosted URL of the icon image
530
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
531
+ * of the user who created the integration
532
+ * @property {string} [created_at] - ISO 8601 timestamp of integration creation
533
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
534
+ * @property {string} [token] - Randomly generated fixed-length string for opted
535
+ * integration. It is auto-generated. It would never change once it is generated.
536
+ * @property {string} [secret] - Randomly generated fixed-length string for
537
+ * opted integration. It is auto-generated. It would never change once it is generated.
538
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
539
+ */
540
+ /**
541
+ * @typedef Validators
542
+ * @property {CompanyValidator} [company]
543
+ * @property {StoreValidator} [store]
544
+ * @property {InventoryValidator} [inventory]
545
+ * @property {OrderValidator} [order]
546
+ */
547
+ /**
548
+ * @typedef CompanyValidator
549
+ * @property {JsonSchema[]} [json_schema]
550
+ * @property {string} [browser_script] - Browser script for the company validator
551
+ */
552
+ /**
553
+ * @typedef JsonSchema
554
+ * @property {string} [display] - Display text of the validator JSON schema. It
555
+ * will show in the UI.
556
+ * @property {string} [key] - Key related to the display text of the validator JSON schema
557
+ * @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
558
+ * @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
559
+ * schema. It will show in the UI.
560
+ */
561
+ /**
562
+ * @typedef StoreValidator
563
+ * @property {JsonSchema[]} [json_schema]
564
+ * @property {string} [browser_script] - Browser script for the store validator
565
+ */
566
+ /**
567
+ * @typedef InventoryValidator
568
+ * @property {JsonSchema[]} [json_schema]
569
+ * @property {string} [browser_script] - Browser script for the inventory validator
570
+ */
571
+ /**
572
+ * @typedef OrderValidator
573
+ * @property {JsonSchema[]} [json_schema]
574
+ * @property {string} [browser_script] - Browser script for the order validator
575
+ */
576
+ /**
577
+ * @typedef IntegrationMeta
578
+ * @property {boolean} [is_public]
579
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
580
+ * of the integration meta
581
+ * @property {string} [name] - Nmae of integration meta, e.g. price_level
582
+ * @property {string} [value] - Value related to integration meta name, e.g. store
583
+ */
584
+ /**
585
+ * @typedef Integration
586
+ * @property {Validators} [validators]
587
+ * @property {string} [description] - Basic description about the integration
588
+ * @property {string} [description_html] - Basic HTML description about the integration
589
+ * @property {Object} [constants]
590
+ * @property {string[]} [companies]
591
+ * @property {string[]} [support]
592
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
593
+ * of the integration
594
+ * @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
595
+ * @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
596
+ * @property {IntegrationMeta[]} [meta]
597
+ * @property {string} [icon] - Hosted URL of the icon image
598
+ * @property {boolean} [hidden]
599
+ * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
600
+ * of the user who created the integration
601
+ * @property {string} [created_at] - ISO 8601 timestamp of integration creation
602
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
603
+ * @property {string} [token] - Randomly generated fixed-length string for opted
604
+ * integration. It is auto-generated. It would never change once it is generated.
605
+ * @property {string} [secret] - Randomly generated fixed-length string for
606
+ * opted integration. It is auto-generated. It would never change once it is generated.
607
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
608
+ */
609
+ /**
610
+ * @typedef IntegrationConfigResponse
611
+ * @property {IntegrationLevel[]} [items]
612
+ */
613
+ /**
614
+ * @typedef IntegrationLevel
615
+ * @property {boolean} [opted] - Shows this integration is opted or not opted
616
+ * for the current company
617
+ * @property {Object[]} [permissions]
618
+ * @property {LastPatch[]} [last_patch]
619
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
620
+ * of the integration config
621
+ * @property {string} [integration] - Integration id. Shows which integration
622
+ * you are enabling.
623
+ * @property {string} [level] - Shows for what level the integration is set up.
624
+ * It can be company level or store level.
625
+ * @property {number} [uid] - It can be store uid or company uid. Depends on the
626
+ * level of integration.
627
+ * @property {number} [company_id] - Unique id of company.
628
+ * @property {IntegrationMeta[]} [meta]
629
+ * @property {string} [token] - Randomly generated fixed-length string for opted
630
+ * integration. It is auto-generated. It would never change once it is generated.
631
+ * @property {string} [created_at] - ISO 8601 timestamp of integration config creation
632
+ * @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
633
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
634
+ * @property {Object} [data] - Schema data of the integration stored in key-value pairs
635
+ * @property {boolean} [success]
636
+ * @property {string} [message]
637
+ */
638
+ /**
639
+ * @typedef UpdateIntegrationLevelRequest
640
+ * @property {IntegrationLevel[]} [items]
641
+ */
642
+ /**
643
+ * @typedef OptedStoreIntegration
644
+ * @property {boolean} [other_opted] - Allow user to opt same store in other integration
645
+ * @property {IntegrationOptIn} [other_integration]
646
+ * @property {OtherEntity} [other_entity]
647
+ */
648
+ /**
649
+ * @typedef OtherEntity
650
+ * @property {boolean} [opted] - Allow other entity opted in integration
651
+ * @property {string[]} [permissions]
652
+ * @property {LastPatch[]} [last_patch]
653
+ * @property {string} [_id] - The unique identifier of the other entity for
654
+ * opted store integration
655
+ * @property {string} [integration] - Integration ID. Shows which integration
656
+ * you are enabling.
657
+ * @property {string} [level] - Indicates integration level. It can be company
658
+ * level or store level.
659
+ * @property {number} [uid] - It can be store uid or company uid. Depends on the
660
+ * level of integration.
661
+ * @property {OtherEntityData} [data]
662
+ * @property {Object[]} [meta]
663
+ * @property {string} [token] - Randomly generated fixed-length string for opted
664
+ * integration. It is auto-generated. It would never change once it is generated.
665
+ * @property {string} [created_at] - ISO 8601 timestamp of other entity creation
666
+ * for opted store integration
667
+ * @property {string} [modified_at] - ISO 8601 timestamp of other entity
668
+ * updation for opted store integration
669
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
670
+ */
671
+ /**
672
+ * @typedef LastPatch
673
+ * @property {string} [op]
674
+ * @property {string} [path]
675
+ * @property {string} [value] - It can be inventory level or order level
676
+ */
677
+ /**
678
+ * @typedef OtherEntityData
679
+ * @property {string} [article_identifier]
680
+ */
538
681
  /**
539
682
  * @typedef App
540
683
  * @property {string} [company_id] - Numeric ID allotted to a business account
@@ -545,12 +688,31 @@ export = ConfigurationPlatformModel;
545
688
  * @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion
546
689
  * @property {string} [desc] - Detailed description about the sales channel
547
690
  */
691
+ /**
692
+ * @typedef InventoryConfig
693
+ * @property {InventoryBrandRule} [brand]
694
+ * @property {InventoryStoreRule} [store]
695
+ * @property {string[]} [image]
696
+ * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
697
+ * to consume the current sales channel's inventory and sell products
698
+ * @property {boolean} [out_of_stock] - Indicates whether out of stock products
699
+ * are allowed to show up on the website.
700
+ * @property {boolean} [only_verified_products] - Show only verified products
701
+ * (the ones whose data have been verified by the admin)
702
+ * @property {PricingStrategy} [pricing_strategy]
703
+ */
704
+ /**
705
+ * @typedef AppInventory
706
+ * @property {InventoryConfig} [inventory]
707
+ * @property {InventoryPaymentConfig} [payment]
708
+ * @property {InventoryArticleAssignment} [article_assignment]
709
+ */
548
710
  /**
549
711
  * @typedef AppDomain
550
712
  * @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
551
713
  */
552
714
  /**
553
- * @typedef CompaniesResponseSchema
715
+ * @typedef CompaniesResponse
554
716
  * @property {AppInventoryCompanies[]} [items]
555
717
  * @property {Page} [page]
556
718
  */
@@ -562,10 +724,18 @@ export = ConfigurationPlatformModel;
562
724
  * franchisee, distributor, etc.
563
725
  */
564
726
  /**
565
- * @typedef StoresResponseSchema
727
+ * @typedef StoresResponse
566
728
  * @property {AppInventoryStores[]} [items]
567
729
  * @property {Page} [page]
568
730
  */
731
+ /**
732
+ * @typedef ListStoreResponse
733
+ * @property {AppInventoryStores[]} [stores]
734
+ */
735
+ /**
736
+ * @typedef ArrayStoreResponse
737
+ * @property {AppInventoryStores[]} [data]
738
+ */
569
739
  /**
570
740
  * @typedef AppInventoryStores
571
741
  * @property {string} [_id] - The unique identifier of the store (24-digit Mongo
@@ -587,7 +757,7 @@ export = ConfigurationPlatformModel;
587
757
  * @property {Object} [integration_type]
588
758
  */
589
759
  /**
590
- * @typedef FilterOrderingStoreRequestSchema
760
+ * @typedef FilterOrderingStoreRequest
591
761
  * @property {boolean} [all_stores] - Allow all stores from the ordering stores
592
762
  * @property {number[]} [deployed_stores]
593
763
  * @property {string} [q] - Store code or name of the ordering store
@@ -611,7 +781,7 @@ export = ConfigurationPlatformModel;
611
781
  * @property {DeploymentMeta} [deployment_meta]
612
782
  */
613
783
  /**
614
- * @typedef OrderingStoreSelectRequestSchema
784
+ * @typedef OrderingStoreSelectRequest
615
785
  * @property {OrderingStoreSelect} ordering_store
616
786
  */
617
787
  /**
@@ -640,7 +810,7 @@ export = ConfigurationPlatformModel;
640
810
  * @property {Page} [page]
641
811
  */
642
812
  /**
643
- * @typedef OptedApplicationResponseSchema
813
+ * @typedef OptedApplicationResponse
644
814
  * @property {string} [name] - Name of the other seller's sales channel
645
815
  * @property {string} [description] - Basic details about the other seller's sales channel
646
816
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
@@ -691,7 +861,7 @@ export = ConfigurationPlatformModel;
691
861
  * of other seller's application
692
862
  */
693
863
  /**
694
- * @typedef TokenResponseSchema
864
+ * @typedef TokenResponse
695
865
  * @property {Tokens} [tokens]
696
866
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
697
867
  * of the token
@@ -886,6 +1056,7 @@ export = ConfigurationPlatformModel;
886
1056
  * @property {QrFeature} [qr]
887
1057
  * @property {PcrFeature} [pcr]
888
1058
  * @property {OrderFeature} [order]
1059
+ * @property {BuyboxFeature} [buybox]
889
1060
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
890
1061
  * for the sales channel features
891
1062
  * @property {string} [app] - Application ID of the sales channel
@@ -894,6 +1065,7 @@ export = ConfigurationPlatformModel;
894
1065
  * @property {string} [modified_at] - ISO 8601 timestamp of last known
895
1066
  * modifications to the sales channel feature configuration
896
1067
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero
1068
+ * @property {PricingStrategy} [pricing_strategy]
897
1069
  */
898
1070
  /**
899
1071
  * @typedef HomePageFeature
@@ -990,11 +1162,21 @@ export = ConfigurationPlatformModel;
990
1162
  * value is false.
991
1163
  */
992
1164
  /**
993
- * @typedef AppFeatureRequestSchema
1165
+ * @typedef BuyboxFeature
1166
+ * @property {boolean} [show_name] - Allow users to see seller/stores name on
1167
+ * PDP (product detail page).
1168
+ * @property {boolean} [enable_selection] - Allow selection of sellers/stores on
1169
+ * PDP (product detail page).
1170
+ * @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
1171
+ * between sellers and stores. True indicates seller listing, while False
1172
+ * indicates store listing.
1173
+ */
1174
+ /**
1175
+ * @typedef AppFeatureRequest
994
1176
  * @property {AppFeature} [feature]
995
1177
  */
996
1178
  /**
997
- * @typedef AppFeatureResponseSchema
1179
+ * @typedef AppFeatureResponse
998
1180
  * @property {AppFeature} [feature]
999
1181
  */
1000
1182
  /**
@@ -1012,7 +1194,7 @@ export = ConfigurationPlatformModel;
1012
1194
  * @property {number} [decimal_digits] - Acceptable decimal limits for a given
1013
1195
  * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
1014
1196
  * value of a currency.
1015
- * @property {string} [symbol] - Unique symbol for identifying the currency, e.g.
1197
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
1016
1198
  * @property {string} [country_name]
1017
1199
  * @property {string} [country_code]
1018
1200
  */
@@ -1089,53 +1271,6 @@ export = ConfigurationPlatformModel;
1089
1271
  * @property {TokenSchema[]} [tokens]
1090
1272
  * @property {string} [secret]
1091
1273
  */
1092
- /**
1093
- * @typedef ApplicationById
1094
- * @property {ApplicationWebsite} [website]
1095
- * @property {ApplicationCors} [cors]
1096
- * @property {ApplicationAuth} [auth]
1097
- * @property {string} [description] - It contains detailed information about the
1098
- * sales channel.
1099
- * @property {string} [channel_type] - It indicates different types of channels,
1100
- * such as store, website, and mobile apps, with 'store' being the default value.
1101
- * @property {number} [cache_ttl] - An integer value that specifies the number
1102
- * of seconds until the key expires
1103
- * @property {boolean} [is_internal] - Indicates whether a sales channel is
1104
- * internal or not
1105
- * @property {boolean} [is_active] - Indicates sales channel is active or not active
1106
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1107
- * of the sales channel
1108
- * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
1109
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
1110
- * of owner who owns the application
1111
- * @property {number} [company_id] - Numeric ID allotted to a business account
1112
- * where the sales channel exists
1113
- * @property {string} [token] - Random generated fix length string for sales
1114
- * channel. It is required and auto-generated.
1115
- * @property {ApplicationRedirections[]} [redirections]
1116
- * @property {ApplicationMeta[]} [meta]
1117
- * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
1118
- * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
1119
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
1120
- * @property {SecureUrl} [banner]
1121
- * @property {SecureUrl} [logo]
1122
- * @property {SecureUrl} [favicon]
1123
- * @property {Domain[]} [domains]
1124
- * @property {string} [app_type] - It shows application is live or in development mode.
1125
- * @property {SecureUrl} [mobile_logo]
1126
- * @property {Domain} [domain]
1127
- * @property {string} [slug]
1128
- * @property {string} [mode]
1129
- * @property {string} [status]
1130
- * @property {TokenSchemaID[]} [tokens]
1131
- * @property {string} [secret]
1132
- */
1133
- /**
1134
- * @typedef TokenSchemaID
1135
- * @property {string} [token]
1136
- * @property {string} [created_by]
1137
- * @property {string} [created_at] - ISO 8601 timestamp of when token created
1138
- */
1139
1274
  /**
1140
1275
  * @typedef TokenSchema
1141
1276
  * @property {string} [token]
@@ -1143,9 +1278,55 @@ export = ConfigurationPlatformModel;
1143
1278
  * @property {string} [created_at] - ISO 8601 timestamp of when token created
1144
1279
  */
1145
1280
  /**
1146
- * @typedef InvalidPayloadRequestSchema
1281
+ * @typedef InvalidPayloadRequest
1147
1282
  * @property {string} [message] - Error message when request body payload is improper
1148
1283
  * @property {boolean} [success] - Flag for required not successfull.
1284
+ * @property {Object} [domain] - All errors related to domin
1285
+ */
1286
+ /**
1287
+ * @typedef InventoryBrandRule
1288
+ * @property {string} [criteria] - Whether all brands are enabled, or explicitly
1289
+ * few brands in the inventory
1290
+ * @property {number[]} [brands]
1291
+ */
1292
+ /**
1293
+ * @typedef PricingStrategy
1294
+ * @property {string} [value] - Indicates the pricing strategy value.
1295
+ */
1296
+ /**
1297
+ * @typedef StoreCriteriaRule
1298
+ * @property {number[]} [companies] - List of company UID
1299
+ * @property {number[]} [brands] - List of brand UID
1300
+ */
1301
+ /**
1302
+ * @typedef InventoryStoreRule
1303
+ * @property {string} [criteria] - Whether all stores are enabled, or explicitly
1304
+ * few stores in the inventory, or use brands and company filter.
1305
+ * @property {StoreCriteriaRule[]} [rules] - List of rules with company and
1306
+ * brands uids. Used when critera is `filter`.
1307
+ * @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
1308
+ */
1309
+ /**
1310
+ * @typedef InventoryPaymentConfig
1311
+ * @property {string} [mode_of_payment] - Mode of payment for the inventory of
1312
+ * sales channel. It is required and default value is null.
1313
+ * @property {string} [source] - Source of the payment mode for the inventory
1314
+ * payment of sales channel. Default value is FYND.
1315
+ */
1316
+ /**
1317
+ * @typedef StorePriorityRule
1318
+ * @property {boolean} [enabled] - Shows store priority is enabled or not
1319
+ * enabled for the article assignment.
1320
+ * @property {string[]} [storetype_order]
1321
+ */
1322
+ /**
1323
+ * @typedef ArticleAssignmentRule
1324
+ * @property {StorePriorityRule} [store_priority]
1325
+ */
1326
+ /**
1327
+ * @typedef InventoryArticleAssignment
1328
+ * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
1329
+ * @property {ArticleAssignmentRule} [rules]
1149
1330
  */
1150
1331
  /**
1151
1332
  * @typedef Page
@@ -1156,6 +1337,7 @@ export = ConfigurationPlatformModel;
1156
1337
  * @property {number} [current] - The current page number.
1157
1338
  * @property {string} type - The type of the page, such as 'PageType'.
1158
1339
  * @property {number} [size] - The number of items per page.
1340
+ * @property {number} [total] - Total number of items.
1159
1341
  */
1160
1342
  /**
1161
1343
  * @typedef ApplicationInformation
@@ -1309,11 +1491,11 @@ export = ConfigurationPlatformModel;
1309
1491
  * @property {number} [company_id]
1310
1492
  */
1311
1493
  /**
1312
- * @typedef CurrenciesResponseSchema
1494
+ * @typedef CurrenciesResponse
1313
1495
  * @property {Currency[]} [items]
1314
1496
  */
1315
1497
  /**
1316
- * @typedef AppCurrencyResponseSchema
1498
+ * @typedef AppCurrencyResponse
1317
1499
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1318
1500
  * of the currency configuration supported by the application
1319
1501
  * @property {string} [application] - Alphanumeric ID allotted to an application
@@ -1336,12 +1518,13 @@ export = ConfigurationPlatformModel;
1336
1518
  * @property {string} [address1] - Address of the opted store
1337
1519
  * @property {StoreLatLong} [lat_long]
1338
1520
  * @property {string} [address2] - Address of the opted store
1339
- * @property {number} [pincode] - 6-digit PIN code of the opted store location
1521
+ * @property {string} [pincode] - 6-digit PIN code of the opted store location
1340
1522
  * @property {string} [country] - Country of the opted store, e.g. India
1341
1523
  * @property {string} [city] - City of the opted store, e.g. Mumbai
1342
1524
  * @property {string} [sector] - Sector for the opted store.
1343
1525
  * @property {string} [country_code] - Country code of the selected country
1344
1526
  * @property {string} [state_code] - Selected state code
1527
+ * @property {string} [landmark] - Landmark of the address
1345
1528
  */
1346
1529
  /**
1347
1530
  * @typedef OrderingStore
@@ -1354,7 +1537,7 @@ export = ConfigurationPlatformModel;
1354
1537
  * @property {string} [store_type] - Store type of the ordering store, e.g.
1355
1538
  * high_street, mall, warehouse
1356
1539
  * @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
1357
- * @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
1540
+ * @property {string} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
1358
1541
  * @property {string} [code] - Code of the ordering store (usually same as Store Code)
1359
1542
  */
1360
1543
  /**
@@ -1374,90 +1557,126 @@ export = ConfigurationPlatformModel;
1374
1557
  * value is zero.
1375
1558
  */
1376
1559
  /**
1377
- * @typedef OrderingStoresResponseSchema
1560
+ * @typedef UpdateDiealog
1561
+ * @property {string} type
1562
+ * @property {number} [interval]
1563
+ */
1564
+ /**
1565
+ * @typedef PlatformVersionRequest
1566
+ * @property {string} app_code_name
1567
+ * @property {string} app_name
1568
+ * @property {string} force_version
1569
+ * @property {string} latest_version
1570
+ * @property {boolean} is_app_blocked
1571
+ * @property {UpdateDiealog} update_dialog
1572
+ */
1573
+ /**
1574
+ * @typedef PlatformVersion
1575
+ * @property {string} app_code_name
1576
+ * @property {string} app_name
1577
+ * @property {string} force_version
1578
+ * @property {string} latest_version
1579
+ * @property {boolean} is_app_blocked
1580
+ * @property {UpdateDiealog} update_dialog
1581
+ * @property {string} [_id]
1582
+ * @property {string} [modified_at] - ISO 8601 timestamp when currency was added
1583
+ * in the list of currencies supported by the sales channel
1584
+ * @property {string} [created_at] - ISO 8601 timestamp when currency was added
1585
+ * in the list of currencies supported by the sales channel
1586
+ * @property {number} [__v]
1587
+ */
1588
+ /**
1589
+ * @typedef OrderingStoresResponse
1378
1590
  * @property {Page} [page]
1379
1591
  * @property {OrderingStore[]} [items]
1380
1592
  */
1381
1593
  /**
1382
- * @typedef ValidationErrors
1383
- * @property {ValidationError[]} errors
1594
+ * @typedef LocationDefaultLanguage
1595
+ * @property {string} [name]
1596
+ * @property {string} [code]
1597
+ */
1598
+ /**
1599
+ * @typedef LocationDefaultCurrency
1600
+ * @property {string} [name]
1601
+ * @property {string} [symbol]
1602
+ * @property {string} [code]
1603
+ */
1604
+ /**
1605
+ * @typedef LocationCountry
1606
+ * @property {string} [capital]
1607
+ * @property {string} [currency]
1608
+ * @property {string} [iso2]
1609
+ * @property {string} [iso3]
1610
+ * @property {string} [name]
1611
+ * @property {string} [parent]
1612
+ * @property {string} [phone_code]
1613
+ * @property {string} [type]
1614
+ * @property {number} [uid]
1615
+ * @property {number} [__v]
1616
+ * @property {string} [_id]
1617
+ * @property {LocationDefaultCurrency} [default_currency]
1618
+ * @property {LocationDefaultLanguage} [default_language]
1619
+ * @property {string} [state_code]
1620
+ * @property {string} [country_code]
1621
+ * @property {string} [latitude]
1622
+ * @property {string} [longitude]
1623
+ */
1624
+ /**
1625
+ * @typedef Locations
1626
+ * @property {LocationCountry[]} [items]
1627
+ */
1628
+ /**
1629
+ * @typedef UrlRedirectionResponse
1630
+ * @property {UrlRedirection[]} [redirections]
1631
+ */
1632
+ /**
1633
+ * @typedef UrlRedirectionRequest
1634
+ * @property {UrlRedirection} [redirection]
1635
+ */
1636
+ /**
1637
+ * @typedef UrlRedirection
1638
+ * @property {string} [redirect_from]
1639
+ * @property {string} [redirect_to]
1640
+ * @property {string} [type]
1641
+ * @property {string} [_id]
1642
+ */
1643
+ /**
1644
+ * @typedef StoreForConfigurationRequest
1645
+ * @property {AppStoreRules[]} [conf]
1646
+ */
1647
+ /**
1648
+ * @typedef DomainOptionsResponse
1649
+ * @property {DomainType[]} [domain_types]
1650
+ * @property {string[]} [network_ips]
1651
+ * @property {string[]} [network_cnames]
1652
+ */
1653
+ /**
1654
+ * @typedef DomainType
1655
+ * @property {string} [key]
1656
+ * @property {string} [display]
1657
+ * @property {DomainValue[]} [values]
1658
+ */
1659
+ /**
1660
+ * @typedef DomainValue
1661
+ * @property {string} [value]
1662
+ * @property {string} [text]
1663
+ */
1664
+ /**
1665
+ * @typedef StoreRequest
1666
+ * @property {number[]} [companies]
1384
1667
  */
1385
1668
  /**
1386
- * @typedef ValidationError
1387
- * @property {string} message - A brief description of the error encountered.
1388
- * @property {string} field - The field in the request that caused the error.
1669
+ * @typedef StoreResponse
1670
+ * @property {number[]} [data]
1389
1671
  */
1390
1672
  declare class ConfigurationPlatformModel {
1391
1673
  }
1392
1674
  declare namespace ConfigurationPlatformModel {
1393
- export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, 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, ListingPageFeature, RegistrationPageFeature, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
1675
+ export { ApplicationInventory, PiiMasking, OwnerAppInventoryConfig, OwnerAppConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, StoreByBrandsRequest, StoreByBrandsResponse, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponse, ValidationFailedResponse, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequest, CreateAppResponse, ApplicationsResponse, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequest, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequest, Domain, DomainsResponse, UpdateDomain, UpdateDomainTypeRequest, DomainStatusRequest, DomainStatus, DomainStatusResponse, DomainSuggestionsRequest, DomainSuggestion, DomainSuggestionsResponse, SuccessMessageResponse, GetIntegrationsOptInsResponse, IntegrationOptIn, Validators, CompanyValidator, JsonSchema, StoreValidator, InventoryValidator, OrderValidator, IntegrationMeta, Integration, IntegrationConfigResponse, IntegrationLevel, UpdateIntegrationLevelRequest, OptedStoreIntegration, OtherEntity, LastPatch, OtherEntityData, App, InventoryConfig, AppInventory, AppDomain, CompaniesResponse, AppInventoryCompanies, StoresResponse, ListStoreResponse, ArrayStoreResponse, AppInventoryStores, FilterOrderingStoreRequest, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequest, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponse, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponse, 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, ListingPageFeature, RegistrationPageFeature, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, BuyboxFeature, AppFeatureRequest, AppFeatureResponse, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, TokenSchema, InvalidPayloadRequest, InventoryBrandRule, PricingStrategy, StoreCriteriaRule, InventoryStoreRule, InventoryPaymentConfig, StorePriorityRule, ArticleAssignmentRule, InventoryArticleAssignment, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponse, AppCurrencyResponse, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, UpdateDiealog, PlatformVersionRequest, PlatformVersion, OrderingStoresResponse, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations, UrlRedirectionResponse, UrlRedirectionRequest, UrlRedirection, StoreForConfigurationRequest, DomainOptionsResponse, DomainType, DomainValue, StoreRequest, StoreResponse };
1394
1676
  }
1395
- /** @returns {CurrencyExchangeResponseV2} */
1396
- declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
1397
- type CurrencyExchangeResponseV2 = {
1398
- /**
1399
- * - The 3-letter ISO 4217 code representing the base currency.
1400
- */
1401
- base: string;
1402
- /**
1403
- * - The name of the base currency.
1404
- */
1405
- base_currency_name: string;
1406
- /**
1407
- * - Time in seconds for which the exchange rates
1408
- * are valid.
1409
- */
1410
- ttl_seconds: number;
1411
- /**
1412
- * - List of exchange rates and currency details.
1413
- */
1414
- items: CurrencyExchangeItem[];
1415
- /**
1416
- * - Total number of currency exchange items.
1417
- */
1418
- total: number;
1419
- };
1420
- /** @returns {CurrencyExchangeItem} */
1421
- declare function CurrencyExchangeItem(): CurrencyExchangeItem;
1422
- type CurrencyExchangeItem = {
1423
- /**
1424
- * - 3-letter ISO 4217 exchange currency code.
1425
- */
1426
- currency_code: string;
1427
- /**
1428
- * - Name of the exchange currency
1429
- */
1430
- name: string;
1431
- /**
1432
- * - Exchange rate of the currency with respect to the
1433
- * base currency.
1434
- */
1435
- rate: number;
1436
- /**
1437
- * - ISO 3166 country code.
1438
- */
1439
- country_code: string;
1440
- /**
1441
- * - Name of the country using this currency.
1442
- */
1443
- country_name: string;
1444
- /**
1445
- * - The name of the subunit for the currency.
1446
- */
1447
- subunit: string;
1448
- /**
1449
- * - Number of decimal digits the currency supports.
1450
- */
1451
- decimal_digits: number;
1452
- /**
1453
- * - The symbol of the currency.
1454
- */
1455
- symbol: string;
1456
- };
1457
1677
  /** @returns {ApplicationInventory} */
1458
1678
  declare function ApplicationInventory(): ApplicationInventory;
1459
1679
  type ApplicationInventory = {
1460
- search?: SearchConfig;
1461
1680
  inventory?: AppInventoryConfig;
1462
1681
  authentication?: AuthenticationConfig;
1463
1682
  article_assignment?: ArticleAssignmentConfig;
@@ -1512,33 +1731,15 @@ declare function PiiMasking(): PiiMasking;
1512
1731
  type PiiMasking = {
1513
1732
  enabled?: boolean;
1514
1733
  };
1515
- /** @returns {FstIdentification} */
1516
- declare function FstIdentification(): FstIdentification;
1517
- type FstIdentification = {
1518
- /**
1519
- * - Indicates whether FST identification is
1520
- * enabled for the application.
1521
- */
1522
- enabled?: boolean;
1523
- };
1524
- /** @returns {QuerySuggestions} */
1525
- declare function QuerySuggestions(): QuerySuggestions;
1526
- type QuerySuggestions = {
1527
- /**
1528
- * - Indicates whether query suggestions are enabled.
1529
- */
1530
- enabled?: boolean;
1531
- /**
1532
- * - Specifies the maximum number of query
1533
- * suggestions that can be returned.
1534
- */
1535
- max_limit?: number;
1734
+ /** @returns {OwnerAppInventoryConfig} */
1735
+ declare function OwnerAppInventoryConfig(): OwnerAppInventoryConfig;
1736
+ type OwnerAppInventoryConfig = {
1737
+ pricing_strategy?: PricingStrategy;
1536
1738
  };
1537
- /** @returns {SearchConfig} */
1538
- declare function SearchConfig(): SearchConfig;
1539
- type SearchConfig = {
1540
- fst_identification?: FstIdentification;
1541
- query_suggestions?: QuerySuggestions;
1739
+ /** @returns {OwnerAppConfig} */
1740
+ declare function OwnerAppConfig(): OwnerAppConfig;
1741
+ type OwnerAppConfig = {
1742
+ inventory?: OwnerAppInventoryConfig;
1542
1743
  };
1543
1744
  /** @returns {AppInventoryConfig} */
1544
1745
  declare function AppInventoryConfig(): AppInventoryConfig;
@@ -1548,6 +1749,7 @@ type AppInventoryConfig = {
1548
1749
  category?: InventoryCategory;
1549
1750
  price?: InventoryPrice;
1550
1751
  discount?: InventoryDiscount;
1752
+ pricing_strategy?: PricingStrategy;
1551
1753
  /**
1552
1754
  * - Indicates whether out of stock products
1553
1755
  * are allowed to show up on the website
@@ -1566,13 +1768,13 @@ type AppInventoryConfig = {
1566
1768
  /**
1567
1769
  * - List of excluded brands category
1568
1770
  */
1569
- exclude_category?: any[];
1771
+ exclude_category?: number[];
1570
1772
  image?: string[];
1571
1773
  /**
1572
1774
  * - List of selling locations whose
1573
1775
  * inventory is available to the sales channel for displaying on the website
1574
1776
  */
1575
- company_store?: any[];
1777
+ company_store?: number[];
1576
1778
  company_id?: number;
1577
1779
  };
1578
1780
  /** @returns {InventoryBrand} */
@@ -1599,7 +1801,7 @@ type InventoryStore = {
1599
1801
  /**
1600
1802
  * - List of stores
1601
1803
  */
1602
- stores?: any[];
1804
+ stores?: number[];
1603
1805
  /**
1604
1806
  * - Rules to show which brands or companies
1605
1807
  * products should be listed on sales channel.
@@ -1628,7 +1830,7 @@ type InventoryCategory = {
1628
1830
  * - List of categories whose products will be
1629
1831
  * shown on the website
1630
1832
  */
1631
- categories?: any[];
1833
+ categories?: number[];
1632
1834
  };
1633
1835
  /** @returns {InventoryPrice} */
1634
1836
  declare function InventoryPrice(): InventoryPrice;
@@ -1694,7 +1896,7 @@ type StorePriority = {
1694
1896
  * - List of store types for article
1695
1897
  * assignment e.g. warehouse, mall, highstreet
1696
1898
  */
1697
- storetype_order?: any[];
1899
+ storetype_order?: number[];
1698
1900
  };
1699
1901
  /** @returns {AppCartConfig} */
1700
1902
  declare function AppCartConfig(): AppCartConfig;
@@ -1897,7 +2099,6 @@ type LoyaltyPointsConfig = {
1897
2099
  /** @returns {AppInventoryPartialUpdate} */
1898
2100
  declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
1899
2101
  type AppInventoryPartialUpdate = {
1900
- search?: SearchConfig;
1901
2102
  reward_points?: RewardPointsConfig;
1902
2103
  cart?: AppCartConfig;
1903
2104
  payment?: AppPaymentConfig;
@@ -1921,9 +2122,9 @@ type BrandCompanyInfo = {
1921
2122
  */
1922
2123
  company_id?: number;
1923
2124
  };
1924
- /** @returns {CompanyByBrandsRequestSchema} */
1925
- declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
1926
- type CompanyByBrandsRequestSchema = {
2125
+ /** @returns {CompanyByBrandsRequest} */
2126
+ declare function CompanyByBrandsRequest(): CompanyByBrandsRequest;
2127
+ type CompanyByBrandsRequest = {
1927
2128
  /**
1928
2129
  * - Brand UID
1929
2130
  */
@@ -1933,15 +2134,15 @@ type CompanyByBrandsRequestSchema = {
1933
2134
  */
1934
2135
  search_text?: string;
1935
2136
  };
1936
- /** @returns {CompanyByBrandsResponseSchema} */
1937
- declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
1938
- type CompanyByBrandsResponseSchema = {
2137
+ /** @returns {CompanyByBrandsResponse} */
2138
+ declare function CompanyByBrandsResponse(): CompanyByBrandsResponse;
2139
+ type CompanyByBrandsResponse = {
1939
2140
  items?: BrandCompanyInfo[];
1940
2141
  page?: Page;
1941
2142
  };
1942
- /** @returns {StoreByBrandsRequestSchema} */
1943
- declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
1944
- type StoreByBrandsRequestSchema = {
2143
+ /** @returns {StoreByBrandsRequest} */
2144
+ declare function StoreByBrandsRequest(): StoreByBrandsRequest;
2145
+ type StoreByBrandsRequest = {
1945
2146
  /**
1946
2147
  * - Current company ID for current company
1947
2148
  * stores only. Don't send in case cross-selling (franchise) is enabled.
@@ -1956,9 +2157,9 @@ type StoreByBrandsRequestSchema = {
1956
2157
  */
1957
2158
  search_text?: string;
1958
2159
  };
1959
- /** @returns {StoreByBrandsResponseSchema} */
1960
- declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
1961
- type StoreByBrandsResponseSchema = {
2160
+ /** @returns {StoreByBrandsResponse} */
2161
+ declare function StoreByBrandsResponse(): StoreByBrandsResponse;
2162
+ type StoreByBrandsResponse = {
1962
2163
  items?: BrandStoreInfo[];
1963
2164
  page?: Page;
1964
2165
  };
@@ -2011,18 +2212,22 @@ type CompanyBrandInfo = {
2011
2212
  */
2012
2213
  brand_banner_portrait_url?: string;
2013
2214
  };
2014
- /** @returns {BrandsByCompanyResponseSchema} */
2015
- declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
2016
- type BrandsByCompanyResponseSchema = {
2215
+ /** @returns {BrandsByCompanyResponse} */
2216
+ declare function BrandsByCompanyResponse(): BrandsByCompanyResponse;
2217
+ type BrandsByCompanyResponse = {
2017
2218
  brands?: CompanyBrandInfo[];
2018
2219
  };
2019
- /** @returns {ValidationFailedResponseSchema} */
2020
- declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
2021
- type ValidationFailedResponseSchema = {
2220
+ /** @returns {ValidationFailedResponse} */
2221
+ declare function ValidationFailedResponse(): ValidationFailedResponse;
2222
+ type ValidationFailedResponse = {
2022
2223
  /**
2023
2224
  * - Response message for failed validation
2024
2225
  */
2025
2226
  message?: string;
2227
+ /**
2228
+ * - Response message for failed validation
2229
+ */
2230
+ errors?: any[];
2026
2231
  };
2027
2232
  /** @returns {NotFound} */
2028
2233
  declare function NotFound(): NotFound;
@@ -2031,6 +2236,14 @@ type NotFound = {
2031
2236
  * - Response message for not found
2032
2237
  */
2033
2238
  message?: string;
2239
+ /**
2240
+ * - Error message for not found
2241
+ */
2242
+ error?: string;
2243
+ /**
2244
+ * - Unique code for each error
2245
+ */
2246
+ code?: string;
2034
2247
  /**
2035
2248
  * - Flag for required not successfull.
2036
2249
  */
@@ -2069,22 +2282,22 @@ type PanCardConfig = {
2069
2282
  */
2070
2283
  online_threshold_amount?: number;
2071
2284
  };
2072
- /** @returns {CreateApplicationRequestSchema} */
2073
- declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
2074
- type CreateApplicationRequestSchema = {
2285
+ /** @returns {CreateApplicationRequest} */
2286
+ declare function CreateApplicationRequest(): CreateApplicationRequest;
2287
+ type CreateApplicationRequest = {
2075
2288
  app?: App;
2076
2289
  configuration?: ApplicationInventory;
2077
2290
  domain?: AppDomain;
2078
2291
  };
2079
- /** @returns {CreateAppResponseSchema} */
2080
- declare function CreateAppResponseSchema(): CreateAppResponseSchema;
2081
- type CreateAppResponseSchema = {
2292
+ /** @returns {CreateAppResponse} */
2293
+ declare function CreateAppResponse(): CreateAppResponse;
2294
+ type CreateAppResponse = {
2082
2295
  app?: Application;
2083
2296
  configuration?: ApplicationInventory;
2084
2297
  };
2085
- /** @returns {ApplicationsResponseSchema} */
2086
- declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
2087
- type ApplicationsResponseSchema = {
2298
+ /** @returns {ApplicationsResponse} */
2299
+ declare function ApplicationsResponse(): ApplicationsResponse;
2300
+ type ApplicationsResponse = {
2088
2301
  items?: Application[];
2089
2302
  page?: Page;
2090
2303
  };
@@ -2159,9 +2372,9 @@ type SplashImage = {
2159
2372
  */
2160
2373
  secure_url?: string;
2161
2374
  };
2162
- /** @returns {MobileAppConfigRequestSchema} */
2163
- declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
2164
- type MobileAppConfigRequestSchema = {
2375
+ /** @returns {MobileAppConfigRequest} */
2376
+ declare function MobileAppConfigRequest(): MobileAppConfigRequest;
2377
+ type MobileAppConfigRequest = {
2165
2378
  /**
2166
2379
  * - Name of the mobile app
2167
2380
  */
@@ -2303,9 +2516,9 @@ type DomainAdd = {
2303
2516
  message?: string;
2304
2517
  txt_records?: string[];
2305
2518
  };
2306
- /** @returns {DomainAddRequestSchema} */
2307
- declare function DomainAddRequestSchema(): DomainAddRequestSchema;
2308
- type DomainAddRequestSchema = {
2519
+ /** @returns {DomainAddRequest} */
2520
+ declare function DomainAddRequest(): DomainAddRequest;
2521
+ type DomainAddRequest = {
2309
2522
  domain?: DomainAdd;
2310
2523
  };
2311
2524
  /** @returns {Domain} */
@@ -2340,9 +2553,9 @@ type Domain = {
2340
2553
  is_predefined?: boolean;
2341
2554
  message?: string;
2342
2555
  };
2343
- /** @returns {DomainsResponseSchema} */
2344
- declare function DomainsResponseSchema(): DomainsResponseSchema;
2345
- type DomainsResponseSchema = {
2556
+ /** @returns {DomainsResponse} */
2557
+ declare function DomainsResponse(): DomainsResponse;
2558
+ type DomainsResponse = {
2346
2559
  domains?: Domain[];
2347
2560
  };
2348
2561
  /** @returns {UpdateDomain} */
@@ -2373,9 +2586,9 @@ type UpdateDomain = {
2373
2586
  */
2374
2587
  is_shortlink?: boolean;
2375
2588
  };
2376
- /** @returns {UpdateDomainTypeRequestSchema} */
2377
- declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
2378
- type UpdateDomainTypeRequestSchema = {
2589
+ /** @returns {UpdateDomainTypeRequest} */
2590
+ declare function UpdateDomainTypeRequest(): UpdateDomainTypeRequest;
2591
+ type UpdateDomainTypeRequest = {
2379
2592
  domain?: UpdateDomain;
2380
2593
  /**
2381
2594
  * - Shows domain is made primary domain for the
@@ -2383,9 +2596,9 @@ type UpdateDomainTypeRequestSchema = {
2383
2596
  */
2384
2597
  action?: string;
2385
2598
  };
2386
- /** @returns {DomainStatusRequestSchema} */
2387
- declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
2388
- type DomainStatusRequestSchema = {
2599
+ /** @returns {DomainStatusRequest} */
2600
+ declare function DomainStatusRequest(): DomainStatusRequest;
2601
+ type DomainStatusRequest = {
2389
2602
  /**
2390
2603
  * - URL of the domain, e.g. uniket.hostx0.de
2391
2604
  */
@@ -2404,9 +2617,9 @@ type DomainStatus = {
2404
2617
  */
2405
2618
  status?: boolean;
2406
2619
  };
2407
- /** @returns {DomainStatusResponseSchema} */
2408
- declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
2409
- type DomainStatusResponseSchema = {
2620
+ /** @returns {DomainStatusResponse} */
2621
+ declare function DomainStatusResponse(): DomainStatusResponse;
2622
+ type DomainStatusResponse = {
2410
2623
  /**
2411
2624
  * - Check if domain is live and mapped to
2412
2625
  * appropriate IP of Fynd Servers
@@ -2414,18 +2627,13 @@ type DomainStatusResponseSchema = {
2414
2627
  connected?: boolean;
2415
2628
  status?: DomainStatus[];
2416
2629
  };
2417
- /** @returns {DomainSuggestionsRequestSchema} */
2418
- declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
2419
- type DomainSuggestionsRequestSchema = {
2630
+ /** @returns {DomainSuggestionsRequest} */
2631
+ declare function DomainSuggestionsRequest(): DomainSuggestionsRequest;
2632
+ type DomainSuggestionsRequest = {
2420
2633
  /**
2421
2634
  * - Domain url
2422
2635
  */
2423
2636
  domain_url?: string;
2424
- /**
2425
- * - Get suggestions for custom domains or
2426
- * Fynd domains
2427
- */
2428
- custom_domain?: boolean;
2429
2637
  };
2430
2638
  /** @returns {DomainSuggestion} */
2431
2639
  declare function DomainSuggestion(): DomainSuggestion;
@@ -2453,17 +2661,17 @@ type DomainSuggestion = {
2453
2661
  */
2454
2662
  currency?: string;
2455
2663
  };
2456
- /** @returns {DomainSuggestionsResponseSchema} */
2457
- declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
2458
- type DomainSuggestionsResponseSchema = {
2664
+ /** @returns {DomainSuggestionsResponse} */
2665
+ declare function DomainSuggestionsResponse(): DomainSuggestionsResponse;
2666
+ type DomainSuggestionsResponse = {
2459
2667
  /**
2460
2668
  * - Domain URL
2461
2669
  */
2462
2670
  domains?: DomainSuggestion[];
2463
2671
  };
2464
- /** @returns {SuccessMessageResponseSchema} */
2465
- declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
2466
- type SuccessMessageResponseSchema = {
2672
+ /** @returns {SuccessMessageResponse} */
2673
+ declare function SuccessMessageResponse(): SuccessMessageResponse;
2674
+ type SuccessMessageResponse = {
2467
2675
  /**
2468
2676
  * - Shows whether domain was deleted successfully
2469
2677
  */
@@ -2473,74 +2681,474 @@ type SuccessMessageResponseSchema = {
2473
2681
  */
2474
2682
  message?: string;
2475
2683
  };
2476
- /** @returns {App} */
2477
- declare function App(): App;
2478
- type App = {
2684
+ /** @returns {GetIntegrationsOptInsResponse} */
2685
+ declare function GetIntegrationsOptInsResponse(): GetIntegrationsOptInsResponse;
2686
+ type GetIntegrationsOptInsResponse = {
2687
+ items?: IntegrationOptIn[];
2688
+ page?: Page;
2689
+ };
2690
+ /** @returns {IntegrationOptIn} */
2691
+ declare function IntegrationOptIn(): IntegrationOptIn;
2692
+ type IntegrationOptIn = {
2693
+ validators?: Validators;
2479
2694
  /**
2480
- * - Numeric ID allotted to a business account
2481
- * on Fynd Platform.
2695
+ * - Basic description about the opted integration
2482
2696
  */
2483
- company_id?: string;
2697
+ description?: string;
2484
2698
  /**
2485
- * - It indicates different channel types like
2486
- * store, website-and-mobile-apps. Default value is store
2699
+ * - Basic HTML description about the
2700
+ * opted integration
2487
2701
  */
2488
- channel_type?: string;
2489
- auth?: ApplicationAuth;
2702
+ description_html?: string;
2703
+ constants?: string;
2704
+ companies?: string[];
2705
+ support?: string[];
2490
2706
  /**
2491
- * - User-friendly name for sales channel, e.g. Zenz Fashion
2707
+ * - The unique identifier (24-digit Mongo Object ID)
2708
+ * of the opted integration
2492
2709
  */
2493
- name?: string;
2710
+ _id?: string;
2494
2711
  /**
2495
- * - Detailed description about the sales channel
2712
+ * - Nmae of the opted integration, e.g. SAP RBL Integration
2496
2713
  */
2497
- desc?: string;
2498
- };
2499
- /** @returns {AppDomain} */
2500
- declare function AppDomain(): AppDomain;
2501
- type AppDomain = {
2714
+ name?: string;
2502
2715
  /**
2503
- * - Domain URL of current sales channel, e.g. zenz.com
2716
+ * - Slug of the opted integration, e.g. ginesys
2504
2717
  */
2505
- name?: string;
2506
- };
2507
- /** @returns {CompaniesResponseSchema} */
2508
- declare function CompaniesResponseSchema(): CompaniesResponseSchema;
2509
- type CompaniesResponseSchema = {
2510
- items?: AppInventoryCompanies[];
2511
- page?: Page;
2512
- };
2513
- /** @returns {AppInventoryCompanies} */
2514
- declare function AppInventoryCompanies(): AppInventoryCompanies;
2515
- type AppInventoryCompanies = {
2718
+ slug?: string;
2719
+ hidden?: boolean;
2720
+ meta?: IntegrationMeta[];
2516
2721
  /**
2517
- * - UID of the company, e.g. 108
2722
+ * - Hosted URL of the icon image
2518
2723
  */
2519
- uid?: number;
2724
+ icon?: string;
2520
2725
  /**
2521
- * - Name of the company, e.g. Newton Traders
2726
+ * - The unique identifier (24-digit Mongo Object ID)
2727
+ * of the user who created the integration
2522
2728
  */
2523
- name?: string;
2729
+ owner?: string;
2524
2730
  /**
2525
- * - Indicates the type of the company, e.g.
2526
- * franchisee, distributor, etc.
2731
+ * - ISO 8601 timestamp of integration creation
2527
2732
  */
2528
- company_type?: string;
2529
- };
2530
- /** @returns {StoresResponseSchema} */
2531
- declare function StoresResponseSchema(): StoresResponseSchema;
2532
- type StoresResponseSchema = {
2533
- items?: AppInventoryStores[];
2534
- page?: Page;
2535
- };
2536
- /** @returns {AppInventoryStores} */
2537
- declare function AppInventoryStores(): AppInventoryStores;
2538
- type AppInventoryStores = {
2733
+ created_at?: string;
2539
2734
  /**
2540
- * - The unique identifier of the store (24-digit Mongo
2541
- * Object ID) in the sales channel inventory
2735
+ * - ISO 8601 timestamp of integration updation
2542
2736
  */
2543
- _id?: string;
2737
+ modified_at?: string;
2738
+ /**
2739
+ * - Randomly generated fixed-length string for opted
2740
+ * integration. It is auto-generated. It would never change once it is generated.
2741
+ */
2742
+ token?: string;
2743
+ /**
2744
+ * - Randomly generated fixed-length string for
2745
+ * opted integration. It is auto-generated. It would never change once it is generated.
2746
+ */
2747
+ secret?: string;
2748
+ /**
2749
+ * - Version key for tracking revisions. Default value is zero.
2750
+ */
2751
+ __v?: number;
2752
+ };
2753
+ /** @returns {Validators} */
2754
+ declare function Validators(): Validators;
2755
+ type Validators = {
2756
+ company?: CompanyValidator;
2757
+ store?: StoreValidator;
2758
+ inventory?: InventoryValidator;
2759
+ order?: OrderValidator;
2760
+ };
2761
+ /** @returns {CompanyValidator} */
2762
+ declare function CompanyValidator(): CompanyValidator;
2763
+ type CompanyValidator = {
2764
+ json_schema?: JsonSchema[];
2765
+ /**
2766
+ * - Browser script for the company validator
2767
+ */
2768
+ browser_script?: string;
2769
+ };
2770
+ /** @returns {JsonSchema} */
2771
+ declare function JsonSchema(): JsonSchema;
2772
+ type JsonSchema = {
2773
+ /**
2774
+ * - Display text of the validator JSON schema. It
2775
+ * will show in the UI.
2776
+ */
2777
+ display?: string;
2778
+ /**
2779
+ * - Key related to the display text of the validator JSON schema
2780
+ */
2781
+ key?: string;
2782
+ /**
2783
+ * - Indicates the type of form field, e.g. Text, Dropdown.
2784
+ */
2785
+ type?: string;
2786
+ /**
2787
+ * - Tooltip text for the UI of the validator JSON
2788
+ * schema. It will show in the UI.
2789
+ */
2790
+ tooltip?: string;
2791
+ };
2792
+ /** @returns {StoreValidator} */
2793
+ declare function StoreValidator(): StoreValidator;
2794
+ type StoreValidator = {
2795
+ json_schema?: JsonSchema[];
2796
+ /**
2797
+ * - Browser script for the store validator
2798
+ */
2799
+ browser_script?: string;
2800
+ };
2801
+ /** @returns {InventoryValidator} */
2802
+ declare function InventoryValidator(): InventoryValidator;
2803
+ type InventoryValidator = {
2804
+ json_schema?: JsonSchema[];
2805
+ /**
2806
+ * - Browser script for the inventory validator
2807
+ */
2808
+ browser_script?: string;
2809
+ };
2810
+ /** @returns {OrderValidator} */
2811
+ declare function OrderValidator(): OrderValidator;
2812
+ type OrderValidator = {
2813
+ json_schema?: JsonSchema[];
2814
+ /**
2815
+ * - Browser script for the order validator
2816
+ */
2817
+ browser_script?: string;
2818
+ };
2819
+ /** @returns {IntegrationMeta} */
2820
+ declare function IntegrationMeta(): IntegrationMeta;
2821
+ type IntegrationMeta = {
2822
+ is_public?: boolean;
2823
+ /**
2824
+ * - The unique identifier (24-digit Mongo Object ID)
2825
+ * of the integration meta
2826
+ */
2827
+ _id?: string;
2828
+ /**
2829
+ * - Nmae of integration meta, e.g. price_level
2830
+ */
2831
+ name?: string;
2832
+ /**
2833
+ * - Value related to integration meta name, e.g. store
2834
+ */
2835
+ value?: string;
2836
+ };
2837
+ /** @returns {Integration} */
2838
+ declare function Integration(): Integration;
2839
+ type Integration = {
2840
+ validators?: Validators;
2841
+ /**
2842
+ * - Basic description about the integration
2843
+ */
2844
+ description?: string;
2845
+ /**
2846
+ * - Basic HTML description about the integration
2847
+ */
2848
+ description_html?: string;
2849
+ constants?: any;
2850
+ companies?: string[];
2851
+ support?: string[];
2852
+ /**
2853
+ * - The unique identifier (24-digit Mongo Object ID)
2854
+ * of the integration
2855
+ */
2856
+ _id?: string;
2857
+ /**
2858
+ * - Name of the integration, e.g. SAP RBL Integration
2859
+ */
2860
+ name?: string;
2861
+ /**
2862
+ * - Name of the integration, e.g. SAP RBL Integration
2863
+ */
2864
+ slug?: string;
2865
+ meta?: IntegrationMeta[];
2866
+ /**
2867
+ * - Hosted URL of the icon image
2868
+ */
2869
+ icon?: string;
2870
+ hidden?: boolean;
2871
+ /**
2872
+ * - The unique identifier (24-digit Mongo Object ID)
2873
+ * of the user who created the integration
2874
+ */
2875
+ owner?: string;
2876
+ /**
2877
+ * - ISO 8601 timestamp of integration creation
2878
+ */
2879
+ created_at?: string;
2880
+ /**
2881
+ * - ISO 8601 timestamp of integration updation
2882
+ */
2883
+ modified_at?: string;
2884
+ /**
2885
+ * - Randomly generated fixed-length string for opted
2886
+ * integration. It is auto-generated. It would never change once it is generated.
2887
+ */
2888
+ token?: string;
2889
+ /**
2890
+ * - Randomly generated fixed-length string for
2891
+ * opted integration. It is auto-generated. It would never change once it is generated.
2892
+ */
2893
+ secret?: string;
2894
+ /**
2895
+ * - Version key for tracking revisions. Default value is zero.
2896
+ */
2897
+ __v?: number;
2898
+ };
2899
+ /** @returns {IntegrationConfigResponse} */
2900
+ declare function IntegrationConfigResponse(): IntegrationConfigResponse;
2901
+ type IntegrationConfigResponse = {
2902
+ items?: IntegrationLevel[];
2903
+ };
2904
+ /** @returns {IntegrationLevel} */
2905
+ declare function IntegrationLevel(): IntegrationLevel;
2906
+ type IntegrationLevel = {
2907
+ /**
2908
+ * - Shows this integration is opted or not opted
2909
+ * for the current company
2910
+ */
2911
+ opted?: boolean;
2912
+ permissions?: any[];
2913
+ last_patch?: LastPatch[];
2914
+ /**
2915
+ * - The unique identifier (24-digit Mongo Object ID)
2916
+ * of the integration config
2917
+ */
2918
+ _id?: string;
2919
+ /**
2920
+ * - Integration id. Shows which integration
2921
+ * you are enabling.
2922
+ */
2923
+ integration?: string;
2924
+ /**
2925
+ * - Shows for what level the integration is set up.
2926
+ * It can be company level or store level.
2927
+ */
2928
+ level?: string;
2929
+ /**
2930
+ * - It can be store uid or company uid. Depends on the
2931
+ * level of integration.
2932
+ */
2933
+ uid?: number;
2934
+ /**
2935
+ * - Unique id of company.
2936
+ */
2937
+ company_id?: number;
2938
+ meta?: IntegrationMeta[];
2939
+ /**
2940
+ * - Randomly generated fixed-length string for opted
2941
+ * integration. It is auto-generated. It would never change once it is generated.
2942
+ */
2943
+ token?: string;
2944
+ /**
2945
+ * - ISO 8601 timestamp of integration config creation
2946
+ */
2947
+ created_at?: string;
2948
+ /**
2949
+ * - ISO 8601 timestamp of integration config updation
2950
+ */
2951
+ modified_at?: string;
2952
+ /**
2953
+ * - Version key for tracking revisions. Default value is zero.
2954
+ */
2955
+ __v?: number;
2956
+ /**
2957
+ * - Schema data of the integration stored in key-value pairs
2958
+ */
2959
+ data?: any;
2960
+ success?: boolean;
2961
+ message?: string;
2962
+ };
2963
+ /** @returns {UpdateIntegrationLevelRequest} */
2964
+ declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
2965
+ type UpdateIntegrationLevelRequest = {
2966
+ items?: IntegrationLevel[];
2967
+ };
2968
+ /** @returns {OptedStoreIntegration} */
2969
+ declare function OptedStoreIntegration(): OptedStoreIntegration;
2970
+ type OptedStoreIntegration = {
2971
+ /**
2972
+ * - Allow user to opt same store in other integration
2973
+ */
2974
+ other_opted?: boolean;
2975
+ other_integration?: IntegrationOptIn;
2976
+ other_entity?: OtherEntity;
2977
+ };
2978
+ /** @returns {OtherEntity} */
2979
+ declare function OtherEntity(): OtherEntity;
2980
+ type OtherEntity = {
2981
+ /**
2982
+ * - Allow other entity opted in integration
2983
+ */
2984
+ opted?: boolean;
2985
+ permissions?: string[];
2986
+ last_patch?: LastPatch[];
2987
+ /**
2988
+ * - The unique identifier of the other entity for
2989
+ * opted store integration
2990
+ */
2991
+ _id?: string;
2992
+ /**
2993
+ * - Integration ID. Shows which integration
2994
+ * you are enabling.
2995
+ */
2996
+ integration?: string;
2997
+ /**
2998
+ * - Indicates integration level. It can be company
2999
+ * level or store level.
3000
+ */
3001
+ level?: string;
3002
+ /**
3003
+ * - It can be store uid or company uid. Depends on the
3004
+ * level of integration.
3005
+ */
3006
+ uid?: number;
3007
+ data?: OtherEntityData;
3008
+ meta?: any[];
3009
+ /**
3010
+ * - Randomly generated fixed-length string for opted
3011
+ * integration. It is auto-generated. It would never change once it is generated.
3012
+ */
3013
+ token?: string;
3014
+ /**
3015
+ * - ISO 8601 timestamp of other entity creation
3016
+ * for opted store integration
3017
+ */
3018
+ created_at?: string;
3019
+ /**
3020
+ * - ISO 8601 timestamp of other entity
3021
+ * updation for opted store integration
3022
+ */
3023
+ modified_at?: string;
3024
+ /**
3025
+ * - Version key for tracking revisions. Default value is zero.
3026
+ */
3027
+ __v?: number;
3028
+ };
3029
+ /** @returns {LastPatch} */
3030
+ declare function LastPatch(): LastPatch;
3031
+ type LastPatch = {
3032
+ op?: string;
3033
+ path?: string;
3034
+ /**
3035
+ * - It can be inventory level or order level
3036
+ */
3037
+ value?: string;
3038
+ };
3039
+ /** @returns {OtherEntityData} */
3040
+ declare function OtherEntityData(): OtherEntityData;
3041
+ type OtherEntityData = {
3042
+ article_identifier?: string;
3043
+ };
3044
+ /** @returns {App} */
3045
+ declare function App(): App;
3046
+ type App = {
3047
+ /**
3048
+ * - Numeric ID allotted to a business account
3049
+ * on Fynd Platform.
3050
+ */
3051
+ company_id?: string;
3052
+ /**
3053
+ * - It indicates different channel types like
3054
+ * store, website-and-mobile-apps. Default value is store
3055
+ */
3056
+ channel_type?: string;
3057
+ auth?: ApplicationAuth;
3058
+ /**
3059
+ * - User-friendly name for sales channel, e.g. Zenz Fashion
3060
+ */
3061
+ name?: string;
3062
+ /**
3063
+ * - Detailed description about the sales channel
3064
+ */
3065
+ desc?: string;
3066
+ };
3067
+ /** @returns {InventoryConfig} */
3068
+ declare function InventoryConfig(): InventoryConfig;
3069
+ type InventoryConfig = {
3070
+ brand?: InventoryBrandRule;
3071
+ store?: InventoryStoreRule;
3072
+ image?: string[];
3073
+ /**
3074
+ * - Allow other businesses (companies)
3075
+ * to consume the current sales channel's inventory and sell products
3076
+ */
3077
+ franchise_enabled?: boolean;
3078
+ /**
3079
+ * - Indicates whether out of stock products
3080
+ * are allowed to show up on the website.
3081
+ */
3082
+ out_of_stock?: boolean;
3083
+ /**
3084
+ * - Show only verified products
3085
+ * (the ones whose data have been verified by the admin)
3086
+ */
3087
+ only_verified_products?: boolean;
3088
+ pricing_strategy?: PricingStrategy;
3089
+ };
3090
+ /** @returns {AppInventory} */
3091
+ declare function AppInventory(): AppInventory;
3092
+ type AppInventory = {
3093
+ inventory?: InventoryConfig;
3094
+ payment?: InventoryPaymentConfig;
3095
+ article_assignment?: InventoryArticleAssignment;
3096
+ };
3097
+ /** @returns {AppDomain} */
3098
+ declare function AppDomain(): AppDomain;
3099
+ type AppDomain = {
3100
+ /**
3101
+ * - Domain URL of current sales channel, e.g. zenz.com
3102
+ */
3103
+ name?: string;
3104
+ };
3105
+ /** @returns {CompaniesResponse} */
3106
+ declare function CompaniesResponse(): CompaniesResponse;
3107
+ type CompaniesResponse = {
3108
+ items?: AppInventoryCompanies[];
3109
+ page?: Page;
3110
+ };
3111
+ /** @returns {AppInventoryCompanies} */
3112
+ declare function AppInventoryCompanies(): AppInventoryCompanies;
3113
+ type AppInventoryCompanies = {
3114
+ /**
3115
+ * - UID of the company, e.g. 108
3116
+ */
3117
+ uid?: number;
3118
+ /**
3119
+ * - Name of the company, e.g. Newton Traders
3120
+ */
3121
+ name?: string;
3122
+ /**
3123
+ * - Indicates the type of the company, e.g.
3124
+ * franchisee, distributor, etc.
3125
+ */
3126
+ company_type?: string;
3127
+ };
3128
+ /** @returns {StoresResponse} */
3129
+ declare function StoresResponse(): StoresResponse;
3130
+ type StoresResponse = {
3131
+ items?: AppInventoryStores[];
3132
+ page?: Page;
3133
+ };
3134
+ /** @returns {ListStoreResponse} */
3135
+ declare function ListStoreResponse(): ListStoreResponse;
3136
+ type ListStoreResponse = {
3137
+ stores?: AppInventoryStores[];
3138
+ };
3139
+ /** @returns {ArrayStoreResponse} */
3140
+ declare function ArrayStoreResponse(): ArrayStoreResponse;
3141
+ type ArrayStoreResponse = {
3142
+ data?: AppInventoryStores[];
3143
+ };
3144
+ /** @returns {AppInventoryStores} */
3145
+ declare function AppInventoryStores(): AppInventoryStores;
3146
+ type AppInventoryStores = {
3147
+ /**
3148
+ * - The unique identifier of the store (24-digit Mongo
3149
+ * Object ID) in the sales channel inventory
3150
+ */
3151
+ _id?: string;
2544
3152
  /**
2545
3153
  * - ISO 8601 timestamp of last known updation
2546
3154
  * to the stores in sales channel inventory
@@ -2578,9 +3186,9 @@ type AppInventoryStores = {
2578
3186
  address?: any;
2579
3187
  integration_type?: any;
2580
3188
  };
2581
- /** @returns {FilterOrderingStoreRequestSchema} */
2582
- declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
2583
- type FilterOrderingStoreRequestSchema = {
3189
+ /** @returns {FilterOrderingStoreRequest} */
3190
+ declare function FilterOrderingStoreRequest(): FilterOrderingStoreRequest;
3191
+ type FilterOrderingStoreRequest = {
2584
3192
  /**
2585
3193
  * - Allow all stores from the ordering stores
2586
3194
  */
@@ -2626,9 +3234,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
2626
3234
  type OrderingStoreConfig = {
2627
3235
  deployment_meta?: DeploymentMeta;
2628
3236
  };
2629
- /** @returns {OrderingStoreSelectRequestSchema} */
2630
- declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
2631
- type OrderingStoreSelectRequestSchema = {
3237
+ /** @returns {OrderingStoreSelectRequest} */
3238
+ declare function OrderingStoreSelectRequest(): OrderingStoreSelectRequest;
3239
+ type OrderingStoreSelectRequest = {
2632
3240
  ordering_store: OrderingStoreSelect;
2633
3241
  };
2634
3242
  /** @returns {OrderingStoreSelect} */
@@ -2684,9 +3292,9 @@ type OtherSellerApplications = {
2684
3292
  items?: OtherSellerApplication[];
2685
3293
  page?: Page;
2686
3294
  };
2687
- /** @returns {OptedApplicationResponseSchema} */
2688
- declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
2689
- type OptedApplicationResponseSchema = {
3295
+ /** @returns {OptedApplicationResponse} */
3296
+ declare function OptedApplicationResponse(): OptedApplicationResponse;
3297
+ type OptedApplicationResponse = {
2690
3298
  /**
2691
3299
  * - Name of the other seller's sales channel
2692
3300
  */
@@ -2798,9 +3406,9 @@ type OptOutInventory = {
2798
3406
  */
2799
3407
  company: number[];
2800
3408
  };
2801
- /** @returns {TokenResponseSchema} */
2802
- declare function TokenResponseSchema(): TokenResponseSchema;
2803
- type TokenResponseSchema = {
3409
+ /** @returns {TokenResponse} */
3410
+ declare function TokenResponse(): TokenResponse;
3411
+ type TokenResponse = {
2804
3412
  tokens?: Tokens;
2805
3413
  /**
2806
3414
  * - The unique identifier (24-digit Mongo Object ID)
@@ -3161,6 +3769,7 @@ type AppFeature = {
3161
3769
  qr?: QrFeature;
3162
3770
  pcr?: PcrFeature;
3163
3771
  order?: OrderFeature;
3772
+ buybox?: BuyboxFeature;
3164
3773
  /**
3165
3774
  * - The unique identifier (24-digit Mongo Object ID)
3166
3775
  * for the sales channel features
@@ -3184,6 +3793,7 @@ type AppFeature = {
3184
3793
  * - Version key for tracking revisions. Default value is zero
3185
3794
  */
3186
3795
  __v?: number;
3796
+ pricing_strategy?: PricingStrategy;
3187
3797
  };
3188
3798
  /** @returns {HomePageFeature} */
3189
3799
  declare function HomePageFeature(): HomePageFeature;
@@ -3362,14 +3972,34 @@ type OrderFeature = {
3362
3972
  */
3363
3973
  buy_again?: boolean;
3364
3974
  };
3365
- /** @returns {AppFeatureRequestSchema} */
3366
- declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
3367
- type AppFeatureRequestSchema = {
3975
+ /** @returns {BuyboxFeature} */
3976
+ declare function BuyboxFeature(): BuyboxFeature;
3977
+ type BuyboxFeature = {
3978
+ /**
3979
+ * - Allow users to see seller/stores name on
3980
+ * PDP (product detail page).
3981
+ */
3982
+ show_name?: boolean;
3983
+ /**
3984
+ * - Allow selection of sellers/stores on
3985
+ * PDP (product detail page).
3986
+ */
3987
+ enable_selection?: boolean;
3988
+ /**
3989
+ * - Toggle buybox listing
3990
+ * between sellers and stores. True indicates seller listing, while False
3991
+ * indicates store listing.
3992
+ */
3993
+ is_seller_buybox_enabled?: boolean;
3994
+ };
3995
+ /** @returns {AppFeatureRequest} */
3996
+ declare function AppFeatureRequest(): AppFeatureRequest;
3997
+ type AppFeatureRequest = {
3368
3998
  feature?: AppFeature;
3369
3999
  };
3370
- /** @returns {AppFeatureResponseSchema} */
3371
- declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
3372
- type AppFeatureResponseSchema = {
4000
+ /** @returns {AppFeatureResponse} */
4001
+ declare function AppFeatureResponse(): AppFeatureResponse;
4002
+ type AppFeatureResponse = {
3373
4003
  feature?: AppFeature;
3374
4004
  };
3375
4005
  /** @returns {Currency} */
@@ -3410,7 +4040,7 @@ type Currency = {
3410
4040
  */
3411
4041
  decimal_digits?: number;
3412
4042
  /**
3413
- * - Unique symbol for identifying the currency, e.g.
4043
+ * - Unique symbol for identifying the currency, e.g. ₹
3414
4044
  */
3415
4045
  symbol?: string;
3416
4046
  country_name?: string;
@@ -3565,121 +4195,117 @@ type Application = {
3565
4195
  tokens?: TokenSchema[];
3566
4196
  secret?: string;
3567
4197
  };
3568
- /** @returns {ApplicationById} */
3569
- declare function ApplicationById(): ApplicationById;
3570
- type ApplicationById = {
3571
- website?: ApplicationWebsite;
3572
- cors?: ApplicationCors;
3573
- auth?: ApplicationAuth;
4198
+ /** @returns {TokenSchema} */
4199
+ declare function TokenSchema(): TokenSchema;
4200
+ type TokenSchema = {
4201
+ token?: string;
4202
+ created_by?: any;
3574
4203
  /**
3575
- * - It contains detailed information about the
3576
- * sales channel.
4204
+ * - ISO 8601 timestamp of when token created
3577
4205
  */
3578
- description?: string;
4206
+ created_at?: string;
4207
+ };
4208
+ /** @returns {InvalidPayloadRequest} */
4209
+ declare function InvalidPayloadRequest(): InvalidPayloadRequest;
4210
+ type InvalidPayloadRequest = {
3579
4211
  /**
3580
- * - It indicates different types of channels,
3581
- * such as store, website, and mobile apps, with 'store' being the default value.
4212
+ * - Error message when request body payload is improper
3582
4213
  */
3583
- channel_type?: string;
4214
+ message?: string;
3584
4215
  /**
3585
- * - An integer value that specifies the number
3586
- * of seconds until the key expires
4216
+ * - Flag for required not successfull.
3587
4217
  */
3588
- cache_ttl?: number;
4218
+ success?: boolean;
3589
4219
  /**
3590
- * - Indicates whether a sales channel is
3591
- * internal or not
4220
+ * - All errors related to domin
3592
4221
  */
3593
- is_internal?: boolean;
4222
+ domain?: any;
4223
+ };
4224
+ /** @returns {InventoryBrandRule} */
4225
+ declare function InventoryBrandRule(): InventoryBrandRule;
4226
+ type InventoryBrandRule = {
3594
4227
  /**
3595
- * - Indicates sales channel is active or not active
4228
+ * - Whether all brands are enabled, or explicitly
4229
+ * few brands in the inventory
3596
4230
  */
3597
- is_active?: boolean;
4231
+ criteria?: string;
4232
+ brands?: number[];
4233
+ };
4234
+ /** @returns {PricingStrategy} */
4235
+ declare function PricingStrategy(): PricingStrategy;
4236
+ type PricingStrategy = {
3598
4237
  /**
3599
- * - The unique identifier (24-digit Mongo Object ID)
3600
- * of the sales channel
4238
+ * - Indicates the pricing strategy value.
3601
4239
  */
3602
- _id?: string;
4240
+ value?: string;
4241
+ };
4242
+ /** @returns {StoreCriteriaRule} */
4243
+ declare function StoreCriteriaRule(): StoreCriteriaRule;
4244
+ type StoreCriteriaRule = {
3603
4245
  /**
3604
- * - Name of the sales channel, e.g. Zenz Fashion
4246
+ * - List of company UID
3605
4247
  */
3606
- name?: string;
4248
+ companies?: number[];
3607
4249
  /**
3608
- * - The unique identifier (24-digit Mongo Object ID)
3609
- * of owner who owns the application
4250
+ * - List of brand UID
3610
4251
  */
3611
- owner?: string;
4252
+ brands?: number[];
4253
+ };
4254
+ /** @returns {InventoryStoreRule} */
4255
+ declare function InventoryStoreRule(): InventoryStoreRule;
4256
+ type InventoryStoreRule = {
3612
4257
  /**
3613
- * - Numeric ID allotted to a business account
3614
- * where the sales channel exists
4258
+ * - Whether all stores are enabled, or explicitly
4259
+ * few stores in the inventory, or use brands and company filter.
3615
4260
  */
3616
- company_id?: number;
3617
- /**
3618
- * - Random generated fix length string for sales
3619
- * channel. It is required and auto-generated.
3620
- */
3621
- token?: string;
3622
- redirections?: ApplicationRedirections[];
3623
- meta?: ApplicationMeta[];
4261
+ criteria?: string;
3624
4262
  /**
3625
- * - ISO 8601 timestamp of sales channel creation
4263
+ * - List of rules with company and
4264
+ * brands uids. Used when critera is `filter`.
3626
4265
  */
3627
- created_at?: string;
4266
+ rules?: StoreCriteriaRule[];
3628
4267
  /**
3629
- * - ISO 8601 timestamp of sales channel updation
4268
+ * - List of store uids. Used when critera is `explicit`.
3630
4269
  */
3631
- modified_at?: string;
4270
+ stores?: number[];
4271
+ };
4272
+ /** @returns {InventoryPaymentConfig} */
4273
+ declare function InventoryPaymentConfig(): InventoryPaymentConfig;
4274
+ type InventoryPaymentConfig = {
3632
4275
  /**
3633
- * - Version key for tracking revisions. Default value is zero.
4276
+ * - Mode of payment for the inventory of
4277
+ * sales channel. It is required and default value is null.
3634
4278
  */
3635
- __v?: number;
3636
- banner?: SecureUrl;
3637
- logo?: SecureUrl;
3638
- favicon?: SecureUrl;
3639
- domains?: Domain[];
4279
+ mode_of_payment?: string;
3640
4280
  /**
3641
- * - It shows application is live or in development mode.
4281
+ * - Source of the payment mode for the inventory
4282
+ * payment of sales channel. Default value is FYND.
3642
4283
  */
3643
- app_type?: string;
3644
- mobile_logo?: SecureUrl;
3645
- domain?: Domain;
3646
- slug?: string;
3647
- mode?: string;
3648
- status?: string;
3649
- tokens?: TokenSchemaID[];
3650
- secret?: string;
4284
+ source?: string;
3651
4285
  };
3652
- /** @returns {TokenSchemaID} */
3653
- declare function TokenSchemaID(): TokenSchemaID;
3654
- type TokenSchemaID = {
3655
- token?: string;
3656
- created_by?: string;
4286
+ /** @returns {StorePriorityRule} */
4287
+ declare function StorePriorityRule(): StorePriorityRule;
4288
+ type StorePriorityRule = {
3657
4289
  /**
3658
- * - ISO 8601 timestamp of when token created
4290
+ * - Shows store priority is enabled or not
4291
+ * enabled for the article assignment.
3659
4292
  */
3660
- created_at?: string;
4293
+ enabled?: boolean;
4294
+ storetype_order?: string[];
3661
4295
  };
3662
- /** @returns {TokenSchema} */
3663
- declare function TokenSchema(): TokenSchema;
3664
- type TokenSchema = {
3665
- token?: string;
3666
- created_by?: any;
3667
- /**
3668
- * - ISO 8601 timestamp of when token created
3669
- */
3670
- created_at?: string;
4296
+ /** @returns {ArticleAssignmentRule} */
4297
+ declare function ArticleAssignmentRule(): ArticleAssignmentRule;
4298
+ type ArticleAssignmentRule = {
4299
+ store_priority?: StorePriorityRule;
3671
4300
  };
3672
- /** @returns {InvalidPayloadRequestSchema} */
3673
- declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
3674
- type InvalidPayloadRequestSchema = {
3675
- /**
3676
- * - Error message when request body payload is improper
3677
- */
3678
- message?: string;
4301
+ /** @returns {InventoryArticleAssignment} */
4302
+ declare function InventoryArticleAssignment(): InventoryArticleAssignment;
4303
+ type InventoryArticleAssignment = {
3679
4304
  /**
3680
- * - Flag for required not successfull.
4305
+ * - Allow post order reassigment of article
3681
4306
  */
3682
- success?: boolean;
4307
+ post_order_reassignment?: boolean;
4308
+ rules?: ArticleAssignmentRule;
3683
4309
  };
3684
4310
  /** @returns {Page} */
3685
4311
  declare function Page(): Page;
@@ -3712,6 +4338,10 @@ type Page = {
3712
4338
  * - The number of items per page.
3713
4339
  */
3714
4340
  size?: number;
4341
+ /**
4342
+ * - Total number of items.
4343
+ */
4344
+ total?: number;
3715
4345
  };
3716
4346
  /** @returns {ApplicationInformation} */
3717
4347
  declare function ApplicationInformation(): ApplicationInformation;
@@ -4046,14 +4676,14 @@ type ApplicationDetail = {
4046
4676
  slug?: string;
4047
4677
  company_id?: number;
4048
4678
  };
4049
- /** @returns {CurrenciesResponseSchema} */
4050
- declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
4051
- type CurrenciesResponseSchema = {
4679
+ /** @returns {CurrenciesResponse} */
4680
+ declare function CurrenciesResponse(): CurrenciesResponse;
4681
+ type CurrenciesResponse = {
4052
4682
  items?: Currency[];
4053
4683
  };
4054
- /** @returns {AppCurrencyResponseSchema} */
4055
- declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
4056
- type AppCurrencyResponseSchema = {
4684
+ /** @returns {AppCurrencyResponse} */
4685
+ declare function AppCurrencyResponse(): AppCurrencyResponse;
4686
+ type AppCurrencyResponse = {
4057
4687
  /**
4058
4688
  * - The unique identifier (24-digit Mongo Object ID)
4059
4689
  * of the currency configuration supported by the application
@@ -4105,7 +4735,7 @@ type OptedStoreAddress = {
4105
4735
  /**
4106
4736
  * - 6-digit PIN code of the opted store location
4107
4737
  */
4108
- pincode?: number;
4738
+ pincode?: string;
4109
4739
  /**
4110
4740
  * - Country of the opted store, e.g. India
4111
4741
  */
@@ -4126,6 +4756,10 @@ type OptedStoreAddress = {
4126
4756
  * - Selected state code
4127
4757
  */
4128
4758
  state_code?: string;
4759
+ /**
4760
+ * - Landmark of the address
4761
+ */
4762
+ landmark?: string;
4129
4763
  };
4130
4764
  /** @returns {OrderingStore} */
4131
4765
  declare function OrderingStore(): OrderingStore;
@@ -4160,7 +4794,7 @@ type OrderingStore = {
4160
4794
  /**
4161
4795
  * - 6-digit PIN Code of the ordering store, e.g. 400001
4162
4796
  */
4163
- pincode?: number;
4797
+ pincode?: string;
4164
4798
  /**
4165
4799
  * - Code of the ordering store (usually same as Store Code)
4166
4800
  */
@@ -4201,26 +4835,139 @@ type OrderingStores = {
4201
4835
  */
4202
4836
  __v?: number;
4203
4837
  };
4204
- /** @returns {OrderingStoresResponseSchema} */
4205
- declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
4206
- type OrderingStoresResponseSchema = {
4207
- page?: Page;
4208
- items?: OrderingStore[];
4209
- };
4210
- /** @returns {ValidationErrors} */
4211
- declare function ValidationErrors(): ValidationErrors;
4212
- type ValidationErrors = {
4213
- errors: ValidationError[];
4214
- };
4215
- /** @returns {ValidationError} */
4216
- declare function ValidationError(): ValidationError;
4217
- type ValidationError = {
4838
+ /** @returns {UpdateDiealog} */
4839
+ declare function UpdateDiealog(): UpdateDiealog;
4840
+ type UpdateDiealog = {
4841
+ type: string;
4842
+ interval?: number;
4843
+ };
4844
+ /** @returns {PlatformVersionRequest} */
4845
+ declare function PlatformVersionRequest(): PlatformVersionRequest;
4846
+ type PlatformVersionRequest = {
4847
+ app_code_name: string;
4848
+ app_name: string;
4849
+ force_version: string;
4850
+ latest_version: string;
4851
+ is_app_blocked: boolean;
4852
+ update_dialog: UpdateDiealog;
4853
+ };
4854
+ /** @returns {PlatformVersion} */
4855
+ declare function PlatformVersion(): PlatformVersion;
4856
+ type PlatformVersion = {
4857
+ app_code_name: string;
4858
+ app_name: string;
4859
+ force_version: string;
4860
+ latest_version: string;
4861
+ is_app_blocked: boolean;
4862
+ update_dialog: UpdateDiealog;
4863
+ _id?: string;
4218
4864
  /**
4219
- * - A brief description of the error encountered.
4865
+ * - ISO 8601 timestamp when currency was added
4866
+ * in the list of currencies supported by the sales channel
4220
4867
  */
4221
- message: string;
4868
+ modified_at?: string;
4222
4869
  /**
4223
- * - The field in the request that caused the error.
4870
+ * - ISO 8601 timestamp when currency was added
4871
+ * in the list of currencies supported by the sales channel
4224
4872
  */
4225
- field: string;
4873
+ created_at?: string;
4874
+ __v?: number;
4875
+ };
4876
+ /** @returns {OrderingStoresResponse} */
4877
+ declare function OrderingStoresResponse(): OrderingStoresResponse;
4878
+ type OrderingStoresResponse = {
4879
+ page?: Page;
4880
+ items?: OrderingStore[];
4881
+ };
4882
+ /** @returns {LocationDefaultLanguage} */
4883
+ declare function LocationDefaultLanguage(): LocationDefaultLanguage;
4884
+ type LocationDefaultLanguage = {
4885
+ name?: string;
4886
+ code?: string;
4887
+ };
4888
+ /** @returns {LocationDefaultCurrency} */
4889
+ declare function LocationDefaultCurrency(): LocationDefaultCurrency;
4890
+ type LocationDefaultCurrency = {
4891
+ name?: string;
4892
+ symbol?: string;
4893
+ code?: string;
4894
+ };
4895
+ /** @returns {LocationCountry} */
4896
+ declare function LocationCountry(): LocationCountry;
4897
+ type LocationCountry = {
4898
+ capital?: string;
4899
+ currency?: string;
4900
+ iso2?: string;
4901
+ iso3?: string;
4902
+ name?: string;
4903
+ parent?: string;
4904
+ phone_code?: string;
4905
+ type?: string;
4906
+ uid?: number;
4907
+ __v?: number;
4908
+ _id?: string;
4909
+ default_currency?: LocationDefaultCurrency;
4910
+ default_language?: LocationDefaultLanguage;
4911
+ state_code?: string;
4912
+ country_code?: string;
4913
+ latitude?: string;
4914
+ longitude?: string;
4915
+ };
4916
+ /** @returns {Locations} */
4917
+ declare function Locations(): Locations;
4918
+ type Locations = {
4919
+ items?: LocationCountry[];
4920
+ };
4921
+ /** @returns {UrlRedirectionResponse} */
4922
+ declare function UrlRedirectionResponse(): UrlRedirectionResponse;
4923
+ type UrlRedirectionResponse = {
4924
+ redirections?: UrlRedirection[];
4925
+ };
4926
+ /** @returns {UrlRedirectionRequest} */
4927
+ declare function UrlRedirectionRequest(): UrlRedirectionRequest;
4928
+ type UrlRedirectionRequest = {
4929
+ redirection?: UrlRedirection;
4930
+ };
4931
+ /** @returns {UrlRedirection} */
4932
+ declare function UrlRedirection(): UrlRedirection;
4933
+ type UrlRedirection = {
4934
+ redirect_from?: string;
4935
+ redirect_to?: string;
4936
+ type?: string;
4937
+ _id?: string;
4938
+ };
4939
+ /** @returns {StoreForConfigurationRequest} */
4940
+ declare function StoreForConfigurationRequest(): StoreForConfigurationRequest;
4941
+ type StoreForConfigurationRequest = {
4942
+ conf?: AppStoreRules[];
4943
+ };
4944
+ /** @returns {DomainOptionsResponse} */
4945
+ declare function DomainOptionsResponse(): DomainOptionsResponse;
4946
+ type DomainOptionsResponse = {
4947
+ domain_types?: DomainType[];
4948
+ network_ips?: string[];
4949
+ network_cnames?: string[];
4950
+ };
4951
+ /** @returns {DomainType} */
4952
+ declare function DomainType(): DomainType;
4953
+ type DomainType = {
4954
+ key?: string;
4955
+ display?: string;
4956
+ values?: DomainValue[];
4957
+ };
4958
+ /** @returns {DomainValue} */
4959
+ declare function DomainValue(): DomainValue;
4960
+ type DomainValue = {
4961
+ value?: string;
4962
+ text?: string;
4963
+ };
4964
+ /** @returns {StoreRequest} */
4965
+ declare function StoreRequest(): StoreRequest;
4966
+ type StoreRequest = {
4967
+ companies?: number[];
4968
+ };
4969
+ /** @returns {StoreResponse} */
4970
+ declare function StoreResponse(): StoreResponse;
4971
+ type StoreResponse = {
4972
+ data?: number[];
4226
4973
  };