@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (310) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
  6. package/sdk/application/Cart/CartApplicationClient.js +157 -530
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -19
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +65 -55
  16. package/sdk/application/Content/ContentApplicationClient.js +211 -341
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
  22. package/sdk/application/Lead/LeadApplicationClient.js +24 -55
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +32 -87
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
  26. package/sdk/application/Order/OrderApplicationClient.js +89 -293
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
  28. package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
  29. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
  31. package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
  32. package/sdk/application/Share/ShareApplicationClient.js +35 -89
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
  34. package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
  35. package/sdk/application/User/UserApplicationClient.d.ts +23 -13
  36. package/sdk/application/User/UserApplicationClient.js +49 -407
  37. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  38. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
  39. package/sdk/common/Utility.d.ts +1 -1
  40. package/sdk/common/Utility.js +10 -7
  41. package/sdk/common/Validator.d.ts +1 -0
  42. package/sdk/common/Validator.js +20 -0
  43. package/sdk/common/utils.d.ts +0 -1
  44. package/sdk/common/utils.js +0 -14
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +18 -62
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  52. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
  54. package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
  55. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
  57. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
  59. package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
  61. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
  62. package/sdk/partner/PartnerClient.d.ts +0 -6
  63. package/sdk/partner/PartnerClient.js +0 -9
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
  65. package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
  66. package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
  67. package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
  68. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
  69. package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
  70. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  71. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  72. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
  73. package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
  74. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  75. package/sdk/partner/index.d.ts +0 -3
  76. package/sdk/partner/index.js +0 -6
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -406
  88. package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
  90. package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
  98. package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
  110. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
  112. package/sdk/platform/Common/CommonPlatformModel.js +11 -14
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +236 -376
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
  117. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
  118. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
  119. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +314 -422
  120. package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
  121. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
  122. package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -68
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  128. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
  132. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +565 -1282
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -246
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
  143. package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
  144. package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
  145. package/sdk/platform/Content/ContentPlatformModel.d.ts +2374 -877
  146. package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
  147. package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
  148. package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
  149. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
  150. package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
  151. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
  152. package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
  153. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  154. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  155. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
  156. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
  157. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
  158. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
  159. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  160. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  161. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
  162. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
  163. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  164. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  165. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  166. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  167. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  168. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  169. package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
  170. package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
  171. package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
  172. package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
  173. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
  174. package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
  175. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
  176. package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
  177. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
  178. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
  179. package/sdk/platform/Order/OrderPlatformClient.d.ts +421 -418
  180. package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
  181. package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
  182. package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
  183. package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
  184. package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
  185. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  186. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  187. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
  188. package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
  189. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
  190. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +934 -2452
  191. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
  192. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -305
  193. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
  194. package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
  195. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1327 -3529
  196. package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
  197. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
  198. package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
  199. package/sdk/platform/PlatformClient.d.ts +0 -2
  200. package/sdk/platform/PlatformClient.js +0 -4
  201. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  202. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  203. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  204. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  205. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
  206. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -513
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
  213. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
  214. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
  215. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
  216. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
  217. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
  218. package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
  219. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
  220. package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
  221. package/sdk/platform/Share/SharePlatformModel.d.ts +53 -4
  222. package/sdk/platform/Share/SharePlatformModel.js +45 -3
  223. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
  224. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
  225. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
  226. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
  227. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
  228. package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
  229. package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
  230. package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
  231. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
  232. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
  233. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
  234. package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
  235. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
  236. package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
  237. package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
  238. package/sdk/platform/User/UserPlatformModel.js +253 -210
  239. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  240. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  241. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
  242. package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
  243. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  244. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  245. package/sdk/platform/index.d.ts +0 -1
  246. package/sdk/platform/index.js +0 -2
  247. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  248. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  249. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  250. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  251. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  252. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  253. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
  254. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
  255. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
  256. package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
  257. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
  258. package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
  259. package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
  260. package/sdk/public/Content/ContentPublicClient.js +254 -280
  261. package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
  262. package/sdk/public/Content/ContentPublicModel.js +98 -44
  263. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
  264. package/sdk/public/Content/ContentPublicValidator.js +26 -19
  265. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  266. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  267. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  268. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  269. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  270. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  271. package/sdk/public/PublicClient.d.ts +2 -2
  272. package/sdk/public/PublicClient.js +2 -2
  273. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  274. package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
  275. package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
  276. package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
  277. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  278. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  279. package/sdk/public/index.d.ts +1 -1
  280. package/sdk/public/index.js +1 -1
  281. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
  282. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
  283. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
  284. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
  285. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
  286. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
  287. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
  288. package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
  289. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
  290. package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
  291. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
  292. package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
  293. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
  294. package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
  295. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
  296. package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
  297. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
  298. package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
  299. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  300. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  301. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
  302. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
  303. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  304. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  305. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
  306. package/sdk/public/Billing/BillingPublicClient.js +0 -397
  307. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
  308. package/sdk/public/Billing/BillingPublicModel.js +0 -560
  309. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
  310. package/sdk/public/Billing/BillingPublicValidator.js +0 -50
@@ -1,7 +1,31 @@
1
1
  const Joi = require("joi");
2
2
 
3
+ /**
4
+ * @typedef CurrencyExchangeResponseV2
5
+ * @property {string} base - The 3-letter ISO 4217 code representing the base currency.
6
+ * @property {string} base_currency_name - The name of the base currency.
7
+ * @property {number} ttl_seconds - Time in seconds for which the exchange rates
8
+ * are valid.
9
+ * @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
10
+ * @property {number} total - Total number of currency exchange items.
11
+ */
12
+
13
+ /**
14
+ * @typedef CurrencyExchangeItem
15
+ * @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
16
+ * @property {string} name - Name of the exchange currency
17
+ * @property {number} rate - Exchange rate of the currency with respect to the
18
+ * base currency.
19
+ * @property {string} country_code - ISO 3166 country code.
20
+ * @property {string} country_name - Name of the country using this currency.
21
+ * @property {string} subunit - The name of the subunit for the currency.
22
+ * @property {number} decimal_digits - Number of decimal digits the currency supports.
23
+ * @property {string} symbol - The symbol of the currency.
24
+ */
25
+
3
26
  /**
4
27
  * @typedef ApplicationInventory
28
+ * @property {SearchConfig} [search]
5
29
  * @property {AppInventoryConfig} [inventory]
6
30
  * @property {AuthenticationConfig} [authentication]
7
31
  * @property {ArticleAssignmentConfig} [article_assignment]
@@ -19,8 +43,7 @@ const Joi = require("joi");
19
43
  * or not for sales channel inventory
20
44
  * @property {CommunicationConfig} [communication]
21
45
  * @property {string[]} [platforms]
22
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
23
- * of the sales channel inventory
46
+ * @property {string} [_id] - The unique identifier of the sales channel inventory
24
47
  * @property {LoyaltyPointsConfig} [loyalty_points]
25
48
  * @property {string} [app] - Current sales channel ID
26
49
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel
@@ -37,32 +60,43 @@ const Joi = require("joi");
37
60
  */
38
61
 
39
62
  /**
40
- * @typedef OwnerAppInventoryConfig
41
- * @property {PricingStrategy} [pricing_strategy]
63
+ * @typedef FstIdentification
64
+ * @property {boolean} [enabled] - Indicates whether search query interpretation
65
+ * is enabled for the application.
66
+ */
67
+
68
+ /**
69
+ * @typedef QuerySuggestions
70
+ * @property {boolean} [enabled] - Indicates whether to enable or disable query
71
+ * suggestions powered by the GPT model using the current live catalog within
72
+ * the application.
73
+ * @property {number} [max_limit] - Specifies the maximum number of query
74
+ * suggestions that can be returned.
42
75
  */
43
76
 
44
77
  /**
45
- * @typedef OwnerAppConfig
46
- * @property {OwnerAppInventoryConfig} [inventory]
78
+ * @typedef SearchConfig
79
+ * @property {FstIdentification} [fst_identification]
80
+ * @property {QuerySuggestions} [query_suggestions]
47
81
  */
48
82
 
49
83
  /**
50
84
  * @typedef AppInventoryConfig
85
+ * @property {DeliveryStrategy} [delivery_strategy]
51
86
  * @property {InventoryBrand} [brand]
52
87
  * @property {InventoryStore} [store]
53
88
  * @property {InventoryCategory} [category]
54
89
  * @property {InventoryPrice} [price]
55
90
  * @property {InventoryDiscount} [discount]
56
- * @property {PricingStrategy} [pricing_strategy]
57
91
  * @property {boolean} [out_of_stock] - Indicates whether out of stock products
58
92
  * are allowed to show up on the website
59
93
  * @property {boolean} [only_verified_products] - Show only verified products
60
94
  * (the ones whose data has been verified by the admin)
61
95
  * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
62
96
  * to consume the current sales channel's inventory and sell products
63
- * @property {number[]} [exclude_category] - List of excluded brands category
97
+ * @property {Object[]} [exclude_category] - List of excluded brands category
64
98
  * @property {string[]} [image]
65
- * @property {number[]} [company_store] - List of selling locations whose
99
+ * @property {Object[]} [company_store] - List of selling locations whose
66
100
  * inventory is available to the sales channel for displaying on the website
67
101
  * @property {number} [company_id]
68
102
  */
@@ -78,7 +112,7 @@ const Joi = require("joi");
78
112
  * @typedef InventoryStore
79
113
  * @property {string} [criteria] - All stores or specific (explicit) stores to
80
114
  * be shown on the website
81
- * @property {number[]} [stores] - List of stores
115
+ * @property {Object[]} [stores] - List of stores
82
116
  * @property {AppStoreRules[]} [rules] - Rules to show which brands or companies
83
117
  * products should be listed on sales channel.
84
118
  */
@@ -94,7 +128,7 @@ const Joi = require("joi");
94
128
  /**
95
129
  * @typedef InventoryCategory
96
130
  * @property {string} [criteria]
97
- * @property {number[]} [categories] - List of categories whose products will be
131
+ * @property {Object[]} [categories] - List of categories whose products will be
98
132
  * shown on the website
99
133
  */
100
134
 
@@ -133,7 +167,7 @@ const Joi = require("joi");
133
167
  * @typedef StorePriority
134
168
  * @property {boolean} [enabled] - Shows store priority is enabled or disabled
135
169
  * for assignment of article
136
- * @property {number[]} [storetype_order] - List of store types for article
170
+ * @property {Object[]} [storetype_order] - List of store types for article
137
171
  * assignment e.g. warehouse, mall, highstreet
138
172
  */
139
173
 
@@ -256,6 +290,7 @@ const Joi = require("joi");
256
290
 
257
291
  /**
258
292
  * @typedef AppInventoryPartialUpdate
293
+ * @property {SearchConfig} [search]
259
294
  * @property {RewardPointsConfig} [reward_points]
260
295
  * @property {AppCartConfig} [cart]
261
296
  * @property {AppPaymentConfig} [payment]
@@ -272,19 +307,19 @@ const Joi = require("joi");
272
307
  */
273
308
 
274
309
  /**
275
- * @typedef CompanyByBrandsRequest
310
+ * @typedef CompanyByBrandsRequestSchema
276
311
  * @property {number} brands - Brand UID
277
312
  * @property {string} [search_text] - A search field for finding a company by its name
278
313
  */
279
314
 
280
315
  /**
281
- * @typedef CompanyByBrandsResponse
316
+ * @typedef CompanyByBrandsResponseSchema
282
317
  * @property {BrandCompanyInfo[]} [items]
283
318
  * @property {Page} [page]
284
319
  */
285
320
 
286
321
  /**
287
- * @typedef StoreByBrandsRequest
322
+ * @typedef StoreByBrandsRequestSchema
288
323
  * @property {number} [company_id] - Current company ID for current company
289
324
  * stores only. Don't send in case cross-selling (franchise) is enabled.
290
325
  * @property {number} brands - Brand UID
@@ -292,7 +327,7 @@ const Joi = require("joi");
292
327
  */
293
328
 
294
329
  /**
295
- * @typedef StoreByBrandsResponse
330
+ * @typedef StoreByBrandsResponseSchema
296
331
  * @property {BrandStoreInfo[]} [items]
297
332
  * @property {Page} [page]
298
333
  */
