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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (304) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  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 +81 -101
  6. package/sdk/application/Cart/CartApplicationClient.js +173 -511
  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 +61 -61
  16. package/sdk/application/Content/ContentApplicationClient.js +183 -366
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
  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 +28 -117
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
  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 +10 -54
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
  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 +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  90. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
  98. package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
  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 +240 -376
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
  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 +330 -502
  120. package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
  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 -100
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
  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 -31
  128. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
  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 +562 -1289
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
  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 -248
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
  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 +2391 -924
  146. package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
  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 +406 -403
  180. package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
  181. package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
  182. package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
  183. package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
  184. package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
  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 +937 -2452
  191. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
  192. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -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 +1307 -3536
  196. package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
  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 -521
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
  213. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
  214. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
  215. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
  216. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
  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 -9
  222. package/sdk/platform/Share/SharePlatformModel.js +45 -5
  223. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
  224. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
  225. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
  226. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
  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 -0
  272. package/sdk/public/PublicClient.js +4 -0
  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 -0
  280. package/sdk/public/index.js +2 -0
  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
@@ -1,5 +1,11 @@
1
1
  const Joi = require("joi");
2
2
 
3
+ /**
4
+ * @typedef ValidationError
5
+ * @property {string} message - A brief description of the error encountered.
6
+ * @property {string} field - The field in the request that caused the error.
7
+ */
8
+
3
9
  /**
4
10
  * @typedef GenerateSEOContent
5
11
  * @property {string} [text]
@@ -25,7 +31,6 @@ const Joi = require("joi");
25
31
  * @property {string} [_id]
26
32
  * @property {string} [updated_at]
27
33
  * @property {string} [created_at]
28
- * @property {number} [__v]
29
34
  */
30
35
 
31
36
  /**
@@ -42,7 +47,7 @@ const Joi = require("joi");
42
47
  * @property {string} [redirect_to]
43
48
  * @property {string} [updated_at]
44
49
  * @property {string} [created_at]
45
- * @property {number} [__v]
50
+ * @property {PathSourceSchema} [__source]
46
51
  */
47
52
 
48
53
  /**
@@ -58,8 +63,8 @@ const Joi = require("joi");
58
63
 
59
64
  /**
60
65
  * @typedef SeoSchema
61
- * @property {string} [_id]
62
66
  * @property {string} [app]
67
+ * @property {string} [_id]
63
68
  * @property {string} [robots_txt]
64
69
  * @property {boolean} [sitemap_enabled]
65
70
  * @property {string} [additional_sitemap]
@@ -68,8 +73,6 @@ const Joi = require("joi");
68
73
  * @property {Detail} [details]
69
74
  * @property {string} [created_at]
70
75
  * @property {string} [updated_at]
71
- * @property {number} [__v]
72
- * @property {SEOSitemap} [sitemap]
73
76
  */
74
77
 
75
78
  /**
@@ -94,55 +97,28 @@ const Joi = require("joi");
94
97
 
95
98
  /**
96
99
  * @typedef SEOSchemaMarkupTemplate
97
- * @property {string} [_id]
100
+ * @property {string} [id]
98
101
  * @property {string} [title]
99
102
  * @property {string} [page_type]
100
103
  * @property {string} [schema]
101
104
  * @property {string} [description]
102
105
  * @property {boolean} [active]
103
- * @property {string} [application]
104
106
  * @property {string} [created_at]
105
107
  * @property {string} [updated_at]
108
+ * @property {string} [application]
106
109
  * @property {Object} [target_json]
107
- * @property {number} [__v]
108
110
  */
109
111
 
110
112
  /**
111
113
  * @typedef SEOSchemaMarkupTemplateRequestBody
112
114
  * @property {string} [title]
113
115
  * @property {string} [page_type]
114
- * @property {string} [description]
115
116
  * @property {string} [schema]
117
+ * @property {string} [description]
116
118
  * @property {Object} [target_json]
117
119
  * @property {boolean} [active]
118
120
  * @property {string} [created_at]
119
- */
120
-
121
- /**
122
- * @typedef DeletPathMappingSchema
123
- * @property {string} [message]
124
- * @property {PathMappingSchema} [data]
125
- */
126
-
127
- /**
128
- * @typedef CreatePathMappingSchema
129
- * @property {string} [message]
130
- * @property {PathMappingSchema} [data]
131
- */
132
-
133
- /**
134
- * @typedef GetAllPathMappingSchema
135
- * @property {string} [message]
136
- * @property {GetPathSchema} [data]
137
- */
138
-
139
- /**
140
- * @typedef GetPathSchema
141
- * @property {PathMappingSchema[]} [docs]
142
- * @property {number} [page]
143
- * @property {number} [limit]
144
- * @property {number} [pages]
145
- * @property {number} [total]
121
+ * @property {string} [updated_at]
146
122
  */
147
123
 
148
124
  /**
@@ -189,11 +165,11 @@ const Joi = require("joi");
189
165
  * @typedef DefaultSEOSchemaMarkupTemplate
190
166
  * @property {string} [page_type]
191
167
  * @property {string} [schema]
168
+ * @property {Object} [target_json]
192
169
  */
193
170
 
194
171
  /**
195
172
  * @typedef ScheduleSchema
196
- * @property {boolean} [published]
197
173
  * @property {string} [cron]
198
174
  * @property {string} [start]
199
175
  * @property {string} [end]
@@ -208,7 +184,7 @@ const Joi = require("joi");
208
184
  */
209
185
 
210
186
  /**
211
- * @typedef BlogGetResponse
187
+ * @typedef BlogGetDetails
212
188
  * @property {BlogSchema[]} [items]
213
189
  * @property {Page} [page]
214
190
  * @property {BlogFilters} [filters]
@@ -236,7 +212,7 @@ const Joi = require("joi");
236
212
  * @typedef Author
237
213
  * @property {string} [designation]
238
214
  * @property {string} [id]
239
- * @property {string} [name]
215
+ * @property {string} [name] - Name of the author
240
216
  */
241
217
 
242
218
  /**
@@ -257,7 +233,6 @@ const Joi = require("joi");
257
233
  * @property {string} [title]
258
234
  * @property {DateMeta} [date_meta]
259
235
  * @property {string} [summary]
260
- * @property {string} [status]
261
236
  */
262
237
 
263
238
  /**
@@ -267,7 +242,7 @@ const Joi = require("joi");
267
242
  * @property {string} [title]
268
243
  * @property {SEOMetaItem[]} [meta_tags]
269
244
  * @property {SEOSitemap} [sitemap]
270
- * @property {SEObreadcrumb[]} [breadcrumbs]
245
+ * @property {SEObreadcrumb[]} [breadcrumb]
271
246
  * @property {string} [canonical_url]
272
247
  */
273
248
 
@@ -307,7 +282,7 @@ const Joi = require("joi");
307
282
  */
308
283
 
309
284
  /**
310
- * @typedef BlogRequest
285
+ * @typedef BlogPayload
311
286
  * @property {string} [application]
312
287
  * @property {Object} [_custom_json]
313
288
  * @property {Author} [author]
@@ -318,7 +293,6 @@ const Joi = require("joi");
318
293
  * @property {string} [slug]
319
294
  * @property {string[]} [tags]
320
295
  * @property {string} [title]
321
- * @property {string} [publish_date]
322
296
  * @property {SEO} [seo]
323
297
  * @property {string} [summary]
324
298
  */
@@ -335,11 +309,6 @@ const Joi = require("joi");
335
309
  * @property {AdminAnnouncementSchema} [data]
336
310
  */
337
311
 
338
- /**
339
- * @typedef DataLoaderItemsResponseSchema
340
- * @property {DataLoaderResponseSchema[]} [items]
341
- */
342
-
343
312
  /**
344
313
  * @typedef DataLoaderResponseSchema
345
314
  * @property {string} [application]
@@ -351,16 +320,12 @@ const Joi = require("joi");
351
320
  * @property {string} [type]
352
321
  * @property {string} [url]
353
322
  * @property {string} [content]
354
- * @property {string} [created_at]
355
- * @property {string} [modified_at]
356
- * @property {number} [__v]
357
- * @property {boolean} [is_selected]
358
323
  * @property {DataLoaderSourceSchema} [__source]
359
324
  */
360
325
 
361
326
  /**
362
327
  * @typedef DataLoaderResetResponseSchema
363
- * @property {boolean} [resetted]
328
+ * @property {boolean} [reset]
364
329
  */
365
330
 
366
331
  /**
@@ -389,6 +354,7 @@ const Joi = require("joi");
389
354
  * @property {LocaleLanguage} [_locale_language]
390
355
  * @property {string} [image]
391
356
  * @property {string} [type]
357
+ * @property {Action} [action]
392
358
  * @property {boolean} [active]
393
359
  * @property {string} [display]
394
360
  * @property {number} [sort_order]
@@ -396,13 +362,6 @@ const Joi = require("joi");
396
362
  * @property {NavigationReference[]} [sub_navigation]
397
363
  */
398
364
 
399
- /**
400
- * @typedef AssignmentReference
401
- * @property {string} [platform]
402
- * @property {string} [orientation]
403
- * @property {string} [position]
404
- */
405
-
406
365
  /**
407
366
  * @typedef CronBasedScheduleSchema
408
367
  * @property {boolean} [enabled]
@@ -418,52 +377,82 @@ const Joi = require("joi");
418
377
 
419
378
  /**
420
379
  * @typedef HandpickedTagSchema
421
- * @property {string} [position]
422
- * @property {Object} [attributes]
423
- * @property {string} [name]
424
- * @property {string} [url]
425
- * @property {string} [type]
426
- * @property {string} [sub_type]
427
- * @property {string} [content]
380
+ * @property {string} [position] - The location in the page where the tag should
381
+ * be injected, such as 'head', 'body-top', or 'body-bottom'.
382
+ * @property {Object} [attributes] - Additional attributes for the tag to define
383
+ * its behavior or compatibility. Supported attributes may vary based on the
384
+ * tag type for example:
385
+ *
386
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
387
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
388
+ * - For `style` tags: `media`, `type`, `scoped`.
389
+ * - Custom data attributes like `data-*` can also be added.
390
+ *
391
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
392
+ * third-party tag can be injected or supported.
393
+ * @property {string} [name] - The name of the tag used to identify it in the
394
+ * system. Example: 'Google External Script' or 'Bootstrap CSS'.
395
+ * @property {string} [url] - The URL where the external tag resource (such as a
396
+ * script or stylesheet) is hosted.
397
+ * @property {string} [type] - The type of the tag, such as 'script' (for
398
+ * JavaScript) or 'link' (for CSS).
399
+ * @property {string} [sub_type] - Defines whether the tag is embedded within
400
+ * the HTML (inline) or linked externally (external).
401
+ * @property {string} [content] - The actual content of the inline tag, such as
402
+ * JavaScript or CSS code if the tag is inline.
428
403
  */
429
404
 
430
405
  /**
431
406
  * @typedef RemoveHandpickedSchema
432
- * @property {string[]} [tags]
407
+ * @property {string[]} [tags] - A list of tag IDs to remove from the system.
433
408
  */
434
409
 
435
410
  /**
436
411
  * @typedef CreateTagSchema
437
- * @property {string} [name]
438
- * @property {string} [sub_type]
439
- * @property {string} [_id]
440
- * @property {string} [type]
441
- * @property {string} [url]
442
- * @property {string} [position]
443
- * @property {Object} [attributes]
444
- * @property {Object[]} [pages]
445
- * @property {string} [content]
412
+ * @property {string} [name] - The name of the tag to be created, used for
413
+ * identification purposes.
414
+ * @property {string} [sub_type] - Indicates if the tag is external (linked) or
415
+ * inline (embedded within the page).
416
+ * @property {string} [_id] - The unique identifier for the tag.
417
+ * @property {string} [type] - The type of the tag, either JavaScript ('js') or
418
+ * CSS ('css').
419
+ * @property {string} [url] - The external URL pointing to the script or
420
+ * stylesheet resource.
421
+ * @property {string} [position] - The position on the webpage where the tag
422
+ * will be injected, such as 'head', 'body-top', or 'body-bottom'.
423
+ * @property {Object} [attributes] - Additional attributes for the tag to define
424
+ * its behavior or compatibility. Supported attributes may vary based on the
425
+ * tag type for example:
426
+ *
427
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
428
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
429
+ * - For `style` tags: `media`, `type`, `scoped`.
430
+ * - Custom data attributes like `data-*` can also be added.
431
+ *
432
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
433
+ * third-party tag can be injected or supported.
434
+ * @property {Object[]} [pages] - Pages or environments where the tag should be
435
+ * injected or active.
436
+ * @property {string} [content] - The inline content for tags of type 'inline'
437
+ * (e.g., JavaScript or CSS code).
446
438
  */
447
439
 
448
440
  /**
449
441
  * @typedef CreateTagRequestSchema
450
- * @property {CreateTagSchema[]} [tags]
442
+ * @property {CreateTagSchema[]} [tags] - A list of tags to be created or
443
+ * updated, each containing details such as name, type, and attributes.
451
444
  */
452
445
 
453
446
  /**
454
447
  * @typedef DataLoaderSchema
455
- * @property {string} [_id]
456
- * @property {string} [url]
457
- * @property {string} [created_at]
458
- * @property {string} [modified_at]
459
- * @property {string} [application]
460
- * @property {string} [company]
461
448
  * @property {string} [name]
462
449
  * @property {string} [service]
463
450
  * @property {string} [operation_id]
464
- * @property {boolean} [is_selected]
465
451
  * @property {string} [type]
452
+ * @property {string} [url]
453
+ * @property {string} [content]
466
454
  * @property {DataLoaderSourceSchema} [__source]
455
+ * @property {string} [_id]
467
456
  */
468
457
 
469
458
  /**
@@ -472,34 +461,15 @@ const Joi = require("joi");
472
461
  * @property {string} [id]
473
462
  */
474
463
 
475
- /**
476
- * @typedef TagSpecSchema
477
- * @property {string} [name]
478
- * @property {string} [description]
479
- */
480
-
481
- /**
482
- * @typedef ServerSchema
483
- * @property {string} [url]
484
- */
485
-
486
- /**
487
- * @typedef DataLoadersApiSpecSchema
488
- * @property {Object} [info]
489
- * @property {ServerSchema[]} [servers]
490
- * @property {TagSpecSchema[]} [tags]
491
- * @property {string} [openapi]
492
- * @property {Object} [paths]
493
- */
494
-
495
464
  /**
496
465
  * @typedef DataLoadersSchema
497
466
  * @property {DataLoaderSchema[]} [items]
498
467
  */
499
468
 
500
469
  /**
501
- * @typedef TagDeleteSuccessResponse
502
- * @property {boolean} [success]
470
+ * @typedef TagDeleteSuccessDetails
471
+ * @property {boolean} [success] - Indicates whether the tag removal operation
472
+ * was successful.
503
473
  */
504
474
 
505
475
  /**
@@ -508,6 +478,7 @@ const Joi = require("joi");
508
478
  * @property {number} [status]
509
479
  * @property {string} [code]
510
480
  * @property {string} [exception]
481
+ * @property {string} [info]
511
482
  * @property {string} [request_id]
512
483
  * @property {string} [stack_trace]
513
484
  * @property {Object} [meta]
@@ -529,7 +500,6 @@ const Joi = require("joi");
529
500
  * @property {string} [application]
530
501
  * @property {string} [icon_url]
531
502
  * @property {Object} [_custom_json]
532
- * @property {number} [__v]
533
503
  */
534
504
 
535
505
  /**
@@ -549,15 +519,15 @@ const Joi = require("joi");
549
519
 
550
520
  /**
551
521
  * @typedef FAQCategorySchema
552
- * @property {string} [_id]
553
- * @property {string} [application]
522
+ * @property {number} [index]
554
523
  * @property {string} [title]
555
524
  * @property {string} [description]
556
- * @property {number} [index]
557
- * @property {string} [slug]
558
525
  * @property {ChildrenSchema[]} [children]
526
+ * @property {string} [_id]
527
+ * @property {string} [slug]
528
+ * @property {string} [application]
559
529
  * @property {string} [icon_url]
560
- * @property {number} [__v]
530
+ * @property {Object} [_custom_json]
561
531
  */
562
532
 
563
533
  /**
@@ -568,7 +538,6 @@ const Joi = require("joi");
568
538
  * @property {string} [question]
569
539
  * @property {string} [answer]
570
540
  * @property {string[]} [tags]
571
- * @property {number} [__v]
572
541
  */
573
542
 
574
543
  /**
@@ -627,11 +596,11 @@ const Joi = require("joi");
627
596
  * @property {number} [current] - The current page number.
628
597
  * @property {string} type - The type of the page, such as 'PageType'.
629
598
  * @property {number} [size] - The number of items per page.
630
- * @property {number} [total] - Total number of items.
599
+ * @property {number} [page_size] - The number of items per page.
631
600
  */
632
601
 
633
602
  /**
634
- * @typedef LandingPageGetResponse
603
+ * @typedef LandingPageGetDetails
635
604
  * @property {LandingPageSchema[]} [items]
636
605
  * @property {Page} [page]
637
606
  */
@@ -639,6 +608,7 @@ const Joi = require("joi");
639
608
  /**
640
609
  * @typedef LandingPageSchema
641
610
  * @property {string} [slug]
611
+ * @property {Action} [action]
642
612
  * @property {string[]} [platform]
643
613
  * @property {CreatedBySchema} [created_by]
644
614
  * @property {DateMeta} [date_meta]
@@ -646,16 +616,15 @@ const Joi = require("joi");
646
616
  * @property {string} [application]
647
617
  * @property {boolean} [archived]
648
618
  * @property {Object} [_custom_json]
649
- * @property {number} [__v]
650
619
  */
651
620
 
652
621
  /**
653
- * @typedef DefaultNavigationResponse
622
+ * @typedef DefaultNavigationDetails
654
623
  * @property {NavigationSchema[]} [items]
655
624
  */
656
625
 