@@ -320,21 +355,18 @@ const Joi = require("joi");
320
355
  */
321
356
 
322
357
  /**
323
- * @typedef BrandsByCompanyResponse
358
+ * @typedef BrandsByCompanyResponseSchema
324
359
  * @property {CompanyBrandInfo[]} [brands]
325
360
  */
326
361
 
327
362
  /**
328
- * @typedef ValidationFailedResponse
363
+ * @typedef ValidationFailedResponseSchema
329
364
  * @property {string} [message] - Response message for failed validation
330
- * @property {Object[]} [errors] - Response message for failed validation
331
365
  */
332
366
 
333
367
  /**
334
368
  * @typedef NotFound
335
369
  * @property {string} [message] - Response message for not found
336
- * @property {string} [error] - Error message for not found
337
- * @property {string} [code] - Unique code for each error
338
370
  * @property {boolean} [success] - Flag for required not successfull.
339
371
  */
340
372
 
@@ -360,20 +392,20 @@ const Joi = require("joi");
360
392
  */
361
393
 
362
394
  /**
363
- * @typedef CreateApplicationRequest
395
+ * @typedef CreateApplicationRequestSchema
364
396
  * @property {App} [app]
365
397
  * @property {ApplicationInventory} [configuration]
366
398
  * @property {AppDomain} [domain]
367
399
  */
368
400
 
369
401
  /**
370
- * @typedef CreateAppResponse
402
+ * @typedef CreateAppResponseSchema
371
403
  * @property {Application} [app]
372
404
  * @property {ApplicationInventory} [configuration]
373
405
  */
374
406
 
375
407
  /**
376
- * @typedef ApplicationsResponse
408
+ * @typedef ApplicationsResponseSchema
377
409
  * @property {Application[]} [items]
378
410
  * @property {Page} [page]
379
411
  */
@@ -381,8 +413,7 @@ const Joi = require("joi");
381
413
  /**
382
414
  * @typedef MobileAppConfiguration
383
415
  * @property {boolean} [is_active] - Indicates the availability of the mobile build
384
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
385
- * for mobile application configuration
416
+ * @property {string} [_id] - The unique identifier for mobile application configuration
386
417
  * @property {string} [app_name] - Name of the mobile app
387
418
  * @property {LandingImage} [landing_image]
388
419
  * @property {SplashImage} [splash_image]
@@ -411,7 +442,7 @@ const Joi = require("joi");
411
442
  */
412
443
 
413
444
  /**
414
- * @typedef MobileAppConfigRequest
445
+ * @typedef MobileAppConfigRequestSchema
415
446
  * @property {string} [app_name] - Name of the mobile app
416
447
  * @property {LandingImage} [landing_image]
417
448
  * @property {SplashImage} [splash_image]
@@ -427,7 +458,7 @@ const Joi = require("joi");
427
458
 
428
459
  /**
429
460
  * @typedef BuildVersion
430
- * @property {string} [_id] - 24-digit Mongo Object ID
461
+ * @property {string} [_id] - Primary Identifier of the build version.
431
462
  * @property {string} [application] - Application ID of the sales channel
432
463
  * @property {string} [platform_type] - Device platform for which the mobile app
433
464
  * was built, e.g. android, ios.
@@ -446,8 +477,8 @@ const Joi = require("joi");
446
477
 
447
478
  /**
448
479
  * @typedef AppSupportedCurrency
449
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
450
- * of the currency configuration supported by the application
480
+ * @property {string} [_id] - The unique identifier of the currency
481
+ * configuration supported by the application
451
482
  * @property {string[]} [supported_currency]
452
483
  * @property {string} [application] - Alphanumeric ID allotted to an application
453
484
  * (sales channel website) created within a business account.
@@ -460,8 +491,7 @@ const Joi = require("joi");
460
491
 
461
492
  /**
462
493
  * @typedef DefaultCurrency
463
- * @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
464
- * of the default currency
494
+ * @property {string} [ref] - The unique identifier of the default currency
465
495
  * @property {string} [code] - 3-character code of the default currency, e.g.
466
496
  * INR, EUR, USD
467
497
  */
@@ -469,8 +499,7 @@ const Joi = require("joi");
469
499
  /**
470
500
  * @typedef DomainAdd
471
501
  * @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
472
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
473
- * of the domain
502
+ * @property {string} [_id] - The unique identifier of the domain
474
503
  * @property {boolean} [verified] - Domain is verified or not (indicates if A
475
504
  * records and TXT records are correct)
476
505
  * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
@@ -483,15 +512,14 @@ const Joi = require("joi");
483
512
  */
484
513
 
485
514
  /**
486
- * @typedef DomainAddRequest
515
+ * @typedef DomainAddRequestSchema
487
516
  * @property {DomainAdd} [domain]
488
517
  */
489
518
 
490
519
  /**
491
520
  * @typedef Domain
492
521
  * @property {string} [name] - Full domain name, e.g. newton.com
493
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
494
- * of the sales channel domain
522
+ * @property {string} [_id] - The unique identifier of the sales channel domain
495
523
  * @property {boolean} [verified] - Domain is verified or not. TXT and A records
496
524
  * should propagate correctly.
497
525
  * @property {boolean} [is_primary] - Domain is primary or not. Primary domain
@@ -502,15 +530,14 @@ const Joi = require("joi");
502
530
  */
503
531
 
504
532
  /**
505
- * @typedef DomainsResponse
533
+ * @typedef DomainsResponseSchema
506
534
  * @property {Domain[]} [domains]
507
535
  */
508
536
 
509
537
  /**
510
538
  * @typedef UpdateDomain
511
539
  * @property {string} [name] - Full domain name, e.g. zenz.com
512
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
513
- * of the domain
540
+ * @property {string} [_id] - The unique identifier of the domain
514
541
  * @property {boolean} [verified] - Domain is verified or not (indicates if A
515
542
  * records and TXT records are correct)
516
543
  * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
@@ -520,14 +547,14 @@ const Joi = require("joi");
520
547
  */
521
548
 
522
549
  /**
523
- * @typedef UpdateDomainTypeRequest
550
+ * @typedef UpdateDomainTypeRequestSchema
524
551
  * @property {UpdateDomain} [domain]
525
552
  * @property {string} [action] - Shows domain is made primary domain for the
526
553
  * sales channel or shorlink is created for the sales channel domain
527
554
  */
528
555
 
529
556
  /**
530
- * @typedef DomainStatusRequest
557
+ * @typedef DomainStatusRequestSchema
531
558
  * @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
532
559
  */
533
560
 
@@ -539,15 +566,17 @@ const Joi = require("joi");
539
566
  */
540
567
 
541
568
  /**
542
- * @typedef DomainStatusResponse
569
+ * @typedef DomainStatusResponseSchema
543
570
  * @property {boolean} [connected] - Check if domain is live and mapped to
544
571
  * appropriate IP of Fynd Servers
545
572
  * @property {DomainStatus[]} [status]
546
573
  */
547
574
 
548
575
  /**
549
- * @typedef DomainSuggestionsRequest
576
+ * @typedef DomainSuggestionsRequestSchema
550
577
  * @property {string} [domain_url] - Domain url
578
+ * @property {boolean} [custom_domain] - Get suggestions for custom domains or
579
+ * Fynd domains
551
580
  */
552
581
 
553
582
  /**
@@ -562,205 +591,16 @@ const Joi = require("joi");
562
591
  */
563
592
 
564
593
  /**
565
- * @typedef DomainSuggestionsResponse
594
+ * @typedef DomainSuggestionsResponseSchema
566
595
  * @property {DomainSuggestion[]} [domains] - Domain URL
567
596
  */
568
597
 
569
598
  /**
570
- * @typedef SuccessMessageResponse
599
+ * @typedef SuccessMessageResponseSchema
571
600
  * @property {boolean} [success] - Shows whether domain was deleted successfully
572
601
  * @property {string} [message] - Success message shown to the user (in a string format)
573
602
  */
574
603
 
575
- /**
576
- * @typedef GetIntegrationsOptInsResponse
577
- * @property {IntegrationOptIn[]} [items]
578
- * @property {Page} [page]
579
- */
580
-
581
- /**
582
- * @typedef IntegrationOptIn
583
- * @property {Validators} [validators]
584
- * @property {string} [description] - Basic description about the opted integration
585
- * @property {string} [description_html] - Basic HTML description about the
586
- * opted integration
587
- * @property {string} [constants]
588
- * @property {string[]} [companies]
589
- * @property {string[]} [support]
590
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
591
- * of the opted integration
592
- * @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
593
- * @property {string} [slug] - Slug of the opted integration, e.g. ginesys
594
- * @property {boolean} [hidden]
595
- * @property {IntegrationMeta[]} [meta]
596
- * @property {string} [icon] - Hosted URL of the icon image
597
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
598
- * of the user who created the integration
599
- * @property {string} [created_at] - ISO 8601 timestamp of integration creation
600
- * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
601
- * @property {string} [token] - Randomly generated fixed-length string for opted
602
- * integration. It is auto-generated. It would never change once it is generated.
603
- * @property {string} [secret] - Randomly generated fixed-length string for
604
- * opted integration. It is auto-generated. It would never change once it is generated.
605
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
606
- */
607
-
608
- /**
609
- * @typedef Validators
610
- * @property {CompanyValidator} [company]
611
- * @property {StoreValidator} [store]
612
- * @property {InventoryValidator} [inventory]
613
- * @property {OrderValidator} [order]
614
- */
615
-
616
- /**
617
- * @typedef CompanyValidator
618
- * @property {JsonSchema[]} [json_schema]
619
- * @property {string} [browser_script] - Browser script for the company validator
620
- */
621
-
622
- /**
623
- * @typedef JsonSchema
624
- * @property {string} [display] - Display text of the validator JSON schema. It
625
- * will show in the UI.
626
- * @property {string} [key] - Key related to the display text of the validator JSON schema
627
- * @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
628
- * @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
629
- * schema. It will show in the UI.
630
- */
631
-
632
- /**
633
- * @typedef StoreValidator
634
- * @property {JsonSchema[]} [json_schema]
635
- * @property {string} [browser_script] - Browser script for the store validator
636
- */
637
-
638
- /**
639
- * @typedef InventoryValidator
640
- * @property {JsonSchema[]} [json_schema]
641
- * @property {string} [browser_script] - Browser script for the inventory validator
642
- */
643
-
644
- /**
645
- * @typedef OrderValidator
646
- * @property {JsonSchema[]} [json_schema]
647
- * @property {string} [browser_script] - Browser script for the order validator
648
- */
649
-
650
- /**
651
- * @typedef IntegrationMeta
652
- * @property {boolean} [is_public]
653
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
654
- * of the integration meta
655
- * @property {string} [name] - Nmae of integration meta, e.g. price_level
656
- * @property {string} [value] - Value related to integration meta name, e.g. store
657
- */
658
-
659
- /**
660
- * @typedef Integration
661
- * @property {Validators} [validators]
662
- * @property {string} [description] - Basic description about the integration
663
- * @property {string} [description_html] - Basic HTML description about the integration
664
- * @property {Object} [constants]
665
- * @property {string[]} [companies]
666
- * @property {string[]} [support]
667
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
668
- * of the integration
669
- * @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
670
- * @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
671
- * @property {IntegrationMeta[]} [meta]
672
- * @property {string} [icon] - Hosted URL of the icon image
673
- * @property {boolean} [hidden]
674
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
675
- * of the user who created the integration
676
- * @property {string} [created_at] - ISO 8601 timestamp of integration creation
677
- * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
678
- * @property {string} [token] - Randomly generated fixed-length string for opted
679
- * integration. It is auto-generated. It would never change once it is generated.
680
- * @property {string} [secret] - Randomly generated fixed-length string for
681
- * opted integration. It is auto-generated. It would never change once it is generated.
682
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
683
- */
684
-
685
- /**
686
- * @typedef IntegrationConfigResponse
687
- * @property {IntegrationLevel[]} [items]
688
- */
689
-
690
- /**
691
- * @typedef IntegrationLevel
692
- * @property {boolean} [opted] - Shows this integration is opted or not opted
693
- * for the current company
694
- * @property {Object[]} [permissions]
695
- * @property {LastPatch[]} [last_patch]
696
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
697
- * of the integration config
698
- * @property {string} [integration] - Integration id. Shows which integration
699
- * you are enabling.
700
- * @property {string} [level] - Shows for what level the integration is set up.
701
- * It can be company level or store level.
702
- * @property {number} [uid] - It can be store uid or company uid. Depends on the
703
- * level of integration.
704
- * @property {number} [company_id] - Unique id of company.
705
- * @property {IntegrationMeta[]} [meta]
706
- * @property {string} [token] - Randomly generated fixed-length string for opted
707
- * integration. It is auto-generated. It would never change once it is generated.
708
- * @property {string} [created_at] - ISO 8601 timestamp of integration config creation
709
- * @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
710
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
711
- * @property {Object} [data] - Schema data of the integration stored in key-value pairs
712
- * @property {boolean} [success]
713
- * @property {string} [message]
714
- */
715
-
716
- /**
717
- * @typedef UpdateIntegrationLevelRequest
718
- * @property {IntegrationLevel[]} [items]
719
- */
720
-
721
- /**
722
- * @typedef OptedStoreIntegration
723
- * @property {boolean} [other_opted] - Allow user to opt same store in other integration
724
- * @property {IntegrationOptIn} [other_integration]
725
- * @property {OtherEntity} [other_entity]
726
- */
727
-
728
- /**
729
- * @typedef OtherEntity
730
- * @property {boolean} [opted] - Allow other entity opted in integration
731
- * @property {string[]} [permissions]
732
- * @property {LastPatch[]} [last_patch]
733
- * @property {string} [_id] - The unique identifier of the other entity for
734
- * opted store integration
735
- * @property {string} [integration] - Integration ID. Shows which integration
736
- * you are enabling.
737
- * @property {string} [level] - Indicates integration level. It can be company
738
- * level or store level.
739
- * @property {number} [uid] - It can be store uid or company uid. Depends on the
740
- * level of integration.
741
- * @property {OtherEntityData} [data]
742
- * @property {Object[]} [meta]
743
- * @property {string} [token] - Randomly generated fixed-length string for opted
744
- * integration. It is auto-generated. It would never change once it is generated.
745
- * @property {string} [created_at] - ISO 8601 timestamp of other entity creation
746
- * for opted store integration
747
- * @property {string} [modified_at] - ISO 8601 timestamp of other entity
748
- * updation for opted store integration
749
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
750
- */
751
-
752
- /**
753
- * @typedef LastPatch
754
- * @property {string} [op]
755
- * @property {string} [path]
756
- * @property {string} [value] - It can be inventory level or order level
757
- */
758
-
759
- /**
760
- * @typedef OtherEntityData
761
- * @property {string} [article_identifier]
762
- */
763
-
764
604
  /**
765
605
  * @typedef App
766
606
  * @property {string} [company_id] - Numeric ID allotted to a business account
@@ -772,34 +612,13 @@ const Joi = require("joi");
772
612
  * @property {string} [desc] - Detailed description about the sales channel
773
613
  */
774
614
 
775
- /**
776
- * @typedef InventoryConfig
777
- * @property {InventoryBrandRule} [brand]
778
- * @property {InventoryStoreRule} [store]
779
- * @property {string[]} [image]
780
- * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
781
- * to consume the current sales channel's inventory and sell products
782
- * @property {boolean} [out_of_stock] - Indicates whether out of stock products
783
- * are allowed to show up on the website.
784
- * @property {boolean} [only_verified_products] - Show only verified products
785
- * (the ones whose data have been verified by the admin)
786
- * @property {PricingStrategy} [pricing_strategy]
787
- */
788
-
789
- /**
790
- * @typedef AppInventory
791
- * @property {InventoryConfig} [inventory]
792
- * @property {InventoryPaymentConfig} [payment]
793
- * @property {InventoryArticleAssignment} [article_assignment]
794
- */
795
-
796
615
  /**
797
616
  * @typedef AppDomain
798
617
  * @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
799
618
  */
800
619
 
801
620
  /**
802
- * @typedef CompaniesResponse
621
+ * @typedef CompaniesResponseSchema
803
622
  * @property {AppInventoryCompanies[]} [items]
804
623
  * @property {Page} [page]
805
624
  */
@@ -813,25 +632,15 @@ const Joi = require("joi");
813
632
  */
814
633
 
815
634
  /**
816
- * @typedef StoresResponse
635
+ * @typedef StoresResponseSchema
817
636
  * @property {AppInventoryStores[]} [items]
818
637
  * @property {Page} [page]
819
638
  */
820
639
 
821
- /**
822
- * @typedef ListStoreResponse
823
- * @property {AppInventoryStores[]} [stores]
824
- */
825
-
826
- /**
827
- * @typedef ArrayStoreResponse
828
- * @property {AppInventoryStores[]} [data]
829
- */
830
-
831
640
  /**
832
641
  * @typedef AppInventoryStores
833
- * @property {string} [_id] - The unique identifier of the store (24-digit Mongo
834
- * Object ID) in the sales channel inventory
642
+ * @property {string} [_id] - The unique identifier of the store in the sales
643
+ * channel inventory
835
644
  * @property {string} [modified_on] - ISO 8601 timestamp of last known updation
836
645
  * to the stores in sales channel inventory
837
646
  * @property {number} [uid] - Sales channel inventory store UID
@@ -850,7 +659,7 @@ const Joi = require("joi");
850
659
  */
851
660
 
852
661
  /**
853
- * @typedef FilterOrderingStoreRequest
662
+ * @typedef FilterOrderingStoreRequestSchema
854
663
  * @property {boolean} [all_stores] - Allow all stores from the ordering stores
855
664
  * @property {number[]} [deployed_stores]
856
665
  * @property {string} [q] - Store code or name of the ordering store
@@ -864,8 +673,7 @@ const Joi = require("joi");
864
673
  * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
865
674
  * type delivery, store selection is compulsory. For soft type, delivery store
866
675
  * selection is optional.
867
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
868
- * of the ordering stores
676
+ * @property {string} [_id] - The unique identifier of the ordering stores
869
677
  * @property {string} [app] - Alphanumeric ID allotted to an application (sales
870
678
  * channel website) created within a business account
871
679
  * @property {number} [__v]
@@ -877,7 +685,7 @@ const Joi = require("joi");
877
685
  */
878
686
 
879
687
  /**
880
- * @typedef OrderingStoreSelectRequest
688
+ * @typedef OrderingStoreSelectRequestSchema
881
689
  * @property {OrderingStoreSelect} ordering_store
882
690
  */
883
691
 
@@ -896,8 +704,7 @@ const Joi = require("joi");
896
704
  * @typedef OtherSellerApplication
897
705
  * @property {string} [name] - Name of the other seller's sales channel
898
706
  * @property {string} [description] - Basic details about the other seller's sales channel
899
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
900
- * of the other seller's sales channel
707
+ * @property {string} [_id] - The unique identifier of the other seller's sales channel
901
708
  * @property {string} [domain] - Domain URL of the other seller's sales channel
902
709
  * @property {OtherSellerCompany} [company]
903
710
  * @property {string} [opt_type] - Inventory opted by the other seller's sales
@@ -911,11 +718,10 @@ const Joi = require("joi");
911
718
  */
912
719
 
913
720
  /**
914
- * @typedef OptedApplicationResponse
721
+ * @typedef OptedApplicationResponseSchema
915
722
  * @property {string} [name] - Name of the other seller's sales channel
916
723
  * @property {string} [description] - Basic details about the other seller's sales channel
917
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
918
- * of the other seller's sales channel
724
+ * @property {string} [_id] - The unique identifier of the other seller's sales channel
919
725
  * @property {string} [domain] - Domain URL of the other seller's sales channel
920
726
  * @property {OptedCompany} [company]
921
727
  * @property {OptedInventory} [opted_inventory]
@@ -968,10 +774,9 @@ const Joi = require("joi");
968
774
  */
969
775
 
970
776
  /**
971
- * @typedef TokenResponse
777
+ * @typedef TokenResponseSchema
972
778
  * @property {Tokens} [tokens]
973
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
974
- * of the token
779
+ * @property {string} [_id] - The unique identifier of the token
975
780
  * @property {string} [application] - Alphanumeric ID allotted to the current
976
781
  * application created within the current business account
977
782
  * @property {string} [created_at] - ISO 8601 timestamp of token creation
@@ -1109,6 +914,7 @@ const Joi = require("joi");
1109
914
 
1110
915
  /**
1111
916
  * @typedef GoogleMap
917
+ * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
1112
918
  * @property {GoogleMapCredentials} [credentials]
1113
919
  */
1114
920
 
@@ -1179,6 +985,22 @@ const Joi = require("joi");
1179
985
  * address of the store, should be displayed upon visiting the website
1180
986
  */
1181
987
 
988
+ /**
989
+ * @typedef BuyboxFeature
990
+ * @property {boolean} [show_name] - Allow users to see seller/stores name on
991
+ * PDP (product detail page).
992
+ * @property {boolean} [enable_selection] - Allow selection of sellers/stores on
993
+ * PDP (product detail page).
994
+ * @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
995
+ * between sellers and stores. True indicates seller listing, while False
996
+ * indicates store listing.
997
+ */
998
+
999
+ /**
1000
+ * @typedef DeliveryStrategy
1001
+ * @property {string} [value] - Indicates the delivery strategy value.
1002
+ */
1003
+
1182
1004
  /**
1183
1005
  * @typedef AppFeature
1184
1006
  * @property {ProductDetailFeature} [product_detail]
@@ -1191,15 +1013,14 @@ const Joi = require("joi");
1191
1013
  * @property {PcrFeature} [pcr]
1192
1014
  * @property {OrderFeature} [order]
1193
1015
  * @property {BuyboxFeature} [buybox]
1194
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1195
- * for the sales channel features
1016
+ * @property {DeliveryStrategy} [delivery_strategy]
1017
+ * @property {string} [_id] - The unique identifier for the sales channel features
1196
1018
  * @property {string} [app] - Application ID of the sales channel
1197
1019
  * @property {string} [created_at] - ISO 8601 timestamp showing the date when
1198
1020
  * the features were configured
1199
1021
  * @property {string} [modified_at] - ISO 8601 timestamp of last known
1200
1022
  * modifications to the sales channel feature configuration
1201
1023
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero
1202
- * @property {PricingStrategy} [pricing_strategy]
1203
1024
  */
1204
1025
 
1205
1026
  /**
@@ -1311,30 +1132,19 @@ const Joi = require("joi");
1311
1132
  */
1312
1133
 
1313
1134
  /**
1314
- * @typedef BuyboxFeature
1315
- * @property {boolean} [show_name] - Allow users to see seller/stores name on
1316
- * PDP (product detail page).
1317
- * @property {boolean} [enable_selection] - Allow selection of sellers/stores on
1318
- * PDP (product detail page).
1319
- * @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
1320
- * between sellers and stores. True indicates seller listing, while False
1321
- * indicates store listing.
1322
- */
1323
-
1324
- /**
1325
- * @typedef AppFeatureRequest
1135
+ * @typedef AppFeatureRequestSchema
1326
1136
  * @property {AppFeature} [feature]
1327
1137
  */
1328
1138
 
1329
1139
  /**
1330
- * @typedef AppFeatureResponse
1140
+ * @typedef AppFeatureResponseSchema
1331
1141
  * @property {AppFeature} [feature]
1332
1142
  */
1333
1143
 