657
626
  /**
658
- * @typedef NavigationGetResponse
627
+ * @typedef NavigationGetDetails
659
628
  * @property {NavigationSchema[]} [items]
660
629
  * @property {Page} [page]
661
630
  */
@@ -679,29 +648,19 @@ const Joi = require("joi");
679
648
  * @property {Orientation} [orientation]
680
649
  * @property {number} [version]
681
650
  * @property {NavigationReference[]} [navigation]
682
- * @property {AssignmentReference[]} [assignments]
683
- * @property {number} [__v]
684
651
  */
685
652
 
686
653
  /**
687
- * @typedef NavigationRequest
654
+ * @typedef NavigationPayload
688
655
  * @property {string} [name]
689
656
  * @property {string} [slug]
690
657
  * @property {string[]} [platform]
691
658
  * @property {Orientation} [orientation]
692
- * @property {NavigationAssignment[]} [assignments]
693
659
  * @property {NavigationReference[]} [navigation]
694
660
  */
695
661
 
696
662
  /**
697
- * @typedef NavigationAssignment
698
- * @property {string} [platform]
699
- * @property {string} [orientation]
700
- * @property {string} [position]
701
- */
702
-
703
- /**
704
- * @typedef PageGetResponse
663
+ * @typedef PageGetDetails
705
664
  * @property {PageSchema[]} [items]
706
665
  * @property {Page} [page]
707
666
  */
@@ -725,52 +684,31 @@ const Joi = require("joi");
725
684
  * @property {PageSpecParam[]} [query]
726
685
  */
727
686
 
728
- /**
729
- * @typedef PageResponseError
730
- * @property {string} [errors]
731
- */
732
-
733
687
  /**
734
688
  * @typedef PageSchema
735
689
  * @property {string} [_id]
736
690
  * @property {string} [application]
737
- * @property {string} [platform]
738
- * @property {string} [title]
739
- * @property {string} [slug]
740
- * @property {string} [type]
741
- * @property {string[]} [tags]
691
+ * @property {string[]} [component_ids] - Components can be used to store
692
+ * multiple components
693
+ * @property {Object[]} [content]
742
694
  * @property {string} [content_path]
743
- * @property {string} [orientation]
744
- * @property {string} [description]
745
- * @property {boolean} [published]
746
695
  * @property {CreatedBySchema} [created_by]
747
696
  * @property {DateMeta} [date_meta]
697
+ * @property {string} [description]
748
698
  * @property {Asset} [feature_image]
699
+ * @property {Object[]} [page_meta]
749
700
  * @property {ScheduleSchema} [_schedule]
750
- * @property {PageMeta[]} [page_meta]
701
+ * @property {Object} [_custom_json]
702
+ * @property {string} [orientation]
703
+ * @property {string} [platform]
704
+ * @property {boolean} [published]
705
+ * @property {string} [slug]
706
+ * @property {string[]} [tags]
707
+ * @property {string} [title]
708
+ * @property {string} [type]
751
709
  * @property {SEO} [seo]
752
- * @property {string[]} [component_ids]
710
+ * @property {Object} [visibility]
753
711
  * @property {boolean} [archived]
754
- * @property {number} [__v]
755
- * @property {PageContent[]} [content]
756
- * @property {SanitizedContent[]} [sanitized_content]
757
- */
758
-
759
- /**
760
- * @typedef SanitizedContent
761
- * @property {string} [type]
762
- * @property {string} [value]
763
- */
764
-
765
- /**
766
- * @typedef PageMeta
767
- * @property {string} [key]
768
- */
769
-
770
- /**
771
- * @typedef PageContent
772
- * @property {string} [type]
773
- * @property {string} [value]
774
712
  */
775
713
 
776
714
  /**
@@ -779,18 +717,13 @@ const Joi = require("joi");
779
717
  */
780
718
 
781
719
  /**
782
- * @typedef PageRequestVisibility
783
- * @property {boolean} [test]
784
- */
785
-
786
- /**
787
- * @typedef PageRequest
720
+ * @typedef PagePayload
788
721
  * @property {CronSchedule} [_schedule]
789
722
  * @property {string} [application]
790
723
  * @property {Author} [author]
791
724
  * @property {Object} [_custom_json]
792
725
  * @property {string} [orientation]
793
- * @property {PageContent[]} [content]
726
+ * @property {Object[]} [content]
794
727
  * @property {Asset} [feature_image]
795
728
  * @property {boolean} [published]
796
729
  * @property {string} [reading_time]
@@ -798,10 +731,6 @@ const Joi = require("joi");
798
731
  * @property {string[]} [tags]
799
732
  * @property {SEO} [seo]
800
733
  * @property {string} [title]
801
- * @property {string} [platform]
802
- * @property {string} [type]
803
- * @property {string} [description]
804
- * @property {Object} [visibility] - Visibility of Page.
805
734
  */
806
735
 
807
736
  /**
@@ -810,45 +739,20 @@ const Joi = require("joi");
810
739
  * @property {string} [start]
811
740
  * @property {string} [end]
812
741
  * @property {number} [duration]
813
- * @property {NextSchedule[]} [next_schedule]
814
742
  */
815
743
 
816
744
  /**
817
- * @typedef PagePublishRequest
745
+ * @typedef PagePublishPayload
818
746
  * @property {boolean} [publish]
819
747
  */
820
748
 
821
749
  /**
822
750
  * @typedef PageMetaSchema
823
- * @property {SystemPages[]} [system_pages]
824
- * @property {CustomePages[]} [custom_pages]
751
+ * @property {NavigationSchema[]} [system_pages]
752
+ * @property {PageSchema[]} [custom_pages]
825
753
  * @property {string} [application_id]
826
754
  */
827
755
 
828
- /**
829
- * @typedef CustomePages
830
- * @property {string} [display]
831
- * @property {string} [slug]
832
- */
833
-
834
- /**
835
- * @typedef SystemPagesActionPage
836
- * @property {string} [type]
837
- */
838
-
839
- /**
840
- * @typedef SystemPagesAction
841
- * @property {SystemPagesActionPage} [page]
842
- * @property {string} [type]
843
- */
844
-
845
- /**
846
- * @typedef SystemPages
847
- * @property {string} [display]
848
- * @property {SystemPagesAction} [action]
849
- * @property {string} [page_type]
850
- */
851
-
852
756
  /**
853
757
  * @typedef Support
854
758
  * @property {boolean} [created]
@@ -893,32 +797,46 @@ const Joi = require("joi");
893
797
 
894
798
  /**
895
799
  * @typedef TagsSchema
896
- * @property {string} [application]
897
- * @property {string} [_id]
898
- * @property {string} [company]
899
- * @property {number} [__v]
900
- * @property {TagSchema[]} [tags]
800
+ * @property {string} [application] - The ID of the application that owns the tags.
801
+ * @property {string} [_id] - The unique identifier for the tag set.
802
+ * @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
803
+ * or stylesheets) that are configured for the application.
901
804
  */
902
805
 
903
806
  /**
904
807
  * @typedef TagSchema
905
- * @property {string} [name]
906
- * @property {string} [url]
907
- * @property {string} [type]
908
- * @property {string} [sub_type]
909
- * @property {string} [_id]
910
- * @property {string} [position]
911
- * @property {Object} [attributes]
912
- * @property {string} [content]
913
- * @property {Object[]} [compatible_engines]
914
- * @property {Object[]} [pages]
808
+ * @property {string} [name] - The name of the tag used to identify it.
809
+ * @property {string} [url] - The URL where the external tag resource (such as a
810
+ * script or stylesheet) is located.
811
+ * @property {string} [type] - Specifies whether the tag is a JavaScript ('js')
812
+ * or CSS ('css') tag.
813
+ * @property {string} [sub_type] - Indicates whether the tag is an external
814
+ * resource (external) or inline content (inline).
815
+ * @property {string} [_id] - The unique identifier for the tag in the system.
816
+ * @property {string} [position] - The position within the page where the tag
817
+ * should be injected.
818
+ * @property {Object} [attributes] - Additional attributes for the tag to define
819
+ * its behavior or compatibility. Supported attributes may vary based on the
820
+ * tag type for example:
821
+ *
822
+ * - For `script` tags: `async`, `defer`, `crossorigin`, `type`, `onload`.
823
+ * - For `link` tags: `rel`, `media`, `type`, `crossorigin`, `onload`.
824
+ * - For `style` tags: `media`, `type`, `scoped`.
825
+ * - Custom data attributes like `data-*` can also be added.
826
+ *
827
+ * @property {string} [content] - Content of the tag if it is inline, such as
828
+ * JavaScript or CSS code.
829
+ * @property {string[]} [compatible_engines] - List of UI frameworks where this
830
+ * third-party tag can be injected or supported.
831
+ * @property {Object[]} [pages] - Pages or environments where the tag should be active.
915
832
  * @property {TagSourceSchema} [__source]
916
833
  */
917
834
 
918
835
  /**
919
836
  * @typedef TagSourceSchema
920
- * @property {string} [type]
921
- * @property {string} [id]
837
+ * @property {string} [type] - The type of source, such as 'extension'
838
+ * @property {string} [id] - The identifier of the source that created or
839
+ * provided the tag.
922
840
  */
923
841
 
924
842
  /**
@@ -935,150 +853,139 @@ const Joi = require("joi");
935
853
 
936
854
  /**
937
855
  * @typedef FieldValidations
938
- * @property {string} [name]
939
- * @property {string} [type]
940
- */
941
-
942
- /**
943
- * @typedef ApplicationFieldDefinitionSchema
944
- * @property {string} [_id]
945
- * @property {string} [creator]
946
- * @property {string} [resource]
947
- * @property {string} [name]
948
- * @property {string} [namespace]
949
- * @property {string} [key]
950
- * @property {string} [description]
951
- * @property {string} [type]
952
- * @property {boolean} [multi_value]
953
- * @property {FieldValidations[]} [validations]
954
- * @property {string} [company_id]
955
- * @property {string} [created_by]
956
- * @property {string} [updated_by]
957
- * @property {boolean} [required]
958
- * @property {boolean} [is_deleted]
959
- * @property {string} [created_at]
960
- * @property {string} [updated_at]
961
- * @property {string} [type_name]
962
- * @property {number} [invalid_fields_count]
963
- * @property {string} [application_id]
856
+ * @property {string} [name] - Name of validation
857
+ * @property {string} [type] - Type of validation
858
+ * @property {Object} [value]
964
859
  */
965
860
 
966
861
  /**
967
862
  * @typedef FieldDefinitionSchema
968
- * @property {string} [_id]
969
- * @property {string} [creator]
970
- * @property {string} [resource]
971
- * @property {string} [name]
972
- * @property {string} [namespace]
973
- * @property {string} [key]
974
- * @property {string} [description]
975
- * @property {string} [type]
976
- * @property {boolean} [multi_value]
977
- * @property {FieldValidations[]} [validations]
978
- * @property {string} [company_id]
979
- * @property {string} [created_by]
980
- * @property {string} [updated_by]
981
- * @property {boolean} [required]
982
- * @property {boolean} [is_deleted]
983
- * @property {string} [created_at]
984
- * @property {string} [updated_at]
985
- * @property {string} [type_name]
986
- * @property {number} [invalid_fields_count]
987
- */
988
-
989
- /**
990
- * @typedef ApplicationCustomFieldDefinitionsSchema
991
- * @property {ApplicationFieldDefinitionSchema[]} [items]
992
- * @property {Page} [page]
863
+ * @property {string} [id] - Unique system generated id
864
+ * @property {string} [resource] - Resource type to which custom field belongs
865
+ * @property {string} [name] - Name of custom field
866
+ * @property {string} [namespace] - Namespace of custom field
867
+ * @property {string} [slug] - Slug of custom field
868
+ * @property {string} [description] - Description of custom field definition
869
+ * @property {string} [type] - Data type of custom field
870
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
871
+ * multivalued or not
872
+ * @property {FieldValidations[]} [validations] - List of validations applied
873
+ * @property {string} [company_id] - Id of company
874
+ * @property {boolean} [required] - Whether the custom field is required or not
875
+ * @property {boolean} [is_deleted] - Whether the custom field is deleted or not
876
+ * @property {string} [type_name] - Type of type field
877
+ * @property {number} [invalid_fields_count] - Count of invalid fields after validation
993
878
  */
994
879
 
995
880
  /**
996
881
  * @typedef CustomFieldDefinitionsSchema
997
- * @property {FieldDefinitionSchema[]} [items]
882
+ * @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
998
883
  * @property {Page} [page]
999
884
  */
1000
885
 
1001
886
  /**
1002
887
  * @typedef CustomFieldDefinitionRequestSchema
1003
- * @property {string} [resource]
1004
- * @property {string} [type]
1005
- * @property {string} [key]
1006
- * @property {string} [namespace]
1007
- * @property {boolean} [multi_value]
1008
- * @property {string} [name]
1009
- * @property {string} [description]
1010
- * @property {string} [creator]
1011
- * @property {FieldValidations[]} [validations]
888
+ * @property {string} [type] - Data type of custom field
889
+ * @property {string} [slug] - Slug of custom field definition
890
+ * @property {string} [namespace] - Namespace of custom field definition
891
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
892
+ * multi valued or not
893
+ * @property {string} [name] - Name of custom field definition
894
+ * @property {string} [description] - Description of a custom field definition
895
+ * @property {FieldValidations[]} [validations] - Validations for a custom field
1012
896
  */
1013
897
 
1014
898
  /**
1015
899
  * @typedef CustomObjectCustomFieldDefinitions
1016
- * @property {string} [_id]
1017
- * @property {string} type
1018
- * @property {string} [description]
1019
- * @property {string} [name]
1020
- * @property {boolean} [multi_value]
1021
- * @property {boolean} [required]
1022
- * @property {string} [key]
1023
- * @property {FieldValidations[]} [validations]
900
+ * @property {string} [id] - Unique identifer for a custom field
901
+ * @property {string} [type] - Data type of custom field
902
+ * @property {string} [description] - Description of custom field
903
+ * @property {string} [name] - Name of custom field
904
+ * @property {boolean} [multi_value] - Flag to denote if cusom field is multi
905
+ * valued or not
906
+ * @property {boolean} [required] - Whether the field is required or not
907
+ * @property {string} [slug] - Slug of custom field definition
908
+ * @property {FieldValidations[]} [validations] - Validations added against the
909
+ * custom field
1024
910
  * @property {string} [action]
1025
911
  */
1026
912
 
1027
913
  /**
1028
914
  * @typedef CustomObjectDefinitionUpdateRequestSchema
1029
- * @property {string} [type]
1030
- * @property {string} [description]
1031
- * @property {string} [name]
1032
- * @property {string} [display_name_key]
1033
- * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions]
915
+ * @property {string} [description] - Description of custom object definiton
916
+ * @property {string} [name] - Name of custom object definition
917
+ * @property {string} [display_name_key] - Custom field slug which is used as a
918
+ * display key in
919
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
1034
920
  */
1035
921
 
1036
922
  /**
1037
923
  * @typedef CustomFieldDefinitionDetailResSchema
1038
- * @property {string} [creator]
1039
- * @property {string} [resource]
1040
- * @property {string} [name]
1041
- * @property {string} [namespace]
1042
- * @property {string} [key]
1043
- * @property {string} [description]
1044
- * @property {string} [type]
1045
- * @property {boolean} [multi_value]
1046
- * @property {string} [company_id]
1047
- * @property {string} [application_id]
1048
- * @property {string} [created_by]
1049
- * @property {string} [updated_by]
1050
- * @property {boolean} [required]
1051
- * @property {boolean} [is_deleted]
1052
- * @property {string} [_id]
924
+ * @property {string} [resource] - Resource to which custom field is associated
925
+ * @property {string} [name] - Name of custom field
926
+ * @property {string} [namespace] - Namespace of custom field
927
+ * @property {string} [slug] - Slug of custom field
928
+ * @property {string} [description] - Description regarding custom field
929
+ * @property {string} [type] - Data type of custom field
930
+ * @property {boolean} [multi_value] - Flag to denote whether custom field is
931
+ * multi valued or not
932
+ * @property {string} [company_id] - Company Identifer
933
+ * @property {string} [application_id] - Sales channel identifier
934
+ * @property {boolean} [required] - Whether the customfield is required or not
935
+ * @property {boolean} [is_deleted] - Is custom field deleted
936
+ * @property {string} [id] - Unique system generated id
1053
937
  * @property {Object[]} [validations]
1054
- * @property {string} [created_at]
1055
- * @property {string} [updated_at]
938
+ * @property {string} [created_at] - Date time at which field was created
939
+ * @property {string} [updated_at] - Date time at for a field's last modification
940
+ */
941
+
942
+ /**
943
+ * @typedef MetaFieldDefinitionDetailResSchema
944
+ * @property {string} [resource] - Resource to which meta field is associated
945
+ * @property {string} [name] - Name of meta field
946
+ * @property {string} [namespace] - Namespace of meta field
947
+ * @property {string} [slug] - Slug of meta field
948
+ * @property {string} [description] - Description regarding meta field
949
+ * @property {string} [type] - Data type of meta field
950
+ * @property {boolean} [multi_value] - Flag to denote whether meta field is
951
+ * multi valued or not
952
+ * @property {string} [company_id] - Company Identifer
953
+ * @property {string} [application_id] - Sales channel identifier
954
+ * @property {boolean} [required] - Whether the field is required or not
955
+ * @property {boolean} [is_deleted] - Is meta field deleted
956
+ * @property {string} [id] - Unique system generated id
957
+ * @property {Object[]} [validations]
958
+ * @property {string} [created_at] - Date time at which field was created
959
+ * @property {string} [updated_at] - Date time at for a field's last modification
1056
960
  */
1057
961
 
1058
962
  /**
1059
963
  * @typedef CustomDataDeleteSchema
1060
- * @property {boolean} [success]
1061
- * @property {string} [message]
964
+ * @property {boolean} [success] - Denotes the success of the delete operation
965
+ * @property {string} [message] - Denotes the message of delete operation
966
+ */
967
+
968
+ /**
969
+ * @typedef CustomFieldValue
970
+ * @property {Object} [value]
1062
971
  */