1334
1144
  /**
1335
1145
  * @typedef Currency
1336
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1337
- * of the current sales channel supported currency
1146
+ * @property {string} [_id] - The unique identifier of the current sales channel
1147
+ * supported currency
1338
1148
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
1339
1149
  * sales channel
1340
1150
  * @property {string} [name] - Name of the currency, e.g Indian Rupee
@@ -1403,11 +1213,9 @@ const Joi = require("joi");
1403
1213
  * @property {boolean} [is_internal] - Indicates whether a sales channel is
1404
1214
  * internal or not
1405
1215
  * @property {boolean} [is_active] - Indicates sales channel is active or not active
1406
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1407
- * of the sales channel
1216
+ * @property {string} [_id] - The unique identifier of the sales channel
1408
1217
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
1409
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
1410
- * of owner who owns the application
1218
+ * @property {string} [owner] - The unique identifier of owner who owns the application
1411
1219
  * @property {number} [company_id] - Numeric ID allotted to a business account
1412
1220
  * where the sales channel exists
1413
1221
  * @property {string} [token] - Random generated fix length string for sales
@@ -1432,70 +1240,63 @@ const Joi = require("joi");
1432
1240
  */
1433
1241
 
1434
1242
  /**
1435
- * @typedef TokenSchema
1436
- * @property {string} [token]
1437
- * @property {Object} [created_by]
1438
- * @property {string} [created_at] - ISO 8601 timestamp of when token created
1439
- */
1440
-
1441
- /**
1442
- * @typedef InvalidPayloadRequest
1443
- * @property {string} [message] - Error message when request body payload is improper
1444
- * @property {boolean} [success] - Flag for required not successfull.
1445
- * @property {Object} [domain] - All errors related to domin
1446
- */
1447
-
1448
- /**
1449
- * @typedef InventoryBrandRule
1450
- * @property {string} [criteria] - Whether all brands are enabled, or explicitly
1451
- * few brands in the inventory
1452
- * @property {number[]} [brands]
1453
- */
1454
-
1455
- /**
1456
- * @typedef PricingStrategy
1457
- * @property {string} [value] - Indicates the pricing strategy value.
1458
- */
1459
-
1460
- /**
1461
- * @typedef StoreCriteriaRule
1462
- * @property {number[]} [companies] - List of company UID
1463
- * @property {number[]} [brands] - List of brand UID
1464
- */
1465
-
1466
- /**
1467
- * @typedef InventoryStoreRule
1468
- * @property {string} [criteria] - Whether all stores are enabled, or explicitly
1469
- * few stores in the inventory, or use brands and company filter.
1470
- * @property {StoreCriteriaRule[]} [rules] - List of rules with company and
1471
- * brands uids. Used when critera is `filter`.
1472
- * @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
1473
- */
1474
-
1475
- /**
1476
- * @typedef InventoryPaymentConfig
1477
- * @property {string} [mode_of_payment] - Mode of payment for the inventory of
1478
- * sales channel. It is required and default value is null.
1479
- * @property {string} [source] - Source of the payment mode for the inventory
1480
- * payment of sales channel. Default value is FYND.
1243
+ * @typedef ApplicationById
1244
+ * @property {ApplicationWebsite} [website]
1245
+ * @property {ApplicationCors} [cors]
1246
+ * @property {ApplicationAuth} [auth]
1247
+ * @property {string} [description] - It contains detailed information about the
1248
+ * sales channel.
1249
+ * @property {string} [channel_type] - It indicates different types of channels,
1250
+ * such as store, website, and mobile apps, with 'store' being the default value.
1251
+ * @property {number} [cache_ttl] - An integer value that specifies the number
1252
+ * of seconds until the key expires
1253
+ * @property {boolean} [is_internal] - Indicates whether a sales channel is
1254
+ * internal or not
1255
+ * @property {boolean} [is_active] - Indicates sales channel is active or not active
1256
+ * @property {string} [_id] - The unique identifier of the sales channel
1257
+ * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
1258
+ * @property {string} [owner] - The unique identifier of owner who owns the application
1259
+ * @property {number} [company_id] - Numeric ID allotted to a business account
1260
+ * where the sales channel exists
1261
+ * @property {string} [token] - Random generated fix length string for sales
1262
+ * channel. It is required and auto-generated.
1263
+ * @property {ApplicationRedirections[]} [redirections]
1264
+ * @property {ApplicationMeta[]} [meta]
1265
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
1266
+ * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
1267
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
1268
+ * @property {SecureUrl} [banner]
1269
+ * @property {SecureUrl} [logo]
1270
+ * @property {SecureUrl} [favicon]
1271
+ * @property {Domain[]} [domains]
1272
+ * @property {string} [app_type] - It shows application is live or in development mode.
1273
+ * @property {SecureUrl} [mobile_logo]
1274
+ * @property {Domain} [domain]
1275
+ * @property {string} [slug]
1276
+ * @property {string} [mode]
1277
+ * @property {string} [status]
1278
+ * @property {TokenSchemaID[]} [tokens]
1279
+ * @property {string} [secret]
1481
1280
  */
1482
1281
 
1483
1282
  /**
1484
- * @typedef StorePriorityRule
1485
- * @property {boolean} [enabled] - Shows store priority is enabled or not
1486
- * enabled for the article assignment.
1487
- * @property {string[]} [storetype_order]
1283
+ * @typedef TokenSchemaID
1284
+ * @property {string} [token]
1285
+ * @property {string} [created_by]
1286
+ * @property {string} [created_at] - ISO 8601 timestamp of when token created
1488
1287
  */
1489
1288
 
1490
1289
  /**
1491
- * @typedef ArticleAssignmentRule
1492
- * @property {StorePriorityRule} [store_priority]
1290
+ * @typedef TokenSchema
1291
+ * @property {string} [token]
1292
+ * @property {Object} [created_by]
1293
+ * @property {string} [created_at] - ISO 8601 timestamp of when token created
1493
1294
  */
1494
1295
 
1495
1296
  /**
1496
- * @typedef InventoryArticleAssignment
1497
- * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
1498
- * @property {ArticleAssignmentRule} [rules]
1297
+ * @typedef InvalidPayloadRequestSchema
1298
+ * @property {string} [message] - Error message when request body payload is improper
1299
+ * @property {boolean} [success] - Flag for required not successfull.
1499
1300
  */
1500
1301
 
1501
1302
  /**
@@ -1507,7 +1308,7 @@ const Joi = require("joi");
1507
1308
  * @property {number} [current] - The current page number.
1508
1309
  * @property {string} type - The type of the page, such as 'PageType'.
1509
1310
  * @property {number} [size] - The number of items per page.
1510
- * @property {number} [total] - Total number of items.
1311
+ * @property {number} [page_size] - The number of items per page.
1511
1312
  */
1512
1313
 
1513
1314
  /**
@@ -1518,8 +1319,7 @@ const Joi = require("joi");
1518
1319
  * @property {Links[]} [links]
1519
1320
  * @property {string} [copyright_text] - Copyright statement usually seen at the
1520
1321
  * site's footer
1521
- * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
1522
- * the application information
1322
+ * @property {string} [_id] - Unique identifier of the application information
1523
1323
  * @property {BusinessHighlights[]} [business_highlights]
1524
1324
  * @property {string} [application] - Alphanumeric ID allotted to a sales
1525
1325
  * channel application created within a business account
@@ -1656,8 +1456,7 @@ const Joi = require("joi");
1656
1456
 
1657
1457
  /**
1658
1458
  * @typedef BusinessHighlights
1659
- * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
1660
- * the related business
1459
+ * @property {string} [_id] - Unique identifier of the related business
1661
1460
  * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
1662
1461
  * @property {string} [icon] - Hosted URL of icon image representing the
1663
1462
  * business highlight
@@ -1675,21 +1474,20 @@ const Joi = require("joi");
1675
1474
  * @property {SecureUrl} [banner]
1676
1475
  * @property {Domain} [domain]
1677
1476
  * @property {Domain[]} [domains]
1678
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1679
- * for the sales channel details
1477
+ * @property {string} [_id] - The unique identifier for the sales channel details
1680
1478
  * @property {string} [slug]
1681
1479
  * @property {number} [company_id]
1682
1480
  */
1683
1481
 
1684
1482
  /**
1685
- * @typedef CurrenciesResponse
1483
+ * @typedef CurrenciesResponseSchema
1686
1484
  * @property {Currency[]} [items]
1687
1485
  */
1688
1486
 
1689
1487
  /**
1690
- * @typedef AppCurrencyResponse
1691
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1692
- * of the currency configuration supported by the application
1488
+ * @typedef AppCurrencyResponseSchema
1489
+ * @property {string} [_id] - The unique identifier of the currency
1490
+ * configuration supported by the application
1693
1491
  * @property {string} [application] - Alphanumeric ID allotted to an application
1694
1492
  * (sales channel website) created within a business account
1695
1493
  * @property {DefaultCurrency} [default_currency]
@@ -1723,8 +1521,7 @@ const Joi = require("joi");
1723
1521
  /**
1724
1522
  * @typedef OrderingStore
1725
1523
  * @property {OptedStoreAddress} [address]
1726
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1727
- * of the ordering store
1524
+ * @property {string} [_id] - The unique identifier of the ordering store
1728
1525
  * @property {number} [uid] - Ordering store UID
1729
1526
  * @property {string} [name] - Store name of the ordering store
1730
1527
  * @property {string} [display_name] - Display name of the ordering store
@@ -1744,8 +1541,7 @@ const Joi = require("joi");
1744
1541
  * @property {boolean} [enabled] - Allow ordering stores for current sales channel
1745
1542
  * @property {string} [type] - For hard type delivery, store selection is
1746
1543
  * compulsory. For soft type, delivery store selection is optional.
1747
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
1748
- * of the ordering store
1544
+ * @property {string} [_id] - The unique identifier of the ordering store
1749
1545
  * @property {string} [app] - Alphanumeric ID allotted to an application (sales
1750
1546
  * channel website) created within a business account
1751
1547
  * @property {number} [__v] - Version key for tracking ordering stores. Default
@@ -1753,139 +1549,54 @@ const Joi = require("joi");
1753
1549
  */
1754
1550
 
1755
1551
  /**
1756
- * @typedef UpdateDiealog
1757
- * @property {string} type
1758
- * @property {number} [interval]
1759
- */
1760
-
1761
- /**
1762
- * @typedef PlatformVersionRequest
1763
- * @property {string} app_code_name
1764
- * @property {string} app_name
1765
- * @property {string} force_version
1766
- * @property {string} latest_version
1767
- * @property {boolean} is_app_blocked
1768
- * @property {UpdateDiealog} update_dialog
1769
- */
1770
-
1771
- /**
1772
- * @typedef PlatformVersion
1773
- * @property {string} app_code_name
1774
- * @property {string} app_name
1775
- * @property {string} force_version
1776
- * @property {string} latest_version
1777
- * @property {boolean} is_app_blocked
1778
- * @property {UpdateDiealog} update_dialog
1779
- * @property {string} [_id]
1780
- * @property {string} [modified_at] - ISO 8601 timestamp when currency was added
1781
- * in the list of currencies supported by the sales channel
1782
- * @property {string} [created_at] - ISO 8601 timestamp when currency was added
1783
- * in the list of currencies supported by the sales channel
1784
- * @property {number} [__v]
1785
- */
1786
-
1787
- /**
1788
- * @typedef OrderingStoresResponse
1552
+ * @typedef OrderingStoresResponseSchema
1789
1553
  * @property {Page} [page]
1790
1554
  * @property {OrderingStore[]} [items]
1791
1555
  */
1792
1556
 
1793
1557
  /**
1794
- * @typedef LocationDefaultLanguage
1795
- * @property {string} [name]
1796
- * @property {string} [code]
1797
- */
1798
-
1799
- /**
1800
- * @typedef LocationDefaultCurrency
1801
- * @property {string} [name]
1802
- * @property {string} [symbol]
1803
- * @property {string} [code]
1804
- */
1805
-
1806
- /**
1807
- * @typedef LocationCountry
1808
- * @property {string} [capital]
1809
- * @property {string} [currency]
1810
- * @property {string} [iso2]
1811
- * @property {string} [iso3]
1812
- * @property {string} [name]
1813
- * @property {string} [parent]
1814
- * @property {string} [phone_code]
1815
- * @property {string} [type]
1816
- * @property {number} [uid]
1817
- * @property {number} [__v]
1818
- * @property {string} [_id]
1819
- * @property {LocationDefaultCurrency} [default_currency]
1820
- * @property {LocationDefaultLanguage} [default_language]
1821
- * @property {string} [state_code]
1822
- * @property {string} [country_code]
1823
- * @property {string} [latitude]
1824
- * @property {string} [longitude]
1825
- */
1826
-
1827
- /**
1828
- * @typedef Locations
1829
- * @property {LocationCountry[]} [items]
1830
- */
1831
-
1832
- /**
1833
- * @typedef UrlRedirectionResponse
1834
- * @property {UrlRedirection[]} [redirections]
1835
- */
1836
-
1837
- /**
1838
- * @typedef UrlRedirectionRequest
1839
- * @property {UrlRedirection} [redirection]
1840
- */
1841
-
1842
- /**
1843
- * @typedef UrlRedirection
1844
- * @property {string} [redirect_from]
1845
- * @property {string} [redirect_to]
1846
- * @property {string} [type]
1847
- * @property {string} [_id]
1848
- */
1849
-
1850
- /**
1851
- * @typedef StoreForConfigurationRequest
1852
- * @property {AppStoreRules[]} [conf]
1558
+ * @typedef ValidationErrors
1559
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
1853
1560
  */