1063
972
 
1064
973
  /**
1065
974
  * @typedef CustomFieldSchema
1066
- * @property {string} [_id]
1067
- * @property {string} [namespace]
1068
- * @property {string} [key]
1069
- * @property {string} [resource]
1070
- * @property {string} [creator]
1071
- * @property {string} [resource_id]
1072
- * @property {string} type
1073
- * @property {boolean} [multi_value]
1074
- * @property {string} [company_id]
1075
- * @property {string} [definition_id]
975
+ * @property {string} [id] - Unique system generated id
976
+ * @property {string} [namespace] - Namespace of custom field definition
977
+ * @property {string} [slug] - Slug of custom field definition
978
+ * @property {string} [resource] - The resource for which custom field is being created
979
+ * @property {CustomFieldValue[]} [value]
980
+ * @property {string} [resource_slug] - Unique identifier of the resource
981
+ * @property {string} [type] - Data type of custom field
982
+ * @property {boolean} [multi_value] - Whether custom field is multi valued
983
+ * @property {string} [company_id] - Identifer for a company
1076
984
  * @property {boolean} [has_invalid_values]
1077
985
  * @property {Object[]} [invalid_value_errors]
1078
- * @property {string} [created_by]
1079
- * @property {boolean} [is_deleted]
1080
- * @property {string} [created_at]
1081
- * @property {string} [updated_at]
986
+ * @property {boolean} [is_deleted] - Indicates whether custom field is deleted
987
+ * @property {string} [created_at] - Time at which customer field was created
988
+ * @property {string} [updated_at] - Time at which custom field was updated
1082
989
  */
1083
990
 
1084
991
  /**
@@ -1099,195 +1006,151 @@ const Joi = require("joi");
1099
1006
  */
1100
1007
 
1101
1008
  /**
1102
- * @typedef CustomFieldRequestSchema
1103
- * @property {Object[]} [fields]
1009
+ * @typedef CustomField
1010
+ * @property {Object[]} [value]
1011
+ * @property {string} [namespace] - This is the namespace to which custom field belongs
1012
+ * @property {string} [slug] - This is the slug of custom field used while
1013
+ * creating a custom field definition
1104
1014
  */
1105
1015
 
1106
1016
  /**
1107
- * @typedef CustomObjectSchema
1108
- * @property {string} [_id]
1109
- * @property {string} [name]
1110
- * @property {string} [creator]
1111
- * @property {string} [company_id]
1112
- * @property {string} [created_by]
1113
- * @property {string} [updated_by]
1114
- * @property {string} [status]
1115
- * @property {string} [slug]
1116
- * @property {string} [type]
1117
- * @property {string} [display_name]
1118
- * @property {string} [definition_id]
1119
- * @property {boolean} [is_deleted]
1120
- * @property {string} [created_at]
1121
- * @property {string} [updated_at]
1122
- * @property {CustomFieldSchema[]} [fields]
1017
+ * @typedef CustomFieldRequestSchema
1018
+ * @property {CustomField[]} [fields]
1123
1019
  */
1124
1020
 
1125
1021
  /**
1126
- * @typedef CustomObjectApplicationSchema
1127
- * @property {string} [_id]
1128
- * @property {string} [name]
1129
- * @property {string} [creator]
1130
- * @property {string} [company_id]
1131
- * @property {string} [application_id]
1132
- * @property {string} [created_by]
1133
- * @property {string} [updated_by]
1134
- * @property {string} [status]
1135
- * @property {string} [slug]
1136
- * @property {string} [type]
1137
- * @property {string} [display_name]
1138
- * @property {string} [definition_id]
1139
- * @property {boolean} [is_deleted]
1140
- * @property {string} [created_at]
1141
- * @property {string} [updated_at]
1142
- * @property {CustomFieldSchema[]} [fields]
1022
+ * @typedef CustomObjectSchema
1023
+ * @property {string} [id] - Unique system generated id
1024
+ * @property {string} [company_id] - Identifer for a company
1025
+ * @property {string} [application_id] - Identifer for a sales channel
1026
+ * @property {string} [status] - Status of custom object
1027
+ * @property {string} [type] - Slug of custom object definition
1028
+ * @property {string} [definition_slug] - Slug for custom object definition
1029
+ * @property {string} [display_name] - Value of custom field used for displaying
1030
+ * custom object
1031
+ * @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
1143
1032
  */
1144
1033
 
1145
1034
  /**
1146
1035
  * @typedef CustomObjectDefinitionRequestSchema
1147
- * @property {string} [type]
1148
- * @property {string} [description]
1149
- * @property {string} [name]
1150
- * @property {string} [display_name_key]
1151
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
1036
+ * @property {string} [type] - Namespace/Slug of Custom object definition
1037
+ * @property {string} [definition_slug] - Unique slug for a custom object definition
1038
+ * @property {string} [description] - Description of custom object definition
1039
+ * @property {string} [name] - Name of custom object
1040
+ * @property {string} [display_name_key] - Denotes which custom field to be used
1041
+ * for displaying custom object
1042
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
1043
+ * of custom field definitions belonging to this custom object definition
1152
1044
  */
1153
1045
 
1154
1046
  /**
1155
- * @typedef CustomObjectCustomFieldDefinitionResSchema
1156
- * @property {string} [creator]
1157
- * @property {string} [resource]
1158
- * @property {string} [name]
1159
- * @property {string} [namespace]
1160
- * @property {string} [key]
1161
- * @property {string} [description]
1162
- * @property {string} type
1163
- * @property {boolean} [multi_value]
1164
- * @property {FieldValidations[]} [validations]
1165
- * @property {string} [company_id]
1166
- * @property {string} [created_by]
1167
- * @property {string} [metaobject_definition_id]
1168
- * @property {boolean} [required]
1169
- * @property {boolean} [is_deleted]
1170
- * @property {string} [_id]
1171
- * @property {string} [created_at]
1172
- * @property {string} [updated_at]
1173
- * @property {string} [application_id]
1174
- */
1175
-
1176
- /**
1177
- * @typedef CustomObjectDefinitionSchema
1178
- * @property {string} [_id]
1179
- * @property {string} [name]
1180
- * @property {string} [type]
1181
- * @property {string} [display_name_key]
1182
- * @property {string} [description]
1183
- * @property {string} [creator]
1184
- * @property {string} [created_by]
1185
- * @property {string} [updated_by]
1186
- * @property {string} [application_id]
1187
- * @property {string} [company_id]
1188
- * @property {string} [created_at]
1189
- * @property {string} [updated_at]
1190
- * @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
1047
+ * @typedef CustomObjectDefinitionSlugSchema
1048
+ * @property {string} [id] - Unique system generated custom object definition id
1049
+ * @property {string} [name] - Display name of custom object definition
1050
+ * @property {string} [type] - Type of custom object definiton
1051
+ * @property {string} [definition_slug] - Slug of custom object definiton
1052
+ * @property {string} [display_name_key] - Display name of custom object definition
1053
+ * @property {string} [description] - Description of custom object definition
1054
+ * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
1055
+ * Custom fields inside custom objects
1191
1056
  */
1192
1057
 
1193
1058
  /**
1194
1059
  * @typedef CustomObjectDefinitionDeleteResponseSchema
1195
- * @property {boolean} [success]
1196
- * @property {string} [message]
1060
+ * @property {boolean} [success] - Success status of delete custom object definition.
1061
+ * @property {string} [message] - Response message when custom object definition
1062
+ * is deleted.
1197
1063
  */
1198
1064
 
1199
1065
  /**
1200
- * @typedef CustomObjectEntryBulkUploadResponse
1201
- * @property {string} [message]
1202
- * @property {string} [task_id]
1066
+ * @typedef CustomObjectEntryBulkUploadDetails
1067
+ * @property {string} [url] - Signed url of csv
1068
+ * @property {number} [total_records] - Total no of records in csv file
1203
1069
  */
1204
1070
 
1205
1071
  /**
1206
- * @typedef CustomObjectListItemDefinationSchema
1207
- * @property {string} [_id]
1208
- * @property {string} [name]
1209
- * @property {string} [type]
1210
- * @property {string} [display_name_key]
1072
+ * @typedef CustomObjectListItemDefinitionModel
1073
+ * @property {string} [id] - Unique system generated id
1074
+ * @property {string} [name] - Name of custom object
1075
+ * @property {string} [type] - Type of custom object entry
1211
1076
  */
1212
1077
 
1213
1078
  /**
1214
1079
  * @typedef CustomObjectListItemSchema
1215
- * @property {string} [_id]
1216
- * @property {string} [definition_id]
1217
- * @property {string} [status]
1218
- * @property {string} [slug]
1219
- * @property {string} [updated_at]
1220
- * @property {string} [display_name]
1221
- * @property {CustomObjectListItemDefinationSchema} [definition]
1222
- * @property {number} [references]
1080
+ * @property {string} [id] - Unique system generated id
1081
+ * @property {string} [status] - Status of custom object
1082
+ * @property {string} [created_at] - Creation time of custom object document
1083
+ * @property {string} [updated_at] - Updation time of custom object document
1084
+ * @property {string} [display_name] - Display name of custom object
1085
+ * @property {CustomObjectListItemDefinitionModel} [definition]
1086
+ * @property {number} [references] - References of the custom object entry
1223
1087
  */
1224
1088
 
1225
1089
  /**
1226
1090
  * @typedef CustomObjectsSchema
1227
- * @property {CustomObjectListItemSchema[]} [items]
1091
+ * @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
1092
+ * object entries
1228
1093
  * @property {Page} [page]
1229
1094
  */
1230
1095
 
1231
1096
  /**
1232
- * @typedef CustomObjectFieldSchema
1233
- * @property {string} [_id]
1234
- * @property {string} [key]
1235
- * @property {string} [type]
1236
- * @property {string} [definition_id]
1237
- */
1238
-
1239
- /**
1240
- * @typedef MetafieldTypesSchema
1241
- * @property {CustomFieldTypeSchema} [metafield_types]
1097
+ * @typedef CustomObjectFieldDefinition
1098
+ * @property {string} [id] - Unique system generate id
1099
+ * @property {string} [slug] - Slug of custom field definition
1100
+ * @property {string} [namespace] - Namespace of custom field definition
1101
+ * @property {Object[]} [value] - Value of custom field
1102
+ * @property {string} [type] - Data type of the custom field
1242
1103
  */
1243
1104
 
1244
1105
  /**
1245
- * @typedef CustomObjectByIdSchema
1246
- * @property {string} [_id]
1247
- * @property {string} [status]
1248
- * @property {string} [slug]
1249
- * @property {string} [display_name]
1250
- * @property {CustomObjectListItemDefinationSchema} [definition]
1251
- * @property {Object[]} [references]
1252
- * @property {CustomObjectFieldSchema[]} [fields]
1106
+ * @typedef CustomObjectBySlugSchema
1107
+ * @property {string} [id] - Unique system generated identifer for a Custom Object
1108
+ * @property {string} [status] - Status of Custom Object
1109
+ * @property {string} [display_name] - Display name for the Custom Object
1110
+ * @property {CustomObjectListItemDefinitionModel} [definition]
1111
+ * @property {Object[]} [references] - Places where the custom object has been
1112
+ * used as a custom field
1113
+ * @property {string} [slug] - Slug of custom object entry
1114
+ * @property {string} [definition_slug] - Slug of custom object definition
1115
+ * @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
1116
+ * inside the custom object
1253
1117
  */
1254
1118
 
1255
1119
  /**
1256
1120
  * @typedef CustomObjectBulkEntryInitiateDownload
1257
- * @property {string} [message]
1258
- * @property {string} [task_id]
1121
+ * @property {string} [message] - Message for the user
1122
+ * @property {string} [task_id] - Identifer for a task
1259
1123
  */
1260
1124
 
1261
1125
  /**
1262
1126
  * @typedef CustomObjectMetaSchema
1263
- * @property {number} [mo_total_count]
1264
- * @property {number} [mo_success_count]
1265
- * @property {number} [mo_error_count]
1266
- * @property {string} [mo_defintion_type]
1127
+ * @property {number} [mo_total_count] - Total number of entries in the bulk entry
1128
+ * @property {number} [mo_success_count] - Number of entries which were successful
1129
+ * @property {number} [mo_error_count] - Number of entries which were failed
1130
+ * @property {string} [mo_defintion_type] - Type of object
1267
1131
  */
1268
1132
 
1269
1133
  /**
1270
1134
  * @typedef JobSchema
1271
- * @property {string} [_id]
1272
- * @property {string[]} [jobs]
1273
- * @property {string[]} [finished_jobs]
1274
- * @property {string[]} [error_jobs]
1275
- * @property {string[]} [errors_occured]
1276
- * @property {string} [company_id]
1277
- * @property {string} [creator]
1278
- * @property {string} [status]
1279
- * @property {string} [action_type]
1280
- * @property {string} [entity]
1281
- * @property {string} [error_url]
1282
- * @property {number} [finished_count]
1283
- * @property {number} [error_count]
1284
- * @property {number} [success_count]
1285
- * @property {number} [total_jobs]
1135
+ * @property {string} [id] - Unique system generated id
1136
+ * @property {string[]} [jobs] - List of total jobs
1137
+ * @property {string[]} [finished_jobs] - List of finished jobs
1138
+ * @property {string[]} [error_jobs] - List of jobs which resulted in an error
1139
+ * @property {string[]} [errors_occured] - List of errors occurred in the job
1140
+ * @property {string} [company_id] - Company Identifer
1141
+ * @property {string} [status] - Status of job
1142
+ * @property {string} [action_type] - Type of job
1143
+ * @property {string} [entity] - Entity against which job is running
1144
+ * @property {string} [error_url] - URL which contains the file with errors
1145
+ * @property {number} [finished_count] - Number of items successfully finished
1146
+ * @property {number} [error_count] - Number of items in error
1147
+ * @property {number} [success_count] - Number of successful items
1148
+ * @property {number} [total_jobs] - Total number of jobs
1286
1149
  * @property {CustomObjectMetaSchema} [meta]
1287
- * @property {string} [created_by]
1288
- * @property {string} [created_at]
1289
- * @property {string} [updated_at]
1290
- * @property {string} [application_id]
1150
+ * @property {string} [created_by] - Source from where the bulk job is created
1151
+ * @property {string} [created_at] - Date/Time when the job was created
1152
+ * @property {string} [updated_at] - Date/Time when the job was updated
1153
+ * @property {string} [application_id] - Sales Channel Identifier
1291
1154
  */
1292
1155
 
1293
1156
  /**
@@ -1302,6 +1165,11 @@ const Joi = require("joi");
1302
1165
  * @property {Page} [page]
1303
1166
  */
1304
1167
 
1168
+ /**
1169
+ * @typedef MetafieldTypesSchema
1170
+ * @property {CustomFieldTypeSchema} [metafield_types]
1171
+ */
1172
+
1305
1173
  /**
1306
1174
  * @typedef CustomFieldTypeSchema
1307
1175
  * @property {StringSingleLine} [string_single_line]
@@ -1321,156 +1189,184 @@ const Joi = require("joi");
1321
1189
  * @property {Duration} [duration]
1322
1190
  */
1323
1191
 
1192
+ /**
1193
+ * @typedef SupportedValidationsMetaExampleSchema
1194
+ * @property {string} [name]
1195
+ * @property {string} [value]
1196
+ */
1197
+
1198
+ /**
1199
+ * @typedef SupportedValidationsMetaSchema
1200
+ * @property {SupportedValidationsMetaExampleSchema[]} [examples]
1201
+ */
1202
+
1324
1203
  /**
1325
1204
  * @typedef SupportedValidationsSchema
1326
1205
  * @property {string} [name]
1327
1206
  * @property {string} [type]
1328
1207
  * @property {string} [display]
1329
1208
  * @property {boolean} [required]
1209
+ * @property {SupportedValidationsMetaSchema} [meta]
1330
1210
  */
1331
1211
 
1332
1212
  /**
1333
1213
  * @typedef Duration
1334
- * @property {string} [name]
1335
- * @property {boolean} [list_enabled]
1336
- * @property {string} [type]
1337
- * @property {string} [category]
1338
- * @property {SupportedValidationsSchema[]} [supported_validations]
1214
+ * @property {string} [name] - Name data type of custom field
1215
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1216
+ * @property {string} [type] - Type of custom field
1217
+ * @property {string} [category] - Category of custom field
1218
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1219
+ * validations available for the field
1339
1220
  */
1340
1221
 
1341
1222
  /**
1342
1223
  * @typedef HTML
1343
- * @property {string} [name]
1344
- * @property {boolean} [list_enabled]
1345
- * @property {string} [type]
1346
- * @property {SupportedValidationsSchema[]} [supported_validations]
1224
+ * @property {string} [name] - Name data type of custom field
1225
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1226
+ * @property {string} [type] - Type of custom field
1227
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1228
+ * validations available for the field
1347
1229
  */
1348
1230
 
1349
1231
  /**
1350
1232
  * @typedef StringSingleLine
1351
- * @property {string} [name]
1352
- * @property {boolean} [list_enabled]
1353
- * @property {string} [category]
1354
- * @property {string} [type]
1355
- * @property {SupportedValidationsSchema[]} [supported_validations]
1233
+ * @property {string} [name] - Name data type of custom field
1234
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1235
+ * @property {string} [category] - Category of custom field
1236
+ * @property {string} [type] - Type of custom field
1237
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1238
+ * validations available for the field
1356
1239
  */
1357
1240
 
1358
1241
  /**
1359
1242
  * @typedef StringMultiLine
1360
- * @property {string} [name]
1361
- * @property {boolean} [list_enabled]
1362
- * @property {string} [category]
1363
- * @property {string} [type]
1364
- * @property {SupportedValidationsSchema[]} [supported_validations]
1243
+ * @property {string} [name] - Name data type of custom field
1244
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1245
+ * @property {string} [category] - Category of custom field
1246
+ * @property {string} [type] - Type of custom field
1247
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1248
+ * validations available for the field
1365
1249
  */