1854
1561
 
1855
1562
  /**
1856
- * @typedef DomainOptionsResponse
1857
- * @property {DomainType[]} [domain_types]
1858
- * @property {string[]} [network_ips]
1859
- * @property {string[]} [network_cnames]
1563
+ * @typedef ValidationError
1564
+ * @property {string} message - A brief description of the error encountered.
1565
+ * @property {string} field - The field in the request that caused the error.
1860
1566
  */
1861
1567
 
1862
- /**
1863
- * @typedef DomainType
1864
- * @property {string} [key]
1865
- * @property {string} [display]
1866
- * @property {DomainValue[]} [values]
1867
- */
1868
-
1869
- /**
1870
- * @typedef DomainValue
1871
- * @property {string} [value]
1872
- * @property {string} [text]
1873
- */
1874
-
1875
- /**
1876
- * @typedef StoreRequest
1877
- * @property {number[]} [companies]
1878
- */
1568
+ class ConfigurationPlatformModel {
1569
+ /** @returns {CurrencyExchangeResponseV2} */
1570
+ static CurrencyExchangeResponseV2() {
1571
+ return Joi.object({
1572
+ base: Joi.string().allow("").required(),
1573
+ base_currency_name: Joi.string().allow("").required(),
1574
+ ttl_seconds: Joi.number().required(),
1575
+ items: Joi.array()
1576
+ .items(ConfigurationPlatformModel.CurrencyExchangeItem())
1577
+ .required(),
1578
+ total: Joi.number().required(),
1579
+ });
1580
+ }
1879
1581
 
1880
- /**
1881
- * @typedef StoreResponse
1882
- * @property {number[]} [data]
1883
- */
1582
+ /** @returns {CurrencyExchangeItem} */
1583
+ static CurrencyExchangeItem() {
1584
+ return Joi.object({
1585
+ currency_code: Joi.string().allow("").required(),
1586
+ name: Joi.string().allow("").required(),
1587
+ rate: Joi.number().required(),
1588
+ country_code: Joi.string().allow("").required(),
1589
+ country_name: Joi.string().allow("").required(),
1590
+ subunit: Joi.string().allow("").required(),
1591
+ decimal_digits: Joi.number().required(),
1592
+ symbol: Joi.string().allow("").required(),
1593
+ });
1594
+ }
1884
1595
 
1885
- class ConfigurationPlatformModel {
1886
1596
  /** @returns {ApplicationInventory} */
1887
1597
  static ApplicationInventory() {
1888
1598
  return Joi.object({
1599
+ search: ConfigurationPlatformModel.SearchConfig(),
1889
1600
  inventory: ConfigurationPlatformModel.AppInventoryConfig(),
1890
1601
  authentication: ConfigurationPlatformModel.AuthenticationConfig(),
1891
1602
  article_assignment: ConfigurationPlatformModel.ArticleAssignmentConfig(),
@@ -1917,35 +1628,44 @@ class ConfigurationPlatformModel {
1917
1628
  });
1918
1629
  }
1919
1630
 
1920
- /** @returns {OwnerAppInventoryConfig} */
1921
- static OwnerAppInventoryConfig() {
1631
+ /** @returns {FstIdentification} */
1632
+ static FstIdentification() {
1633
+ return Joi.object({
1634
+ enabled: Joi.boolean(),
1635
+ });
1636
+ }
1637
+
1638
+ /** @returns {QuerySuggestions} */
1639
+ static QuerySuggestions() {
1922
1640
  return Joi.object({
1923
- pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
1641
+ enabled: Joi.boolean(),
1642
+ max_limit: Joi.number(),
1924
1643
  });
1925
1644
  }
1926
1645
 
1927
- /** @returns {OwnerAppConfig} */
1928
- static OwnerAppConfig() {
1646
+ /** @returns {SearchConfig} */
1647
+ static SearchConfig() {
1929
1648
  return Joi.object({
1930
- inventory: ConfigurationPlatformModel.OwnerAppInventoryConfig(),
1649
+ fst_identification: ConfigurationPlatformModel.FstIdentification(),
1650
+ query_suggestions: ConfigurationPlatformModel.QuerySuggestions(),
1931
1651
  });
1932
1652
  }
1933
1653
 
1934
1654
  /** @returns {AppInventoryConfig} */
1935
1655
  static AppInventoryConfig() {
1936
1656
  return Joi.object({
1657
+ delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
1937
1658
  brand: ConfigurationPlatformModel.InventoryBrand(),
1938
1659
  store: ConfigurationPlatformModel.InventoryStore(),
1939
1660
  category: ConfigurationPlatformModel.InventoryCategory(),
1940
1661
  price: ConfigurationPlatformModel.InventoryPrice(),
1941
1662
  discount: ConfigurationPlatformModel.InventoryDiscount(),
1942
- pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
1943
1663
  out_of_stock: Joi.boolean(),
1944
1664
  only_verified_products: Joi.boolean(),
1945
1665
  franchise_enabled: Joi.boolean(),
1946
- exclude_category: Joi.array().items(Joi.number()),
1666
+ exclude_category: Joi.array().items(Joi.any()),
1947
1667
  image: Joi.array().items(Joi.string().allow("")),
1948
- company_store: Joi.array().items(Joi.number()),
1668
+ company_store: Joi.array().items(Joi.any()),
1949
1669
  company_id: Joi.number(),
1950
1670
  });
1951
1671
  }
@@ -1962,7 +1682,7 @@ class ConfigurationPlatformModel {
1962
1682
  static InventoryStore() {
1963
1683
  return Joi.object({
1964
1684
  criteria: Joi.string().allow(""),
1965
- stores: Joi.array().items(Joi.number()),
1685
+ stores: Joi.array().items(Joi.any()),
1966
1686
  rules: Joi.array().items(ConfigurationPlatformModel.AppStoreRules()),
1967
1687
  });
1968
1688
  }
@@ -1979,7 +1699,7 @@ class ConfigurationPlatformModel {
1979
1699
  static InventoryCategory() {
1980
1700
  return Joi.object({
1981
1701
  criteria: Joi.string().allow(""),
1982
- categories: Joi.array().items(Joi.number()),
1702
+ categories: Joi.array().items(Joi.any()),
1983
1703
  });
1984
1704
  }
1985
1705
 
@@ -2027,7 +1747,7 @@ class ConfigurationPlatformModel {
2027
1747
  static StorePriority() {
2028
1748
  return Joi.object({
2029
1749
  enabled: Joi.boolean(),
2030
- storetype_order: Joi.array().items(Joi.number()),
1750
+ storetype_order: Joi.array().items(Joi.any()),
2031
1751
  });
2032
1752
  }
2033
1753
 
@@ -2164,6 +1884,7 @@ class ConfigurationPlatformModel {
2164
1884
  /** @returns {AppInventoryPartialUpdate} */
2165
1885
  static AppInventoryPartialUpdate() {
2166
1886
  return Joi.object({
1887
+ search: ConfigurationPlatformModel.SearchConfig(),
2167
1888
  reward_points: ConfigurationPlatformModel.RewardPointsConfig(),
2168
1889
  cart: ConfigurationPlatformModel.AppCartConfig(),
2169
1890
  payment: ConfigurationPlatformModel.AppPaymentConfig(),
@@ -2181,24 +1902,24 @@ class ConfigurationPlatformModel {
2181
1902
  });
2182
1903
  }
2183
1904
 
2184
- /** @returns {CompanyByBrandsRequest} */
2185
- static CompanyByBrandsRequest() {
1905
+ /** @returns {CompanyByBrandsRequestSchema} */
1906
+ static CompanyByBrandsRequestSchema() {
2186
1907
  return Joi.object({
2187
1908
  brands: Joi.number().required(),
2188
1909
  search_text: Joi.string().allow(""),
2189
1910
  });
2190
1911
  }
2191
1912
 
2192
- /** @returns {CompanyByBrandsResponse} */
2193
- static CompanyByBrandsResponse() {
1913
+ /** @returns {CompanyByBrandsResponseSchema} */
1914
+ static CompanyByBrandsResponseSchema() {
2194
1915
  return Joi.object({
2195
1916
  items: Joi.array().items(ConfigurationPlatformModel.BrandCompanyInfo()),
2196
1917
  page: ConfigurationPlatformModel.Page(),
2197
1918
  });
2198
1919
  }
2199
1920
 
2200
- /** @returns {StoreByBrandsRequest} */
2201
- static StoreByBrandsRequest() {
1921
+ /** @returns {StoreByBrandsRequestSchema} */
1922
+ static StoreByBrandsRequestSchema() {
2202
1923
  return Joi.object({
2203
1924
  company_id: Joi.number(),
2204
1925
  brands: Joi.number().required(),
@@ -2206,8 +1927,8 @@ class ConfigurationPlatformModel {
2206
1927
  });
2207
1928
  }
2208
1929
 
2209
- /** @returns {StoreByBrandsResponse} */
2210
- static StoreByBrandsResponse() {
1930
+ /** @returns {StoreByBrandsResponseSchema} */
1931
+ static StoreByBrandsResponseSchema() {
2211
1932
  return Joi.object({
2212
1933
  items: Joi.array().items(ConfigurationPlatformModel.BrandStoreInfo()),
2213
1934
  page: ConfigurationPlatformModel.Page(),
@@ -2237,18 +1958,17 @@ class ConfigurationPlatformModel {
2237
1958
  });
2238
1959
  }
2239
1960
 
2240
- /** @returns {BrandsByCompanyResponse} */
2241
- static BrandsByCompanyResponse() {
1961
+ /** @returns {BrandsByCompanyResponseSchema} */
1962
+ static BrandsByCompanyResponseSchema() {
2242
1963
  return Joi.object({
2243
1964
  brands: Joi.array().items(ConfigurationPlatformModel.CompanyBrandInfo()),
2244
1965
  });
2245
1966
  }
2246
1967
 
2247
- /** @returns {ValidationFailedResponse} */
2248
- static ValidationFailedResponse() {
1968
+ /** @returns {ValidationFailedResponseSchema} */
1969
+ static ValidationFailedResponseSchema() {
2249
1970
  return Joi.object({
2250
1971
  message: Joi.string().allow(""),
2251
- errors: Joi.array().items(Joi.any()),
2252
1972
  });
2253
1973
  }
2254
1974
 
@@ -2256,8 +1976,6 @@ class ConfigurationPlatformModel {
2256
1976
  static NotFound() {
2257
1977
  return Joi.object({
2258
1978
  message: Joi.string().allow(""),
2259
- error: Joi.string().allow(""),
2260
- code: Joi.string().allow(""),
2261
1979
  success: Joi.boolean(),
2262
1980
  });
2263
1981
  }
@@ -2287,8 +2005,8 @@ class ConfigurationPlatformModel {
2287
2005
  });
2288
2006
  }
2289
2007
 
2290
- /** @returns {CreateApplicationRequest} */
2291
- static CreateApplicationRequest() {
2008
+ /** @returns {CreateApplicationRequestSchema} */
2009
+ static CreateApplicationRequestSchema() {
2292
2010
  return Joi.object({
2293
2011
  app: ConfigurationPlatformModel.App(),
2294
2012
  configuration: ConfigurationPlatformModel.ApplicationInventory(),
@@ -2296,16 +2014,16 @@ class ConfigurationPlatformModel {
2296
2014
  });
2297
2015
  }
2298
2016
 
2299
- /** @returns {CreateAppResponse} */
2300
- static CreateAppResponse() {
2017
+ /** @returns {CreateAppResponseSchema} */
2018
+ static CreateAppResponseSchema() {
2301
2019
  return Joi.object({
2302
2020
  app: ConfigurationPlatformModel.Application(),
2303
2021
  configuration: ConfigurationPlatformModel.ApplicationInventory(),
2304
2022
  });
2305
2023
  }
2306
2024
 
2307
- /** @returns {ApplicationsResponse} */
2308
- static ApplicationsResponse() {
2025
+ /** @returns {ApplicationsResponseSchema} */
2026
+ static ApplicationsResponseSchema() {
2309
2027
  return Joi.object({
2310
2028
  items: Joi.array().items(ConfigurationPlatformModel.Application()),
2311
2029
  page: ConfigurationPlatformModel.Page(),
@@ -2345,8 +2063,8 @@ class ConfigurationPlatformModel {
2345
2063
  });
2346
2064
  }
2347
2065
 
2348
- /** @returns {MobileAppConfigRequest} */
2349
- static MobileAppConfigRequest() {
2066
+ /** @returns {MobileAppConfigRequestSchema} */
2067
+ static MobileAppConfigRequestSchema() {
2350
2068
  return Joi.object({
2351
2069
  app_name: Joi.string().allow(""),
2352
2070
  landing_image: ConfigurationPlatformModel.LandingImage(),
@@ -2412,8 +2130,8 @@ class ConfigurationPlatformModel {
2412
2130
  });
2413
2131
  }
2414
2132
 
2415
- /** @returns {DomainAddRequest} */
2416
- static DomainAddRequest() {
2133
+ /** @returns {DomainAddRequestSchema} */
2134
+ static DomainAddRequestSchema() {
2417
2135
  return Joi.object({
2418
2136
  domain: ConfigurationPlatformModel.DomainAdd(),
2419
2137
  });
@@ -2432,8 +2150,8 @@ class ConfigurationPlatformModel {
2432
2150
  });
2433
2151
  }
2434
2152
 
2435
- /** @returns {DomainsResponse} */
2436
- static DomainsResponse() {
2153
+ /** @returns {DomainsResponseSchema} */
2154
+ static DomainsResponseSchema() {
2437
2155
  return Joi.object({
2438
2156
  domains: Joi.array().items(ConfigurationPlatformModel.Domain()),
2439
2157
  });
@@ -2450,16 +2168,16 @@ class ConfigurationPlatformModel {
2450
2168
  });
2451
2169
  }
2452
2170
 
2453
- /** @returns {UpdateDomainTypeRequest} */
2454
- static UpdateDomainTypeRequest() {
2171
+ /** @returns {UpdateDomainTypeRequestSchema} */
2172
+ static UpdateDomainTypeRequestSchema() {
2455
2173
  return Joi.object({
2456
2174
  domain: ConfigurationPlatformModel.UpdateDomain(),
2457
2175
  action: Joi.string().allow(""),
2458
2176
  });
2459
2177
  }
2460
2178
 
2461
- /** @returns {DomainStatusRequest} */
2462
- static DomainStatusRequest() {
2179
+ /** @returns {DomainStatusRequestSchema} */
2180
+ static DomainStatusRequestSchema() {
2463
2181
  return Joi.object({
2464
2182
  domain_url: Joi.string().allow(""),
2465
2183
  });
@@ -2473,18 +2191,19 @@ class ConfigurationPlatformModel {
2473
2191
  });
2474
2192
  }
2475
2193
 
2476
- /** @returns {DomainStatusResponse} */
2477
- static DomainStatusResponse() {
2194
+ /** @returns {DomainStatusResponseSchema} */
2195
+ static DomainStatusResponseSchema() {
2478
2196
  return Joi.object({
2479
2197
  connected: Joi.boolean(),
2480
2198
  status: Joi.array().items(ConfigurationPlatformModel.DomainStatus()),
2481
2199
  });
2482
2200
  }
2483
2201
 
2484
- /** @returns {DomainSuggestionsRequest} */
2485
- static DomainSuggestionsRequest() {
2202
+ /** @returns {DomainSuggestionsRequestSchema} */
2203
+ static DomainSuggestionsRequestSchema() {
2486
2204
  return Joi.object({
2487
2205
  domain_url: Joi.string().allow(""),
2206
+ custom_domain: Joi.boolean(),
2488
2207
  });
2489
2208
  }
2490
2209
 
@@ -2499,261 +2218,41 @@ class ConfigurationPlatformModel {
2499
2218
  });
2500
2219
  }
2501
2220
 
2502
- /** @returns {DomainSuggestionsResponse} */
2503
- static DomainSuggestionsResponse() {
2221
+ /** @returns {DomainSuggestionsResponseSchema} */
2222
+ static DomainSuggestionsResponseSchema() {
2504
2223
  return Joi.object({
2505
2224
  domains: Joi.array().items(ConfigurationPlatformModel.DomainSuggestion()),
2506
2225
  });
2507
2226
  }
2508
2227
 
2509
- /** @returns {SuccessMessageResponse} */
2510
- static SuccessMessageResponse() {
2228
+ /** @returns {SuccessMessageResponseSchema} */
2229
+ static SuccessMessageResponseSchema() {
2511
2230
  return Joi.object({
2512
2231
  success: Joi.boolean(),
2513
2232
  message: Joi.string().allow(""),
2514
2233
  });
2515
2234
  }
2516
2235
 
2517
- /** @returns {GetIntegrationsOptInsResponse} */
2518
- static GetIntegrationsOptInsResponse() {
2236
+ /** @returns {App} */
2237
+ static App() {
2519
2238
  return Joi.object({
2520
- items: Joi.array().items(ConfigurationPlatformModel.IntegrationOptIn()),
2521
- page: ConfigurationPlatformModel.Page(),
2239
+ company_id: Joi.string().allow(""),
2240
+ channel_type: Joi.string().allow(""),
2241
+ auth: ConfigurationPlatformModel.ApplicationAuth(),
2242
+ name: Joi.string().allow(""),
2243
+ desc: Joi.string().allow(""),
2522
2244
  });
2523
2245
  }
2524
2246
 
2525
- /** @returns {IntegrationOptIn} */
2526
- static IntegrationOptIn() {
2247
+ /** @returns {AppDomain} */
2248
+ static AppDomain() {
2527
2249
  return Joi.object({
2528
- validators: ConfigurationPlatformModel.Validators(),
2529
- description: Joi.string().allow(""),
2530
- description_html: Joi.string().allow(""),
2531
- constants: Joi.string().allow(""),
2532
- companies: Joi.array().items(Joi.string().allow("")),
2533
- support: Joi.array().items(Joi.string().allow("")),
2534
- _id: Joi.string().allow(""),
2535
2250
  name: Joi.string().allow(""),
2536
- slug: Joi.string().allow(""),
2537
- hidden: Joi.boolean(),
2538
- meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
2539
- icon: Joi.string().allow(""),
2540
- owner: Joi.string().allow(""),
2541
- created_at: Joi.string().allow(""),
2542
- modified_at: Joi.string().allow(""),
2543
- token: Joi.string().allow(""),
2544
- secret: Joi.string().allow(""),
2545
- __v: Joi.number(),
2546
2251
  });
2547
2252
  }
2548
2253
 
2549
- /** @returns {Validators} */
2550
- static Validators() {
2551
- return Joi.object({
2552
- company: ConfigurationPlatformModel.CompanyValidator(),
2553
- store: ConfigurationPlatformModel.StoreValidator(),
2554
- inventory: ConfigurationPlatformModel.InventoryValidator(),
2555
- order: ConfigurationPlatformModel.OrderValidator(),
2556
- });
2557
- }
2558
-
2559
- /** @returns {CompanyValidator} */
2560
- static CompanyValidator() {
2561
- return Joi.object({
2562
- json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
2563
- browser_script: Joi.string().allow(""),
2564
- });
2565
- }
2566
-
2567
- /** @returns {JsonSchema} */
2568
- static JsonSchema() {
2569
- return Joi.object({
2570
- display: Joi.string().allow(""),
2571
- key: Joi.string().allow(""),
2572
- type: Joi.string().allow(""),
2573
- tooltip: Joi.string().allow(""),
2574
- });
2575
- }
2576
-
2577
- /** @returns {StoreValidator} */
2578
- static StoreValidator() {
2579
- return Joi.object({
2580
- json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
2581
- browser_script: Joi.string().allow(""),
2582
- });
2583
- }
2584
-
2585
- /** @returns {InventoryValidator} */
2586
- static InventoryValidator() {
2587
- return Joi.object({
2588
- json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
2589
- browser_script: Joi.string().allow(""),
2590
- });
2591
- }
2592
-
2593
- /** @returns {OrderValidator} */
2594
- static OrderValidator() {
2595
- return Joi.object({
2596
- json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
2597
- browser_script: Joi.string().allow(""),
2598
- });
2599
- }
2600
-
2601
- /** @returns {IntegrationMeta} */
2602
- static IntegrationMeta() {
2603
- return Joi.object({
2604
- is_public: Joi.boolean(),
2605
- _id: Joi.string().allow(""),
2606
- name: Joi.string().allow(""),
2607
- value: Joi.string().allow(""),
2608
- });
2609
- }
2610
-
2611
- /** @returns {Integration} */
2612
- static Integration() {
2613
- return Joi.object({
2614
- validators: ConfigurationPlatformModel.Validators(),
2615
- description: Joi.string().allow(""),
2616
- description_html: Joi.string().allow(""),
2617
- constants: Joi.any(),
2618
- companies: Joi.array().items(Joi.string().allow("")),
2619
- support: Joi.array().items(Joi.string().allow("")),
2620
- _id: Joi.string().allow(""),
2621
- name: Joi.string().allow(""),
2622
- slug: Joi.string().allow(""),
2623
- meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
2624
- icon: Joi.string().allow(""),
2625
- hidden: Joi.boolean(),
2626
- owner: Joi.string().allow(""),
2627
- created_at: Joi.string().allow(""),
2628
- modified_at: Joi.string().allow(""),
2629
- token: Joi.string().allow(""),
2630
- secret: Joi.string().allow(""),
2631
- __v: Joi.number(),
2632
- });
2633
- }
2634
-
2635
- /** @returns {IntegrationConfigResponse} */
2636
- static IntegrationConfigResponse() {
2637
- return Joi.object({
2638
- items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
2639
- });
2640
- }
2641
-
2642
- /** @returns {IntegrationLevel} */
2643
- static IntegrationLevel() {
2644
- return Joi.object({
2645
- opted: Joi.boolean(),
2646
- permissions: Joi.array().items(Joi.any()),
2647
- last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
2648
- _id: Joi.string().allow(""),
2649
- integration: Joi.string().allow(""),
2650
- level: Joi.string().allow(""),
2651
- uid: Joi.number(),
2652
- company_id: Joi.number(),
2653
- meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
2654
- token: Joi.string().allow(""),
2655
- created_at: Joi.string().allow(""),
2656
- modified_at: Joi.string().allow(""),
2657
- __v: Joi.number(),
2658
- data: Joi.any(),
2659
- success: Joi.boolean(),
2660
- message: Joi.string().allow(""),
2661
- });
2662
- }
2663
-
2664
- /** @returns {UpdateIntegrationLevelRequest} */
2665
- static UpdateIntegrationLevelRequest() {
2666
- return Joi.object({
2667
- items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
2668
- });
2669
- }
2670
-
2671
- /** @returns {OptedStoreIntegration} */
2672
- static OptedStoreIntegration() {
2673
- return Joi.object({
2674
- other_opted: Joi.boolean(),
2675
- other_integration: ConfigurationPlatformModel.IntegrationOptIn(),
2676
- other_entity: ConfigurationPlatformModel.OtherEntity(),
2677
- });
2678
- }
2679
-
2680
- /** @returns {OtherEntity} */
2681
- static OtherEntity() {
2682
- return Joi.object({
2683
- opted: Joi.boolean(),
2684
- permissions: Joi.array().items(Joi.string().allow("")),
2685
- last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
2686
- _id: Joi.string().allow(""),
2687
- integration: Joi.string().allow(""),
2688
- level: Joi.string().allow(""),
2689
- uid: Joi.number(),
2690
- data: ConfigurationPlatformModel.OtherEntityData(),
2691
- meta: Joi.array().items(Joi.any()),
2692
- token: Joi.string().allow(""),
2693
- created_at: Joi.string().allow(""),
2694
- modified_at: Joi.string().allow(""),
2695
- __v: Joi.number(),
2696
- });
2697
- }
2698
-
2699
- /** @returns {LastPatch} */
2700
- static LastPatch() {
2701
- return Joi.object({
2702
- op: Joi.string().allow(""),
2703
- path: Joi.string().allow(""),
2704
- value: Joi.string().allow(""),
2705
- });
2706
- }
2707
-
2708
- /** @returns {OtherEntityData} */
2709
- static OtherEntityData() {
2710
- return Joi.object({
2711
- article_identifier: Joi.string().allow(""),
2712
- });
2713
- }
2714
-
2715
- /** @returns {App} */
2716
- static App() {
2717
- return Joi.object({
2718
- company_id: Joi.string().allow(""),
2719
- channel_type: Joi.string().allow(""),
2720
- auth: ConfigurationPlatformModel.ApplicationAuth(),
2721
- name: Joi.string().allow(""),
2722
- desc: Joi.string().allow(""),
2723
- });
2724
- }
2725
-
2726
- /** @returns {InventoryConfig} */
2727
- static InventoryConfig() {
2728
- return Joi.object({
2729
- brand: ConfigurationPlatformModel.InventoryBrandRule(),
2730
- store: ConfigurationPlatformModel.InventoryStoreRule(),
2731
- image: Joi.array().items(Joi.string().allow("")),
2732
- franchise_enabled: Joi.boolean(),
2733
- out_of_stock: Joi.boolean(),
2734
- only_verified_products: Joi.boolean(),
2735
- pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
2736
- });
2737
- }
2738
-
2739
- /** @returns {AppInventory} */
2740
- static AppInventory() {
2741
- return Joi.object({
2742
- inventory: ConfigurationPlatformModel.InventoryConfig(),
2743
- payment: ConfigurationPlatformModel.InventoryPaymentConfig(),
2744
- article_assignment: ConfigurationPlatformModel.InventoryArticleAssignment(),
2745
- });
2746
- }
2747
-
2748
- /** @returns {AppDomain} */
2749
- static AppDomain() {
2750
- return Joi.object({
2751
- name: Joi.string().allow(""),
2752
- });
2753
- }
2754
-
2755
- /** @returns {CompaniesResponse} */
2756
- static CompaniesResponse() {
2254
+ /** @returns {CompaniesResponseSchema} */
2255
+ static CompaniesResponseSchema() {
2757
2256
  return Joi.object({
2758
2257
  items: Joi.array().items(
2759
2258
  ConfigurationPlatformModel.AppInventoryCompanies()
@@ -2771,30 +2270,14 @@ class ConfigurationPlatformModel {
2771
2270
  });
2772
2271
  }
2773
2272
 
2774
- /** @returns {StoresResponse} */
2775
- static StoresResponse() {
2273
+ /** @returns {StoresResponseSchema} */
2274
+ static StoresResponseSchema() {
2776
2275
  return Joi.object({
2777
2276
  items: Joi.array().items(ConfigurationPlatformModel.AppInventoryStores()),
2778
2277
  page: ConfigurationPlatformModel.Page(),
2779
2278
  });
2780
2279
  }
2781
2280
 
2782
- /** @returns {ListStoreResponse} */
2783
- static ListStoreResponse() {
2784
- return Joi.object({
2785
- stores: Joi.array().items(
2786
- ConfigurationPlatformModel.AppInventoryStores()
2787
- ),
2788
- });
2789
- }
2790
-
2791
- /** @returns {ArrayStoreResponse} */
2792
- static ArrayStoreResponse() {
2793
- return Joi.object({
2794
- data: Joi.array().items(ConfigurationPlatformModel.AppInventoryStores()),
2795
- });
2796
- }
2797
-
2798
2281
  /** @returns {AppInventoryStores} */
2799
2282
  static AppInventoryStores() {
2800
2283
  return Joi.object({
@@ -2811,8 +2294,8 @@ class ConfigurationPlatformModel {
2811
2294
  });
2812
2295
  }
2813
2296
 
2814
- /** @returns {FilterOrderingStoreRequest} */
2815
- static FilterOrderingStoreRequest() {
2297
+ /** @returns {FilterOrderingStoreRequestSchema} */
2298
+ static FilterOrderingStoreRequestSchema() {
2816
2299
  return Joi.object({
2817
2300
  all_stores: Joi.boolean(),
2818
2301
  deployed_stores: Joi.array().items(Joi.number()),
@@ -2840,8 +2323,8 @@ class ConfigurationPlatformModel {
2840
2323
  });
2841
2324
  }
2842
2325
 
2843
- /** @returns {OrderingStoreSelectRequest} */
2844
- static OrderingStoreSelectRequest() {
2326
+ /** @returns {OrderingStoreSelectRequestSchema} */
2327
+ static OrderingStoreSelectRequestSchema() {
2845
2328
  return Joi.object({
2846
2329
  ordering_store: ConfigurationPlatformModel.OrderingStoreSelect().required(),
2847
2330
  });
@@ -2884,8 +2367,8 @@ class ConfigurationPlatformModel {
2884
2367
  });
2885
2368
  }
2886
2369
 
2887
- /** @returns {OptedApplicationResponse} */
2888
- static OptedApplicationResponse() {
2370
+ /** @returns {OptedApplicationResponseSchema} */
2371
+ static OptedApplicationResponseSchema() {
2889
2372
  return Joi.object({
2890
2373
  name: Joi.string().allow(""),
2891
2374
  description: Joi.string().allow(""),
@@ -2945,8 +2428,8 @@ class ConfigurationPlatformModel {
2945
2428
  });
2946
2429
  }
2947
2430
 
2948
- /** @returns {TokenResponse} */
2949
- static TokenResponse() {
2431
+ /** @returns {TokenResponseSchema} */
2432
+ static TokenResponseSchema() {
2950
2433
  return Joi.object({
2951
2434
  tokens: ConfigurationPlatformModel.Tokens(),
2952
2435
  _id: Joi.string().allow(""),
@@ -3102,6 +2585,7 @@ class ConfigurationPlatformModel {
3102
2585
  /** @returns {GoogleMap} */
3103
2586
  static GoogleMap() {
3104
2587
  return Joi.object({
2588
+ enabled: Joi.boolean(),
3105
2589
  credentials: ConfigurationPlatformModel.GoogleMapCredentials(),
3106
2590
  });
3107
2591
  }
@@ -3151,8 +2635,8 @@ class ConfigurationPlatformModel {
3151
2635
  static LaunchPage() {
3152
2636
  return Joi.object({
3153
2637
  page_type: Joi.string().allow(""),
3154
- params: Joi.any(),
3155
- query: Joi.any(),
2638
+ params: Joi.object().pattern(/\S/, Joi.any()),
2639
+ query: Joi.object().pattern(/\S/, Joi.any()),
3156
2640
  });
3157
2641
  }
3158
2642
 
@@ -3181,6 +2665,22 @@ class ConfigurationPlatformModel {
3181
2665
  });
3182
2666
  }
3183
2667
 
2668
+ /** @returns {BuyboxFeature} */
2669
+ static BuyboxFeature() {
2670
+ return Joi.object({
2671
+ show_name: Joi.boolean(),
2672
+ enable_selection: Joi.boolean(),
2673
+ is_seller_buybox_enabled: Joi.boolean(),
2674
+ });
2675
+ }
2676
+
2677
+ /** @returns {DeliveryStrategy} */
2678
+ static DeliveryStrategy() {
2679
+ return Joi.object({
2680
+ value: Joi.string().allow(""),
2681
+ });
2682
+ }
2683
+
3184
2684
  /** @returns {AppFeature} */
3185
2685
  static AppFeature() {
3186
2686
  return Joi.object({
@@ -3194,12 +2694,12 @@ class ConfigurationPlatformModel {
3194
2694
  pcr: ConfigurationPlatformModel.PcrFeature(),
3195
2695
  order: ConfigurationPlatformModel.OrderFeature(),
3196
2696
  buybox: ConfigurationPlatformModel.BuyboxFeature(),
2697
+ delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
3197
2698
  _id: Joi.string().allow(""),
3198
2699
  app: Joi.string().allow(""),
3199
2700
  created_at: Joi.string().allow(""),
3200
2701
  modified_at: Joi.string().allow(""),
3201
2702
  __v: Joi.number(),
3202
- pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
3203
2703
  });
3204
2704
  }
3205
2705
 
@@ -3320,24 +2820,15 @@ class ConfigurationPlatformModel {
3320
2820
  });
3321
2821
  }
3322
2822
 
3323
- /** @returns {BuyboxFeature} */
3324
- static BuyboxFeature() {
3325
- return Joi.object({
3326
- show_name: Joi.boolean(),
3327
- enable_selection: Joi.boolean(),
3328
- is_seller_buybox_enabled: Joi.boolean(),
3329
- });
3330
- }
3331
-
3332
- /** @returns {AppFeatureRequest} */
3333
- static AppFeatureRequest() {
2823
+ /** @returns {AppFeatureRequestSchema} */
2824
+ static AppFeatureRequestSchema() {
3334
2825
  return Joi.object({
3335
2826
  feature: ConfigurationPlatformModel.AppFeature(),
3336
2827
  });
3337
2828
  }
3338
2829
 
3339
- /** @returns {AppFeatureResponse} */
3340
- static AppFeatureResponse() {
2830
+ /** @returns {AppFeatureResponseSchema} */
2831
+ static AppFeatureResponseSchema() {
3341
2832
  return Joi.object({
3342
2833
  feature: ConfigurationPlatformModel.AppFeature(),
3343
2834
  });
@@ -3443,84 +2934,67 @@ class ConfigurationPlatformModel {
3443
2934
  });
3444
2935
  }
3445
2936
 
3446
- /** @returns {TokenSchema} */
3447
- static TokenSchema() {
2937
+ /** @returns {ApplicationById} */
2938
+ static ApplicationById() {
3448
2939
  return Joi.object({
2940
+ website: ConfigurationPlatformModel.ApplicationWebsite(),
2941
+ cors: ConfigurationPlatformModel.ApplicationCors(),
2942
+ auth: ConfigurationPlatformModel.ApplicationAuth(),
2943
+ description: Joi.string().allow(""),
2944
+ channel_type: Joi.string().allow(""),
2945
+ cache_ttl: Joi.number(),
2946
+ is_internal: Joi.boolean(),
2947
+ is_active: Joi.boolean(),
2948
+ _id: Joi.string().allow(""),
2949
+ name: Joi.string().allow(""),
2950
+ owner: Joi.string().allow(""),
2951
+ company_id: Joi.number(),
3449
2952
  token: Joi.string().allow(""),
3450
- created_by: Joi.object().pattern(/\S/, Joi.any()),
2953
+ redirections: Joi.array().items(
2954
+ ConfigurationPlatformModel.ApplicationRedirections()
2955
+ ),
2956
+ meta: Joi.array().items(ConfigurationPlatformModel.ApplicationMeta()),
3451
2957
  created_at: Joi.string().allow(""),
2958
+ modified_at: Joi.string().allow(""),
2959
+ __v: Joi.number(),
2960
+ banner: ConfigurationPlatformModel.SecureUrl(),
2961
+ logo: ConfigurationPlatformModel.SecureUrl(),
2962
+ favicon: ConfigurationPlatformModel.SecureUrl(),
2963
+ domains: Joi.array().items(ConfigurationPlatformModel.Domain()),
2964
+ app_type: Joi.string().allow(""),
2965
+ mobile_logo: ConfigurationPlatformModel.SecureUrl(),
2966
+ domain: ConfigurationPlatformModel.Domain(),
2967
+ slug: Joi.string().allow(""),
2968
+ mode: Joi.string().allow(""),
2969
+ status: Joi.string().allow(""),
2970
+ tokens: Joi.array().items(ConfigurationPlatformModel.TokenSchemaID()),
2971
+ secret: Joi.string().allow(""),
3452
2972
  });
3453
2973
  }
3454
2974
 
3455
- /** @returns {InvalidPayloadRequest} */
3456
- static InvalidPayloadRequest() {
3457
- return Joi.object({
3458
- message: Joi.string().allow(""),
3459
- success: Joi.boolean(),
3460
- domain: Joi.any(),
3461
- });
3462
- }
3463
-
3464
- /** @returns {InventoryBrandRule} */
3465
- static InventoryBrandRule() {
3466
- return Joi.object({
3467
- criteria: Joi.string().allow(""),
3468
- brands: Joi.array().items(Joi.number()),
3469
- });
3470
- }
3471
-
3472
- /** @returns {PricingStrategy} */
3473
- static PricingStrategy() {
3474
- return Joi.object({
3475
- value: Joi.string().allow(""),
3476
- });
3477
- }
3478
-
3479
- /** @returns {StoreCriteriaRule} */
3480
- static StoreCriteriaRule() {
3481
- return Joi.object({
3482
- companies: Joi.array().items(Joi.number()),
3483
- brands: Joi.array().items(Joi.number()),
3484
- });
3485
- }
3486
-
3487
- /** @returns {InventoryStoreRule} */
3488
- static InventoryStoreRule() {
3489
- return Joi.object({
3490
- criteria: Joi.string().allow(""),
3491
- rules: Joi.array().items(ConfigurationPlatformModel.StoreCriteriaRule()),
3492
- stores: Joi.array().items(Joi.number()),
3493
- });
3494
- }
3495
-
3496
- /** @returns {InventoryPaymentConfig} */
3497
- static InventoryPaymentConfig() {
3498
- return Joi.object({
3499
- mode_of_payment: Joi.string().allow(""),
3500
- source: Joi.string().allow(""),
3501
- });
3502
- }
3503
-
3504
- /** @returns {StorePriorityRule} */
3505
- static StorePriorityRule() {
2975
+ /** @returns {TokenSchemaID} */
2976
+ static TokenSchemaID() {
3506
2977
  return Joi.object({
3507
- enabled: Joi.boolean(),
3508
- storetype_order: Joi.array().items(Joi.string().allow("")),
2978
+ token: Joi.string().allow(""),
2979
+ created_by: Joi.string().allow(""),
2980
+ created_at: Joi.string().allow(""),
3509
2981
  });
3510
2982
  }
3511
2983
 
3512
- /** @returns {ArticleAssignmentRule} */
3513
- static ArticleAssignmentRule() {
2984
+ /** @returns {TokenSchema} */
2985
+ static TokenSchema() {
3514
2986
  return Joi.object({
3515
- store_priority: ConfigurationPlatformModel.StorePriorityRule(),
2987
+ token: Joi.string().allow(""),
2988
+ created_by: Joi.object().pattern(/\S/, Joi.any()),
2989
+ created_at: Joi.string().allow(""),
3516
2990
  });
3517
2991
  }
3518
2992
 
3519
- /** @returns {InventoryArticleAssignment} */
3520
- static InventoryArticleAssignment() {
2993
+ /** @returns {InvalidPayloadRequestSchema} */
2994
+ static InvalidPayloadRequestSchema() {
3521
2995
  return Joi.object({
3522
- post_order_reassignment: Joi.boolean(),
3523
- rules: ConfigurationPlatformModel.ArticleAssignmentRule(),
2996
+ message: Joi.string().allow(""),
2997
+ success: Joi.boolean(),
3524
2998
  });
3525
2999
  }
3526
3000
 
@@ -3534,7 +3008,7 @@ class ConfigurationPlatformModel {
3534
3008
  current: Joi.number(),
3535
3009
  type: Joi.string().allow("").required(),
3536
3010
  size: Joi.number(),
3537
- total: Joi.number(),
3011
+ page_size: Joi.number(),
3538
3012
  });
3539
3013
  }
3540
3014
 
@@ -3746,15 +3220,15 @@ class ConfigurationPlatformModel {
3746
3220
  });
3747
3221
  }
3748
3222
 
3749
- /** @returns {CurrenciesResponse} */
3750
- static CurrenciesResponse() {
3223
+ /** @returns {CurrenciesResponseSchema} */
3224
+ static CurrenciesResponseSchema() {
3751
3225
  return Joi.object({
3752
3226
  items: Joi.array().items(ConfigurationPlatformModel.Currency()),
3753
3227
  });
3754
3228
  }
3755
3229
 
3756
- /** @returns {AppCurrencyResponse} */
3757
- static AppCurrencyResponse() {
3230
+ /** @returns {AppCurrencyResponseSchema} */
3231
+ static AppCurrencyResponseSchema() {
3758
3232
  return Joi.object({
3759
3233
  _id: Joi.string().allow(""),
3760
3234
  application: Joi.string().allow(""),
@@ -3821,167 +3295,28 @@ class ConfigurationPlatformModel {
3821
3295
  });
3822
3296
  }
3823
3297
 
3824
- /** @returns {UpdateDiealog} */
3825
- static UpdateDiealog() {
3826
- return Joi.object({
3827
- type: Joi.string().allow("").required(),
3828
- interval: Joi.number(),
3829
- });
3830
- }
3831
-
3832
- /** @returns {PlatformVersionRequest} */
3833
- static PlatformVersionRequest() {
3834
- return Joi.object({
3835
- app_code_name: Joi.string().allow("").required(),
3836
- app_name: Joi.string().allow("").required(),
3837
- force_version: Joi.string().allow("").required(),
3838
- latest_version: Joi.string().allow("").required(),
3839
- is_app_blocked: Joi.boolean().required(),
3840
- update_dialog: ConfigurationPlatformModel.UpdateDiealog().required(),
3841
- });
3842
- }
3843
-
3844
- /** @returns {PlatformVersion} */
3845
- static PlatformVersion() {
3846
- return Joi.object({
3847
- app_code_name: Joi.string().allow("").required(),
3848
- app_name: Joi.string().allow("").required(),
3849
- force_version: Joi.string().allow("").required(),
3850
- latest_version: Joi.string().allow("").required(),
3851
- is_app_blocked: Joi.boolean().required(),
3852
- update_dialog: ConfigurationPlatformModel.UpdateDiealog().required(),
3853
- _id: Joi.string().allow(""),
3854
- modified_at: Joi.string().allow(""),
3855
- created_at: Joi.string().allow(""),
3856
- __v: Joi.number(),
3857
- });
3858
- }
3859
-
3860
- /** @returns {OrderingStoresResponse} */
3861
- static OrderingStoresResponse() {
3298
+ /** @returns {OrderingStoresResponseSchema} */
3299
+ static OrderingStoresResponseSchema() {
3862
3300
  return Joi.object({
3863
3301
  page: ConfigurationPlatformModel.Page(),
3864
3302
  items: Joi.array().items(ConfigurationPlatformModel.OrderingStore()),
3865
3303
  });
3866
3304
  }
3867
3305
 
3868
- /** @returns {LocationDefaultLanguage} */
3869
- static LocationDefaultLanguage() {
3870
- return Joi.object({
3871
- name: Joi.string().allow(""),
3872
- code: Joi.string().allow(""),
3873
- });
3874
- }
3875
-
3876
- /** @returns {LocationDefaultCurrency} */
3877
- static LocationDefaultCurrency() {
3878
- return Joi.object({
3879
- name: Joi.string().allow(""),
3880
- symbol: Joi.string().allow(""),
3881
- code: Joi.string().allow(""),
3882
- });
3883
- }
3884
-
3885
- /** @returns {LocationCountry} */
3886
- static LocationCountry() {
3887
- return Joi.object({
3888
- capital: Joi.string().allow(""),
3889
- currency: Joi.string().allow(""),
3890
- iso2: Joi.string().allow(""),
3891
- iso3: Joi.string().allow(""),
3892
- name: Joi.string().allow(""),
3893
- parent: Joi.string().allow(""),
3894
- phone_code: Joi.string().allow(""),
3895
- type: Joi.string().allow(""),
3896
- uid: Joi.number(),
3897
- __v: Joi.number(),
3898
- _id: Joi.string().allow(""),
3899
- default_currency: ConfigurationPlatformModel.LocationDefaultCurrency(),
3900
- default_language: ConfigurationPlatformModel.LocationDefaultLanguage(),
3901
- state_code: Joi.string().allow(""),
3902
- country_code: Joi.string().allow(""),
3903
- latitude: Joi.string().allow(""),
3904
- longitude: Joi.string().allow(""),
3905
- });
3906
- }
3907
-
3908
- /** @returns {Locations} */
3909
- static Locations() {
3306
+ /** @returns {ValidationErrors} */
3307
+ static ValidationErrors() {
3910
3308
  return Joi.object({
3911
- items: Joi.array().items(ConfigurationPlatformModel.LocationCountry()),
3912
- });
3913
- }
3914
-
3915
- /** @returns {UrlRedirectionResponse} */
3916
- static UrlRedirectionResponse() {
3917
- return Joi.object({
3918
- redirections: Joi.array().items(
3919
- ConfigurationPlatformModel.UrlRedirection()
3920
- ),
3921
- });
3922
- }
3923
-
3924
- /** @returns {UrlRedirectionRequest} */
3925
- static UrlRedirectionRequest() {
3926
- return Joi.object({
3927
- redirection: ConfigurationPlatformModel.UrlRedirection(),
3928
- });
3929
- }
3930
-
3931
- /** @returns {UrlRedirection} */
3932
- static UrlRedirection() {
3933
- return Joi.object({
3934
- redirect_from: Joi.string().allow(""),
3935
- redirect_to: Joi.string().allow(""),
3936
- type: Joi.string().allow(""),
3937
- _id: Joi.string().allow(""),
3938
- });
3939
- }
3940
-
3941
- /** @returns {StoreForConfigurationRequest} */
3942
- static StoreForConfigurationRequest() {
3943
- return Joi.object({
3944
- conf: Joi.array().items(ConfigurationPlatformModel.AppStoreRules()),
3945
- });
3946
- }
3947
-
3948
- /** @returns {DomainOptionsResponse} */
3949
- static DomainOptionsResponse() {
3950
- return Joi.object({
3951
- domain_types: Joi.array().items(ConfigurationPlatformModel.DomainType()),
3952
- network_ips: Joi.array().items(Joi.string().allow("")),
3953
- network_cnames: Joi.array().items(Joi.string().allow("")),
3954
- });
3955
- }
3956
-
3957
- /** @returns {DomainType} */
3958
- static DomainType() {
3959
- return Joi.object({
3960
- key: Joi.string().allow(""),
3961
- display: Joi.string().allow(""),
3962
- values: Joi.array().items(ConfigurationPlatformModel.DomainValue()),
3963
- });
3964
- }
3965
-
3966
- /** @returns {DomainValue} */
3967
- static DomainValue() {
3968
- return Joi.object({
3969
- value: Joi.string().allow(""),
3970
- text: Joi.string().allow(""),
3971
- });
3972
- }
3973
-
3974
- /** @returns {StoreRequest} */
3975
- static StoreRequest() {
3976
- return Joi.object({
3977
- companies: Joi.array().items(Joi.number()),
3309
+ errors: Joi.array()
3310
+ .items(ConfigurationPlatformModel.ValidationError())
3311
+ .required(),
3978
3312
  });
3979
3313
  }
3980
3314
 
3981
- /** @returns {StoreResponse} */
3982
- static StoreResponse() {
3315
+ /** @returns {ValidationError} */
3316
+ static ValidationError() {
3983
3317
  return Joi.object({
3984
- data: Joi.array().items(Joi.number()),
3318
+ message: Joi.string().allow("").required(),
3319
+ field: Joi.string().allow("").required(),
3985
3320
  });
3986
3321
  }
3987
3322
  }