1366
1250
 
1367
1251
  /**
1368
1252
  * @typedef Dropdown
1369
- * @property {string} [name]
1370
- * @property {boolean} [list_enabled]
1371
- * @property {string} [category]
1372
- * @property {string} [type]
1373
- * @property {SupportedValidationsSchema[]} [supported_validations]
1253
+ * @property {string} [name] - Name data type of custom field
1254
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1255
+ * @property {string} [category] - Category of custom field
1256
+ * @property {string} [type] - Category of custom field
1257
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1258
+ * validations available for the field
1374
1259
  */
1375
1260
 
1376
1261
  /**
1377
1262
  * @typedef Integer
1378
- * @property {string} [name]
1379
- * @property {boolean} [list_enabled]
1380
- * @property {string} [type]
1381
- * @property {string} [category]
1382
- * @property {SupportedValidationsSchema[]} [supported_validations]
1263
+ * @property {string} [name] - Name data type of custom field
1264
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1265
+ * @property {string} [type] - Type of custom field
1266
+ * @property {string} [category] - Category of custom field
1267
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1268
+ * validations available for the field
1383
1269
  */
1384
1270
 
1385
1271
  /**
1386
1272
  * @typedef FloatType
1387
- * @property {string} [name]
1388
- * @property {boolean} [list_enabled]
1389
- * @property {string} [type]
1390
- * @property {string} [category]
1391
- * @property {SupportedValidationsSchema[]} [supported_validations]
1273
+ * @property {string} [name] - Name data type of custom field
1274
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1275
+ * @property {string} [type] - Type of custom field
1276
+ * @property {string} [category] - Category of custom field
1277
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1278
+ * validations available for the field
1392
1279
  */
1393
1280
 
1394
1281
  /**
1395
1282
  * @typedef BooleanType
1396
- * @property {string} [name]
1397
- * @property {string} [category]
1398
- * @property {boolean} [list_enabled]
1399
- * @property {string} [type]
1400
- * @property {SupportedValidationsSchema[]} [supported_validations]
1283
+ * @property {string} [name] - Name data type of custom field
1284
+ * @property {string} [category] - Category of custom field
1285
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1286
+ * @property {string} [type] - Category of custom field
1287
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1288
+ * validations available for the field
1401
1289
  */
1402
1290
 
1403
1291
  /**
1404
1292
  * @typedef Date
1405
- * @property {string} [name]
1406
- * @property {boolean} [list_enabled]
1407
- * @property {string} [category]
1408
- * @property {string} [type]
1409
- * @property {SupportedValidationsSchema[]} [supported_validations]
1293
+ * @property {string} [name] - Name data type of custom field
1294
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1295
+ * @property {string} [category] - Category of custom field
1296
+ * @property {string} [type] - Type of custom field
1297
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1298
+ * validations available for the field
1410
1299
  */
1411
1300
 
1412
1301
  /**
1413
1302
  * @typedef Datetime
1414
- * @property {string} [name]
1415
- * @property {string} [category]
1416
- * @property {boolean} [list_enabled]
1417
- * @property {string} [type]
1418
- * @property {SupportedValidationsSchema[]} [supported_validations]
1303
+ * @property {string} [name] - Name data type of custom field
1304
+ * @property {string} [category] - Category of custom field
1305
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1306
+ * @property {string} [type] - Type of custom field
1307
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1308
+ * validations available for the field
1419
1309
  */
1420
1310
 
1421
1311
  /**
1422
1312
  * @typedef Json
1423
- * @property {string} [name]
1424
- * @property {boolean} [list_enabled]
1425
- * @property {string} [category]
1426
- * @property {string} [type]
1427
- * @property {SupportedValidationsSchema[]} [supported_validations]
1313
+ * @property {string} [name] - Name data type of custom field
1314
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1315
+ * @property {string} [category] - Category of custom field
1316
+ * @property {string} [type] - Type of custom field
1317
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1318
+ * validations available for the field
1428
1319
  */
1429
1320
 
1430
1321
  /**
1431
1322
  * @typedef File
1432
- * @property {string} [name]
1433
- * @property {string} [category]
1434
- * @property {boolean} [list_enabled]
1435
- * @property {string} [type]
1323
+ * @property {string} [name] - Name data type of custom field
1324
+ * @property {string} [category] - Category of custom field
1325
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1326
+ * @property {string} [type] - Type of custom field
1436
1327
  * @property {SupportedValidationsSchema[]} [supported_validations]
1437
1328
  */
1438
1329
 
1439
1330
  /**
1440
1331
  * @typedef Url
1441
- * @property {string} [name]
1442
- * @property {boolean} [list_enabled]
1443
- * @property {string} [type]
1444
- * @property {SupportedValidationsSchema[]} [supported_validations]
1332
+ * @property {string} [name] - Name data type of custom field
1333
+ * @property {boolean} [list_enabled] - Flag for listing enabled or not
1334
+ * @property {string} [type] - Type of custom field
1335
+ * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1336
+ * validations available for the field
1445
1337
  */
1446
1338
 
1447
1339
  /**
1448
1340
  * @typedef Metaobject
1449
- * @property {string} [name]
1450
- * @property {boolean} [list_enabled]
1451
- * @property {string} [category]
1452
- * @property {string} [type]
1341
+ * @property {string} [name] - Name of Custom Object
1342
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1343
+ * multiple list items
1344
+ * @property {string} [category] - Category of Custom Object Definition that
1345
+ * Custom Object belongs to
1346
+ * @property {string} [type] - Type of Custom Object Definition
1453
1347
  * @property {SupportedValidationsSchema[]} [supported_validations]
1454
1348
  */
1455
1349
 
1456
1350
  /**
1457
1351
  * @typedef Product
1458
- * @property {string} [name]
1459
- * @property {boolean} [list_enabled]
1460
- * @property {string} [category]
1461
- * @property {string} [type]
1352
+ * @property {string} [name] - Name of Product
1353
+ * @property {boolean} [list_enabled] - Whether the field is allowed to have
1354
+ * multiple list items
1355
+ * @property {string} [category] - Category of Custom Object Definition that
1356
+ * Product is associated with
1357
+ * @property {string} [type] - Custom Object Definition that Product is associated with
1462
1358
  * @property {SupportedValidationsSchema[]} [supported_validations]
1463
- * @property {string[]} [scope]
1464
1359
  */
1465
1360
 
1466
1361
  /**
1467
1362
  * @typedef CustomObjectEntry
1468
- * @property {string} [_id]
1469
- * @property {string} [name]
1470
- * @property {string} [type]
1471
- * @property {string} [updated_at]
1472
- * @property {number} [entries_count]
1473
- * @property {number} [fields_count]
1363
+ * @property {string} [id] - Unique system generated id
1364
+ * @property {string} [name] - Name of Custom Object definition
1365
+ * @property {string} [type] - Type of Custom Object Definition
1366
+ * @property {string} [updated_at] - Updation time of a Custom Object
1367
+ * @property {number} [entries_count] - Number of entries against the Custom
1368
+ * Object definition
1369
+ * @property {number} [fields_count] - Number of fields against a Custom Object definition
1474
1370
  */
1475
1371
 
1476
1372
  /**
@@ -1481,21 +1377,33 @@ const Joi = require("joi");
1481
1377
 
1482
1378
  /**
1483
1379
  * @typedef CustomObjectEntryFieldSchema
1484
- * @property {string} [definition_id]
1380
+ * @property {string} [namespace] - This is namespace for a custom field definition
1381
+ * @property {string} [slug] - This is slug for a custom field definition
1382
+ */
1383
+
1384
+ /**
1385
+ * @typedef CustomObjectEntryFieldSchemaWithoutID
1386
+ * @property {string} [slug] - Custom fields belonging to a custom object
1387
+ * @property {Object} [value] - Value of custom field inside a custom object
1485
1388
  */
1486
1389
 
1487
1390
  /**
1488
1391
  * @typedef CustomObjectRequestSchema
1489
- * @property {string} [status]
1490
- * @property {string} [slug]
1491
- * @property {string} [definition_id]
1492
- * @property {CustomObjectEntryFieldSchema[]} [fields]
1392
+ * @property {string} [status] - Flag to denote status of Custom Object
1393
+ * @property {string} [slug] - This is slug for a custom field definition
1394
+ * @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
1395
+ */
1396
+
1397
+ /**
1398
+ * @typedef CustomObjectRequestSchemaWithoutId
1399
+ * @property {string} [status] - Status of the custom object entry.
1400
+ * @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
1493
1401
  */
1494
1402
 
1495
1403
  /**
1496
1404
  * @typedef CustomObjectBulkSchema
1497
- * @property {string} [url]
1498
- * @property {number} [total_records]
1405
+ * @property {string} [url] - Full URL for the bulk operations data
1406
+ * @property {number} [total_records] - Total records in the upload.
1499
1407
  */
1500
1408
 
1501
1409
  /**
@@ -1506,6 +1414,297 @@ const Joi = require("joi");
1506
1414
  * @property {PageType} type
1507
1415
  */
1508
1416
 
1417
+ /**
1418
+ * @typedef TranslateUiLabels
1419
+ * @property {string} [_id] - Unique identifier assigned to the Translate Ui Labels entry
1420
+ * @property {string} [company_id] - Identifier linking the resource to a
1421
+ * specific company within the platform
1422
+ * @property {string} [application_id] - Reference to the application where this
1423
+ * Translate Ui Labels is utilized
1424
+ * @property {string} [template_theme_id] - Links the resource to a specific
1425
+ * template theme configuration
1426
+ * @property {string} [theme_id] - Associates the resource with a particular
1427
+ * theme implementation
1428
+ * @property {string} [locale] - Specifies the language and region format for
1429
+ * the resource content
1430
+ * @property {Object} [resource] - Contains the actual resource data and
1431
+ * configuration settings
1432
+ * @property {string} [type] - Categorizes the resource type for proper handling
1433
+ * and processing
1434
+ */
1435
+
1436
+ /**
1437
+ * @typedef TranslateUiLabelsCreate
1438
+ * @property {string} [template_theme_id] - Unique identifier for the template theme
1439
+ * @property {string} [theme_id] - Unique identifier for the theme
1440
+ * @property {string} [locale] - Locale
1441
+ * @property {Object} [resource] - Translate Ui Labels json object
1442
+ * @property {string} [type] - Resource type
1443
+ */
1444
+
1445
+ /**
1446
+ * @typedef StaticResourceUpdate
1447
+ * @property {string} [template_theme_id] - Unique identifier for the template theme
1448
+ * @property {string} [theme_id] - Unique identifier for the theme
1449
+ * @property {string} [locale] - Locale
1450
+ * @property {Object} [resource] - Translate Ui Labels json object
1451
+ * @property {string} [type] - Resource type
1452
+ */
1453
+
1454
+ /**
1455
+ * @typedef TranslateUiLabelsPage
1456
+ * @property {TranslateUiLabels[]} [items] - List of items containing all the
1457
+ * static info data.
1458
+ * @property {Page} [page]
1459
+ */
1460
+
1461
+ /**
1462
+ * @typedef Error
1463
+ * @property {string} [error] - Detailed message explaining the error that occurred
1464
+ */
1465
+
1466
+ /**
1467
+ * @typedef Meta
1468
+ * @property {string} [created_by] - Identifier of the user who created this resource
1469
+ * @property {string} [modified_by] - Identifier of the user who last modified
1470
+ * this resource
1471
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1472
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1473
+ */
1474
+
1475
+ /**
1476
+ * @typedef CompanyLanguage
1477
+ * @property {string} [_id] - Unique identifier for the company language setting
1478
+ * @property {string} company_id - Identifier of the company this language
1479
+ * configuration belongs to
1480
+ * @property {string} [locale] - Language code following ISO standards for this
1481
+ * company setting
1482
+ * @property {string} [name] - Display name of the language for company usage
1483
+ * @property {string} [direction] - Text direction setting for company content
1484
+ * in this language
1485
+ * @property {boolean} [is_default] - Indicates if this is the default language
1486
+ * for the company
1487
+ * @property {string} [display_name] - Translated name of the language in
1488
+ * English for easy reference and display at the website.
1489
+ */
1490
+
1491
+ /**
1492
+ * @typedef CompanyLanguageCreate
1493
+ * @property {string[]} locales - List of language codes to be added to company
1494
+ * configuration
1495
+ */
1496
+
1497
+ /**
1498
+ * @typedef CompanyLanguageUpdate
1499
+ * @property {boolean} is_default - Sets the specified language as the company default
1500
+ */
1501
+
1502
+ /**
1503
+ * @typedef ApplicationLanguage
1504
+ * @property {string} [_id] - Unique identifier for the application language setting
1505
+ * @property {string} company_id - Identifier of the company this application belongs to
1506
+ * @property {string} application_id - Unique identifier of the application
1507
+ * using this language
1508
+ * @property {string} locale - Language code following ISO standards for this application
1509
+ * @property {string} name - Display name of the language for application usage
1510
+ * @property {string} direction - Specifies the text direction for displaying
1511
+ * application content, either left-to-right (ltr) or right-to-left (rtl)
1512
+ * @property {boolean} is_default - Indicates if this is the default language
1513
+ * for the application
1514
+ * @property {boolean} published - Indicates whether this language is currently
1515
+ * active and visible within the storefront.
1516
+ * @property {string} [display_name] - Translated name of the language in
1517
+ * English for easy reference and display at the website.
1518
+ */
1519
+
1520
+ /**
1521
+ * @typedef unPublishApplicationLanguage
1522
+ * @property {boolean} published - Updates the publication status of the language
1523
+ */
1524
+
1525
+ /**
1526
+ * @typedef ApplicationLanguageCreate
1527
+ * @property {string[]} locales - List of language codes to be added to
1528
+ * application configuration
1529
+ */
1530
+
1531
+ /**
1532
+ * @typedef ApplicationLanguageUpdate
1533
+ * @property {boolean} is_default - Sets the specified language as the application default
1534
+ * @property {boolean} published - Updates the publication status of the language
1535
+ */
1536
+
1537
+ /**
1538
+ * @typedef TranslatableResource
1539
+ * @property {string} [_id] - Unique identifier for the translatable resource
1540
+ * @property {string} type - Categorizes the type of content that can be translated
1541
+ * @property {string} name - Display name of the translatable resource
1542
+ * @property {string} description - Detailed explanation of the translatable resource
1543
+ * @property {string} schema_type - Defines the processing type for the
1544
+ * translation schema static (fixed), dynamic (flexible), or partial_dynamic (mixed).
1545
+ * @property {string} [created_by] - Identifier of the user who created this resource
1546
+ * @property {string} [modified_by] - Identifier of the user who last modified
1547
+ * this resource
1548
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1549
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1550
+ * @property {TranslatableSection} [section_id]
1551
+ */
1552
+
1553
+ /**
1554
+ * @typedef ResourceDefinition
1555
+ * @property {string} [_id] - Unique identifier for the resource definition
1556
+ * @property {string} translatable_resource_id - Reference to the associated
1557
+ * translatable resource
1558
+ * @property {ResourceJsonSchema} [json_schema]
1559
+ * @property {ResourceUISchema} [ui_schema]
1560
+ * @property {ResourceBulkDetails} [bulk_details]
1561
+ */
1562
+
1563
+ /**
1564
+ * @typedef ResourceJsonSchema
1565
+ * @property {string} [schema]
1566
+ * @property {ResourceJsonSchemaType} [type]
1567
+ */
1568
+
1569
+ /**
1570
+ * @typedef ResourceJsonSchemaType
1571
+ * @property {Author} [author]
1572
+ * @property {Title} [title]
1573
+ * @property {FeatureImage} [feature_image]
1574
+ */
1575
+
1576
+ /**
1577
+ * @typedef ResourceUISchema
1578
+ * @property {Author} [author]
1579
+ * @property {Title} [title]
1580
+ * @property {FeatureImage} [feature_image]
1581
+ * @property {Seo} [seo]
1582
+ */
1583
+
1584
+ /**
1585
+ * @typedef ResourceBulkDetails
1586
+ * @property {string[]} [fields]
1587
+ */
1588
+
1589
+ /**
1590
+ * @typedef Title
1591
+ * @property {string} [ui_widget]
1592
+ * @property {boolean} [ui_description]
1593
+ */
1594
+
1595
+ /**
1596
+ * @typedef FeatureImage
1597
+ * @property {string} [secure_url] - URL of the secure image
1598
+ */
1599
+
1600
+ /**
1601
+ * @typedef Seo
1602
+ * @property {Title} [title]
1603
+ * @property {string} [description]
1604
+ * @property {string} [canonical_url]
1605
+ * @property {MetaTag[]} [meta_tags]
1606
+ */
1607
+
1608
+ /**
1609
+ * @typedef MetaTag
1610
+ * @property {string} [title] - Title of the meta tag
1611
+ * @property {MetaTagItem[]} [items]
1612
+ */
1613
+
1614
+ /**
1615
+ * @typedef MetaTagItem
1616
+ * @property {string} [key] - Key of the meta tag item
1617
+ * @property {string} [value] - Value of the meta tag item
1618
+ */
1619
+
1620
+ /**
1621
+ * @typedef ResourceTranslation
1622
+ * @property {string} [_id] - Unique identifier for the translation entry
1623
+ * @property {string} [locale] - Language code for this translation
1624
+ * @property {TranslationValue} [value]
1625
+ */
1626
+
1627
+ /**
1628
+ * @typedef TranslationValue
1629
+ * @property {string} [name] - Translated name
1630
+ * @property {TranslationSeo} [seo]
1631
+ */
1632
+
1633
+ /**
1634
+ * @typedef TranslationSeo
1635
+ * @property {string} [title] - Translated SEO title
1636
+ * @property {string[]} [breadcrumbs] - List of translated breadcrumbs
1637
+ * @property {string[]} [meta_tags] - List of translated meta tags
1638
+ * @property {string} [canonical_url] - Translated canonical URL
1639
+ * @property {string} [description] - Translated SEO description
1640
+ */
1641
+
1642
+ /**
1643
+ * @typedef ResourceTranslationList
1644
+ * @property {ResourceTranslationCreate[]} [items]
1645
+ */
1646
+
1647
+ /**
1648
+ * @typedef ResourceTranslationCreate
1649
+ * @property {string} [type] - Type of content being translated
1650
+ * @property {string} [resource_id] - Identifier of the resource requiring translation
1651
+ * @property {string} [locale] - Target language code for the translation
1652
+ * @property {TranslationValue} [value]
1653
+ */
1654
+
1655
+ /**
1656
+ * @typedef ResourceTranslationUpdate
1657
+ * @property {TranslationValue} [value]
1658
+ */
1659
+
1660
+ /**
1661
+ * @typedef TranslatableSection
1662
+ * @property {string} [_id] - Unique identifier for the translatable section
1663
+ * @property {string} [name] - Display name of the section
1664
+ * @property {string} [description] - Detailed explanation of the section's purpose
1665
+ * @property {string} [created_by] - Identifier of the user who created this resource
1666
+ * @property {string} [modified_by] - Identifier of the user who last modified
1667
+ * this resource
1668
+ * @property {string} [created_on] - Timestamp when this resource was initially created
1669
+ * @property {string} [modified_on] - Timestamp when this resource was last modified
1670
+ */
1671
+
1672
+ /**
1673
+ * @typedef Metrics
1674
+ * @property {number} [total] - Total number of translation operations attempted
1675
+ * @property {number} [success] - Number of successful translation operations
1676
+ * @property {number} [failed] - Number of failed translation operations
1677
+ */
1678
+
1679
+ /**
1680
+ * @typedef ResourceTranslationUpsertItem
1681
+ * @property {string} [message] - Status message for the translation operation
1682
+ * @property {ResourceTranslationCreate} [data]
1683
+ */
1684
+
1685
+ /**
1686
+ * @typedef ResourceTranslationBulkUpsert
1687
+ * @property {Metrics} [metrics]
1688
+ * @property {ResourceTranslationUpsertItem[]} [failed_items] - List of failed
1689
+ * translation operations
1690
+ * @property {ResourceTranslationUpsertItem[]} [updated_items] - List of
1691
+ * successful translation operations
1692
+ */
1693
+
1694
+ /**
1695
+ * @typedef StandardError
1696
+ * @property {string} message - A brief description of the error.
1697
+ */
1698
+
1699
+ /**
1700
+ * @typedef OperationResponseSchema
1701
+ * @property {boolean} success - Indicates if the operation was successful
1702
+ * @property {string} [message] - Optional message providing additional
1703
+ * information about the operation
1704
+ */
1705
+
1706
+ /** @typedef {"title" | "description"} GenerationEntityType */
1707
+
1509
1708
  /**
1510
1709
  * @typedef {| "about-us"
1511
1710
  * | "addresses"
@@ -1558,6 +1757,14 @@ const Joi = require("joi");
1558
1757
  */
1559
1758
 
1560
1759
  class ContentPlatformModel {
1760
+ /** @returns {ValidationError} */
1761
+ static ValidationError() {
1762
+ return Joi.object({
1763
+ message: Joi.string().allow("").required(),
1764
+ field: Joi.string().allow("").required(),
1765
+ });
1766
+ }
1767
+
1561
1768
  /** @returns {GenerateSEOContent} */
1562
1769
  static GenerateSEOContent() {
1563
1770
  return Joi.object({
@@ -1588,7 +1795,6 @@ class ContentPlatformModel {
1588
1795
  _id: Joi.string().allow(""),
1589
1796
  updated_at: Joi.string().allow(""),
1590
1797
  created_at: Joi.string().allow(""),
1591
- __v: Joi.number(),
1592
1798
  });
1593
1799
  }
1594
1800
 
@@ -1609,7 +1815,7 @@ class ContentPlatformModel {
1609
1815
  redirect_to: Joi.string().allow(""),
1610
1816
  updated_at: Joi.string().allow(""),
1611
1817
  created_at: Joi.string().allow(""),
1612
- __v: Joi.number(),
1818
+ __source: ContentPlatformModel.PathSourceSchema(),
1613
1819
  });
1614
1820
  }
1615
1821
 
@@ -1631,8 +1837,8 @@ class ContentPlatformModel {
1631
1837
  /** @returns {SeoSchema} */
1632
1838
  static SeoSchema() {
1633
1839
  return Joi.object({
1634
- _id: Joi.string().allow(""),
1635
1840
  app: Joi.string().allow(""),
1841
+ _id: Joi.string().allow(""),
1636
1842
  robots_txt: Joi.string().allow(""),
1637
1843
  sitemap_enabled: Joi.boolean(),
1638
1844
  additional_sitemap: Joi.string().allow(""),
@@ -1641,8 +1847,6 @@ class ContentPlatformModel {
1641
1847
  details: ContentPlatformModel.Detail(),
1642
1848
  created_at: Joi.string().allow(""),
1643
1849
  updated_at: Joi.string().allow(""),
1644
- __v: Joi.number(),
1645
- sitemap: ContentPlatformModel.SEOSitemap(),
1646
1850
  });
1647
1851
  }
1648
1852
 
@@ -1675,17 +1879,16 @@ class ContentPlatformModel {
1675
1879
  /** @returns {SEOSchemaMarkupTemplate} */
1676
1880
  static SEOSchemaMarkupTemplate() {
1677
1881
  return Joi.object({
1678
- _id: Joi.string().allow(""),
1882
+ id: Joi.string().allow(""),
1679
1883
  title: Joi.string().allow(""),
1680
1884
  page_type: Joi.string().allow(""),
1681
1885
  schema: Joi.string().allow(""),
1682
1886
  description: Joi.string().allow(""),
1683
1887
  active: Joi.boolean(),
1684
- application: Joi.string().allow(""),
1685
1888
  created_at: Joi.string().allow(""),
1686
1889
  updated_at: Joi.string().allow(""),
1890
+ application: Joi.string().allow(""),
1687
1891
  target_json: Joi.object().pattern(/\S/, Joi.any()),
1688
- __v: Joi.number(),
1689
1892
  });
1690
1893
  }
1691
1894
 
@@ -1694,46 +1897,12 @@ class ContentPlatformModel {
1694
1897
  return Joi.object({
1695
1898
  title: Joi.string().allow(""),
1696
1899
  page_type: Joi.string().allow(""),
1697
- description: Joi.string().allow(""),
1698
1900
  schema: Joi.string().allow(""),
1901
+ description: Joi.string().allow(""),
1699
1902
  target_json: Joi.object().pattern(/\S/, Joi.any()),
1700
1903
  active: Joi.boolean(),
1701
1904
  created_at: Joi.string().allow(""),
1702
- });
1703
- }
1704
-
1705
- /** @returns {DeletPathMappingSchema} */
1706
- static DeletPathMappingSchema() {
1707
- return Joi.object({
1708
- message: Joi.string().allow(""),
1709
- data: ContentPlatformModel.PathMappingSchema(),
1710
- });
1711
- }
1712
-
1713
- /** @returns {CreatePathMappingSchema} */
1714
- static CreatePathMappingSchema() {
1715
- return Joi.object({
1716
- message: Joi.string().allow(""),
1717
- data: ContentPlatformModel.PathMappingSchema(),
1718
- });
1719
- }
1720
-
1721
- /** @returns {GetAllPathMappingSchema} */
1722
- static GetAllPathMappingSchema() {
1723
- return Joi.object({
1724
- message: Joi.string().allow(""),
1725
- data: ContentPlatformModel.GetPathSchema(),
1726
- });
1727
- }
1728
-
1729
- /** @returns {GetPathSchema} */
1730
- static GetPathSchema() {
1731
- return Joi.object({
1732
- docs: Joi.array().items(ContentPlatformModel.PathMappingSchema()),
1733
- page: Joi.number(),
1734
- limit: Joi.number(),
1735
- pages: Joi.number(),
1736
- total: Joi.number(),
1905
+ updated_at: Joi.string().allow(""),
1737
1906
  });
1738
1907
  }
1739
1908
 
@@ -1794,13 +1963,13 @@ class ContentPlatformModel {
1794
1963
  return Joi.object({
1795
1964
  page_type: Joi.string().allow(""),
1796
1965
  schema: Joi.string().allow(""),
1966
+ target_json: Joi.object().pattern(/\S/, Joi.any()),
1797
1967
  });
1798
1968
  }
1799
1969
 
1800
1970
  /** @returns {ScheduleSchema} */
1801
1971
  static ScheduleSchema() {
1802
1972
  return Joi.object({
1803
- published: Joi.boolean(),
1804
1973
  cron: Joi.string().allow(""),
1805
1974
  start: Joi.string().allow(""),
1806
1975
  end: Joi.string().allow(""),
@@ -1817,8 +1986,8 @@ class ContentPlatformModel {
1817
1986
  });
1818
1987
  }
1819
1988
 
1820
- /** @returns {BlogGetResponse} */
1821
- static BlogGetResponse() {
1989
+ /** @returns {BlogGetDetails} */
1990
+ static BlogGetDetails() {
1822
1991
  return Joi.object({
1823
1992
  items: Joi.array().items(ContentPlatformModel.BlogSchema()),
1824
1993
  page: ContentPlatformModel.Page(),
@@ -1863,7 +2032,7 @@ class ContentPlatformModel {
1863
2032
  static BlogSchema() {
1864
2033
  return Joi.object({
1865
2034
  _id: Joi.string().allow(""),
1866
- _custom_json: Joi.any(),
2035
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
1867
2036
  application: Joi.string().allow(""),
1868
2037
  archived: Joi.boolean(),
1869
2038
  author: ContentPlatformModel.Author(),
@@ -1878,7 +2047,6 @@ class ContentPlatformModel {
1878
2047
  title: Joi.string().allow(""),
1879
2048
  date_meta: ContentPlatformModel.DateMeta(),
1880
2049
  summary: Joi.string().allow(""),
1881
- status: Joi.string().allow(""),
1882
2050
  });
1883
2051
  }
1884
2052
 
@@ -1890,7 +2058,7 @@ class ContentPlatformModel {
1890
2058
  title: Joi.string().allow(""),
1891
2059
  meta_tags: Joi.array().items(ContentPlatformModel.SEOMetaItem()),
1892
2060
  sitemap: ContentPlatformModel.SEOSitemap(),
1893
- breadcrumbs: Joi.array().items(ContentPlatformModel.SEObreadcrumb()),
2061
+ breadcrumb: Joi.array().items(ContentPlatformModel.SEObreadcrumb()),
1894
2062
  canonical_url: Joi.string().allow(""),
1895
2063
  });
1896
2064
  }
@@ -1942,11 +2110,11 @@ class ContentPlatformModel {
1942
2110
  });
1943
2111
  }
1944
2112
 
1945
- /** @returns {BlogRequest} */
1946
- static BlogRequest() {
2113
+ /** @returns {BlogPayload} */
2114
+ static BlogPayload() {
1947
2115
  return Joi.object({
1948
2116
  application: Joi.string().allow(""),
1949
- _custom_json: Joi.any(),
2117
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
1950
2118
  author: ContentPlatformModel.Author(),
1951
2119
  content: Joi.array().items(ContentPlatformModel.ResourceContent()),
1952
2120
  feature_image: ContentPlatformModel.Asset(),
@@ -1955,7 +2123,6 @@ class ContentPlatformModel {
1955
2123
  slug: Joi.string().allow(""),
1956
2124
  tags: Joi.array().items(Joi.string().allow("")),
1957
2125
  title: Joi.string().allow(""),
1958
- publish_date: Joi.string().allow(""),
1959
2126
  seo: ContentPlatformModel.SEO(),
1960
2127
  summary: Joi.string().allow(""),
1961
2128
  });
@@ -1977,13 +2144,6 @@ class ContentPlatformModel {
1977
2144
  });
1978
2145
  }
1979
2146
 
1980
- /** @returns {DataLoaderItemsResponseSchema} */
1981
- static DataLoaderItemsResponseSchema() {
1982
- return Joi.object({
1983
- items: Joi.array().items(ContentPlatformModel.DataLoaderResponseSchema()),
1984
- });
1985
- }
1986
-
1987
2147
  /** @returns {DataLoaderResponseSchema} */
1988
2148
  static DataLoaderResponseSchema() {
1989
2149
  return Joi.object({
@@ -1996,10 +2156,6 @@ class ContentPlatformModel {
1996
2156
  type: Joi.string().allow(""),
1997
2157
  url: Joi.string().allow(""),
1998
2158
  content: Joi.string().allow(""),
1999
- created_at: Joi.string().allow(""),
2000
- modified_at: Joi.string().allow(""),
2001
- __v: Joi.number(),
2002
- is_selected: Joi.boolean(),
2003
2159
  __source: ContentPlatformModel.DataLoaderSourceSchema(),
2004
2160
  });
2005
2161
  }
@@ -2007,7 +2163,7 @@ class ContentPlatformModel {
2007
2163
  /** @returns {DataLoaderResetResponseSchema} */
2008
2164
  static DataLoaderResetResponseSchema() {
2009
2165
  return Joi.object({
2010
- resetted: Joi.boolean(),
2166
+ reset: Joi.boolean(),
2011
2167
  });
2012
2168
  }
2013
2169
 
@@ -2044,6 +2200,7 @@ class ContentPlatformModel {
2044
2200
  _locale_language: ContentPlatformModel.LocaleLanguage(),
2045
2201
  image: Joi.string().allow(""),
2046
2202
  type: Joi.string().allow(""),
2203
+ action: ContentPlatformModel.Action(),
2047
2204
  active: Joi.boolean(),
2048
2205
  display: Joi.string().allow(""),
2049
2206
  sort_order: Joi.number(),
@@ -2052,15 +2209,6 @@ class ContentPlatformModel {
2052
2209
  }).id("NavigationReference");
2053
2210
  }
2054
2211
 
2055
- /** @returns {AssignmentReference} */
2056
- static AssignmentReference() {
2057
- return Joi.object({
2058
- platform: Joi.string().allow(""),
2059
- orientation: Joi.string().allow(""),
2060
- position: Joi.string().allow(""),
2061
- });
2062
- }
2063
-
2064
2212
  /** @returns {CronBasedScheduleSchema} */
2065
2213
  static CronBasedScheduleSchema() {
2066
2214
  return Joi.object({
@@ -2082,7 +2230,8 @@ class ContentPlatformModel {
2082
2230
  static HandpickedTagSchema() {
2083
2231
  return Joi.object({
2084
2232
  position: Joi.string().allow(""),
2085
- attributes: Joi.any(),
2233
+ attributes: Joi.object().pattern(/\S/, Joi.any()),
2234
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
2086
2235
  name: Joi.string().allow(""),
2087
2236
  url: Joi.string().allow(""),
2088
2237
  type: Joi.string().allow(""),
@@ -2107,7 +2256,8 @@ class ContentPlatformModel {
2107
2256
  type: Joi.string().allow(""),
2108
2257
  url: Joi.string().allow(""),
2109
2258
  position: Joi.string().allow(""),
2110
- attributes: Joi.any(),
2259
+ attributes: Joi.object().pattern(/\S/, Joi.any()),
2260
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
2111
2261
  pages: Joi.array().items(Joi.any()),
2112
2262
  content: Joi.string().allow(""),
2113
2263
  });
@@ -2123,18 +2273,14 @@ class ContentPlatformModel {
2123
2273
  /** @returns {DataLoaderSchema} */
2124
2274
  static DataLoaderSchema() {
2125
2275
  return Joi.object({
2126
- _id: Joi.string().allow(""),
2127
- url: Joi.string().allow(""),
2128
- created_at: Joi.string().allow(""),
2129
- modified_at: Joi.string().allow(""),
2130
- application: Joi.string().allow(""),
2131
- company: Joi.string().allow(""),
2132
2276
  name: Joi.string().allow(""),
2133
2277
  service: Joi.string().allow(""),
2134
2278
  operation_id: Joi.string().allow(""),
2135
- is_selected: Joi.boolean(),
2136
2279
  type: Joi.string().allow(""),
2280
+ url: Joi.string().allow(""),
2281
+ content: Joi.string().allow(""),
2137
2282
  __source: ContentPlatformModel.DataLoaderSourceSchema(),
2283
+ _id: Joi.string().allow(""),
2138
2284
  });
2139
2285
  }
2140
2286
 
@@ -2146,32 +2292,6 @@ class ContentPlatformModel {
2146
2292
  });
2147
2293
  }
2148
2294
 
2149
- /** @returns {TagSpecSchema} */
2150
- static TagSpecSchema() {
2151
- return Joi.object({
2152
- name: Joi.string().allow(""),
2153
- description: Joi.string().allow(""),
2154
- });
2155
- }
2156
-
2157
- /** @returns {ServerSchema} */
2158
- static ServerSchema() {
2159
- return Joi.object({
2160
- url: Joi.string().allow(""),
2161
- });
2162
- }
2163
-
2164
- /** @returns {DataLoadersApiSpecSchema} */
2165
- static DataLoadersApiSpecSchema() {
2166
- return Joi.object({
2167
- info: Joi.any(),
2168
- servers: Joi.array().items(ContentPlatformModel.ServerSchema()),
2169
- tags: Joi.array().items(ContentPlatformModel.TagSpecSchema()),
2170
- openapi: Joi.string().allow(""),
2171
- paths: Joi.object().pattern(/\S/, Joi.any()),
2172
- });
2173
- }
2174
-
2175
2295
  /** @returns {DataLoadersSchema} */
2176
2296
  static DataLoadersSchema() {
2177
2297
  return Joi.object({
@@ -2179,8 +2299,8 @@ class ContentPlatformModel {
2179
2299
  });
2180
2300
  }
2181
2301
 
2182
- /** @returns {TagDeleteSuccessResponse} */
2183
- static TagDeleteSuccessResponse() {
2302
+ /** @returns {TagDeleteSuccessDetails} */
2303
+ static TagDeleteSuccessDetails() {
2184
2304
  return Joi.object({
2185
2305
  success: Joi.boolean(),
2186
2306
  });
@@ -2193,9 +2313,10 @@ class ContentPlatformModel {
2193
2313
  status: Joi.number(),
2194
2314
  code: Joi.string().allow(""),
2195
2315
  exception: Joi.string().allow(""),
2316
+ info: Joi.string().allow(""),
2196
2317
  request_id: Joi.string().allow(""),
2197
2318
  stack_trace: Joi.string().allow(""),
2198
- meta: Joi.any(),
2319
+ meta: Joi.object().pattern(/\S/, Joi.any()),
2199
2320
  });
2200
2321
  }
2201
2322
 
@@ -2217,8 +2338,7 @@ class ContentPlatformModel {
2217
2338
  slug: Joi.string().allow(""),
2218
2339
  application: Joi.string().allow(""),
2219
2340
  icon_url: Joi.string().allow(""),
2220
- _custom_json: Joi.any(),
2221
- __v: Joi.number(),
2341
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2222
2342
  });
2223
2343
  }
2224
2344
 
@@ -2244,15 +2364,15 @@ class ContentPlatformModel {
2244
2364
  /** @returns {FAQCategorySchema} */
2245
2365
  static FAQCategorySchema() {
2246
2366
  return Joi.object({
2247
- _id: Joi.string().allow(""),
2248
- application: Joi.string().allow(""),
2367
+ index: Joi.number(),
2249
2368
  title: Joi.string().allow(""),
2250
2369
  description: Joi.string().allow(""),
2251
- index: Joi.number(),
2252
- slug: Joi.string().allow(""),
2253
2370
  children: Joi.array().items(ContentPlatformModel.ChildrenSchema()),
2371
+ _id: Joi.string().allow(""),
2372
+ slug: Joi.string().allow(""),
2373
+ application: Joi.string().allow(""),
2254
2374
  icon_url: Joi.string().allow(""),
2255
- __v: Joi.number(),
2375
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2256
2376
  });
2257
2377
  }
2258
2378
 
@@ -2265,7 +2385,6 @@ class ContentPlatformModel {
2265
2385
  question: Joi.string().allow(""),
2266
2386
  answer: Joi.string().allow(""),
2267
2387
  tags: Joi.array().items(Joi.string().allow("")),
2268
- __v: Joi.number(),
2269
2388
  });
2270
2389
  }
2271
2390
 
@@ -2344,12 +2463,12 @@ class ContentPlatformModel {
2344
2463
  current: Joi.number(),
2345
2464
  type: Joi.string().allow("").required(),
2346
2465
  size: Joi.number(),
2347
- total: Joi.number(),
2466
+ page_size: Joi.number(),
2348
2467
  });
2349
2468
  }
2350
2469
 
2351
- /** @returns {LandingPageGetResponse} */
2352
- static LandingPageGetResponse() {
2470
+ /** @returns {LandingPageGetDetails} */
2471
+ static LandingPageGetDetails() {
2353
2472
  return Joi.object({
2354
2473
  items: Joi.array().items(ContentPlatformModel.LandingPageSchema()),
2355
2474
  page: ContentPlatformModel.Page(),
@@ -2360,26 +2479,26 @@ class ContentPlatformModel {
2360
2479
  static LandingPageSchema() {
2361
2480
  return Joi.object({
2362
2481
  slug: Joi.string().allow(""),
2482
+ action: ContentPlatformModel.Action(),
2363
2483
  platform: Joi.array().items(Joi.string().allow("")),
2364
2484
  created_by: ContentPlatformModel.CreatedBySchema(),
2365
2485
  date_meta: ContentPlatformModel.DateMeta(),
2366
2486
  _id: Joi.string().allow(""),
2367
2487
  application: Joi.string().allow(""),
2368
2488
  archived: Joi.boolean(),
2369
- _custom_json: Joi.any(),
2370
- __v: Joi.number(),
2489
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2371
2490
  });
2372
2491
  }
2373
2492
 
2374
- /** @returns {DefaultNavigationResponse} */
2375
- static DefaultNavigationResponse() {
2493
+ /** @returns {DefaultNavigationDetails} */
2494
+ static DefaultNavigationDetails() {
2376
2495
  return Joi.object({
2377
2496
  items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
2378
2497
  });
2379
2498
  }
2380
2499
 
2381
- /** @returns {NavigationGetResponse} */
2382
- static NavigationGetResponse() {
2500
+ /** @returns {NavigationGetDetails} */
2501
+ static NavigationGetDetails() {
2383
2502
  return Joi.object({
2384
2503
  items: Joi.array().items(ContentPlatformModel.NavigationSchema()),
2385
2504
  page: ContentPlatformModel.Page(),
@@ -2408,38 +2527,22 @@ class ContentPlatformModel {
2408
2527
  orientation: ContentPlatformModel.Orientation(),
2409
2528
  version: Joi.number(),
2410
2529
  navigation: Joi.array().items(ContentPlatformModel.NavigationReference()),
2411
- assignments: Joi.array().items(
2412
- ContentPlatformModel.AssignmentReference()
2413
- ),
2414
- __v: Joi.number(),
2415
2530
  });
2416
2531
  }
2417
2532
 
2418
- /** @returns {NavigationRequest} */
2419
- static NavigationRequest() {
2533
+ /** @returns {NavigationPayload} */
2534
+ static NavigationPayload() {
2420
2535
  return Joi.object({
2421
2536
  name: Joi.string().allow(""),
2422
2537
  slug: Joi.string().allow(""),
2423
2538
  platform: Joi.array().items(Joi.string().allow("")),
2424
2539
  orientation: ContentPlatformModel.Orientation(),
2425
- assignments: Joi.array().items(
2426
- ContentPlatformModel.NavigationAssignment()
2427
- ),
2428
2540
  navigation: Joi.array().items(ContentPlatformModel.NavigationReference()),
2429
2541
  });
2430
2542
  }
2431
2543
 
2432
- /** @returns {NavigationAssignment} */
2433
- static NavigationAssignment() {
2434
- return Joi.object({
2435
- platform: Joi.string().allow(""),
2436
- orientation: Joi.string().allow(""),
2437
- position: Joi.string().allow(""),
2438
- });
2439
- }
2440
-
2441
- /** @returns {PageGetResponse} */
2442
- static PageGetResponse() {
2544
+ /** @returns {PageGetDetails} */
2545
+ static PageGetDetails() {
2443
2546
  return Joi.object({
2444
2547
  items: Joi.array().items(ContentPlatformModel.PageSchema()),
2445
2548
  page: ContentPlatformModel.Page(),
@@ -2471,63 +2574,31 @@ class ContentPlatformModel {
2471
2574
  });
2472
2575
  }
2473
2576
 
2474
- /** @returns {PageResponseError} */
2475
- static PageResponseError() {
2476
- return Joi.object({
2477
- errors: Joi.string().allow(""),
2478
- });
2479
- }
2480
-
2481
2577
  /** @returns {PageSchema} */
2482
2578
  static PageSchema() {
2483
2579
  return Joi.object({
2484
2580
  _id: Joi.string().allow(""),
2485
2581
  application: Joi.string().allow(""),
2486
- platform: Joi.string().allow(""),
2487
- title: Joi.string().allow(""),
2488
- slug: Joi.string().allow(""),
2489
- type: Joi.string().allow(""),
2490
- tags: Joi.array().items(Joi.string().allow("")),
2582
+ component_ids: Joi.array().items(Joi.string().allow("")),
2583
+ content: Joi.array().items(Joi.any()),
2491
2584
  content_path: Joi.string().allow(""),
2492
- orientation: Joi.string().allow(""),
2493
- description: Joi.string().allow(""),
2494
- published: Joi.boolean(),
2495
2585
  created_by: ContentPlatformModel.CreatedBySchema(),
2496
2586
  date_meta: ContentPlatformModel.DateMeta(),
2587
+ description: Joi.string().allow(""),
2497
2588
  feature_image: ContentPlatformModel.Asset(),
2589
+ page_meta: Joi.array().items(Joi.any()),
2498
2590
  _schedule: ContentPlatformModel.ScheduleSchema(),
2499
- page_meta: Joi.array().items(ContentPlatformModel.PageMeta()),
2591
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2592
+ orientation: Joi.string().allow(""),
2593
+ platform: Joi.string().allow(""),
2594
+ published: Joi.boolean(),
2595
+ slug: Joi.string().allow(""),
2596
+ tags: Joi.array().items(Joi.string().allow("")),
2597
+ title: Joi.string().allow(""),
2598
+ type: Joi.string().allow(""),
2500
2599
  seo: ContentPlatformModel.SEO(),
2501
- component_ids: Joi.array().items(Joi.string().allow("")),
2600
+ visibility: Joi.object().pattern(/\S/, Joi.any()),
2502
2601
  archived: Joi.boolean(),
2503
- __v: Joi.number(),
2504
- content: Joi.array().items(ContentPlatformModel.PageContent()),
2505
- sanitized_content: Joi.array().items(
2506
- ContentPlatformModel.SanitizedContent()
2507
- ),
2508
- });
2509
- }
2510
-
2511
- /** @returns {SanitizedContent} */
2512
- static SanitizedContent() {
2513
- return Joi.object({
2514
- type: Joi.string().allow(""),
2515
- value: Joi.string().allow(""),
2516
- });
2517
- }
2518
-
2519
- /** @returns {PageMeta} */
2520
- static PageMeta() {
2521
- return Joi.object({
2522
- key: Joi.string().allow(""),
2523
- });
2524
- }
2525
-
2526
- /** @returns {PageContent} */
2527
- static PageContent() {
2528
- return Joi.object({
2529
- type: Joi.string().allow(""),
2530
- value: Joi.string().allow(""),
2531
2602
  });
2532
2603
  }
2533
2604
 
@@ -2538,22 +2609,15 @@ class ContentPlatformModel {
2538
2609
  });
2539
2610
  }
2540
2611
 
2541
- /** @returns {PageRequestVisibility} */
2542
- static PageRequestVisibility() {
2543
- return Joi.object({
2544
- test: Joi.boolean(),
2545
- });
2546
- }
2547
-
2548
- /** @returns {PageRequest} */
2549
- static PageRequest() {
2612
+ /** @returns {PagePayload} */
2613
+ static PagePayload() {
2550
2614
  return Joi.object({
2551
2615
  _schedule: ContentPlatformModel.CronSchedule(),
2552
2616
  application: Joi.string().allow(""),
2553
2617
  author: ContentPlatformModel.Author(),
2554
- _custom_json: Joi.any(),
2618
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
2555
2619
  orientation: Joi.string().allow(""),
2556
- content: Joi.array().items(ContentPlatformModel.PageContent()),
2620
+ content: Joi.array().items(Joi.any()),
2557
2621
  feature_image: ContentPlatformModel.Asset(),
2558
2622
  published: Joi.boolean(),
2559
2623
  reading_time: Joi.string().allow(""),
@@ -2561,10 +2625,6 @@ class ContentPlatformModel {
2561
2625
  tags: Joi.array().items(Joi.string().allow("")),
2562
2626
  seo: ContentPlatformModel.SEO(),
2563
2627
  title: Joi.string().allow(""),
2564
- platform: Joi.string().allow(""),
2565
- type: Joi.string().allow(""),
2566
- description: Joi.string().allow(""),
2567
- visibility: Joi.any(),
2568
2628
  });
2569
2629
  }
2570
2630
 
@@ -2575,12 +2635,11 @@ class ContentPlatformModel {
2575
2635
  start: Joi.string().allow(""),
2576
2636
  end: Joi.string().allow(""),
2577
2637
  duration: Joi.number(),
2578
- next_schedule: Joi.array().items(ContentPlatformModel.NextSchedule()),
2579
2638
  });
2580
2639
  }
2581
2640
 
2582
- /** @returns {PagePublishRequest} */
2583
- static PagePublishRequest() {
2641
+ /** @returns {PagePublishPayload} */
2642
+ static PagePublishPayload() {
2584
2643
  return Joi.object({
2585
2644
  publish: Joi.boolean(),
2586
2645
  });
@@ -2589,44 +2648,12 @@ class ContentPlatformModel {
2589
2648
  /** @returns {PageMetaSchema} */
2590
2649
  static PageMetaSchema() {
2591
2650
  return Joi.object({
2592
- system_pages: Joi.array().items(ContentPlatformModel.SystemPages()),
2593
- custom_pages: Joi.array().items(ContentPlatformModel.CustomePages()),
2651
+ system_pages: Joi.array().items(ContentPlatformModel.NavigationSchema()),
2652
+ custom_pages: Joi.array().items(ContentPlatformModel.PageSchema()),
2594
2653
  application_id: Joi.string().allow(""),
2595
2654
  });
2596
2655
  }
2597
2656
 
2598
- /** @returns {CustomePages} */
2599
- static CustomePages() {
2600
- return Joi.object({
2601
- display: Joi.string().allow(""),
2602
- slug: Joi.string().allow(""),
2603
- });
2604
- }
2605
-
2606
- /** @returns {SystemPagesActionPage} */
2607
- static SystemPagesActionPage() {
2608
- return Joi.object({
2609
- type: Joi.string().allow(""),
2610
- });
2611
- }
2612
-
2613
- /** @returns {SystemPagesAction} */
2614
- static SystemPagesAction() {
2615
- return Joi.object({
2616
- page: ContentPlatformModel.SystemPagesActionPage(),
2617
- type: Joi.string().allow(""),
2618
- });
2619
- }
2620
-
2621
- /** @returns {SystemPages} */
2622
- static SystemPages() {
2623
- return Joi.object({
2624
- display: Joi.string().allow(""),
2625
- action: ContentPlatformModel.SystemPagesAction(),
2626
- page_type: Joi.string().allow(""),
2627
- });
2628
- }
2629
-
2630
2657
  /** @returns {Support} */
2631
2658
  static Support() {
2632
2659
  return Joi.object({
@@ -2686,8 +2713,6 @@ class ContentPlatformModel {
2686
2713
  return Joi.object({
2687
2714
  application: Joi.string().allow(""),
2688
2715
  _id: Joi.string().allow(""),
2689
- company: Joi.string().allow(""),
2690
- __v: Joi.number(),
2691
2716
  tags: Joi.array().items(ContentPlatformModel.TagSchema()),
2692
2717
  });
2693
2718
  }
@@ -2701,9 +2726,9 @@ class ContentPlatformModel {
2701
2726
  sub_type: Joi.string().allow(""),
2702
2727
  _id: Joi.string().allow(""),
2703
2728
  position: Joi.string().allow(""),
2704
- attributes: Joi.any(),
2729
+ attributes: Joi.object().pattern(/\S/, Joi.any()),
2705
2730
  content: Joi.string().allow(""),
2706
- compatible_engines: Joi.array().items(Joi.any()),
2731
+ compatible_engines: Joi.array().items(Joi.string().allow("")),
2707
2732
  pages: Joi.array().items(Joi.any()),
2708
2733
  __source: ContentPlatformModel.TagSourceSchema(),
2709
2734
  });
@@ -2738,70 +2763,30 @@ class ContentPlatformModel {
2738
2763
  return Joi.object({
2739
2764
  name: Joi.string().allow(""),
2740
2765
  type: Joi.string().allow(""),
2741
- });
2742
- }
2743
-
2744
- /** @returns {ApplicationFieldDefinitionSchema} */
2745
- static ApplicationFieldDefinitionSchema() {
2746
- return Joi.object({
2747
- _id: Joi.string().allow(""),
2748
- creator: Joi.string().allow(""),
2749
- resource: Joi.string().allow(""),
2750
- name: Joi.string().allow(""),
2751
- namespace: Joi.string().allow(""),
2752
- key: Joi.string().allow(""),
2753
- description: Joi.string().allow(""),
2754
- type: Joi.string().allow(""),
2755
- multi_value: Joi.boolean(),
2756
- validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
2757
- company_id: Joi.string().allow(""),
2758
- created_by: Joi.string().allow(""),
2759
- updated_by: Joi.string().allow(""),
2760
- required: Joi.boolean(),
2761
- is_deleted: Joi.boolean(),
2762
- created_at: Joi.string().allow(""),
2763
- updated_at: Joi.string().allow(""),
2764
- type_name: Joi.string().allow(""),
2765
- invalid_fields_count: Joi.number(),
2766
- application_id: Joi.string().allow(""),
2766
+ value: Joi.any(),
2767
2767
  });
2768
2768
  }
2769
2769
 
2770
2770
  /** @returns {FieldDefinitionSchema} */
2771
2771
  static FieldDefinitionSchema() {
2772
2772
  return Joi.object({
2773
- _id: Joi.string().allow(""),
2774
- creator: Joi.string().allow(""),
2773
+ id: Joi.string().allow(""),
2775
2774
  resource: Joi.string().allow(""),
2776
2775
  name: Joi.string().allow(""),
2777
2776
  namespace: Joi.string().allow(""),
2778
- key: Joi.string().allow(""),
2777
+ slug: Joi.string().allow(""),
2779
2778
  description: Joi.string().allow(""),
2780
2779
  type: Joi.string().allow(""),
2781
2780
  multi_value: Joi.boolean(),
2782
2781
  validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
2783
2782
  company_id: Joi.string().allow(""),
2784
- created_by: Joi.string().allow(""),
2785
- updated_by: Joi.string().allow(""),
2786
2783
  required: Joi.boolean(),
2787
2784
  is_deleted: Joi.boolean(),
2788
- created_at: Joi.string().allow(""),
2789
- updated_at: Joi.string().allow(""),
2790
2785
  type_name: Joi.string().allow(""),
2791
2786
  invalid_fields_count: Joi.number(),
2792
2787
  });
2793
2788
  }
2794
2789
 
2795
- /** @returns {ApplicationCustomFieldDefinitionsSchema} */
2796
- static ApplicationCustomFieldDefinitionsSchema() {
2797
- return Joi.object({
2798
- items: Joi.array().items(
2799
- ContentPlatformModel.ApplicationFieldDefinitionSchema()
2800
- ),
2801
- page: ContentPlatformModel.Page(),
2802
- });
2803
- }
2804
-
2805
2790
  /** @returns {CustomFieldDefinitionsSchema} */
2806
2791
  static CustomFieldDefinitionsSchema() {
2807
2792
  return Joi.object({
@@ -2813,14 +2798,12 @@ class ContentPlatformModel {
2813
2798
  /** @returns {CustomFieldDefinitionRequestSchema} */
2814
2799
  static CustomFieldDefinitionRequestSchema() {
2815
2800
  return Joi.object({
2816
- resource: Joi.string().allow(""),
2817
2801
  type: Joi.string().allow(""),
2818
- key: Joi.string().allow(""),
2802
+ slug: Joi.string().allow(""),
2819
2803
  namespace: Joi.string().allow(""),
2820
2804
  multi_value: Joi.boolean(),
2821
2805
  name: Joi.string().allow(""),
2822
2806
  description: Joi.string().allow(""),
2823
- creator: Joi.string().allow(""),
2824
2807
  validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
2825
2808
  });
2826
2809
  }
@@ -2828,13 +2811,13 @@ class ContentPlatformModel {
2828
2811
  /** @returns {CustomObjectCustomFieldDefinitions} */
2829
2812
  static CustomObjectCustomFieldDefinitions() {
2830
2813
  return Joi.object({
2831
- _id: Joi.string().allow(""),
2832
- type: Joi.string().allow("").required(),
2814
+ id: Joi.string().allow(""),
2815
+ type: Joi.string().allow(""),
2833
2816
  description: Joi.string().allow(""),
2834
2817
  name: Joi.string().allow(""),
2835
2818
  multi_value: Joi.boolean(),
2836
2819
  required: Joi.boolean(),
2837
- key: Joi.string().allow(""),
2820
+ slug: Joi.string().allow(""),
2838
2821
  validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
2839
2822
  action: Joi.string().allow(""),
2840
2823
  });
@@ -2843,12 +2826,11 @@ class ContentPlatformModel {
2843
2826
  /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
2844
2827
  static CustomObjectDefinitionUpdateRequestSchema() {
2845
2828
  return Joi.object({
2846
- type: Joi.string().allow(""),
2847
2829
  description: Joi.string().allow(""),
2848
2830
  name: Joi.string().allow(""),
2849
2831
  display_name_key: Joi.string().allow(""),
2850
2832
  field_definitions: Joi.array().items(
2851
- ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
2833
+ ContentPlatformModel.CustomObjectCustomFieldDefinitions()
2852
2834
  ),
2853
2835
  });
2854
2836
  }
@@ -2856,21 +2838,39 @@ class ContentPlatformModel {
2856
2838
  /** @returns {CustomFieldDefinitionDetailResSchema} */
2857
2839
  static CustomFieldDefinitionDetailResSchema() {
2858
2840
  return Joi.object({
2859
- creator: Joi.string().allow(""),
2860
2841
  resource: Joi.string().allow(""),
2861
2842
  name: Joi.string().allow(""),
2862
2843
  namespace: Joi.string().allow(""),
2863
- key: Joi.string().allow(""),
2844
+ slug: Joi.string().allow(""),
2864
2845
  description: Joi.string().allow(""),
2865
2846
  type: Joi.string().allow(""),
2866
2847
  multi_value: Joi.boolean(),
2867
2848
  company_id: Joi.string().allow(""),
2868
2849
  application_id: Joi.string().allow(""),
2869
- created_by: Joi.string().allow(""),
2870
- updated_by: Joi.string().allow(""),
2871
2850
  required: Joi.boolean(),
2872
2851
  is_deleted: Joi.boolean(),
2873
- _id: Joi.string().allow(""),
2852
+ id: Joi.string().allow(""),
2853
+ validations: Joi.array().items(Joi.any()),
2854
+ created_at: Joi.string().allow(""),
2855
+ updated_at: Joi.string().allow(""),
2856
+ });
2857
+ }
2858
+
2859
+ /** @returns {MetaFieldDefinitionDetailResSchema} */
2860
+ static MetaFieldDefinitionDetailResSchema() {
2861
+ return Joi.object({
2862
+ resource: Joi.string().allow(""),
2863
+ name: Joi.string().allow(""),
2864
+ namespace: Joi.string().allow(""),
2865
+ slug: Joi.string().allow(""),
2866
+ description: Joi.string().allow(""),
2867
+ type: Joi.string().allow(""),
2868
+ multi_value: Joi.boolean(),
2869
+ company_id: Joi.string().allow(""),
2870
+ application_id: Joi.string().allow(""),
2871
+ required: Joi.boolean(),
2872
+ is_deleted: Joi.boolean(),
2873
+ id: Joi.string().allow(""),
2874
2874
  validations: Joi.array().items(Joi.any()),
2875
2875
  created_at: Joi.string().allow(""),
2876
2876
  updated_at: Joi.string().allow(""),
@@ -2885,22 +2885,27 @@ class ContentPlatformModel {
2885
2885
  });
2886
2886
  }
2887
2887
 
2888
+ /** @returns {CustomFieldValue} */
2889
+ static CustomFieldValue() {
2890
+ return Joi.object({
2891
+ value: Joi.any(),
2892
+ });
2893
+ }
2894
+
2888
2895
  /** @returns {CustomFieldSchema} */
2889
2896
  static CustomFieldSchema() {
2890
2897
  return Joi.object({
2891
- _id: Joi.string().allow(""),
2898
+ id: Joi.string().allow(""),
2892
2899
  namespace: Joi.string().allow(""),
2893
- key: Joi.string().allow(""),
2900
+ slug: Joi.string().allow(""),
2894
2901
  resource: Joi.string().allow(""),
2895
- creator: Joi.string().allow(""),
2896
- resource_id: Joi.string().allow(""),
2897
- type: Joi.string().allow("").required(),
2902
+ value: Joi.array().items(ContentPlatformModel.CustomFieldValue()),
2903
+ resource_slug: Joi.string().allow(""),
2904
+ type: Joi.string().allow(""),
2898
2905
  multi_value: Joi.boolean(),
2899
2906
  company_id: Joi.string().allow(""),
2900
- definition_id: Joi.string().allow(""),
2901
2907
  has_invalid_values: Joi.boolean(),
2902
2908
  invalid_value_errors: Joi.array().items(Joi.any()),
2903
- created_by: Joi.string().allow(""),
2904
2909
  is_deleted: Joi.boolean(),
2905
2910
  created_at: Joi.string().allow(""),
2906
2911
  updated_at: Joi.string().allow(""),
@@ -2930,52 +2935,32 @@ class ContentPlatformModel {
2930
2935
  });
2931
2936
  }
2932
2937
 
2933
- /** @returns {CustomFieldRequestSchema} */
2934
- static CustomFieldRequestSchema() {
2938
+ /** @returns {CustomField} */
2939
+ static CustomField() {
2935
2940
  return Joi.object({
2936
- fields: Joi.array().items(Joi.any()),
2941
+ value: Joi.array().items(Joi.any()),
2942
+ namespace: Joi.string().allow(""),
2943
+ slug: Joi.string().allow(""),
2937
2944
  });
2938
2945
  }
2939
2946
 
2940
- /** @returns {CustomObjectSchema} */
2941
- static CustomObjectSchema() {
2947
+ /** @returns {CustomFieldRequestSchema} */
2948
+ static CustomFieldRequestSchema() {
2942
2949
  return Joi.object({
2943
- _id: Joi.string().allow(""),
2944
- name: Joi.string().allow(""),
2945
- creator: Joi.string().allow(""),
2946
- company_id: Joi.string().allow(""),
2947
- created_by: Joi.string().allow(""),
2948
- updated_by: Joi.string().allow(""),
2949
- status: Joi.string().allow(""),
2950
- slug: Joi.string().allow(""),
2951
- type: Joi.string().allow(""),
2952
- display_name: Joi.string().allow(""),
2953
- definition_id: Joi.string().allow(""),
2954
- is_deleted: Joi.boolean(),
2955
- created_at: Joi.string().allow(""),
2956
- updated_at: Joi.string().allow(""),
2957
- fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
2950
+ fields: Joi.array().items(ContentPlatformModel.CustomField()),
2958
2951
  });
2959
2952
  }
2960
2953
 
2961
- /** @returns {CustomObjectApplicationSchema} */
2962
- static CustomObjectApplicationSchema() {
2954
+ /** @returns {CustomObjectSchema} */
2955
+ static CustomObjectSchema() {
2963
2956
  return Joi.object({
2964
- _id: Joi.string().allow(""),
2965
- name: Joi.string().allow(""),
2966
- creator: Joi.string().allow(""),
2957
+ id: Joi.string().allow(""),
2967
2958
  company_id: Joi.string().allow(""),
2968
2959
  application_id: Joi.string().allow(""),
2969
- created_by: Joi.string().allow(""),
2970
- updated_by: Joi.string().allow(""),
2971
2960
  status: Joi.string().allow(""),
2972
- slug: Joi.string().allow(""),
2973
2961
  type: Joi.string().allow(""),
2962
+ definition_slug: Joi.string().allow(""),
2974
2963
  display_name: Joi.string().allow(""),
2975
- definition_id: Joi.string().allow(""),
2976
- is_deleted: Joi.boolean(),
2977
- created_at: Joi.string().allow(""),
2978
- updated_at: Joi.string().allow(""),
2979
2964
  fields: Joi.array().items(ContentPlatformModel.CustomFieldSchema()),
2980
2965
  });
2981
2966
  }
@@ -2984,6 +2969,7 @@ class ContentPlatformModel {
2984
2969
  static CustomObjectDefinitionRequestSchema() {
2985
2970
  return Joi.object({
2986
2971
  type: Joi.string().allow(""),
2972
+ definition_slug: Joi.string().allow(""),
2987
2973
  description: Joi.string().allow(""),
2988
2974
  name: Joi.string().allow(""),
2989
2975
  display_name_key: Joi.string().allow(""),
@@ -2993,47 +2979,17 @@ class ContentPlatformModel {
2993
2979
  });
2994
2980
  }
2995
2981
 
2996
- /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
2997
- static CustomObjectCustomFieldDefinitionResSchema() {
2982
+ /** @returns {CustomObjectDefinitionSlugSchema} */
2983
+ static CustomObjectDefinitionSlugSchema() {
2998
2984
  return Joi.object({
2999
- creator: Joi.string().allow(""),
3000
- resource: Joi.string().allow(""),
2985
+ id: Joi.string().allow(""),
3001
2986
  name: Joi.string().allow(""),
3002
- namespace: Joi.string().allow(""),
3003
- key: Joi.string().allow(""),
2987
+ type: Joi.string().allow(""),
2988
+ definition_slug: Joi.string().allow(""),
2989
+ display_name_key: Joi.string().allow(""),
3004
2990
  description: Joi.string().allow(""),
3005
- type: Joi.string().allow("").required(),
3006
- multi_value: Joi.boolean(),
3007
- validations: Joi.array().items(ContentPlatformModel.FieldValidations()),
3008
- company_id: Joi.string().allow(""),
3009
- created_by: Joi.string().allow(""),
3010
- metaobject_definition_id: Joi.string().allow(""),
3011
- required: Joi.boolean(),
3012
- is_deleted: Joi.boolean(),
3013
- _id: Joi.string().allow(""),
3014
- created_at: Joi.string().allow(""),
3015
- updated_at: Joi.string().allow(""),
3016
- application_id: Joi.string().allow(""),
3017
- });
3018
- }
3019
-
3020
- /** @returns {CustomObjectDefinitionSchema} */
3021
- static CustomObjectDefinitionSchema() {
3022
- return Joi.object({
3023
- _id: Joi.string().allow(""),
3024
- name: Joi.string().allow(""),
3025
- type: Joi.string().allow(""),
3026
- display_name_key: Joi.string().allow(""),
3027
- description: Joi.string().allow(""),
3028
- creator: Joi.string().allow(""),
3029
- created_by: Joi.string().allow(""),
3030
- updated_by: Joi.string().allow(""),
3031
- application_id: Joi.string().allow(""),
3032
- company_id: Joi.string().allow(""),
3033
- created_at: Joi.string().allow(""),
3034
- updated_at: Joi.string().allow(""),
3035
2991
  field_definitions: Joi.array().items(
3036
- ContentPlatformModel.CustomObjectCustomFieldDefinitionResSchema()
2992
+ ContentPlatformModel.CustomFieldDefinitionDetailResSchema()
3037
2993
  ),
3038
2994
  });
3039
2995
  }
@@ -3046,34 +3002,32 @@ class ContentPlatformModel {
3046
3002
  });
3047
3003
  }
3048
3004
 
3049
- /** @returns {CustomObjectEntryBulkUploadResponse} */
3050
- static CustomObjectEntryBulkUploadResponse() {
3005
+ /** @returns {CustomObjectEntryBulkUploadDetails} */
3006
+ static CustomObjectEntryBulkUploadDetails() {
3051
3007
  return Joi.object({
3052
- message: Joi.string().allow(""),
3053
- task_id: Joi.string().allow(""),
3008
+ url: Joi.string().allow(""),
3009
+ total_records: Joi.number(),
3054
3010
  });
3055
3011
  }
3056
3012
 
3057
- /** @returns {CustomObjectListItemDefinationSchema} */
3058
- static CustomObjectListItemDefinationSchema() {
3013
+ /** @returns {CustomObjectListItemDefinitionModel} */
3014
+ static CustomObjectListItemDefinitionModel() {
3059
3015
  return Joi.object({
3060
- _id: Joi.string().allow(""),
3016
+ id: Joi.string().allow(""),
3061
3017
  name: Joi.string().allow(""),
3062
3018
  type: Joi.string().allow(""),
3063
- display_name_key: Joi.string().allow(""),
3064
3019
  });
3065
3020
  }
3066
3021
 
3067
3022
  /** @returns {CustomObjectListItemSchema} */
3068
3023
  static CustomObjectListItemSchema() {
3069
3024
  return Joi.object({
3070
- _id: Joi.string().allow(""),
3071
- definition_id: Joi.string().allow(""),
3025
+ id: Joi.string().allow(""),
3072
3026
  status: Joi.string().allow(""),
3073
- slug: Joi.string().allow(""),
3027
+ created_at: Joi.string().allow(""),
3074
3028
  updated_at: Joi.string().allow(""),
3075
3029
  display_name: Joi.string().allow(""),
3076
- definition: ContentPlatformModel.CustomObjectListItemDefinationSchema(),
3030
+ definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
3077
3031
  references: Joi.number(),
3078
3032
  });
3079
3033
  }
@@ -3088,33 +3042,30 @@ class ContentPlatformModel {
3088
3042
  });
3089
3043
  }
3090
3044
 
3091
- /** @returns {CustomObjectFieldSchema} */
3092
- static CustomObjectFieldSchema() {
3045
+ /** @returns {CustomObjectFieldDefinition} */
3046
+ static CustomObjectFieldDefinition() {
3093
3047
  return Joi.object({
3094
- _id: Joi.string().allow(""),
3095
- key: Joi.string().allow(""),
3048
+ id: Joi.string().allow(""),
3049
+ slug: Joi.string().allow(""),
3050
+ namespace: Joi.string().allow(""),
3051
+ value: Joi.array().items(Joi.any()),
3096
3052
  type: Joi.string().allow(""),
3097
- definition_id: Joi.string().allow(""),
3098
- });
3099
- }
3100
-
3101
- /** @returns {MetafieldTypesSchema} */
3102
- static MetafieldTypesSchema() {
3103
- return Joi.object({
3104
- metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
3105
3053
  });
3106
3054
  }
3107
3055
 
3108
- /** @returns {CustomObjectByIdSchema} */
3109
- static CustomObjectByIdSchema() {
3056
+ /** @returns {CustomObjectBySlugSchema} */
3057
+ static CustomObjectBySlugSchema() {
3110
3058
  return Joi.object({
3111
- _id: Joi.string().allow(""),
3059
+ id: Joi.string().allow(""),
3112
3060
  status: Joi.string().allow(""),
3113
- slug: Joi.string().allow(""),
3114
3061
  display_name: Joi.string().allow(""),
3115
- definition: ContentPlatformModel.CustomObjectListItemDefinationSchema(),
3062
+ definition: ContentPlatformModel.CustomObjectListItemDefinitionModel(),
3116
3063
  references: Joi.array().items(Joi.any()),
3117
- fields: Joi.array().items(ContentPlatformModel.CustomObjectFieldSchema()),
3064
+ slug: Joi.string().allow(""),
3065
+ definition_slug: Joi.string().allow(""),
3066
+ fields: Joi.array().items(
3067
+ ContentPlatformModel.CustomObjectFieldDefinition()
3068
+ ),
3118
3069
  });
3119
3070
  }
3120
3071
 
@@ -3139,13 +3090,12 @@ class ContentPlatformModel {
3139
3090
  /** @returns {JobSchema} */
3140
3091
  static JobSchema() {
3141
3092
  return Joi.object({
3142
- _id: Joi.string().allow(""),
3093
+ id: Joi.string().allow(""),
3143
3094
  jobs: Joi.array().items(Joi.string().allow("")),
3144
3095
  finished_jobs: Joi.array().items(Joi.string().allow("")),
3145
3096
  error_jobs: Joi.array().items(Joi.string().allow("")),
3146
3097
  errors_occured: Joi.array().items(Joi.string().allow("")),
3147
3098
  company_id: Joi.string().allow(""),
3148
- creator: Joi.string().allow(""),
3149
3099
  status: Joi.string().allow(""),
3150
3100
  action_type: Joi.string().allow(""),
3151
3101
  entity: Joi.string().allow(""),
@@ -3178,6 +3128,13 @@ class ContentPlatformModel {
3178
3128
  });
3179
3129
  }
3180
3130
 
3131
+ /** @returns {MetafieldTypesSchema} */
3132
+ static MetafieldTypesSchema() {
3133
+ return Joi.object({
3134
+ metafield_types: ContentPlatformModel.CustomFieldTypeSchema(),
3135
+ });
3136
+ }
3137
+
3181
3138
  /** @returns {CustomFieldTypeSchema} */
3182
3139
  static CustomFieldTypeSchema() {
3183
3140
  return Joi.object({
@@ -3199,6 +3156,23 @@ class ContentPlatformModel {
3199
3156
  });
3200
3157
  }
3201
3158
 
3159
+ /** @returns {SupportedValidationsMetaExampleSchema} */
3160
+ static SupportedValidationsMetaExampleSchema() {
3161
+ return Joi.object({
3162
+ name: Joi.string().allow(""),
3163
+ value: Joi.string().allow(""),
3164
+ });
3165
+ }
3166
+
3167
+ /** @returns {SupportedValidationsMetaSchema} */
3168
+ static SupportedValidationsMetaSchema() {
3169
+ return Joi.object({
3170
+ examples: Joi.array().items(
3171
+ ContentPlatformModel.SupportedValidationsMetaExampleSchema()
3172
+ ),
3173
+ });
3174
+ }
3175
+
3202
3176
  /** @returns {SupportedValidationsSchema} */
3203
3177
  static SupportedValidationsSchema() {
3204
3178
  return Joi.object({
@@ -3206,6 +3180,7 @@ class ContentPlatformModel {
3206
3180
  type: Joi.string().allow(""),
3207
3181
  display: Joi.string().allow(""),
3208
3182
  required: Joi.boolean(),
3183
+ meta: ContentPlatformModel.SupportedValidationsMetaSchema(),
3209
3184
  });
3210
3185
  }
3211
3186
 
@@ -3399,14 +3374,13 @@ class ContentPlatformModel {
3399
3374
  supported_validations: Joi.array().items(
3400
3375
  ContentPlatformModel.SupportedValidationsSchema()
3401
3376
  ),
3402
- scope: Joi.array().items(Joi.string().allow("")),
3403
3377
  });
3404
3378
  }
3405
3379
 
3406
3380
  /** @returns {CustomObjectEntry} */
3407
3381
  static CustomObjectEntry() {
3408
3382
  return Joi.object({
3409
- _id: Joi.string().allow(""),
3383
+ id: Joi.string().allow(""),
3410
3384
  name: Joi.string().allow(""),
3411
3385
  type: Joi.string().allow(""),
3412
3386
  updated_at: Joi.string().allow(""),
@@ -3426,7 +3400,16 @@ class ContentPlatformModel {
3426
3400
  /** @returns {CustomObjectEntryFieldSchema} */
3427
3401
  static CustomObjectEntryFieldSchema() {
3428
3402
  return Joi.object({
3429
- definition_id: Joi.string().allow(""),
3403
+ namespace: Joi.string().allow(""),
3404
+ slug: Joi.string().allow(""),
3405
+ });
3406
+ }
3407
+
3408
+ /** @returns {CustomObjectEntryFieldSchemaWithoutID} */
3409
+ static CustomObjectEntryFieldSchemaWithoutID() {
3410
+ return Joi.object({
3411
+ slug: Joi.string().allow(""),
3412
+ value: Joi.any(),
3430
3413
  });
3431
3414
  }
3432
3415
 
@@ -3435,13 +3418,22 @@ class ContentPlatformModel {
3435
3418
  return Joi.object({
3436
3419
  status: Joi.string().allow(""),
3437
3420
  slug: Joi.string().allow(""),
3438
- definition_id: Joi.string().allow(""),
3439
3421
  fields: Joi.array().items(
3440
3422
  ContentPlatformModel.CustomObjectEntryFieldSchema()
3441
3423
  ),
3442
3424
  });
3443
3425
  }
3444
3426
 
3427
+ /** @returns {CustomObjectRequestSchemaWithoutId} */
3428
+ static CustomObjectRequestSchemaWithoutId() {
3429
+ return Joi.object({
3430
+ status: Joi.string().allow(""),
3431
+ fields: Joi.array().items(
3432
+ ContentPlatformModel.CustomObjectEntryFieldSchemaWithoutID()
3433
+ ),
3434
+ });
3435
+ }
3436
+
3445
3437
  /** @returns {CustomObjectBulkSchema} */
3446
3438
  static CustomObjectBulkSchema() {
3447
3439
  return Joi.object({
@@ -3466,6 +3458,358 @@ class ContentPlatformModel {
3466
3458
  });
3467
3459
  }
3468
3460
 
3461
+ /** @returns {TranslateUiLabels} */
3462
+ static TranslateUiLabels() {
3463
+ return Joi.object({
3464
+ _id: Joi.string().allow(""),
3465
+ company_id: Joi.string().allow(""),
3466
+ application_id: Joi.string().allow(""),
3467
+ template_theme_id: Joi.string().allow(""),
3468
+ theme_id: Joi.string().allow(""),
3469
+ locale: Joi.string().allow(""),
3470
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3471
+ type: Joi.string().allow(""),
3472
+ });
3473
+ }
3474
+
3475
+ /** @returns {TranslateUiLabelsCreate} */
3476
+ static TranslateUiLabelsCreate() {
3477
+ return Joi.object({
3478
+ template_theme_id: Joi.string().allow(""),
3479
+ theme_id: Joi.string().allow(""),
3480
+ locale: Joi.string().allow(""),
3481
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3482
+ type: Joi.string().allow(""),
3483
+ });
3484
+ }
3485
+
3486
+ /** @returns {StaticResourceUpdate} */
3487
+ static StaticResourceUpdate() {
3488
+ return Joi.object({
3489
+ template_theme_id: Joi.string().allow(""),
3490
+ theme_id: Joi.string().allow(""),
3491
+ locale: Joi.string().allow(""),
3492
+ resource: Joi.object().pattern(/\S/, Joi.any()),
3493
+ type: Joi.string().allow(""),
3494
+ });
3495
+ }
3496
+
3497
+ /** @returns {TranslateUiLabelsPage} */
3498
+ static TranslateUiLabelsPage() {
3499
+ return Joi.object({
3500
+ items: Joi.array().items(ContentPlatformModel.TranslateUiLabels()),
3501
+ page: ContentPlatformModel.Page(),
3502
+ });
3503
+ }
3504
+
3505
+ /** @returns {Error} */
3506
+ static Error() {
3507
+ return Joi.object({
3508
+ error: Joi.string().allow(""),
3509
+ });
3510
+ }
3511
+
3512
+ /** @returns {Meta} */
3513
+ static Meta() {
3514
+ return Joi.object({
3515
+ created_by: Joi.string().allow(""),
3516
+ modified_by: Joi.string().allow(""),
3517
+ created_on: Joi.string().allow(""),
3518
+ modified_on: Joi.string().allow(""),
3519
+ });
3520
+ }
3521
+
3522
+ /** @returns {CompanyLanguage} */
3523
+ static CompanyLanguage() {
3524
+ return Joi.object({
3525
+ _id: Joi.string().allow(""),
3526
+ company_id: Joi.string().allow("").required(),
3527
+ locale: Joi.string().allow(""),
3528
+ name: Joi.string().allow(""),
3529
+ direction: Joi.string().allow(""),
3530
+ is_default: Joi.boolean(),
3531
+ display_name: Joi.string().allow(""),
3532
+ });
3533
+ }
3534
+
3535
+ /** @returns {CompanyLanguageCreate} */
3536
+ static CompanyLanguageCreate() {
3537
+ return Joi.object({
3538
+ locales: Joi.array().items(Joi.string().allow("")).required(),
3539
+ });
3540
+ }
3541
+
3542
+ /** @returns {CompanyLanguageUpdate} */
3543
+ static CompanyLanguageUpdate() {
3544
+ return Joi.object({
3545
+ is_default: Joi.boolean().required(),
3546
+ });
3547
+ }
3548
+
3549
+ /** @returns {ApplicationLanguage} */
3550
+ static ApplicationLanguage() {
3551
+ return Joi.object({
3552
+ _id: Joi.string().allow(""),
3553
+ company_id: Joi.string().allow("").required(),
3554
+ application_id: Joi.string().allow("").required(),
3555
+ locale: Joi.string().allow("").required(),
3556
+ name: Joi.string().allow("").required(),
3557
+ direction: Joi.string().allow("").required(),
3558
+ is_default: Joi.boolean().required(),
3559
+ published: Joi.boolean().required(),
3560
+ display_name: Joi.string().allow(""),
3561
+ });
3562
+ }
3563
+
3564
+ /** @returns {unPublishApplicationLanguage} */
3565
+ static unPublishApplicationLanguage() {
3566
+ return Joi.object({
3567
+ published: Joi.boolean().required(),
3568
+ });
3569
+ }
3570
+
3571
+ /** @returns {ApplicationLanguageCreate} */
3572
+ static ApplicationLanguageCreate() {
3573
+ return Joi.object({
3574
+ locales: Joi.array().items(Joi.string().allow("")).required(),
3575
+ });
3576
+ }
3577
+
3578
+ /** @returns {ApplicationLanguageUpdate} */
3579
+ static ApplicationLanguageUpdate() {
3580
+ return Joi.object({
3581
+ is_default: Joi.boolean().required(),
3582
+ published: Joi.boolean().required(),
3583
+ });
3584
+ }
3585
+
3586
+ /** @returns {TranslatableResource} */
3587
+ static TranslatableResource() {
3588
+ return Joi.object({
3589
+ _id: Joi.string().allow(""),
3590
+ type: Joi.string().allow("").required(),
3591
+ name: Joi.string().allow("").required(),
3592
+ description: Joi.string().allow("").required(),
3593
+ schema_type: Joi.string().allow("").required(),
3594
+ created_by: Joi.string().allow(""),
3595
+ modified_by: Joi.string().allow(""),
3596
+ created_on: Joi.string().allow(""),
3597
+ modified_on: Joi.string().allow(""),
3598
+ section_id: ContentPlatformModel.TranslatableSection(),
3599
+ });
3600
+ }
3601
+
3602
+ /** @returns {ResourceDefinition} */
3603
+ static ResourceDefinition() {
3604
+ return Joi.object({
3605
+ _id: Joi.string().allow(""),
3606
+ translatable_resource_id: Joi.string().allow("").required(),
3607
+ json_schema: ContentPlatformModel.ResourceJsonSchema(),
3608
+ ui_schema: ContentPlatformModel.ResourceUISchema(),
3609
+ bulk_details: ContentPlatformModel.ResourceBulkDetails(),
3610
+ });
3611
+ }
3612
+
3613
+ /** @returns {ResourceJsonSchema} */
3614
+ static ResourceJsonSchema() {
3615
+ return Joi.object({
3616
+ schema: Joi.string().allow(""),
3617
+ type: ContentPlatformModel.ResourceJsonSchemaType(),
3618
+ }).allow(null);
3619
+ }
3620
+
3621
+ /** @returns {ResourceJsonSchemaType} */
3622
+ static ResourceJsonSchemaType() {
3623
+ return Joi.object({
3624
+ author: ContentPlatformModel.Author(),
3625
+ title: ContentPlatformModel.Title(),
3626
+ feature_image: ContentPlatformModel.FeatureImage(),
3627
+ });
3628
+ }
3629
+
3630
+ /** @returns {ResourceUISchema} */
3631
+ static ResourceUISchema() {
3632
+ return Joi.object({
3633
+ author: ContentPlatformModel.Author(),
3634
+ title: ContentPlatformModel.Title(),
3635
+ feature_image: ContentPlatformModel.FeatureImage(),
3636
+ seo: ContentPlatformModel.Seo(),
3637
+ }).allow(null);
3638
+ }
3639
+
3640
+ /** @returns {ResourceBulkDetails} */
3641
+ static ResourceBulkDetails() {
3642
+ return Joi.object({
3643
+ fields: Joi.array().items(Joi.string().allow("")),
3644
+ }).allow(null);
3645
+ }
3646
+
3647
+ /** @returns {Title} */
3648
+ static Title() {
3649
+ return Joi.object({
3650
+ ui_widget: Joi.string().allow(""),
3651
+ ui_description: Joi.boolean(),
3652
+ });
3653
+ }
3654
+
3655
+ /** @returns {FeatureImage} */
3656
+ static FeatureImage() {
3657
+ return Joi.object({
3658
+ secure_url: Joi.string().allow(""),
3659
+ });
3660
+ }
3661
+
3662
+ /** @returns {Seo} */
3663
+ static Seo() {
3664
+ return Joi.object({
3665
+ title: ContentPlatformModel.Title(),
3666
+ description: Joi.string().allow(""),
3667
+ canonical_url: Joi.string().allow(""),
3668
+ meta_tags: Joi.array().items(ContentPlatformModel.MetaTag()),
3669
+ });
3670
+ }
3671
+
3672
+ /** @returns {MetaTag} */
3673
+ static MetaTag() {
3674
+ return Joi.object({
3675
+ title: Joi.string().allow(""),
3676
+ items: Joi.array().items(ContentPlatformModel.MetaTagItem()),
3677
+ });
3678
+ }
3679
+
3680
+ /** @returns {MetaTagItem} */
3681
+ static MetaTagItem() {
3682
+ return Joi.object({
3683
+ key: Joi.string().allow(""),
3684
+ value: Joi.string().allow(""),
3685
+ });
3686
+ }
3687
+
3688
+ /** @returns {ResourceTranslation} */
3689
+ static ResourceTranslation() {
3690
+ return Joi.object({
3691
+ _id: Joi.string().allow(""),
3692
+ locale: Joi.string().allow(""),
3693
+ value: ContentPlatformModel.TranslationValue(),
3694
+ });
3695
+ }
3696
+
3697
+ /** @returns {TranslationValue} */
3698
+ static TranslationValue() {
3699
+ return Joi.object({
3700
+ name: Joi.string().allow(""),
3701
+ seo: ContentPlatformModel.TranslationSeo(),
3702
+ });
3703
+ }
3704
+
3705
+ /** @returns {TranslationSeo} */
3706
+ static TranslationSeo() {
3707
+ return Joi.object({
3708
+ title: Joi.string().allow(""),
3709
+ breadcrumbs: Joi.array().items(Joi.string().allow("")),
3710
+ meta_tags: Joi.array().items(Joi.string().allow("")),
3711
+ canonical_url: Joi.string().allow(""),
3712
+ description: Joi.string().allow(""),
3713
+ });
3714
+ }
3715
+
3716
+ /** @returns {ResourceTranslationList} */
3717
+ static ResourceTranslationList() {
3718
+ return Joi.object({
3719
+ items: Joi.array().items(
3720
+ ContentPlatformModel.ResourceTranslationCreate()
3721
+ ),
3722
+ });
3723
+ }
3724
+
3725
+ /** @returns {ResourceTranslationCreate} */
3726
+ static ResourceTranslationCreate() {
3727
+ return Joi.object({
3728
+ type: Joi.string().allow(""),
3729
+ resource_id: Joi.string().allow(""),
3730
+ locale: Joi.string().allow(""),
3731
+ value: ContentPlatformModel.TranslationValue(),
3732
+ });
3733
+ }
3734
+
3735
+ /** @returns {ResourceTranslationUpdate} */
3736
+ static ResourceTranslationUpdate() {
3737
+ return Joi.object({
3738
+ value: ContentPlatformModel.TranslationValue(),
3739
+ });
3740
+ }
3741
+
3742
+ /** @returns {TranslatableSection} */
3743
+ static TranslatableSection() {
3744
+ return Joi.object({
3745
+ _id: Joi.string().allow(""),
3746
+ name: Joi.string().allow(""),
3747
+ description: Joi.string().allow(""),
3748
+ created_by: Joi.string().allow(""),
3749
+ modified_by: Joi.string().allow(""),
3750
+ created_on: Joi.string().allow(""),
3751
+ modified_on: Joi.string().allow(""),
3752
+ });
3753
+ }
3754
+
3755
+ /** @returns {Metrics} */
3756
+ static Metrics() {
3757
+ return Joi.object({
3758
+ total: Joi.number(),
3759
+ success: Joi.number(),
3760
+ failed: Joi.number(),
3761
+ });
3762
+ }
3763
+
3764
+ /** @returns {ResourceTranslationUpsertItem} */
3765
+ static ResourceTranslationUpsertItem() {
3766
+ return Joi.object({
3767
+ message: Joi.string().allow(""),
3768
+ data: ContentPlatformModel.ResourceTranslationCreate(),
3769
+ });
3770
+ }
3771
+
3772
+ /** @returns {ResourceTranslationBulkUpsert} */
3773
+ static ResourceTranslationBulkUpsert() {
3774
+ return Joi.object({
3775
+ metrics: ContentPlatformModel.Metrics(),
3776
+ failed_items: Joi.array().items(
3777
+ ContentPlatformModel.ResourceTranslationUpsertItem()
3778
+ ),
3779
+ updated_items: Joi.array().items(
3780
+ ContentPlatformModel.ResourceTranslationUpsertItem()
3781
+ ),
3782
+ });
3783
+ }
3784
+
3785
+ /** @returns {StandardError} */
3786
+ static StandardError() {
3787
+ return Joi.object({
3788
+ message: Joi.string().allow("").required(),
3789
+ });
3790
+ }
3791
+
3792
+ /** @returns {OperationResponseSchema} */
3793
+ static OperationResponseSchema() {
3794
+ return Joi.object({
3795
+ success: Joi.boolean().required(),
3796
+ message: Joi.string().allow(""),
3797
+ });
3798
+ }
3799
+
3800
+ /**
3801
+ * Enum: GenerationEntityType Used By: Content
3802
+ *
3803
+ * @returns {GenerationEntityType}
3804
+ */
3805
+ static GenerationEntityType() {
3806
+ return Joi.string().valid(
3807
+ "title",
3808
+
3809
+ "description"
3810
+ );
3811
+ }
3812
+
3469
3813
  /**
3470
3814
  * Enum: PageType Used By: Content
3471
3815
  *