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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (290) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
  6. package/sdk/application/Cart/CartApplicationClient.js +257 -126
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +250 -36
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  18. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  22. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  24. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  28. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  30. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  31. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  32. package/sdk/application/User/UserApplicationClient.js +9 -57
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  36. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  37. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  41. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  42. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  43. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  44. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  45. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  46. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  47. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
  48. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
  49. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
  50. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
  51. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  52. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
  53. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  55. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  56. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  57. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  58. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  60. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  62. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  64. package/sdk/partner/PartnerClient.d.ts +6 -0
  65. package/sdk/partner/PartnerClient.js +9 -0
  66. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  67. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  68. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  69. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  70. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  71. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  72. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  73. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  74. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  75. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  76. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  77. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  78. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  79. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  80. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  81. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  82. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  83. package/sdk/partner/index.d.ts +3 -0
  84. package/sdk/partner/index.js +6 -0
  85. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  86. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  88. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  90. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  95. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  96. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  97. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  98. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  99. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  100. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  101. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
  103. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  105. package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
  106. package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
  108. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
  111. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
  112. package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
  113. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
  114. package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
  115. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
  116. package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
  117. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  118. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  119. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  120. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  121. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
  122. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  125. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  126. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  127. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
  128. package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
  129. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  130. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
  137. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  138. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  141. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  142. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  143. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
  144. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
  145. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  146. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  147. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
  148. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
  149. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  150. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  151. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  152. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  153. package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
  154. package/sdk/platform/Content/ContentPlatformModel.js +940 -599
  155. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  156. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  157. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  158. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  159. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  160. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  161. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  162. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  163. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  164. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  167. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  168. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  169. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  170. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  171. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  172. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  173. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  174. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  175. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  176. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  177. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  178. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  179. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  180. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  181. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  182. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  183. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  184. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  185. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  186. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  187. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  188. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  189. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  190. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  191. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  192. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  193. package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
  194. package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
  195. package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
  196. package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
  197. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  198. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  199. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  200. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  201. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  203. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  204. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  205. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  206. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  207. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  208. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  209. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
  210. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
  211. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  212. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  213. package/sdk/platform/PlatformClient.d.ts +2 -0
  214. package/sdk/platform/PlatformClient.js +4 -0
  215. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  216. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  220. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  221. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  222. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
  231. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  232. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  233. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  234. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  235. package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
  236. package/sdk/platform/Share/SharePlatformModel.js +5 -43
  237. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
  238. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
  239. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
  240. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
  241. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  242. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  243. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  244. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  245. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  246. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  247. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  248. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  249. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  250. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  251. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  252. package/sdk/platform/User/UserPlatformModel.js +209 -216
  253. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  254. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  255. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  256. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  257. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  258. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  259. package/sdk/platform/index.d.ts +1 -0
  260. package/sdk/platform/index.js +2 -0
  261. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  262. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  263. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  264. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  265. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  266. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  267. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  268. package/sdk/public/Content/ContentPublicClient.js +183 -0
  269. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  270. package/sdk/public/Content/ContentPublicModel.js +47 -1
  271. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  272. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  273. package/sdk/public/PublicClient.d.ts +0 -2
  274. package/sdk/public/PublicClient.js +0 -4
  275. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  276. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  277. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  278. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  279. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  280. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  281. package/sdk/public/index.d.ts +0 -1
  282. package/sdk/public/index.js +0 -2
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  285. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  286. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  287. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  288. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  289. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  290. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -1,9 +1,4 @@
1
1
  export = ContentPlatformModel;
2
- /**
3
- * @typedef ValidationError
4
- * @property {string} message - A brief description of the error encountered.
5
- * @property {string} field - The field in the request that caused the error.
6
- */
7
2
  /**
8
3
  * @typedef GenerateSEOContent
9
4
  * @property {string} [text]
@@ -27,6 +22,7 @@ export = ContentPlatformModel;
27
22
  * @property {string} [_id]
28
23
  * @property {string} [updated_at]
29
24
  * @property {string} [created_at]
25
+ * @property {number} [__v]
30
26
  */
31
27
  /**
32
28
  * @typedef ApplicationLegalFAQ
@@ -41,7 +37,7 @@ export = ContentPlatformModel;
41
37
  * @property {string} [redirect_to]
42
38
  * @property {string} [updated_at]
43
39
  * @property {string} [created_at]
44
- * @property {PathSourceSchema} [__source]
40
+ * @property {number} [__v]
45
41
  */
46
42
  /**
47
43
  * @typedef PathSourceSchema
@@ -54,8 +50,8 @@ export = ContentPlatformModel;
54
50
  */
55
51
  /**
56
52
  * @typedef SeoSchema
57
- * @property {string} [app]
58
53
  * @property {string} [_id]
54
+ * @property {string} [app]
59
55
  * @property {string} [robots_txt]
60
56
  * @property {boolean} [sitemap_enabled]
61
57
  * @property {string} [additional_sitemap]
@@ -64,6 +60,8 @@ export = ContentPlatformModel;
64
60
  * @property {Detail} [details]
65
61
  * @property {string} [created_at]
66
62
  * @property {string} [updated_at]
63
+ * @property {number} [__v]
64
+ * @property {SEOSitemap} [sitemap]
67
65
  */
68
66
  /**
69
67
  * @typedef CustomMetaTag
@@ -84,27 +82,50 @@ export = ContentPlatformModel;
84
82
  */
85
83
  /**
86
84
  * @typedef SEOSchemaMarkupTemplate
87
- * @property {string} [id]
85
+ * @property {string} [_id]
88
86
  * @property {string} [title]
89
87
  * @property {string} [page_type]
90
88
  * @property {string} [schema]
91
89
  * @property {string} [description]
92
90
  * @property {boolean} [active]
91
+ * @property {string} [application]
93
92
  * @property {string} [created_at]
94
93
  * @property {string} [updated_at]
95
- * @property {string} [application]
96
94
  * @property {Object} [target_json]
95
+ * @property {number} [__v]
97
96
  */
98
97
  /**
99
98
  * @typedef SEOSchemaMarkupTemplateRequestBody
100
99
  * @property {string} [title]
101
100
  * @property {string} [page_type]
102
- * @property {string} [schema]
103
101
  * @property {string} [description]
102
+ * @property {string} [schema]
104
103
  * @property {Object} [target_json]
105
104
  * @property {boolean} [active]
106
105
  * @property {string} [created_at]
107
- * @property {string} [updated_at]
106
+ */
107
+ /**
108
+ * @typedef DeletPathMappingSchema
109
+ * @property {string} [message]
110
+ * @property {PathMappingSchema} [data]
111
+ */
112
+ /**
113
+ * @typedef CreatePathMappingSchema
114
+ * @property {string} [message]
115
+ * @property {PathMappingSchema} [data]
116
+ */
117
+ /**
118
+ * @typedef GetAllPathMappingSchema
119
+ * @property {string} [message]
120
+ * @property {GetPathSchema} [data]
121
+ */
122
+ /**
123
+ * @typedef GetPathSchema
124
+ * @property {PathMappingSchema[]} [docs]
125
+ * @property {number} [page]
126
+ * @property {number} [limit]
127
+ * @property {number} [pages]
128
+ * @property {number} [total]
108
129
  */
109
130
  /**
110
131
  * @typedef AnnouncementPageSchema
@@ -145,10 +166,10 @@ export = ContentPlatformModel;
145
166
  * @typedef DefaultSEOSchemaMarkupTemplate
146
167
  * @property {string} [page_type]
147
168
  * @property {string} [schema]
148
- * @property {Object} [target_json]
149
169
  */
150
170
  /**
151
171
  * @typedef ScheduleSchema
172
+ * @property {boolean} [published]
152
173
  * @property {string} [cron]
153
174
  * @property {string} [start]
154
175
  * @property {string} [end]
@@ -161,7 +182,7 @@ export = ContentPlatformModel;
161
182
  * @property {string} [end]
162
183
  */
163
184
  /**
164
- * @typedef BlogGetDetails
185
+ * @typedef BlogGetResponse
165
186
  * @property {BlogSchema[]} [items]
166
187
  * @property {Page} [page]
167
188
  * @property {BlogFilters} [filters]
@@ -205,6 +226,7 @@ export = ContentPlatformModel;
205
226
  * @property {string} [title]
206
227
  * @property {DateMeta} [date_meta]
207
228
  * @property {string} [summary]
229
+ * @property {string} [status]
208
230
  */
209
231
  /**
210
232
  * @typedef SEO
@@ -213,7 +235,7 @@ export = ContentPlatformModel;
213
235
  * @property {string} [title]
214
236
  * @property {SEOMetaItem[]} [meta_tags]
215
237
  * @property {SEOSitemap} [sitemap]
216
- * @property {SEObreadcrumb[]} [breadcrumb]
238
+ * @property {SEObreadcrumb[]} [breadcrumbs]
217
239
  * @property {string} [canonical_url]
218
240
  */
219
241
  /**
@@ -246,7 +268,7 @@ export = ContentPlatformModel;
246
268
  * @property {string} [modified_on]
247
269
  */
248
270
  /**
249
- * @typedef BlogPayload
271
+ * @typedef BlogRequest
250
272
  * @property {string} [application]
251
273
  * @property {Object} [_custom_json]
252
274
  * @property {Author} [author]
@@ -257,6 +279,7 @@ export = ContentPlatformModel;
257
279
  * @property {string} [slug]
258
280
  * @property {string[]} [tags]
259
281
  * @property {string} [title]
282
+ * @property {string} [publish_date]
260
283
  * @property {SEO} [seo]
261
284
  * @property {string} [summary]
262
285
  */
@@ -270,6 +293,10 @@ export = ContentPlatformModel;
270
293
  * @property {string} [message]
271
294
  * @property {AdminAnnouncementSchema} [data]
272
295
  */
296
+ /**
297
+ * @typedef DataLoaderItemsResponseSchema
298
+ * @property {DataLoaderResponseSchema[]} [items]
299
+ */
273
300
  /**
274
301
  * @typedef DataLoaderResponseSchema
275
302
  * @property {string} [application]
@@ -281,11 +308,15 @@ export = ContentPlatformModel;
281
308
  * @property {string} [type]
282
309
  * @property {string} [url]
283
310
  * @property {string} [content]
311
+ * @property {string} [created_at]
312
+ * @property {string} [modified_at]
313
+ * @property {number} [__v]
314
+ * @property {boolean} [is_selected]
284
315
  * @property {DataLoaderSourceSchema} [__source]
285
316
  */
286
317
  /**
287
318
  * @typedef DataLoaderResetResponseSchema
288
- * @property {boolean} [reset]
319
+ * @property {boolean} [resetted]
289
320
  */
290
321
  /**
291
322
  * @typedef LocaleLanguage
@@ -310,13 +341,18 @@ export = ContentPlatformModel;
310
341
  * @property {LocaleLanguage} [_locale_language]
311
342
  * @property {string} [image]
312
343
  * @property {string} [type]
313
- * @property {Action} [action]
314
344
  * @property {boolean} [active]
315
345
  * @property {string} [display]
316
346
  * @property {number} [sort_order]
317
347
  * @property {CronBasedScheduleSchema} [schedule]
318
348
  * @property {NavigationReference[]} [sub_navigation]
319
349
  */
350
+ /**
351
+ * @typedef AssignmentReference
352
+ * @property {string} [platform]
353
+ * @property {string} [orientation]
354
+ * @property {string} [position]
355
+ */
320
356
  /**
321
357
  * @typedef CronBasedScheduleSchema
322
358
  * @property {boolean} [enabled]
@@ -360,26 +396,47 @@ export = ContentPlatformModel;
360
396
  */
361
397
  /**
362
398
  * @typedef DataLoaderSchema
399
+ * @property {string} [_id]
400
+ * @property {string} [url]
401
+ * @property {string} [created_at]
402
+ * @property {string} [modified_at]
403
+ * @property {string} [application]
404
+ * @property {string} [company]
363
405
  * @property {string} [name]
364
406
  * @property {string} [service]
365
407
  * @property {string} [operation_id]
408
+ * @property {boolean} [is_selected]
366
409
  * @property {string} [type]
367
- * @property {string} [url]
368
- * @property {string} [content]
369
410
  * @property {DataLoaderSourceSchema} [__source]
370
- * @property {string} [_id]
371
411
  */
372
412
  /**
373
413
  * @typedef DataLoaderSourceSchema
374
414
  * @property {string} [type]
375
415
  * @property {string} [id]
376
416
  */
417
+ /**
418
+ * @typedef TagSpecSchema
419
+ * @property {string} [name]
420
+ * @property {string} [description]
421
+ */
422
+ /**
423
+ * @typedef ServerSchema
424
+ * @property {string} [url]
425
+ */
426
+ /**
427
+ * @typedef DataLoadersApiSpecSchema
428
+ * @property {Object} [info]
429
+ * @property {ServerSchema[]} [servers]
430
+ * @property {TagSpecSchema[]} [tags]
431
+ * @property {string} [openapi]
432
+ * @property {Object} [paths]
433
+ */
377
434
  /**
378
435
  * @typedef DataLoadersSchema
379
436
  * @property {DataLoaderSchema[]} [items]
380
437
  */
381
438
  /**
382
- * @typedef TagDeleteSuccessDetails
439
+ * @typedef TagDeleteSuccessResponse
383
440
  * @property {boolean} [success]
384
441
  */
385
442
  /**
@@ -388,7 +445,6 @@ export = ContentPlatformModel;
388
445
  * @property {number} [status]
389
446
  * @property {string} [code]
390
447
  * @property {string} [exception]
391
- * @property {string} [info]
392
448
  * @property {string} [request_id]
393
449
  * @property {string} [stack_trace]
394
450
  * @property {Object} [meta]
@@ -408,6 +464,7 @@ export = ContentPlatformModel;
408
464
  * @property {string} [application]
409
465
  * @property {string} [icon_url]
410
466
  * @property {Object} [_custom_json]
467
+ * @property {number} [__v]
411
468
  */
412
469
  /**
413
470
  * @typedef ChildrenSchema
@@ -424,15 +481,15 @@ export = ContentPlatformModel;
424
481
  */
425
482
  /**
426
483
  * @typedef FAQCategorySchema
427
- * @property {number} [index]
484
+ * @property {string} [_id]
485
+ * @property {string} [application]
428
486
  * @property {string} [title]
429
487
  * @property {string} [description]
430
- * @property {ChildrenSchema[]} [children]
431
- * @property {string} [_id]
488
+ * @property {number} [index]
432
489
  * @property {string} [slug]
433
- * @property {string} [application]
490
+ * @property {ChildrenSchema[]} [children]
434
491
  * @property {string} [icon_url]
435
- * @property {Object} [_custom_json]
492
+ * @property {number} [__v]
436
493
  */
437
494
  /**
438
495
  * @typedef FaqSchema
@@ -442,6 +499,7 @@ export = ContentPlatformModel;
442
499
  * @property {string} [question]
443
500
  * @property {string} [answer]
444
501
  * @property {string[]} [tags]
502
+ * @property {number} [__v]
445
503
  */
446
504
  /**
447
505
  * @typedef FAQ
@@ -490,16 +548,16 @@ export = ContentPlatformModel;
490
548
  * @property {number} [current] - The current page number.
491
549
  * @property {string} type - The type of the page, such as 'PageType'.
492
550
  * @property {number} [size] - The number of items per page.
551
+ * @property {number} [total] - Total number of items.
493
552
  */
494
553
  /**
495
- * @typedef LandingPageGetDetails
554
+ * @typedef LandingPageGetResponse
496
555
  * @property {LandingPageSchema[]} [items]
497
556
  * @property {Page} [page]
498
557
  */
499
558
  /**
500
559
  * @typedef LandingPageSchema
501
560
  * @property {string} [slug]
502
- * @property {Action} [action]
503
561
  * @property {string[]} [platform]
504
562
  * @property {CreatedBySchema} [created_by]
505
563
  * @property {DateMeta} [date_meta]
@@ -507,13 +565,14 @@ export = ContentPlatformModel;
507
565
  * @property {string} [application]
508
566
  * @property {boolean} [archived]
509
567
  * @property {Object} [_custom_json]
568
+ * @property {number} [__v]
510
569
  */
511
570
  /**
512
- * @typedef DefaultNavigationDetails
571
+ * @typedef DefaultNavigationResponse
513
572
  * @property {NavigationSchema[]} [items]
514
573
  */
515
574
  /**
516
- * @typedef NavigationGetDetails
575
+ * @typedef NavigationGetResponse
517
576
  * @property {NavigationSchema[]} [items]
518
577
  * @property {Page} [page]
519
578
  */
@@ -535,17 +594,26 @@ export = ContentPlatformModel;
535
594
  * @property {Orientation} [orientation]
536
595
  * @property {number} [version]
537
596
  * @property {NavigationReference[]} [navigation]
597
+ * @property {AssignmentReference[]} [assignments]
598
+ * @property {number} [__v]
538
599
  */
539
600
  /**
540
- * @typedef NavigationPayload
601
+ * @typedef NavigationRequest
541
602
  * @property {string} [name]
542
603
  * @property {string} [slug]
543
604
  * @property {string[]} [platform]
544
605
  * @property {Orientation} [orientation]
606
+ * @property {NavigationAssignment[]} [assignments]
545
607
  * @property {NavigationReference[]} [navigation]
546
608
  */
547
609
  /**
548
- * @typedef PageGetDetails
610
+ * @typedef NavigationAssignment
611
+ * @property {string} [platform]
612
+ * @property {string} [orientation]
613
+ * @property {string} [position]
614
+ */
615
+ /**
616
+ * @typedef PageGetResponse
549
617
  * @property {PageSchema[]} [items]
550
618
  * @property {Page} [page]
551
619
  */
@@ -565,44 +633,65 @@ export = ContentPlatformModel;
565
633
  * @property {PageSpecParam[]} [params]
566
634
  * @property {PageSpecParam[]} [query]
567
635
  */
636
+ /**
637
+ * @typedef PageResponseError
638
+ * @property {string} [errors]
639
+ */
568
640
  /**
569
641
  * @typedef PageSchema
570
642
  * @property {string} [_id]
571
643
  * @property {string} [application]
572
- * @property {string[]} [component_ids] - Components can be used to store
573
- * multiple components
574
- * @property {Object[]} [content]
644
+ * @property {string} [platform]
645
+ * @property {string} [title]
646
+ * @property {string} [slug]
647
+ * @property {string} [type]
648
+ * @property {string[]} [tags]
575
649
  * @property {string} [content_path]
650
+ * @property {string} [orientation]
651
+ * @property {string} [description]
652
+ * @property {boolean} [published]
576
653
  * @property {CreatedBySchema} [created_by]
577
654
  * @property {DateMeta} [date_meta]
578
- * @property {string} [description]
579
655
  * @property {Asset} [feature_image]
580
- * @property {Object[]} [page_meta]
581
656
  * @property {ScheduleSchema} [_schedule]
582
- * @property {Object} [_custom_json]
583
- * @property {string} [orientation]
584
- * @property {string} [platform]
585
- * @property {boolean} [published]
586
- * @property {string} [slug]
587
- * @property {string[]} [tags]
588
- * @property {string} [title]
589
- * @property {string} [type]
657
+ * @property {PageMeta[]} [page_meta]
590
658
  * @property {SEO} [seo]
591
- * @property {Object} [visibility]
659
+ * @property {string[]} [component_ids]
592
660
  * @property {boolean} [archived]
661
+ * @property {number} [__v]
662
+ * @property {PageContent[]} [content]
663
+ * @property {SanitizedContent[]} [sanitized_content]
664
+ */
665
+ /**
666
+ * @typedef SanitizedContent
667
+ * @property {string} [type]
668
+ * @property {string} [value]
669
+ */
670
+ /**
671
+ * @typedef PageMeta
672
+ * @property {string} [key]
673
+ */
674
+ /**
675
+ * @typedef PageContent
676
+ * @property {string} [type]
677
+ * @property {string} [value]
593
678
  */
594
679
  /**
595
680
  * @typedef CreatedBySchema
596
681
  * @property {string} [id]
597
682
  */
598
683
  /**
599
- * @typedef PagePayload
684
+ * @typedef PageRequestVisibility
685
+ * @property {boolean} [test]
686
+ */
687
+ /**
688
+ * @typedef PageRequest
600
689
  * @property {CronSchedule} [_schedule]
601
690
  * @property {string} [application]
602
691
  * @property {Author} [author]
603
692
  * @property {Object} [_custom_json]
604
693
  * @property {string} [orientation]
605
- * @property {Object[]} [content]
694
+ * @property {PageContent[]} [content]
606
695
  * @property {Asset} [feature_image]
607
696
  * @property {boolean} [published]
608
697
  * @property {string} [reading_time]
@@ -610,6 +699,10 @@ export = ContentPlatformModel;
610
699
  * @property {string[]} [tags]
611
700
  * @property {SEO} [seo]
612
701
  * @property {string} [title]
702
+ * @property {string} [platform]
703
+ * @property {string} [type]
704
+ * @property {string} [description]
705
+ * @property {Object} [visibility] - Visibility of Page.
613
706
  */
614
707
  /**
615
708
  * @typedef CronSchedule
@@ -617,17 +710,38 @@ export = ContentPlatformModel;
617
710
  * @property {string} [start]
618
711
  * @property {string} [end]
619
712
  * @property {number} [duration]
713
+ * @property {NextSchedule[]} [next_schedule]
620
714
  */
621
715
  /**
622
- * @typedef PagePublishPayload
716
+ * @typedef PagePublishRequest
623
717
  * @property {boolean} [publish]
624
718
  */
625
719
  /**
626
720
  * @typedef PageMetaSchema
627
- * @property {NavigationSchema[]} [system_pages]
628
- * @property {PageSchema[]} [custom_pages]
721
+ * @property {SystemPages[]} [system_pages]
722
+ * @property {CustomePages[]} [custom_pages]
629
723
  * @property {string} [application_id]
630
724
  */
725
+ /**
726
+ * @typedef CustomePages
727
+ * @property {string} [display]
728
+ * @property {string} [slug]
729
+ */
730
+ /**
731
+ * @typedef SystemPagesActionPage
732
+ * @property {string} [type]
733
+ */
734
+ /**
735
+ * @typedef SystemPagesAction
736
+ * @property {SystemPagesActionPage} [page]
737
+ * @property {string} [type]
738
+ */
739
+ /**
740
+ * @typedef SystemPages
741
+ * @property {string} [display]
742
+ * @property {SystemPagesAction} [action]
743
+ * @property {string} [page_type]
744
+ */
631
745
  /**
632
746
  * @typedef Support
633
747
  * @property {boolean} [created]
@@ -668,6 +782,8 @@ export = ContentPlatformModel;
668
782
  * @typedef TagsSchema
669
783
  * @property {string} [application]
670
784
  * @property {string} [_id]
785
+ * @property {string} [company]
786
+ * @property {number} [__v]
671
787
  * @property {TagSchema[]} [tags]
672
788
  */
673
789
  /**
@@ -680,6 +796,7 @@ export = ContentPlatformModel;
680
796
  * @property {string} [position]
681
797
  * @property {Object} [attributes]
682
798
  * @property {string} [content]
799
+ * @property {Object[]} [compatible_engines]
683
800
  * @property {Object[]} [pages]
684
801
  * @property {TagSourceSchema} [__source]
685
802
  */
@@ -700,129 +817,140 @@ export = ContentPlatformModel;
700
817
  */
701
818
  /**
702
819
  * @typedef FieldValidations
703
- * @property {string} [name] - Name of validation
704
- * @property {string} [type] - Type of validation
705
- * @property {Object} [value]
820
+ * @property {string} [name]
821
+ * @property {string} [type]
822
+ */
823
+ /**
824
+ * @typedef ApplicationFieldDefinitionSchema
825
+ * @property {string} [_id]
826
+ * @property {string} [creator]
827
+ * @property {string} [resource]
828
+ * @property {string} [name]
829
+ * @property {string} [namespace]
830
+ * @property {string} [key]
831
+ * @property {string} [description]
832
+ * @property {string} [type]
833
+ * @property {boolean} [multi_value]
834
+ * @property {FieldValidations[]} [validations]
835
+ * @property {string} [company_id]
836
+ * @property {string} [created_by]
837
+ * @property {string} [updated_by]
838
+ * @property {boolean} [required]
839
+ * @property {boolean} [is_deleted]
840
+ * @property {string} [created_at]
841
+ * @property {string} [updated_at]
842
+ * @property {string} [type_name]
843
+ * @property {number} [invalid_fields_count]
844
+ * @property {string} [application_id]
706
845
  */
707
846
  /**
708
847
  * @typedef FieldDefinitionSchema
709
- * @property {string} [id] - Unique system generated id
710
- * @property {string} [resource] - Resource type to which custom field belongs
711
- * @property {string} [name] - Name of custom field
712
- * @property {string} [namespace] - Namespace of custom field
713
- * @property {string} [slug] - Slug of custom field
714
- * @property {string} [description] - Description of custom field definition
715
- * @property {string} [type] - Data type of custom field
716
- * @property {boolean} [multi_value] - Flag to denote whether custom field is
717
- * multivalued or not
718
- * @property {FieldValidations[]} [validations] - List of validations applied
719
- * @property {string} [company_id] - Id of company
720
- * @property {boolean} [required] - Whether the custom field is required or not
721
- * @property {boolean} [is_deleted] - Whether the custom field is deleted or not
722
- * @property {string} [type_name] - Type of type field
723
- * @property {number} [invalid_fields_count] - Count of invalid fields after validation
848
+ * @property {string} [_id]
849
+ * @property {string} [creator]
850
+ * @property {string} [resource]
851
+ * @property {string} [name]
852
+ * @property {string} [namespace]
853
+ * @property {string} [key]
854
+ * @property {string} [description]
855
+ * @property {string} [type]
856
+ * @property {boolean} [multi_value]
857
+ * @property {FieldValidations[]} [validations]
858
+ * @property {string} [company_id]
859
+ * @property {string} [created_by]
860
+ * @property {string} [updated_by]
861
+ * @property {boolean} [required]
862
+ * @property {boolean} [is_deleted]
863
+ * @property {string} [created_at]
864
+ * @property {string} [updated_at]
865
+ * @property {string} [type_name]
866
+ * @property {number} [invalid_fields_count]
867
+ */
868
+ /**
869
+ * @typedef ApplicationCustomFieldDefinitionsSchema
870
+ * @property {ApplicationFieldDefinitionSchema[]} [items]
871
+ * @property {Page} [page]
724
872
  */
725
873
  /**
726
874
  * @typedef CustomFieldDefinitionsSchema
727
- * @property {FieldDefinitionSchema[]} [items] - List of custom field definitions
875
+ * @property {FieldDefinitionSchema[]} [items]
728
876
  * @property {Page} [page]
729
877
  */
730
878
  /**
731
879
  * @typedef CustomFieldDefinitionRequestSchema
732
- * @property {string} [type] - Data type of custom field
733
- * @property {string} [slug] - Slug of custom field definition
734
- * @property {string} [namespace] - Namespace of custom field definition
735
- * @property {boolean} [multi_value] - Flag to denote whether custom field is
736
- * multi valued or not
737
- * @property {string} [name] - Name of custom field definition
738
- * @property {string} [description] - Description of a custom field definition
739
- * @property {FieldValidations[]} [validations] - Validations for a custom field
880
+ * @property {string} [resource]
881
+ * @property {string} [type]
882
+ * @property {string} [key]
883
+ * @property {string} [namespace]
884
+ * @property {boolean} [multi_value]
885
+ * @property {string} [name]
886
+ * @property {string} [description]
887
+ * @property {string} [creator]
888
+ * @property {FieldValidations[]} [validations]
740
889
  */
741
890
  /**
742
891
  * @typedef CustomObjectCustomFieldDefinitions
743
- * @property {string} [id] - Unique identifer for a custom field
744
- * @property {string} [type] - Data type of custom field
745
- * @property {string} [description] - Description of custom field
746
- * @property {string} [name] - Name of custom field
747
- * @property {boolean} [multi_value] - Flag to denote if cusom field is multi
748
- * valued or not
749
- * @property {boolean} [required] - Whether the field is required or not
750
- * @property {string} [slug] - Slug of custom field definition
751
- * @property {FieldValidations[]} [validations] - Validations added against the
752
- * custom field
892
+ * @property {string} [_id]
893
+ * @property {string} type
894
+ * @property {string} [description]
895
+ * @property {string} [name]
896
+ * @property {boolean} [multi_value]
897
+ * @property {boolean} [required]
898
+ * @property {string} [key]
899
+ * @property {FieldValidations[]} [validations]
753
900
  * @property {string} [action]
754
901
  */
755
902
  /**
756
903
  * @typedef CustomObjectDefinitionUpdateRequestSchema
757
- * @property {string} [description] - Description of custom object definiton
758
- * @property {string} [name] - Name of custom object definition
759
- * @property {string} [display_name_key] - Custom field slug which is used as a
760
- * display key in
761
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
904
+ * @property {string} [type]
905
+ * @property {string} [description]
906
+ * @property {string} [name]
907
+ * @property {string} [display_name_key]
908
+ * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions]
762
909
  */
763
910
  /**
764
911
  * @typedef CustomFieldDefinitionDetailResSchema
765
- * @property {string} [resource] - Resource to which custom field is associated
766
- * @property {string} [name] - Name of custom field
767
- * @property {string} [namespace] - Namespace of custom field
768
- * @property {string} [slug] - Slug of custom field
769
- * @property {string} [description] - Description regarding custom field
770
- * @property {string} [type] - Data type of custom field
771
- * @property {boolean} [multi_value] - Flag to denote whether custom field is
772
- * multi valued or not
773
- * @property {string} [company_id] - Company Identifer
774
- * @property {string} [application_id] - Sales channel identifier
775
- * @property {boolean} [required] - Whether the customfield is required or not
776
- * @property {boolean} [is_deleted] - Is custom field deleted
777
- * @property {string} [id] - Unique system generated id
778
- * @property {Object[]} [validations]
779
- * @property {string} [created_at] - Date time at which field was created
780
- * @property {string} [updated_at] - Date time at for a field's last modification
781
- */
782
- /**
783
- * @typedef MetaFieldDefinitionDetailResSchema
784
- * @property {string} [resource] - Resource to which meta field is associated
785
- * @property {string} [name] - Name of meta field
786
- * @property {string} [namespace] - Namespace of meta field
787
- * @property {string} [slug] - Slug of meta field
788
- * @property {string} [description] - Description regarding meta field
789
- * @property {string} [type] - Data type of meta field
790
- * @property {boolean} [multi_value] - Flag to denote whether meta field is
791
- * multi valued or not
792
- * @property {string} [company_id] - Company Identifer
793
- * @property {string} [application_id] - Sales channel identifier
794
- * @property {boolean} [required] - Whether the field is required or not
795
- * @property {boolean} [is_deleted] - Is meta field deleted
796
- * @property {string} [id] - Unique system generated id
912
+ * @property {string} [creator]
913
+ * @property {string} [resource]
914
+ * @property {string} [name]
915
+ * @property {string} [namespace]
916
+ * @property {string} [key]
917
+ * @property {string} [description]
918
+ * @property {string} [type]
919
+ * @property {boolean} [multi_value]
920
+ * @property {string} [company_id]
921
+ * @property {string} [application_id]
922
+ * @property {string} [created_by]
923
+ * @property {string} [updated_by]
924
+ * @property {boolean} [required]
925
+ * @property {boolean} [is_deleted]
926
+ * @property {string} [_id]
797
927
  * @property {Object[]} [validations]
798
- * @property {string} [created_at] - Date time at which field was created
799
- * @property {string} [updated_at] - Date time at for a field's last modification
928
+ * @property {string} [created_at]
929
+ * @property {string} [updated_at]
800
930
  */
801
931
  /**
802
932
  * @typedef CustomDataDeleteSchema
803
- * @property {boolean} [success] - Denotes the success of the delete operation
804
- * @property {string} [message] - Denotes the message of delete operation
805
- */
806
- /**
807
- * @typedef CustomFieldValue
808
- * @property {Object} [value]
933
+ * @property {boolean} [success]
934
+ * @property {string} [message]
809
935
  */
810
936
  /**
811
937
  * @typedef CustomFieldSchema
812
- * @property {string} [id] - Unique system generated id
813
- * @property {string} [namespace] - Namespace of custom field definition
814
- * @property {string} [slug] - Slug of custom field definition
815
- * @property {string} [resource] - The resource for which custom field is being created
816
- * @property {CustomFieldValue[]} [value]
817
- * @property {string} [resource_slug] - Unique identifier of the resource
818
- * @property {string} [type] - Data type of custom field
819
- * @property {boolean} [multi_value] - Whether custom field is multi valued
820
- * @property {string} [company_id] - Identifer for a company
938
+ * @property {string} [_id]
939
+ * @property {string} [namespace]
940
+ * @property {string} [key]
941
+ * @property {string} [resource]
942
+ * @property {string} [creator]
943
+ * @property {string} [resource_id]
944
+ * @property {string} type
945
+ * @property {boolean} [multi_value]
946
+ * @property {string} [company_id]
947
+ * @property {string} [definition_id]
821
948
  * @property {boolean} [has_invalid_values]
822
949
  * @property {Object[]} [invalid_value_errors]
823
- * @property {boolean} [is_deleted] - Indicates whether custom field is deleted
824
- * @property {string} [created_at] - Time at which customer field was created
825
- * @property {string} [updated_at] - Time at which custom field was updated
950
+ * @property {string} [created_by]
951
+ * @property {boolean} [is_deleted]
952
+ * @property {string} [created_at]
953
+ * @property {string} [updated_at]
826
954
  */
827
955
  /**
828
956
  * @typedef CustomFieldsResponseSchema
@@ -838,138 +966,180 @@ export = ContentPlatformModel;
838
966
  * @typedef CustomFieldsResponseByResourceIdSchema
839
967
  * @property {CustomFieldSchema[]} [items]
840
968
  */
841
- /**
842
- * @typedef CustomField
843
- * @property {Object[]} [value]
844
- * @property {string} [namespace] - This is the namespace to which custom field belongs
845
- * @property {string} [slug] - This is the slug of custom field used while
846
- * creating a custom field definition
847
- */
848
969
  /**
849
970
  * @typedef CustomFieldRequestSchema
850
- * @property {CustomField[]} [fields]
971
+ * @property {Object[]} [fields]
851
972
  */
852
973
  /**
853
974
  * @typedef CustomObjectSchema
854
- * @property {string} [id] - Unique system generated id
855
- * @property {string} [company_id] - Identifer for a company
856
- * @property {string} [application_id] - Identifer for a sales channel
857
- * @property {string} [status] - Status of custom object
858
- * @property {string} [type] - Slug of custom object definition
859
- * @property {string} [definition_slug] - Slug for custom object definition
860
- * @property {string} [display_name] - Value of custom field used for displaying
861
- * custom object
862
- * @property {CustomFieldSchema[]} [fields] - Fields associated to the custom object
975
+ * @property {string} [_id]
976
+ * @property {string} [name]
977
+ * @property {string} [creator]
978
+ * @property {string} [company_id]
979
+ * @property {string} [created_by]
980
+ * @property {string} [updated_by]
981
+ * @property {string} [status]
982
+ * @property {string} [slug]
983
+ * @property {string} [type]
984
+ * @property {string} [display_name]
985
+ * @property {string} [definition_id]
986
+ * @property {boolean} [is_deleted]
987
+ * @property {string} [created_at]
988
+ * @property {string} [updated_at]
989
+ * @property {CustomFieldSchema[]} [fields]
990
+ */
991
+ /**
992
+ * @typedef CustomObjectApplicationSchema
993
+ * @property {string} [_id]
994
+ * @property {string} [name]
995
+ * @property {string} [creator]
996
+ * @property {string} [company_id]
997
+ * @property {string} [application_id]
998
+ * @property {string} [created_by]
999
+ * @property {string} [updated_by]
1000
+ * @property {string} [status]
1001
+ * @property {string} [slug]
1002
+ * @property {string} [type]
1003
+ * @property {string} [display_name]
1004
+ * @property {string} [definition_id]
1005
+ * @property {boolean} [is_deleted]
1006
+ * @property {string} [created_at]
1007
+ * @property {string} [updated_at]
1008
+ * @property {CustomFieldSchema[]} [fields]
863
1009
  */
864
1010
  /**
865
1011
  * @typedef CustomObjectDefinitionRequestSchema
866
- * @property {string} [type] - Namespace/Slug of Custom object definition
867
- * @property {string} [definition_slug] - Unique slug for a custom object definition
868
- * @property {string} [description] - Description of custom object definition
869
- * @property {string} [name] - Name of custom object
870
- * @property {string} [display_name_key] - Denotes which custom field to be used
871
- * for displaying custom object
872
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions] - List
873
- * of custom field definitions belonging to this custom object definition
874
- */
875
- /**
876
- * @typedef CustomObjectDefinitionSlugSchema
877
- * @property {string} [id] - Unique system generated custom object definition id
878
- * @property {string} [name] - Display name of custom object definition
879
- * @property {string} [type] - Type of custom object definiton
880
- * @property {string} [definition_slug] - Slug of custom object definiton
881
- * @property {string} [display_name_key] - Display name of custom object definition
882
- * @property {string} [description] - Description of custom object definition
883
- * @property {CustomFieldDefinitionDetailResSchema[]} [field_definitions] -
884
- * Custom fields inside custom objects
1012
+ * @property {string} [type]
1013
+ * @property {string} [description]
1014
+ * @property {string} [name]
1015
+ * @property {string} [display_name_key]
1016
+ * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
1017
+ */
1018
+ /**
1019
+ * @typedef CustomObjectCustomFieldDefinitionResSchema
1020
+ * @property {string} [creator]
1021
+ * @property {string} [resource]
1022
+ * @property {string} [name]
1023
+ * @property {string} [namespace]
1024
+ * @property {string} [key]
1025
+ * @property {string} [description]
1026
+ * @property {string} type
1027
+ * @property {boolean} [multi_value]
1028
+ * @property {FieldValidations[]} [validations]
1029
+ * @property {string} [company_id]
1030
+ * @property {string} [created_by]
1031
+ * @property {string} [metaobject_definition_id]
1032
+ * @property {boolean} [required]
1033
+ * @property {boolean} [is_deleted]
1034
+ * @property {string} [_id]
1035
+ * @property {string} [created_at]
1036
+ * @property {string} [updated_at]
1037
+ * @property {string} [application_id]
1038
+ */
1039
+ /**
1040
+ * @typedef CustomObjectDefinitionSchema
1041
+ * @property {string} [_id]
1042
+ * @property {string} [name]
1043
+ * @property {string} [type]
1044
+ * @property {string} [display_name_key]
1045
+ * @property {string} [description]
1046
+ * @property {string} [creator]
1047
+ * @property {string} [created_by]
1048
+ * @property {string} [updated_by]
1049
+ * @property {string} [application_id]
1050
+ * @property {string} [company_id]
1051
+ * @property {string} [created_at]
1052
+ * @property {string} [updated_at]
1053
+ * @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
885
1054
  */
886
1055
  /**
887
1056
  * @typedef CustomObjectDefinitionDeleteResponseSchema
888
- * @property {boolean} [success] - Success status of delete custom object definition.
889
- * @property {string} [message] - Response message when custom object definition
890
- * is deleted.
1057
+ * @property {boolean} [success]
1058
+ * @property {string} [message]
891
1059
  */
892
1060
  /**
893
- * @typedef CustomObjectEntryBulkUploadDetails
894
- * @property {string} [url] - Signed url of csv
895
- * @property {number} [total_records] - Total no of records in csv file
1061
+ * @typedef CustomObjectEntryBulkUploadResponse
1062
+ * @property {string} [message]
1063
+ * @property {string} [task_id]
896
1064
  */
897
1065
  /**
898
- * @typedef CustomObjectListItemDefinitionModel
899
- * @property {string} [id] - Unique system generated id
900
- * @property {string} [name] - Name of custom object
901
- * @property {string} [type] - Type of custom object entry
1066
+ * @typedef CustomObjectListItemDefinationSchema
1067
+ * @property {string} [_id]
1068
+ * @property {string} [name]
1069
+ * @property {string} [type]
1070
+ * @property {string} [display_name_key]
902
1071
  */
903
1072
  /**
904
1073
  * @typedef CustomObjectListItemSchema
905
- * @property {string} [id] - Unique system generated id
906
- * @property {string} [status] - Status of custom object
907
- * @property {string} [created_at] - Creation time of custom object document
908
- * @property {string} [updated_at] - Updation time of custom object document
909
- * @property {string} [display_name] - Display name of custom object
910
- * @property {CustomObjectListItemDefinitionModel} [definition]
911
- * @property {number} [references] - References of the custom object entry
1074
+ * @property {string} [_id]
1075
+ * @property {string} [definition_id]
1076
+ * @property {string} [status]
1077
+ * @property {string} [slug]
1078
+ * @property {string} [updated_at]
1079
+ * @property {string} [display_name]
1080
+ * @property {CustomObjectListItemDefinationSchema} [definition]
1081
+ * @property {number} [references]
912
1082
  */
913
1083
  /**
914
1084
  * @typedef CustomObjectsSchema
915
- * @property {CustomObjectListItemSchema[]} [items] - List of paginated custom
916
- * object entries
1085
+ * @property {CustomObjectListItemSchema[]} [items]
917
1086
  * @property {Page} [page]
918
1087
  */
919
1088
  /**
920
- * @typedef CustomObjectFieldDefinition
921
- * @property {string} [id] - Unique system generate id
922
- * @property {string} [slug] - Slug of custom field definition
923
- * @property {string} [namespace] - Namespace of custom field definition
924
- * @property {Object[]} [value] - Value of custom field
925
- * @property {string} [type] - Data type of the custom field
1089
+ * @typedef CustomObjectFieldSchema
1090
+ * @property {string} [_id]
1091
+ * @property {string} [key]
1092
+ * @property {string} [type]
1093
+ * @property {string} [definition_id]
1094
+ */
1095
+ /**
1096
+ * @typedef MetafieldTypesSchema
1097
+ * @property {CustomFieldTypeSchema} [metafield_types]
926
1098
  */
927
1099
  /**
928
- * @typedef CustomObjectBySlugSchema
929
- * @property {string} [id] - Unique system generated identifer for a Custom Object
930
- * @property {string} [status] - Status of Custom Object
931
- * @property {string} [display_name] - Display name for the Custom Object
932
- * @property {CustomObjectListItemDefinitionModel} [definition]
933
- * @property {Object[]} [references] - Places where the custom object has been
934
- * used as a custom field
935
- * @property {string} [slug] - Slug of custom object entry
936
- * @property {string} [definition_slug] - Slug of custom object definition
937
- * @property {CustomObjectFieldDefinition[]} [fields] - List of custom fields
938
- * inside the custom object
1100
+ * @typedef CustomObjectByIdSchema
1101
+ * @property {string} [_id]
1102
+ * @property {string} [status]
1103
+ * @property {string} [slug]
1104
+ * @property {string} [display_name]
1105
+ * @property {CustomObjectListItemDefinationSchema} [definition]
1106
+ * @property {Object[]} [references]
1107
+ * @property {CustomObjectFieldSchema[]} [fields]
939
1108
  */
940
1109
  /**
941
1110
  * @typedef CustomObjectBulkEntryInitiateDownload
942
- * @property {string} [message] - Message for the user
943
- * @property {string} [task_id] - Identifer for a task
1111
+ * @property {string} [message]
1112
+ * @property {string} [task_id]
944
1113
  */
945
1114
  /**
946
1115
  * @typedef CustomObjectMetaSchema
947
- * @property {number} [mo_total_count] - Total number of entries in the bulk entry
948
- * @property {number} [mo_success_count] - Number of entries which were successful
949
- * @property {number} [mo_error_count] - Number of entries which were failed
950
- * @property {string} [mo_defintion_type] - Type of object
1116
+ * @property {number} [mo_total_count]
1117
+ * @property {number} [mo_success_count]
1118
+ * @property {number} [mo_error_count]
1119
+ * @property {string} [mo_defintion_type]
951
1120
  */
952
1121
  /**
953
1122
  * @typedef JobSchema
954
- * @property {string} [id] - Unique system generated id
955
- * @property {string[]} [jobs] - List of total jobs
956
- * @property {string[]} [finished_jobs] - List of finished jobs
957
- * @property {string[]} [error_jobs] - List of jobs which resulted in an error
958
- * @property {string[]} [errors_occured] - List of errors occurred in the job
959
- * @property {string} [company_id] - Company Identifer
960
- * @property {string} [status] - Status of job
961
- * @property {string} [action_type] - Type of job
962
- * @property {string} [entity] - Entity against which job is running
963
- * @property {string} [error_url] - URL which contains the file with errors
964
- * @property {number} [finished_count] - Number of items successfully finished
965
- * @property {number} [error_count] - Number of items in error
966
- * @property {number} [success_count] - Number of successful items
967
- * @property {number} [total_jobs] - Total number of jobs
1123
+ * @property {string} [_id]
1124
+ * @property {string[]} [jobs]
1125
+ * @property {string[]} [finished_jobs]
1126
+ * @property {string[]} [error_jobs]
1127
+ * @property {string[]} [errors_occured]
1128
+ * @property {string} [company_id]
1129
+ * @property {string} [creator]
1130
+ * @property {string} [status]
1131
+ * @property {string} [action_type]
1132
+ * @property {string} [entity]
1133
+ * @property {string} [error_url]
1134
+ * @property {number} [finished_count]
1135
+ * @property {number} [error_count]
1136
+ * @property {number} [success_count]
1137
+ * @property {number} [total_jobs]
968
1138
  * @property {CustomObjectMetaSchema} [meta]
969
- * @property {string} [created_by] - Source from where the bulk job is created
970
- * @property {string} [created_at] - Date/Time when the job was created
971
- * @property {string} [updated_at] - Date/Time when the job was updated
972
- * @property {string} [application_id] - Sales Channel Identifier
1139
+ * @property {string} [created_by]
1140
+ * @property {string} [created_at]
1141
+ * @property {string} [updated_at]
1142
+ * @property {string} [application_id]
973
1143
  */
974
1144
  /**
975
1145
  * @typedef CustomFieldBulkEntry
@@ -981,10 +1151,6 @@ export = ContentPlatformModel;
981
1151
  * @property {JobSchema[]} [items]
982
1152
  * @property {Page} [page]
983
1153
  */
984
- /**
985
- * @typedef MetafieldTypesSchema
986
- * @property {CustomFieldTypeSchema} [metafield_types]
987
- */
988
1154
  /**
989
1155
  * @typedef CustomFieldTypeSchema
990
1156
  * @property {StringSingleLine} [string_single_line]
@@ -1004,165 +1170,139 @@ export = ContentPlatformModel;
1004
1170
  * @property {Duration} [duration]
1005
1171
  */
1006
1172
  /**
1007
- * @typedef SupportedValidationsMetaExampleSchema
1008
- * @property {string} [name]
1009
- * @property {string} [value]
1010
- */
1011
- /**
1012
- * @typedef SupportedValidationsMetaSchema
1013
- * @property {SupportedValidationsMetaExampleSchema[]} [examples]
1014
- */
1015
- /**
1016
- * @typedef SupportedValidationsSchema
1173
+ * @typedef SupportedValidationsSchema
1017
1174
  * @property {string} [name]
1018
1175
  * @property {string} [type]
1019
1176
  * @property {string} [display]
1020
1177
  * @property {boolean} [required]
1021
- * @property {SupportedValidationsMetaSchema} [meta]
1022
1178
  */
1023
1179
  /**
1024
1180
  * @typedef Duration
1025
- * @property {string} [name] - Name data type of custom field
1026
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1027
- * @property {string} [type] - Type of custom field
1028
- * @property {string} [category] - Category of custom field
1029
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1030
- * validations available for the field
1181
+ * @property {string} [name]
1182
+ * @property {boolean} [list_enabled]
1183
+ * @property {string} [type]
1184
+ * @property {string} [category]
1185
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1031
1186
  */
1032
1187
  /**
1033
1188
  * @typedef HTML
1034
- * @property {string} [name] - Name data type of custom field
1035
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1036
- * @property {string} [type] - Type of custom field
1037
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1038
- * validations available for the field
1189
+ * @property {string} [name]
1190
+ * @property {boolean} [list_enabled]
1191
+ * @property {string} [type]
1192
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1039
1193
  */
1040
1194
  /**
1041
1195
  * @typedef StringSingleLine
1042
- * @property {string} [name] - Name data type of custom field
1043
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1044
- * @property {string} [category] - Category of custom field
1045
- * @property {string} [type] - Type of custom field
1046
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1047
- * validations available for the field
1196
+ * @property {string} [name]
1197
+ * @property {boolean} [list_enabled]
1198
+ * @property {string} [category]
1199
+ * @property {string} [type]
1200
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1048
1201
  */
1049
1202
  /**
1050
1203
  * @typedef StringMultiLine
1051
- * @property {string} [name] - Name data type of custom field
1052
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1053
- * @property {string} [category] - Category of custom field
1054
- * @property {string} [type] - Type of custom field
1055
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1056
- * validations available for the field
1204
+ * @property {string} [name]
1205
+ * @property {boolean} [list_enabled]
1206
+ * @property {string} [category]
1207
+ * @property {string} [type]
1208
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1057
1209
  */
1058
1210
  /**
1059
1211
  * @typedef Dropdown
1060
- * @property {string} [name] - Name data type of custom field
1061
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1062
- * @property {string} [category] - Category of custom field
1063
- * @property {string} [type] - Category of custom field
1064
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1065
- * validations available for the field
1212
+ * @property {string} [name]
1213
+ * @property {boolean} [list_enabled]
1214
+ * @property {string} [category]
1215
+ * @property {string} [type]
1216
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1066
1217
  */
1067
1218
  /**
1068
1219
  * @typedef Integer
1069
- * @property {string} [name] - Name data type of custom field
1070
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1071
- * @property {string} [type] - Type of custom field
1072
- * @property {string} [category] - Category of custom field
1073
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1074
- * validations available for the field
1220
+ * @property {string} [name]
1221
+ * @property {boolean} [list_enabled]
1222
+ * @property {string} [type]
1223
+ * @property {string} [category]
1224
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1075
1225
  */
1076
1226
  /**
1077
1227
  * @typedef FloatType
1078
- * @property {string} [name] - Name data type of custom field
1079
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1080
- * @property {string} [type] - Type of custom field
1081
- * @property {string} [category] - Category of custom field
1082
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1083
- * validations available for the field
1228
+ * @property {string} [name]
1229
+ * @property {boolean} [list_enabled]
1230
+ * @property {string} [type]
1231
+ * @property {string} [category]
1232
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1084
1233
  */
1085
1234
  /**
1086
1235
  * @typedef BooleanType
1087
- * @property {string} [name] - Name data type of custom field
1088
- * @property {string} [category] - Category of custom field
1089
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1090
- * @property {string} [type] - Category of custom field
1091
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1092
- * validations available for the field
1236
+ * @property {string} [name]
1237
+ * @property {string} [category]
1238
+ * @property {boolean} [list_enabled]
1239
+ * @property {string} [type]
1240
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1093
1241
  */
1094
1242
  /**
1095
1243
  * @typedef Date
1096
- * @property {string} [name] - Name data type of custom field
1097
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1098
- * @property {string} [category] - Category of custom field
1099
- * @property {string} [type] - Type of custom field
1100
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1101
- * validations available for the field
1244
+ * @property {string} [name]
1245
+ * @property {boolean} [list_enabled]
1246
+ * @property {string} [category]
1247
+ * @property {string} [type]
1248
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1102
1249
  */
1103
1250
  /**
1104
1251
  * @typedef Datetime
1105
- * @property {string} [name] - Name data type of custom field
1106
- * @property {string} [category] - Category of custom field
1107
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1108
- * @property {string} [type] - Type of custom field
1109
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1110
- * validations available for the field
1252
+ * @property {string} [name]
1253
+ * @property {string} [category]
1254
+ * @property {boolean} [list_enabled]
1255
+ * @property {string} [type]
1256
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1111
1257
  */
1112
1258
  /**
1113
1259
  * @typedef Json
1114
- * @property {string} [name] - Name data type of custom field
1115
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1116
- * @property {string} [category] - Category of custom field
1117
- * @property {string} [type] - Type of custom field
1118
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1119
- * validations available for the field
1260
+ * @property {string} [name]
1261
+ * @property {boolean} [list_enabled]
1262
+ * @property {string} [category]
1263
+ * @property {string} [type]
1264
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1120
1265
  */
1121
1266
  /**
1122
1267
  * @typedef File
1123
- * @property {string} [name] - Name data type of custom field
1124
- * @property {string} [category] - Category of custom field
1125
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1126
- * @property {string} [type] - Type of custom field
1268
+ * @property {string} [name]
1269
+ * @property {string} [category]
1270
+ * @property {boolean} [list_enabled]
1271
+ * @property {string} [type]
1127
1272
  * @property {SupportedValidationsSchema[]} [supported_validations]
1128
1273
  */
1129
1274
  /**
1130
1275
  * @typedef Url
1131
- * @property {string} [name] - Name data type of custom field
1132
- * @property {boolean} [list_enabled] - Flag for listing enabled or not
1133
- * @property {string} [type] - Type of custom field
1134
- * @property {SupportedValidationsSchema[]} [supported_validations] - List of
1135
- * validations available for the field
1276
+ * @property {string} [name]
1277
+ * @property {boolean} [list_enabled]
1278
+ * @property {string} [type]
1279
+ * @property {SupportedValidationsSchema[]} [supported_validations]
1136
1280
  */
1137
1281
  /**
1138
1282
  * @typedef Metaobject
1139
- * @property {string} [name] - Name of Custom Object
1140
- * @property {boolean} [list_enabled] - Whether the field is allowed to have
1141
- * multiple list items
1142
- * @property {string} [category] - Category of Custom Object Definition that
1143
- * Custom Object belongs to
1144
- * @property {string} [type] - Type of Custom Object Definition
1283
+ * @property {string} [name]
1284
+ * @property {boolean} [list_enabled]
1285
+ * @property {string} [category]
1286
+ * @property {string} [type]
1145
1287
  * @property {SupportedValidationsSchema[]} [supported_validations]
1146
1288
  */
1147
1289
  /**
1148
1290
  * @typedef Product
1149
- * @property {string} [name] - Name of Product
1150
- * @property {boolean} [list_enabled] - Whether the field is allowed to have
1151
- * multiple list items
1152
- * @property {string} [category] - Category of Custom Object Definition that
1153
- * Product is associated with
1154
- * @property {string} [type] - Custom Object Definition that Product is associated with
1291
+ * @property {string} [name]
1292
+ * @property {boolean} [list_enabled]
1293
+ * @property {string} [category]
1294
+ * @property {string} [type]
1155
1295
  * @property {SupportedValidationsSchema[]} [supported_validations]
1296
+ * @property {string[]} [scope]
1156
1297
  */
1157
1298
  /**
1158
1299
  * @typedef CustomObjectEntry
1159
- * @property {string} [id] - Unique system generated id
1160
- * @property {string} [name] - Name of Custom Object definition
1161
- * @property {string} [type] - Type of Custom Object Definition
1162
- * @property {string} [updated_at] - Updation time of a Custom Object
1163
- * @property {number} [entries_count] - Number of entries against the Custom
1164
- * Object definition
1165
- * @property {number} [fields_count] - Number of fields against a Custom Object definition
1300
+ * @property {string} [_id]
1301
+ * @property {string} [name]
1302
+ * @property {string} [type]
1303
+ * @property {string} [updated_at]
1304
+ * @property {number} [entries_count]
1305
+ * @property {number} [fields_count]
1166
1306
  */
1167
1307
  /**
1168
1308
  * @typedef CustomObjectDefinitionsSchema
@@ -1171,29 +1311,19 @@ export = ContentPlatformModel;
1171
1311
  */
1172
1312
  /**
1173
1313
  * @typedef CustomObjectEntryFieldSchema
1174
- * @property {string} [namespace] - This is namespace for a custom field definition
1175
- * @property {string} [slug] - This is slug for a custom field definition
1176
- */
1177
- /**
1178
- * @typedef CustomObjectEntryFieldSchemaWithoutID
1179
- * @property {string} [slug] - Custom fields belonging to a custom object
1180
- * @property {Object} [value] - Value of custom field inside a custom object
1314
+ * @property {string} [definition_id]
1181
1315
  */
1182
1316
  /**
1183
1317
  * @typedef CustomObjectRequestSchema
1184
- * @property {string} [status] - Flag to denote status of Custom Object
1185
- * @property {string} [slug] - This is slug for a custom field definition
1186
- * @property {CustomObjectEntryFieldSchema[]} [fields] - List of custom fields
1187
- */
1188
- /**
1189
- * @typedef CustomObjectRequestSchemaWithoutId
1190
- * @property {string} [status] - Status of the custom object entry.
1191
- * @property {CustomObjectEntryFieldSchemaWithoutID[]} [fields] - List of custom fields
1318
+ * @property {string} [status]
1319
+ * @property {string} [slug]
1320
+ * @property {string} [definition_id]
1321
+ * @property {CustomObjectEntryFieldSchema[]} [fields]
1192
1322
  */
1193
1323
  /**
1194
1324
  * @typedef CustomObjectBulkSchema
1195
- * @property {string} [url] - Full URL for the bulk operations data
1196
- * @property {number} [total_records] - Total records in the upload.
1325
+ * @property {string} [url]
1326
+ * @property {number} [total_records]
1197
1327
  */
1198
1328
  /**
1199
1329
  * @typedef ActionPage
@@ -1202,7 +1332,6 @@ export = ContentPlatformModel;
1202
1332
  * @property {string} [url] - The URL for the action.
1203
1333
  * @property {PageType} type
1204
1334
  */
1205
- /** @typedef {"title" | "description"} GenerationEntityType */
1206
1335
  /**
1207
1336
  * @typedef {| "about-us"
1208
1337
  * | "addresses"
@@ -1256,20 +1385,8 @@ export = ContentPlatformModel;
1256
1385
  declare class ContentPlatformModel {
1257
1386
  }
1258
1387
  declare namespace ContentPlatformModel {
1259
- export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
1388
+ export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, DeletPathMappingSchema, CreatePathMappingSchema, GetAllPathMappingSchema, GetPathSchema, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderItemsResponseSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, AssignmentReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, TagSpecSchema, ServerSchema, DataLoadersApiSpecSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, NavigationAssignment, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageResponseError, PageSchema, SanitizedContent, PageMeta, PageContent, CreatedBySchema, PageRequestVisibility, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, CustomePages, SystemPagesActionPage, SystemPagesAction, SystemPages, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, ApplicationFieldDefinitionSchema, FieldDefinitionSchema, ApplicationCustomFieldDefinitionsSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectApplicationSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, MetafieldTypesSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, PageType };
1260
1389
  }
1261
- /** @returns {ValidationError} */
1262
- declare function ValidationError(): ValidationError;
1263
- type ValidationError = {
1264
- /**
1265
- * - A brief description of the error encountered.
1266
- */
1267
- message: string;
1268
- /**
1269
- * - The field in the request that caused the error.
1270
- */
1271
- field: string;
1272
- };
1273
1390
  /** @returns {GenerateSEOContent} */
1274
1391
  declare function GenerateSEOContent(): GenerateSEOContent;
1275
1392
  type GenerateSEOContent = {
@@ -1296,6 +1413,7 @@ type ApplicationLegal = {
1296
1413
  _id?: string;
1297
1414
  updated_at?: string;
1298
1415
  created_at?: string;
1416
+ __v?: number;
1299
1417
  };
1300
1418
  /** @returns {ApplicationLegalFAQ} */
1301
1419
  declare function ApplicationLegalFAQ(): ApplicationLegalFAQ;
@@ -1312,7 +1430,7 @@ type PathMappingSchema = {
1312
1430
  redirect_to?: string;
1313
1431
  updated_at?: string;
1314
1432
  created_at?: string;
1315
- __source?: PathSourceSchema;
1433
+ __v?: number;
1316
1434
  };
1317
1435
  /** @returns {PathSourceSchema} */
1318
1436
  declare function PathSourceSchema(): PathSourceSchema;
@@ -1328,8 +1446,8 @@ type SeoComponent = {
1328
1446
  /** @returns {SeoSchema} */
1329
1447
  declare function SeoSchema(): SeoSchema;
1330
1448
  type SeoSchema = {
1331
- app?: string;
1332
1449
  _id?: string;
1450
+ app?: string;
1333
1451
  robots_txt?: string;
1334
1452
  sitemap_enabled?: boolean;
1335
1453
  additional_sitemap?: string;
@@ -1338,6 +1456,8 @@ type SeoSchema = {
1338
1456
  details?: Detail;
1339
1457
  created_at?: string;
1340
1458
  updated_at?: string;
1459
+ __v?: number;
1460
+ sitemap?: SEOSitemap;
1341
1461
  };
1342
1462
  /** @returns {CustomMetaTag} */
1343
1463
  declare function CustomMetaTag(): CustomMetaTag;
@@ -1362,28 +1482,55 @@ type SeoSchemaComponent = {
1362
1482
  /** @returns {SEOSchemaMarkupTemplate} */
1363
1483
  declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
1364
1484
  type SEOSchemaMarkupTemplate = {
1365
- id?: string;
1485
+ _id?: string;
1366
1486
  title?: string;
1367
1487
  page_type?: string;
1368
1488
  schema?: string;
1369
1489
  description?: string;
1370
1490
  active?: boolean;
1491
+ application?: string;
1371
1492
  created_at?: string;
1372
1493
  updated_at?: string;
1373
- application?: string;
1374
1494
  target_json?: any;
1495
+ __v?: number;
1375
1496
  };
1376
1497
  /** @returns {SEOSchemaMarkupTemplateRequestBody} */
1377
1498
  declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
1378
1499
  type SEOSchemaMarkupTemplateRequestBody = {
1379
1500
  title?: string;
1380
1501
  page_type?: string;
1381
- schema?: string;
1382
1502
  description?: string;
1503
+ schema?: string;
1383
1504
  target_json?: any;
1384
1505
  active?: boolean;
1385
1506
  created_at?: string;
1386
- updated_at?: string;
1507
+ };
1508
+ /** @returns {DeletPathMappingSchema} */
1509
+ declare function DeletPathMappingSchema(): DeletPathMappingSchema;
1510
+ type DeletPathMappingSchema = {
1511
+ message?: string;
1512
+ data?: PathMappingSchema;
1513
+ };
1514
+ /** @returns {CreatePathMappingSchema} */
1515
+ declare function CreatePathMappingSchema(): CreatePathMappingSchema;
1516
+ type CreatePathMappingSchema = {
1517
+ message?: string;
1518
+ data?: PathMappingSchema;
1519
+ };
1520
+ /** @returns {GetAllPathMappingSchema} */
1521
+ declare function GetAllPathMappingSchema(): GetAllPathMappingSchema;
1522
+ type GetAllPathMappingSchema = {
1523
+ message?: string;
1524
+ data?: GetPathSchema;
1525
+ };
1526
+ /** @returns {GetPathSchema} */
1527
+ declare function GetPathSchema(): GetPathSchema;
1528
+ type GetPathSchema = {
1529
+ docs?: PathMappingSchema[];
1530
+ page?: number;
1531
+ limit?: number;
1532
+ pages?: number;
1533
+ total?: number;
1387
1534
  };
1388
1535
  /** @returns {AnnouncementPageSchema} */
1389
1536
  declare function AnnouncementPageSchema(): AnnouncementPageSchema;
@@ -1430,11 +1577,11 @@ declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplat
1430
1577
  type DefaultSEOSchemaMarkupTemplate = {
1431
1578
  page_type?: string;
1432
1579
  schema?: string;
1433
- target_json?: any;
1434
1580
  };
1435
1581
  /** @returns {ScheduleSchema} */
1436
1582
  declare function ScheduleSchema(): ScheduleSchema;
1437
1583
  type ScheduleSchema = {
1584
+ published?: boolean;
1438
1585
  cron?: string;
1439
1586
  start?: string;
1440
1587
  end?: string;
@@ -1447,9 +1594,9 @@ type NextSchedule = {
1447
1594
  start?: string;
1448
1595
  end?: string;
1449
1596
  };
1450
- /** @returns {BlogGetDetails} */
1451
- declare function BlogGetDetails(): BlogGetDetails;
1452
- type BlogGetDetails = {
1597
+ /** @returns {BlogGetResponse} */
1598
+ declare function BlogGetResponse(): BlogGetResponse;
1599
+ type BlogGetResponse = {
1453
1600
  items?: BlogSchema[];
1454
1601
  page?: Page;
1455
1602
  filters?: BlogFilters;
@@ -1498,6 +1645,7 @@ type BlogSchema = {
1498
1645
  title?: string;
1499
1646
  date_meta?: DateMeta;
1500
1647
  summary?: string;
1648
+ status?: string;
1501
1649
  };
1502
1650
  /** @returns {SEO} */
1503
1651
  declare function SEO(): SEO;
@@ -1507,7 +1655,7 @@ type SEO = {
1507
1655
  title?: string;
1508
1656
  meta_tags?: SEOMetaItem[];
1509
1657
  sitemap?: SEOSitemap;
1510
- breadcrumb?: SEObreadcrumb[];
1658
+ breadcrumbs?: SEObreadcrumb[];
1511
1659
  canonical_url?: string;
1512
1660
  };
1513
1661
  /** @returns {SEOImage} */
@@ -1545,9 +1693,9 @@ type DateMeta = {
1545
1693
  created_on?: string;
1546
1694
  modified_on?: string;
1547
1695
  };
1548
- /** @returns {BlogPayload} */
1549
- declare function BlogPayload(): BlogPayload;
1550
- type BlogPayload = {
1696
+ /** @returns {BlogRequest} */
1697
+ declare function BlogRequest(): BlogRequest;
1698
+ type BlogRequest = {
1551
1699
  application?: string;
1552
1700
  _custom_json?: any;
1553
1701
  author?: Author;
@@ -1558,6 +1706,7 @@ type BlogPayload = {
1558
1706
  slug?: string;
1559
1707
  tags?: string[];
1560
1708
  title?: string;
1709
+ publish_date?: string;
1561
1710
  seo?: SEO;
1562
1711
  summary?: string;
1563
1712
  };
@@ -1573,6 +1722,11 @@ type CreateAnnouncementSchema = {
1573
1722
  message?: string;
1574
1723
  data?: AdminAnnouncementSchema;
1575
1724
  };
1725
+ /** @returns {DataLoaderItemsResponseSchema} */
1726
+ declare function DataLoaderItemsResponseSchema(): DataLoaderItemsResponseSchema;
1727
+ type DataLoaderItemsResponseSchema = {
1728
+ items?: DataLoaderResponseSchema[];
1729
+ };
1576
1730
  /** @returns {DataLoaderResponseSchema} */
1577
1731
  declare function DataLoaderResponseSchema(): DataLoaderResponseSchema;
1578
1732
  type DataLoaderResponseSchema = {
@@ -1585,12 +1739,16 @@ type DataLoaderResponseSchema = {
1585
1739
  type?: string;
1586
1740
  url?: string;
1587
1741
  content?: string;
1742
+ created_at?: string;
1743
+ modified_at?: string;
1744
+ __v?: number;
1745
+ is_selected?: boolean;
1588
1746
  __source?: DataLoaderSourceSchema;
1589
1747
  };
1590
1748
  /** @returns {DataLoaderResetResponseSchema} */
1591
1749
  declare function DataLoaderResetResponseSchema(): DataLoaderResetResponseSchema;
1592
1750
  type DataLoaderResetResponseSchema = {
1593
- reset?: boolean;
1751
+ resetted?: boolean;
1594
1752
  };
1595
1753
  /** @returns {LocaleLanguage} */
1596
1754
  declare function LocaleLanguage(): LocaleLanguage;
@@ -1622,13 +1780,19 @@ type NavigationReference = {
1622
1780
  _locale_language?: LocaleLanguage;
1623
1781
  image?: string;
1624
1782
  type?: string;
1625
- action?: Action;
1626
1783
  active?: boolean;
1627
1784
  display?: string;
1628
1785
  sort_order?: number;
1629
1786
  schedule?: CronBasedScheduleSchema;
1630
1787
  sub_navigation?: NavigationReference[];
1631
1788
  };
1789
+ /** @returns {AssignmentReference} */
1790
+ declare function AssignmentReference(): AssignmentReference;
1791
+ type AssignmentReference = {
1792
+ platform?: string;
1793
+ orientation?: string;
1794
+ position?: string;
1795
+ };
1632
1796
  /** @returns {CronBasedScheduleSchema} */
1633
1797
  declare function CronBasedScheduleSchema(): CronBasedScheduleSchema;
1634
1798
  type CronBasedScheduleSchema = {
@@ -1679,14 +1843,18 @@ type CreateTagRequestSchema = {
1679
1843
  /** @returns {DataLoaderSchema} */
1680
1844
  declare function DataLoaderSchema(): DataLoaderSchema;
1681
1845
  type DataLoaderSchema = {
1846
+ _id?: string;
1847
+ url?: string;
1848
+ created_at?: string;
1849
+ modified_at?: string;
1850
+ application?: string;
1851
+ company?: string;
1682
1852
  name?: string;
1683
1853
  service?: string;
1684
1854
  operation_id?: string;
1855
+ is_selected?: boolean;
1685
1856
  type?: string;
1686
- url?: string;
1687
- content?: string;
1688
1857
  __source?: DataLoaderSourceSchema;
1689
- _id?: string;
1690
1858
  };
1691
1859
  /** @returns {DataLoaderSourceSchema} */
1692
1860
  declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
@@ -1694,14 +1862,34 @@ type DataLoaderSourceSchema = {
1694
1862
  type?: string;
1695
1863
  id?: string;
1696
1864
  };
1865
+ /** @returns {TagSpecSchema} */
1866
+ declare function TagSpecSchema(): TagSpecSchema;
1867
+ type TagSpecSchema = {
1868
+ name?: string;
1869
+ description?: string;
1870
+ };
1871
+ /** @returns {ServerSchema} */
1872
+ declare function ServerSchema(): ServerSchema;
1873
+ type ServerSchema = {
1874
+ url?: string;
1875
+ };
1876
+ /** @returns {DataLoadersApiSpecSchema} */
1877
+ declare function DataLoadersApiSpecSchema(): DataLoadersApiSpecSchema;
1878
+ type DataLoadersApiSpecSchema = {
1879
+ info?: any;
1880
+ servers?: ServerSchema[];
1881
+ tags?: TagSpecSchema[];
1882
+ openapi?: string;
1883
+ paths?: any;
1884
+ };
1697
1885
  /** @returns {DataLoadersSchema} */
1698
1886
  declare function DataLoadersSchema(): DataLoadersSchema;
1699
1887
  type DataLoadersSchema = {
1700
1888
  items?: DataLoaderSchema[];
1701
1889
  };
1702
- /** @returns {TagDeleteSuccessDetails} */
1703
- declare function TagDeleteSuccessDetails(): TagDeleteSuccessDetails;
1704
- type TagDeleteSuccessDetails = {
1890
+ /** @returns {TagDeleteSuccessResponse} */
1891
+ declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
1892
+ type TagDeleteSuccessResponse = {
1705
1893
  success?: boolean;
1706
1894
  };
1707
1895
  /** @returns {ContentAPIError} */
@@ -1711,7 +1899,6 @@ type ContentAPIError = {
1711
1899
  status?: number;
1712
1900
  code?: string;
1713
1901
  exception?: string;
1714
- info?: string;
1715
1902
  request_id?: string;
1716
1903
  stack_trace?: string;
1717
1904
  meta?: any;
@@ -1733,6 +1920,7 @@ type CategorySchema = {
1733
1920
  application?: string;
1734
1921
  icon_url?: string;
1735
1922
  _custom_json?: any;
1923
+ __v?: number;
1736
1924
  };
1737
1925
  /** @returns {ChildrenSchema} */
1738
1926
  declare function ChildrenSchema(): ChildrenSchema;
@@ -1752,15 +1940,15 @@ type CategoryRequestSchema = {
1752
1940
  /** @returns {FAQCategorySchema} */
1753
1941
  declare function FAQCategorySchema(): FAQCategorySchema;
1754
1942
  type FAQCategorySchema = {
1755
- index?: number;
1943
+ _id?: string;
1944
+ application?: string;
1756
1945
  title?: string;
1757
1946
  description?: string;
1758
- children?: ChildrenSchema[];
1759
- _id?: string;
1947
+ index?: number;
1760
1948
  slug?: string;
1761
- application?: string;
1949
+ children?: ChildrenSchema[];
1762
1950
  icon_url?: string;
1763
- _custom_json?: any;
1951
+ __v?: number;
1764
1952
  };
1765
1953
  /** @returns {FaqSchema} */
1766
1954
  declare function FaqSchema(): FaqSchema;
@@ -1771,6 +1959,7 @@ type FaqSchema = {
1771
1959
  question?: string;
1772
1960
  answer?: string;
1773
1961
  tags?: string[];
1962
+ __v?: number;
1774
1963
  };
1775
1964
  /** @returns {FAQ} */
1776
1965
  declare function FAQ(): FAQ;
@@ -1850,10 +2039,14 @@ type Page = {
1850
2039
  * - The number of items per page.
1851
2040
  */
1852
2041
  size?: number;
2042
+ /**
2043
+ * - Total number of items.
2044
+ */
2045
+ total?: number;
1853
2046
  };
1854
- /** @returns {LandingPageGetDetails} */
1855
- declare function LandingPageGetDetails(): LandingPageGetDetails;
1856
- type LandingPageGetDetails = {
2047
+ /** @returns {LandingPageGetResponse} */
2048
+ declare function LandingPageGetResponse(): LandingPageGetResponse;
2049
+ type LandingPageGetResponse = {
1857
2050
  items?: LandingPageSchema[];
1858
2051
  page?: Page;
1859
2052
  };
@@ -1861,7 +2054,6 @@ type LandingPageGetDetails = {
1861
2054
  declare function LandingPageSchema(): LandingPageSchema;
1862
2055
  type LandingPageSchema = {
1863
2056
  slug?: string;
1864
- action?: Action;
1865
2057
  platform?: string[];
1866
2058
  created_by?: CreatedBySchema;
1867
2059
  date_meta?: DateMeta;
@@ -1869,15 +2061,16 @@ type LandingPageSchema = {
1869
2061
  application?: string;
1870
2062
  archived?: boolean;
1871
2063
  _custom_json?: any;
2064
+ __v?: number;
1872
2065
  };
1873
- /** @returns {DefaultNavigationDetails} */
1874
- declare function DefaultNavigationDetails(): DefaultNavigationDetails;
1875
- type DefaultNavigationDetails = {
2066
+ /** @returns {DefaultNavigationResponse} */
2067
+ declare function DefaultNavigationResponse(): DefaultNavigationResponse;
2068
+ type DefaultNavigationResponse = {
1876
2069
  items?: NavigationSchema[];
1877
2070
  };
1878
- /** @returns {NavigationGetDetails} */
1879
- declare function NavigationGetDetails(): NavigationGetDetails;
1880
- type NavigationGetDetails = {
2071
+ /** @returns {NavigationGetResponse} */
2072
+ declare function NavigationGetResponse(): NavigationGetResponse;
2073
+ type NavigationGetResponse = {
1881
2074
  items?: NavigationSchema[];
1882
2075
  page?: Page;
1883
2076
  };
@@ -1901,19 +2094,29 @@ type NavigationSchema = {
1901
2094
  orientation?: Orientation;
1902
2095
  version?: number;
1903
2096
  navigation?: NavigationReference[];
2097
+ assignments?: AssignmentReference[];
2098
+ __v?: number;
1904
2099
  };
1905
- /** @returns {NavigationPayload} */
1906
- declare function NavigationPayload(): NavigationPayload;
1907
- type NavigationPayload = {
2100
+ /** @returns {NavigationRequest} */
2101
+ declare function NavigationRequest(): NavigationRequest;
2102
+ type NavigationRequest = {
1908
2103
  name?: string;
1909
2104
  slug?: string;
1910
2105
  platform?: string[];
1911
2106
  orientation?: Orientation;
2107
+ assignments?: NavigationAssignment[];
1912
2108
  navigation?: NavigationReference[];
1913
2109
  };
1914
- /** @returns {PageGetDetails} */
1915
- declare function PageGetDetails(): PageGetDetails;
1916
- type PageGetDetails = {
2110
+ /** @returns {NavigationAssignment} */
2111
+ declare function NavigationAssignment(): NavigationAssignment;
2112
+ type NavigationAssignment = {
2113
+ platform?: string;
2114
+ orientation?: string;
2115
+ position?: string;
2116
+ };
2117
+ /** @returns {PageGetResponse} */
2118
+ declare function PageGetResponse(): PageGetResponse;
2119
+ type PageGetResponse = {
1917
2120
  items?: PageSchema[];
1918
2121
  page?: Page;
1919
2122
  };
@@ -1936,50 +2139,73 @@ type PageSpecItem = {
1936
2139
  params?: PageSpecParam[];
1937
2140
  query?: PageSpecParam[];
1938
2141
  };
2142
+ /** @returns {PageResponseError} */
2143
+ declare function PageResponseError(): PageResponseError;
2144
+ type PageResponseError = {
2145
+ errors?: string;
2146
+ };
1939
2147
  /** @returns {PageSchema} */
1940
2148
  declare function PageSchema(): PageSchema;
1941
2149
  type PageSchema = {
1942
2150
  _id?: string;
1943
2151
  application?: string;
1944
- /**
1945
- * - Components can be used to store
1946
- * multiple components
1947
- */
1948
- component_ids?: string[];
1949
- content?: any[];
2152
+ platform?: string;
2153
+ title?: string;
2154
+ slug?: string;
2155
+ type?: string;
2156
+ tags?: string[];
1950
2157
  content_path?: string;
2158
+ orientation?: string;
2159
+ description?: string;
2160
+ published?: boolean;
1951
2161
  created_by?: CreatedBySchema;
1952
2162
  date_meta?: DateMeta;
1953
- description?: string;
1954
2163
  feature_image?: Asset;
1955
- page_meta?: any[];
1956
2164
  _schedule?: ScheduleSchema;
1957
- _custom_json?: any;
1958
- orientation?: string;
1959
- platform?: string;
1960
- published?: boolean;
1961
- slug?: string;
1962
- tags?: string[];
1963
- title?: string;
1964
- type?: string;
2165
+ page_meta?: PageMeta[];
1965
2166
  seo?: SEO;
1966
- visibility?: any;
2167
+ component_ids?: string[];
1967
2168
  archived?: boolean;
2169
+ __v?: number;
2170
+ content?: PageContent[];
2171
+ sanitized_content?: SanitizedContent[];
2172
+ };
2173
+ /** @returns {SanitizedContent} */
2174
+ declare function SanitizedContent(): SanitizedContent;
2175
+ type SanitizedContent = {
2176
+ type?: string;
2177
+ value?: string;
2178
+ };
2179
+ /** @returns {PageMeta} */
2180
+ declare function PageMeta(): PageMeta;
2181
+ type PageMeta = {
2182
+ key?: string;
2183
+ };
2184
+ /** @returns {PageContent} */
2185
+ declare function PageContent(): PageContent;
2186
+ type PageContent = {
2187
+ type?: string;
2188
+ value?: string;
1968
2189
  };
1969
2190
  /** @returns {CreatedBySchema} */
1970
2191
  declare function CreatedBySchema(): CreatedBySchema;
1971
2192
  type CreatedBySchema = {
1972
2193
  id?: string;
1973
2194
  };
1974
- /** @returns {PagePayload} */
1975
- declare function PagePayload(): PagePayload;
1976
- type PagePayload = {
2195
+ /** @returns {PageRequestVisibility} */
2196
+ declare function PageRequestVisibility(): PageRequestVisibility;
2197
+ type PageRequestVisibility = {
2198
+ test?: boolean;
2199
+ };
2200
+ /** @returns {PageRequest} */
2201
+ declare function PageRequest(): PageRequest;
2202
+ type PageRequest = {
1977
2203
  _schedule?: CronSchedule;
1978
2204
  application?: string;
1979
2205
  author?: Author;
1980
2206
  _custom_json?: any;
1981
2207
  orientation?: string;
1982
- content?: any[];
2208
+ content?: PageContent[];
1983
2209
  feature_image?: Asset;
1984
2210
  published?: boolean;
1985
2211
  reading_time?: string;
@@ -1987,6 +2213,13 @@ type PagePayload = {
1987
2213
  tags?: string[];
1988
2214
  seo?: SEO;
1989
2215
  title?: string;
2216
+ platform?: string;
2217
+ type?: string;
2218
+ description?: string;
2219
+ /**
2220
+ * - Visibility of Page.
2221
+ */
2222
+ visibility?: any;
1990
2223
  };
1991
2224
  /** @returns {CronSchedule} */
1992
2225
  declare function CronSchedule(): CronSchedule;
@@ -1995,19 +2228,44 @@ type CronSchedule = {
1995
2228
  start?: string;
1996
2229
  end?: string;
1997
2230
  duration?: number;
2231
+ next_schedule?: NextSchedule[];
1998
2232
  };
1999
- /** @returns {PagePublishPayload} */
2000
- declare function PagePublishPayload(): PagePublishPayload;
2001
- type PagePublishPayload = {
2233
+ /** @returns {PagePublishRequest} */
2234
+ declare function PagePublishRequest(): PagePublishRequest;
2235
+ type PagePublishRequest = {
2002
2236
  publish?: boolean;
2003
2237
  };
2004
2238
  /** @returns {PageMetaSchema} */
2005
2239
  declare function PageMetaSchema(): PageMetaSchema;
2006
2240
  type PageMetaSchema = {
2007
- system_pages?: NavigationSchema[];
2008
- custom_pages?: PageSchema[];
2241
+ system_pages?: SystemPages[];
2242
+ custom_pages?: CustomePages[];
2009
2243
  application_id?: string;
2010
2244
  };
2245
+ /** @returns {CustomePages} */
2246
+ declare function CustomePages(): CustomePages;
2247
+ type CustomePages = {
2248
+ display?: string;
2249
+ slug?: string;
2250
+ };
2251
+ /** @returns {SystemPagesActionPage} */
2252
+ declare function SystemPagesActionPage(): SystemPagesActionPage;
2253
+ type SystemPagesActionPage = {
2254
+ type?: string;
2255
+ };
2256
+ /** @returns {SystemPagesAction} */
2257
+ declare function SystemPagesAction(): SystemPagesAction;
2258
+ type SystemPagesAction = {
2259
+ page?: SystemPagesActionPage;
2260
+ type?: string;
2261
+ };
2262
+ /** @returns {SystemPages} */
2263
+ declare function SystemPages(): SystemPages;
2264
+ type SystemPages = {
2265
+ display?: string;
2266
+ action?: SystemPagesAction;
2267
+ page_type?: string;
2268
+ };
2011
2269
  /** @returns {Support} */
2012
2270
  declare function Support(): Support;
2013
2271
  type Support = {
@@ -2055,6 +2313,8 @@ declare function TagsSchema(): TagsSchema;
2055
2313
  type TagsSchema = {
2056
2314
  application?: string;
2057
2315
  _id?: string;
2316
+ company?: string;
2317
+ __v?: number;
2058
2318
  tags?: TagSchema[];
2059
2319
  };
2060
2320
  /** @returns {TagSchema} */
@@ -2068,6 +2328,7 @@ type TagSchema = {
2068
2328
  position?: string;
2069
2329
  attributes?: any;
2070
2330
  content?: string;
2331
+ compatible_engines?: any[];
2071
2332
  pages?: any[];
2072
2333
  __source?: TagSourceSchema;
2073
2334
  };
@@ -2101,366 +2362,149 @@ type ResourceSchema = {
2101
2362
  /** @returns {FieldValidations} */
2102
2363
  declare function FieldValidations(): FieldValidations;
2103
2364
  type FieldValidations = {
2104
- /**
2105
- * - Name of validation
2106
- */
2107
2365
  name?: string;
2108
- /**
2109
- * - Type of validation
2110
- */
2111
2366
  type?: string;
2112
- value?: any;
2367
+ };
2368
+ /** @returns {ApplicationFieldDefinitionSchema} */
2369
+ declare function ApplicationFieldDefinitionSchema(): ApplicationFieldDefinitionSchema;
2370
+ type ApplicationFieldDefinitionSchema = {
2371
+ _id?: string;
2372
+ creator?: string;
2373
+ resource?: string;
2374
+ name?: string;
2375
+ namespace?: string;
2376
+ key?: string;
2377
+ description?: string;
2378
+ type?: string;
2379
+ multi_value?: boolean;
2380
+ validations?: FieldValidations[];
2381
+ company_id?: string;
2382
+ created_by?: string;
2383
+ updated_by?: string;
2384
+ required?: boolean;
2385
+ is_deleted?: boolean;
2386
+ created_at?: string;
2387
+ updated_at?: string;
2388
+ type_name?: string;
2389
+ invalid_fields_count?: number;
2390
+ application_id?: string;
2113
2391
  };
2114
2392
  /** @returns {FieldDefinitionSchema} */
2115
2393
  declare function FieldDefinitionSchema(): FieldDefinitionSchema;
2116
2394
  type FieldDefinitionSchema = {
2117
- /**
2118
- * - Unique system generated id
2119
- */
2120
- id?: string;
2121
- /**
2122
- * - Resource type to which custom field belongs
2123
- */
2395
+ _id?: string;
2396
+ creator?: string;
2124
2397
  resource?: string;
2125
- /**
2126
- * - Name of custom field
2127
- */
2128
2398
  name?: string;
2129
- /**
2130
- * - Namespace of custom field
2131
- */
2132
2399
  namespace?: string;
2133
- /**
2134
- * - Slug of custom field
2135
- */
2136
- slug?: string;
2137
- /**
2138
- * - Description of custom field definition
2139
- */
2400
+ key?: string;
2140
2401
  description?: string;
2141
- /**
2142
- * - Data type of custom field
2143
- */
2144
2402
  type?: string;
2145
- /**
2146
- * - Flag to denote whether custom field is
2147
- * multivalued or not
2148
- */
2149
2403
  multi_value?: boolean;
2150
- /**
2151
- * - List of validations applied
2152
- */
2153
2404
  validations?: FieldValidations[];
2154
- /**
2155
- * - Id of company
2156
- */
2157
2405
  company_id?: string;
2158
- /**
2159
- * - Whether the custom field is required or not
2160
- */
2406
+ created_by?: string;
2407
+ updated_by?: string;
2161
2408
  required?: boolean;
2162
- /**
2163
- * - Whether the custom field is deleted or not
2164
- */
2165
2409
  is_deleted?: boolean;
2166
- /**
2167
- * - Type of type field
2168
- */
2410
+ created_at?: string;
2411
+ updated_at?: string;
2169
2412
  type_name?: string;
2170
- /**
2171
- * - Count of invalid fields after validation
2172
- */
2173
2413
  invalid_fields_count?: number;
2174
2414
  };
2415
+ /** @returns {ApplicationCustomFieldDefinitionsSchema} */
2416
+ declare function ApplicationCustomFieldDefinitionsSchema(): ApplicationCustomFieldDefinitionsSchema;
2417
+ type ApplicationCustomFieldDefinitionsSchema = {
2418
+ items?: ApplicationFieldDefinitionSchema[];
2419
+ page?: Page;
2420
+ };
2175
2421
  /** @returns {CustomFieldDefinitionsSchema} */
2176
2422
  declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
2177
2423
  type CustomFieldDefinitionsSchema = {
2178
- /**
2179
- * - List of custom field definitions
2180
- */
2181
2424
  items?: FieldDefinitionSchema[];
2182
2425
  page?: Page;
2183
2426
  };
2184
2427
  /** @returns {CustomFieldDefinitionRequestSchema} */
2185
2428
  declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
2186
2429
  type CustomFieldDefinitionRequestSchema = {
2187
- /**
2188
- * - Data type of custom field
2189
- */
2430
+ resource?: string;
2190
2431
  type?: string;
2191
- /**
2192
- * - Slug of custom field definition
2193
- */
2194
- slug?: string;
2195
- /**
2196
- * - Namespace of custom field definition
2197
- */
2432
+ key?: string;
2198
2433
  namespace?: string;
2199
- /**
2200
- * - Flag to denote whether custom field is
2201
- * multi valued or not
2202
- */
2203
2434
  multi_value?: boolean;
2204
- /**
2205
- * - Name of custom field definition
2206
- */
2207
2435
  name?: string;
2208
- /**
2209
- * - Description of a custom field definition
2210
- */
2211
2436
  description?: string;
2212
- /**
2213
- * - Validations for a custom field
2214
- */
2437
+ creator?: string;
2215
2438
  validations?: FieldValidations[];
2216
2439
  };
2217
2440
  /** @returns {CustomObjectCustomFieldDefinitions} */
2218
2441
  declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
2219
2442
  type CustomObjectCustomFieldDefinitions = {
2220
- /**
2221
- * - Unique identifer for a custom field
2222
- */
2223
- id?: string;
2224
- /**
2225
- * - Data type of custom field
2226
- */
2227
- type?: string;
2228
- /**
2229
- * - Description of custom field
2230
- */
2443
+ _id?: string;
2444
+ type: string;
2231
2445
  description?: string;
2232
- /**
2233
- * - Name of custom field
2234
- */
2235
2446
  name?: string;
2236
- /**
2237
- * - Flag to denote if cusom field is multi
2238
- * valued or not
2239
- */
2240
2447
  multi_value?: boolean;
2241
- /**
2242
- * - Whether the field is required or not
2243
- */
2244
2448
  required?: boolean;
2245
- /**
2246
- * - Slug of custom field definition
2247
- */
2248
- slug?: string;
2249
- /**
2250
- * - Validations added against the
2251
- * custom field
2252
- */
2449
+ key?: string;
2253
2450
  validations?: FieldValidations[];
2254
2451
  action?: string;
2255
2452
  };
2256
2453
  /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
2257
2454
  declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
2258
2455
  type CustomObjectDefinitionUpdateRequestSchema = {
2259
- /**
2260
- * - Description of custom object definiton
2261
- */
2456
+ type?: string;
2262
2457
  description?: string;
2263
- /**
2264
- * - Name of custom object definition
2265
- */
2266
2458
  name?: string;
2267
- /**
2268
- * - Custom field slug which is used as a
2269
- * display key in
2270
- */
2271
2459
  display_name_key?: string;
2272
- field_definitions?: CustomObjectCustomFieldDefinitions[];
2460
+ field_definitions?: CustomFieldDefinitionDetailResSchema[];
2273
2461
  };
2274
2462
  /** @returns {CustomFieldDefinitionDetailResSchema} */
2275
2463
  declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
2276
2464
  type CustomFieldDefinitionDetailResSchema = {
2277
- /**
2278
- * - Resource to which custom field is associated
2279
- */
2465
+ creator?: string;
2280
2466
  resource?: string;
2281
- /**
2282
- * - Name of custom field
2283
- */
2284
- name?: string;
2285
- /**
2286
- * - Namespace of custom field
2287
- */
2288
- namespace?: string;
2289
- /**
2290
- * - Slug of custom field
2291
- */
2292
- slug?: string;
2293
- /**
2294
- * - Description regarding custom field
2295
- */
2296
- description?: string;
2297
- /**
2298
- * - Data type of custom field
2299
- */
2300
- type?: string;
2301
- /**
2302
- * - Flag to denote whether custom field is
2303
- * multi valued or not
2304
- */
2305
- multi_value?: boolean;
2306
- /**
2307
- * - Company Identifer
2308
- */
2309
- company_id?: string;
2310
- /**
2311
- * - Sales channel identifier
2312
- */
2313
- application_id?: string;
2314
- /**
2315
- * - Whether the customfield is required or not
2316
- */
2317
- required?: boolean;
2318
- /**
2319
- * - Is custom field deleted
2320
- */
2321
- is_deleted?: boolean;
2322
- /**
2323
- * - Unique system generated id
2324
- */
2325
- id?: string;
2326
- validations?: any[];
2327
- /**
2328
- * - Date time at which field was created
2329
- */
2330
- created_at?: string;
2331
- /**
2332
- * - Date time at for a field's last modification
2333
- */
2334
- updated_at?: string;
2335
- };
2336
- /** @returns {MetaFieldDefinitionDetailResSchema} */
2337
- declare function MetaFieldDefinitionDetailResSchema(): MetaFieldDefinitionDetailResSchema;
2338
- type MetaFieldDefinitionDetailResSchema = {
2339
- /**
2340
- * - Resource to which meta field is associated
2341
- */
2342
- resource?: string;
2343
- /**
2344
- * - Name of meta field
2345
- */
2346
2467
  name?: string;
2347
- /**
2348
- * - Namespace of meta field
2349
- */
2350
2468
  namespace?: string;
2351
- /**
2352
- * - Slug of meta field
2353
- */
2354
- slug?: string;
2355
- /**
2356
- * - Description regarding meta field
2357
- */
2469
+ key?: string;
2358
2470
  description?: string;
2359
- /**
2360
- * - Data type of meta field
2361
- */
2362
2471
  type?: string;
2363
- /**
2364
- * - Flag to denote whether meta field is
2365
- * multi valued or not
2366
- */
2367
2472
  multi_value?: boolean;
2368
- /**
2369
- * - Company Identifer
2370
- */
2371
2473
  company_id?: string;
2372
- /**
2373
- * - Sales channel identifier
2374
- */
2375
2474
  application_id?: string;
2376
- /**
2377
- * - Whether the field is required or not
2378
- */
2475
+ created_by?: string;
2476
+ updated_by?: string;
2379
2477
  required?: boolean;
2380
- /**
2381
- * - Is meta field deleted
2382
- */
2383
2478
  is_deleted?: boolean;
2384
- /**
2385
- * - Unique system generated id
2386
- */
2387
- id?: string;
2479
+ _id?: string;
2388
2480
  validations?: any[];
2389
- /**
2390
- * - Date time at which field was created
2391
- */
2392
2481
  created_at?: string;
2393
- /**
2394
- * - Date time at for a field's last modification
2395
- */
2396
2482
  updated_at?: string;
2397
2483
  };
2398
2484
  /** @returns {CustomDataDeleteSchema} */
2399
2485
  declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
2400
2486
  type CustomDataDeleteSchema = {
2401
- /**
2402
- * - Denotes the success of the delete operation
2403
- */
2404
2487
  success?: boolean;
2405
- /**
2406
- * - Denotes the message of delete operation
2407
- */
2408
2488
  message?: string;
2409
2489
  };
2410
- /** @returns {CustomFieldValue} */
2411
- declare function CustomFieldValue(): CustomFieldValue;
2412
- type CustomFieldValue = {
2413
- value?: any;
2414
- };
2415
2490
  /** @returns {CustomFieldSchema} */
2416
2491
  declare function CustomFieldSchema(): CustomFieldSchema;
2417
2492
  type CustomFieldSchema = {
2418
- /**
2419
- * - Unique system generated id
2420
- */
2421
- id?: string;
2422
- /**
2423
- * - Namespace of custom field definition
2424
- */
2493
+ _id?: string;
2425
2494
  namespace?: string;
2426
- /**
2427
- * - Slug of custom field definition
2428
- */
2429
- slug?: string;
2430
- /**
2431
- * - The resource for which custom field is being created
2432
- */
2495
+ key?: string;
2433
2496
  resource?: string;
2434
- value?: CustomFieldValue[];
2435
- /**
2436
- * - Unique identifier of the resource
2437
- */
2438
- resource_slug?: string;
2439
- /**
2440
- * - Data type of custom field
2441
- */
2442
- type?: string;
2443
- /**
2444
- * - Whether custom field is multi valued
2445
- */
2497
+ creator?: string;
2498
+ resource_id?: string;
2499
+ type: string;
2446
2500
  multi_value?: boolean;
2447
- /**
2448
- * - Identifer for a company
2449
- */
2450
2501
  company_id?: string;
2502
+ definition_id?: string;
2451
2503
  has_invalid_values?: boolean;
2452
2504
  invalid_value_errors?: any[];
2453
- /**
2454
- * - Indicates whether custom field is deleted
2455
- */
2505
+ created_by?: string;
2456
2506
  is_deleted?: boolean;
2457
- /**
2458
- * - Time at which customer field was created
2459
- */
2460
2507
  created_at?: string;
2461
- /**
2462
- * - Time at which custom field was updated
2463
- */
2464
2508
  updated_at?: string;
2465
2509
  };
2466
2510
  /** @returns {CustomFieldsResponseSchema} */
@@ -2480,371 +2524,196 @@ declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseB
2480
2524
  type CustomFieldsResponseByResourceIdSchema = {
2481
2525
  items?: CustomFieldSchema[];
2482
2526
  };
2483
- /** @returns {CustomField} */
2484
- declare function CustomField(): CustomField;
2485
- type CustomField = {
2486
- value?: any[];
2487
- /**
2488
- * - This is the namespace to which custom field belongs
2489
- */
2490
- namespace?: string;
2491
- /**
2492
- * - This is the slug of custom field used while
2493
- * creating a custom field definition
2494
- */
2495
- slug?: string;
2496
- };
2497
2527
  /** @returns {CustomFieldRequestSchema} */
2498
2528
  declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
2499
2529
  type CustomFieldRequestSchema = {
2500
- fields?: CustomField[];
2530
+ fields?: any[];
2501
2531
  };
2502
2532
  /** @returns {CustomObjectSchema} */
2503
2533
  declare function CustomObjectSchema(): CustomObjectSchema;
2504
2534
  type CustomObjectSchema = {
2505
- /**
2506
- * - Unique system generated id
2507
- */
2508
- id?: string;
2509
- /**
2510
- * - Identifer for a company
2511
- */
2535
+ _id?: string;
2536
+ name?: string;
2537
+ creator?: string;
2538
+ company_id?: string;
2539
+ created_by?: string;
2540
+ updated_by?: string;
2541
+ status?: string;
2542
+ slug?: string;
2543
+ type?: string;
2544
+ display_name?: string;
2545
+ definition_id?: string;
2546
+ is_deleted?: boolean;
2547
+ created_at?: string;
2548
+ updated_at?: string;
2549
+ fields?: CustomFieldSchema[];
2550
+ };
2551
+ /** @returns {CustomObjectApplicationSchema} */
2552
+ declare function CustomObjectApplicationSchema(): CustomObjectApplicationSchema;
2553
+ type CustomObjectApplicationSchema = {
2554
+ _id?: string;
2555
+ name?: string;
2556
+ creator?: string;
2512
2557
  company_id?: string;
2513
- /**
2514
- * - Identifer for a sales channel
2515
- */
2516
2558
  application_id?: string;
2517
- /**
2518
- * - Status of custom object
2519
- */
2559
+ created_by?: string;
2560
+ updated_by?: string;
2520
2561
  status?: string;
2521
- /**
2522
- * - Slug of custom object definition
2523
- */
2562
+ slug?: string;
2524
2563
  type?: string;
2525
- /**
2526
- * - Slug for custom object definition
2527
- */
2528
- definition_slug?: string;
2529
- /**
2530
- * - Value of custom field used for displaying
2531
- * custom object
2532
- */
2533
2564
  display_name?: string;
2534
- /**
2535
- * - Fields associated to the custom object
2536
- */
2565
+ definition_id?: string;
2566
+ is_deleted?: boolean;
2567
+ created_at?: string;
2568
+ updated_at?: string;
2537
2569
  fields?: CustomFieldSchema[];
2538
2570
  };
2539
2571
  /** @returns {CustomObjectDefinitionRequestSchema} */
2540
2572
  declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
2541
2573
  type CustomObjectDefinitionRequestSchema = {
2542
- /**
2543
- * - Namespace/Slug of Custom object definition
2544
- */
2545
2574
  type?: string;
2546
- /**
2547
- * - Unique slug for a custom object definition
2548
- */
2549
- definition_slug?: string;
2550
- /**
2551
- * - Description of custom object definition
2552
- */
2553
2575
  description?: string;
2554
- /**
2555
- * - Name of custom object
2556
- */
2557
2576
  name?: string;
2558
- /**
2559
- * - Denotes which custom field to be used
2560
- * for displaying custom object
2561
- */
2562
2577
  display_name_key?: string;
2563
- /**
2564
- * - List
2565
- * of custom field definitions belonging to this custom object definition
2566
- */
2567
2578
  field_definitions?: CustomObjectCustomFieldDefinitions[];
2568
2579
  };
2569
- /** @returns {CustomObjectDefinitionSlugSchema} */
2570
- declare function CustomObjectDefinitionSlugSchema(): CustomObjectDefinitionSlugSchema;
2571
- type CustomObjectDefinitionSlugSchema = {
2572
- /**
2573
- * - Unique system generated custom object definition id
2574
- */
2575
- id?: string;
2576
- /**
2577
- * - Display name of custom object definition
2578
- */
2580
+ /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
2581
+ declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
2582
+ type CustomObjectCustomFieldDefinitionResSchema = {
2583
+ creator?: string;
2584
+ resource?: string;
2585
+ name?: string;
2586
+ namespace?: string;
2587
+ key?: string;
2588
+ description?: string;
2589
+ type: string;
2590
+ multi_value?: boolean;
2591
+ validations?: FieldValidations[];
2592
+ company_id?: string;
2593
+ created_by?: string;
2594
+ metaobject_definition_id?: string;
2595
+ required?: boolean;
2596
+ is_deleted?: boolean;
2597
+ _id?: string;
2598
+ created_at?: string;
2599
+ updated_at?: string;
2600
+ application_id?: string;
2601
+ };
2602
+ /** @returns {CustomObjectDefinitionSchema} */
2603
+ declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
2604
+ type CustomObjectDefinitionSchema = {
2605
+ _id?: string;
2579
2606
  name?: string;
2580
- /**
2581
- * - Type of custom object definiton
2582
- */
2583
2607
  type?: string;
2584
- /**
2585
- * - Slug of custom object definiton
2586
- */
2587
- definition_slug?: string;
2588
- /**
2589
- * - Display name of custom object definition
2590
- */
2591
2608
  display_name_key?: string;
2592
- /**
2593
- * - Description of custom object definition
2594
- */
2595
2609
  description?: string;
2596
- /**
2597
- * -
2598
- * Custom fields inside custom objects
2599
- */
2600
- field_definitions?: CustomFieldDefinitionDetailResSchema[];
2610
+ creator?: string;
2611
+ created_by?: string;
2612
+ updated_by?: string;
2613
+ application_id?: string;
2614
+ company_id?: string;
2615
+ created_at?: string;
2616
+ updated_at?: string;
2617
+ field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
2601
2618
  };
2602
2619
  /** @returns {CustomObjectDefinitionDeleteResponseSchema} */
2603
2620
  declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
2604
2621
  type CustomObjectDefinitionDeleteResponseSchema = {
2605
- /**
2606
- * - Success status of delete custom object definition.
2607
- */
2608
2622
  success?: boolean;
2609
- /**
2610
- * - Response message when custom object definition
2611
- * is deleted.
2612
- */
2613
2623
  message?: string;
2614
2624
  };
2615
- /** @returns {CustomObjectEntryBulkUploadDetails} */
2616
- declare function CustomObjectEntryBulkUploadDetails(): CustomObjectEntryBulkUploadDetails;
2617
- type CustomObjectEntryBulkUploadDetails = {
2618
- /**
2619
- * - Signed url of csv
2620
- */
2621
- url?: string;
2622
- /**
2623
- * - Total no of records in csv file
2624
- */
2625
- total_records?: number;
2625
+ /** @returns {CustomObjectEntryBulkUploadResponse} */
2626
+ declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
2627
+ type CustomObjectEntryBulkUploadResponse = {
2628
+ message?: string;
2629
+ task_id?: string;
2626
2630
  };
2627
- /** @returns {CustomObjectListItemDefinitionModel} */
2628
- declare function CustomObjectListItemDefinitionModel(): CustomObjectListItemDefinitionModel;
2629
- type CustomObjectListItemDefinitionModel = {
2630
- /**
2631
- * - Unique system generated id
2632
- */
2633
- id?: string;
2634
- /**
2635
- * - Name of custom object
2636
- */
2631
+ /** @returns {CustomObjectListItemDefinationSchema} */
2632
+ declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
2633
+ type CustomObjectListItemDefinationSchema = {
2634
+ _id?: string;
2637
2635
  name?: string;
2638
- /**
2639
- * - Type of custom object entry
2640
- */
2641
2636
  type?: string;
2637
+ display_name_key?: string;
2642
2638
  };
2643
2639
  /** @returns {CustomObjectListItemSchema} */
2644
2640
  declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
2645
2641
  type CustomObjectListItemSchema = {
2646
- /**
2647
- * - Unique system generated id
2648
- */
2649
- id?: string;
2650
- /**
2651
- * - Status of custom object
2652
- */
2642
+ _id?: string;
2643
+ definition_id?: string;
2653
2644
  status?: string;
2654
- /**
2655
- * - Creation time of custom object document
2656
- */
2657
- created_at?: string;
2658
- /**
2659
- * - Updation time of custom object document
2660
- */
2645
+ slug?: string;
2661
2646
  updated_at?: string;
2662
- /**
2663
- * - Display name of custom object
2664
- */
2665
2647
  display_name?: string;
2666
- definition?: CustomObjectListItemDefinitionModel;
2667
- /**
2668
- * - References of the custom object entry
2669
- */
2648
+ definition?: CustomObjectListItemDefinationSchema;
2670
2649
  references?: number;
2671
2650
  };
2672
2651
  /** @returns {CustomObjectsSchema} */
2673
2652
  declare function CustomObjectsSchema(): CustomObjectsSchema;
2674
2653
  type CustomObjectsSchema = {
2675
- /**
2676
- * - List of paginated custom
2677
- * object entries
2678
- */
2679
2654
  items?: CustomObjectListItemSchema[];
2680
2655
  page?: Page;
2681
2656
  };
2682
- /** @returns {CustomObjectFieldDefinition} */
2683
- declare function CustomObjectFieldDefinition(): CustomObjectFieldDefinition;
2684
- type CustomObjectFieldDefinition = {
2685
- /**
2686
- * - Unique system generate id
2687
- */
2688
- id?: string;
2689
- /**
2690
- * - Slug of custom field definition
2691
- */
2692
- slug?: string;
2693
- /**
2694
- * - Namespace of custom field definition
2695
- */
2696
- namespace?: string;
2697
- /**
2698
- * - Value of custom field
2699
- */
2700
- value?: any[];
2701
- /**
2702
- * - Data type of the custom field
2703
- */
2657
+ /** @returns {CustomObjectFieldSchema} */
2658
+ declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
2659
+ type CustomObjectFieldSchema = {
2660
+ _id?: string;
2661
+ key?: string;
2704
2662
  type?: string;
2663
+ definition_id?: string;
2705
2664
  };
2706
- /** @returns {CustomObjectBySlugSchema} */
2707
- declare function CustomObjectBySlugSchema(): CustomObjectBySlugSchema;
2708
- type CustomObjectBySlugSchema = {
2709
- /**
2710
- * - Unique system generated identifer for a Custom Object
2711
- */
2712
- id?: string;
2713
- /**
2714
- * - Status of Custom Object
2715
- */
2665
+ /** @returns {MetafieldTypesSchema} */
2666
+ declare function MetafieldTypesSchema(): MetafieldTypesSchema;
2667
+ type MetafieldTypesSchema = {
2668
+ metafield_types?: CustomFieldTypeSchema;
2669
+ };
2670
+ /** @returns {CustomObjectByIdSchema} */
2671
+ declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
2672
+ type CustomObjectByIdSchema = {
2673
+ _id?: string;
2716
2674
  status?: string;
2717
- /**
2718
- * - Display name for the Custom Object
2719
- */
2675
+ slug?: string;
2720
2676
  display_name?: string;
2721
- definition?: CustomObjectListItemDefinitionModel;
2722
- /**
2723
- * - Places where the custom object has been
2724
- * used as a custom field
2725
- */
2677
+ definition?: CustomObjectListItemDefinationSchema;
2726
2678
  references?: any[];
2727
- /**
2728
- * - Slug of custom object entry
2729
- */
2730
- slug?: string;
2731
- /**
2732
- * - Slug of custom object definition
2733
- */
2734
- definition_slug?: string;
2735
- /**
2736
- * - List of custom fields
2737
- * inside the custom object
2738
- */
2739
- fields?: CustomObjectFieldDefinition[];
2679
+ fields?: CustomObjectFieldSchema[];
2740
2680
  };
2741
2681
  /** @returns {CustomObjectBulkEntryInitiateDownload} */
2742
2682
  declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
2743
2683
  type CustomObjectBulkEntryInitiateDownload = {
2744
- /**
2745
- * - Message for the user
2746
- */
2747
2684
  message?: string;
2748
- /**
2749
- * - Identifer for a task
2750
- */
2751
2685
  task_id?: string;
2752
2686
  };
2753
2687
  /** @returns {CustomObjectMetaSchema} */
2754
2688
  declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
2755
2689
  type CustomObjectMetaSchema = {
2756
- /**
2757
- * - Total number of entries in the bulk entry
2758
- */
2759
2690
  mo_total_count?: number;
2760
- /**
2761
- * - Number of entries which were successful
2762
- */
2763
2691
  mo_success_count?: number;
2764
- /**
2765
- * - Number of entries which were failed
2766
- */
2767
2692
  mo_error_count?: number;
2768
- /**
2769
- * - Type of object
2770
- */
2771
2693
  mo_defintion_type?: string;
2772
2694
  };
2773
2695
  /** @returns {JobSchema} */
2774
2696
  declare function JobSchema(): JobSchema;
2775
2697
  type JobSchema = {
2776
- /**
2777
- * - Unique system generated id
2778
- */
2779
- id?: string;
2780
- /**
2781
- * - List of total jobs
2782
- */
2698
+ _id?: string;
2783
2699
  jobs?: string[];
2784
- /**
2785
- * - List of finished jobs
2786
- */
2787
2700
  finished_jobs?: string[];
2788
- /**
2789
- * - List of jobs which resulted in an error
2790
- */
2791
2701
  error_jobs?: string[];
2792
- /**
2793
- * - List of errors occurred in the job
2794
- */
2795
2702
  errors_occured?: string[];
2796
- /**
2797
- * - Company Identifer
2798
- */
2799
2703
  company_id?: string;
2800
- /**
2801
- * - Status of job
2802
- */
2704
+ creator?: string;
2803
2705
  status?: string;
2804
- /**
2805
- * - Type of job
2806
- */
2807
2706
  action_type?: string;
2808
- /**
2809
- * - Entity against which job is running
2810
- */
2811
2707
  entity?: string;
2812
- /**
2813
- * - URL which contains the file with errors
2814
- */
2815
2708
  error_url?: string;
2816
- /**
2817
- * - Number of items successfully finished
2818
- */
2819
2709
  finished_count?: number;
2820
- /**
2821
- * - Number of items in error
2822
- */
2823
2710
  error_count?: number;
2824
- /**
2825
- * - Number of successful items
2826
- */
2827
2711
  success_count?: number;
2828
- /**
2829
- * - Total number of jobs
2830
- */
2831
2712
  total_jobs?: number;
2832
2713
  meta?: CustomObjectMetaSchema;
2833
- /**
2834
- * - Source from where the bulk job is created
2835
- */
2836
2714
  created_by?: string;
2837
- /**
2838
- * - Date/Time when the job was created
2839
- */
2840
2715
  created_at?: string;
2841
- /**
2842
- * - Date/Time when the job was updated
2843
- */
2844
2716
  updated_at?: string;
2845
- /**
2846
- * - Sales Channel Identifier
2847
- */
2848
2717
  application_id?: string;
2849
2718
  };
2850
2719
  /** @returns {CustomFieldBulkEntry} */
@@ -2859,11 +2728,6 @@ type CustomObjectBulkEntry = {
2859
2728
  items?: JobSchema[];
2860
2729
  page?: Page;
2861
2730
  };
2862
- /** @returns {MetafieldTypesSchema} */
2863
- declare function MetafieldTypesSchema(): MetafieldTypesSchema;
2864
- type MetafieldTypesSchema = {
2865
- metafield_types?: CustomFieldTypeSchema;
2866
- };
2867
2731
  /** @returns {CustomFieldTypeSchema} */
2868
2732
  declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
2869
2733
  type CustomFieldTypeSchema = {
@@ -2883,17 +2747,6 @@ type CustomFieldTypeSchema = {
2883
2747
  html?: HTML;
2884
2748
  duration?: Duration;
2885
2749
  };
2886
- /** @returns {SupportedValidationsMetaExampleSchema} */
2887
- declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
2888
- type SupportedValidationsMetaExampleSchema = {
2889
- name?: string;
2890
- value?: string;
2891
- };
2892
- /** @returns {SupportedValidationsMetaSchema} */
2893
- declare function SupportedValidationsMetaSchema(): SupportedValidationsMetaSchema;
2894
- type SupportedValidationsMetaSchema = {
2895
- examples?: SupportedValidationsMetaExampleSchema[];
2896
- };
2897
2750
  /** @returns {SupportedValidationsSchema} */
2898
2751
  declare function SupportedValidationsSchema(): SupportedValidationsSchema;
2899
2752
  type SupportedValidationsSchema = {
@@ -2901,394 +2754,149 @@ type SupportedValidationsSchema = {
2901
2754
  type?: string;
2902
2755
  display?: string;
2903
2756
  required?: boolean;
2904
- meta?: SupportedValidationsMetaSchema;
2905
2757
  };
2906
2758
  /** @returns {Duration} */
2907
2759
  declare function Duration(): Duration;
2908
2760
  type Duration = {
2909
- /**
2910
- * - Name data type of custom field
2911
- */
2912
2761
  name?: string;
2913
- /**
2914
- * - Flag for listing enabled or not
2915
- */
2916
2762
  list_enabled?: boolean;
2917
- /**
2918
- * - Type of custom field
2919
- */
2920
2763
  type?: string;
2921
- /**
2922
- * - Category of custom field
2923
- */
2924
2764
  category?: string;
2925
- /**
2926
- * - List of
2927
- * validations available for the field
2928
- */
2929
2765
  supported_validations?: SupportedValidationsSchema[];
2930
2766
  };
2931
2767
  /** @returns {HTML} */
2932
2768
  declare function HTML(): HTML;
2933
2769
  type HTML = {
2934
- /**
2935
- * - Name data type of custom field
2936
- */
2937
2770
  name?: string;
2938
- /**
2939
- * - Flag for listing enabled or not
2940
- */
2941
2771
  list_enabled?: boolean;
2942
- /**
2943
- * - Type of custom field
2944
- */
2945
2772
  type?: string;
2946
- /**
2947
- * - List of
2948
- * validations available for the field
2949
- */
2950
2773
  supported_validations?: SupportedValidationsSchema[];
2951
2774
  };
2952
2775
  /** @returns {StringSingleLine} */
2953
2776
  declare function StringSingleLine(): StringSingleLine;
2954
2777
  type StringSingleLine = {
2955
- /**
2956
- * - Name data type of custom field
2957
- */
2958
2778
  name?: string;
2959
- /**
2960
- * - Flag for listing enabled or not
2961
- */
2962
2779
  list_enabled?: boolean;
2963
- /**
2964
- * - Category of custom field
2965
- */
2966
2780
  category?: string;
2967
- /**
2968
- * - Type of custom field
2969
- */
2970
2781
  type?: string;
2971
- /**
2972
- * - List of
2973
- * validations available for the field
2974
- */
2975
2782
  supported_validations?: SupportedValidationsSchema[];
2976
2783
  };
2977
2784
  /** @returns {StringMultiLine} */
2978
2785
  declare function StringMultiLine(): StringMultiLine;
2979
2786
  type StringMultiLine = {
2980
- /**
2981
- * - Name data type of custom field
2982
- */
2983
2787
  name?: string;
2984
- /**
2985
- * - Flag for listing enabled or not
2986
- */
2987
2788
  list_enabled?: boolean;
2988
- /**
2989
- * - Category of custom field
2990
- */
2991
2789
  category?: string;
2992
- /**
2993
- * - Type of custom field
2994
- */
2995
2790
  type?: string;
2996
- /**
2997
- * - List of
2998
- * validations available for the field
2999
- */
3000
2791
  supported_validations?: SupportedValidationsSchema[];
3001
2792
  };
3002
2793
  /** @returns {Dropdown} */
3003
2794
  declare function Dropdown(): Dropdown;
3004
2795
  type Dropdown = {
3005
- /**
3006
- * - Name data type of custom field
3007
- */
3008
2796
  name?: string;
3009
- /**
3010
- * - Flag for listing enabled or not
3011
- */
3012
2797
  list_enabled?: boolean;
3013
- /**
3014
- * - Category of custom field
3015
- */
3016
2798
  category?: string;
3017
- /**
3018
- * - Category of custom field
3019
- */
3020
2799
  type?: string;
3021
- /**
3022
- * - List of
3023
- * validations available for the field
3024
- */
3025
2800
  supported_validations?: SupportedValidationsSchema[];
3026
2801
  };
3027
2802
  /** @returns {Integer} */
3028
2803
  declare function Integer(): Integer;
3029
2804
  type Integer = {
3030
- /**
3031
- * - Name data type of custom field
3032
- */
3033
2805
  name?: string;
3034
- /**
3035
- * - Flag for listing enabled or not
3036
- */
3037
2806
  list_enabled?: boolean;
3038
- /**
3039
- * - Type of custom field
3040
- */
3041
2807
  type?: string;
3042
- /**
3043
- * - Category of custom field
3044
- */
3045
2808
  category?: string;
3046
- /**
3047
- * - List of
3048
- * validations available for the field
3049
- */
3050
2809
  supported_validations?: SupportedValidationsSchema[];
3051
2810
  };
3052
2811
  /** @returns {FloatType} */
3053
2812
  declare function FloatType(): FloatType;
3054
2813
  type FloatType = {
3055
- /**
3056
- * - Name data type of custom field
3057
- */
3058
2814
  name?: string;
3059
- /**
3060
- * - Flag for listing enabled or not
3061
- */
3062
2815
  list_enabled?: boolean;
3063
- /**
3064
- * - Type of custom field
3065
- */
3066
2816
  type?: string;
3067
- /**
3068
- * - Category of custom field
3069
- */
3070
2817
  category?: string;
3071
- /**
3072
- * - List of
3073
- * validations available for the field
3074
- */
3075
2818
  supported_validations?: SupportedValidationsSchema[];
3076
2819
  };
3077
2820
  /** @returns {BooleanType} */
3078
2821
  declare function BooleanType(): BooleanType;
3079
2822
  type BooleanType = {
3080
- /**
3081
- * - Name data type of custom field
3082
- */
3083
2823
  name?: string;
3084
- /**
3085
- * - Category of custom field
3086
- */
3087
2824
  category?: string;
3088
- /**
3089
- * - Flag for listing enabled or not
3090
- */
3091
2825
  list_enabled?: boolean;
3092
- /**
3093
- * - Category of custom field
3094
- */
3095
2826
  type?: string;
3096
- /**
3097
- * - List of
3098
- * validations available for the field
3099
- */
3100
2827
  supported_validations?: SupportedValidationsSchema[];
3101
2828
  };
3102
2829
  /** @returns {Date} */
3103
2830
  declare function Date(): Date;
3104
2831
  type Date = {
3105
- /**
3106
- * - Name data type of custom field
3107
- */
3108
2832
  name?: string;
3109
- /**
3110
- * - Flag for listing enabled or not
3111
- */
3112
2833
  list_enabled?: boolean;
3113
- /**
3114
- * - Category of custom field
3115
- */
3116
2834
  category?: string;
3117
- /**
3118
- * - Type of custom field
3119
- */
3120
2835
  type?: string;
3121
- /**
3122
- * - List of
3123
- * validations available for the field
3124
- */
3125
2836
  supported_validations?: SupportedValidationsSchema[];
3126
2837
  };
3127
2838
  /** @returns {Datetime} */
3128
2839
  declare function Datetime(): Datetime;
3129
2840
  type Datetime = {
3130
- /**
3131
- * - Name data type of custom field
3132
- */
3133
2841
  name?: string;
3134
- /**
3135
- * - Category of custom field
3136
- */
3137
2842
  category?: string;
3138
- /**
3139
- * - Flag for listing enabled or not
3140
- */
3141
2843
  list_enabled?: boolean;
3142
- /**
3143
- * - Type of custom field
3144
- */
3145
2844
  type?: string;
3146
- /**
3147
- * - List of
3148
- * validations available for the field
3149
- */
3150
2845
  supported_validations?: SupportedValidationsSchema[];
3151
2846
  };
3152
2847
  /** @returns {Json} */
3153
2848
  declare function Json(): Json;
3154
2849
  type Json = {
3155
- /**
3156
- * - Name data type of custom field
3157
- */
3158
2850
  name?: string;
3159
- /**
3160
- * - Flag for listing enabled or not
3161
- */
3162
2851
  list_enabled?: boolean;
3163
- /**
3164
- * - Category of custom field
3165
- */
3166
2852
  category?: string;
3167
- /**
3168
- * - Type of custom field
3169
- */
3170
2853
  type?: string;
3171
- /**
3172
- * - List of
3173
- * validations available for the field
3174
- */
3175
2854
  supported_validations?: SupportedValidationsSchema[];
3176
2855
  };
3177
2856
  /** @returns {File} */
3178
2857
  declare function File(): File;
3179
2858
  type File = {
3180
- /**
3181
- * - Name data type of custom field
3182
- */
3183
2859
  name?: string;
3184
- /**
3185
- * - Category of custom field
3186
- */
3187
2860
  category?: string;
3188
- /**
3189
- * - Flag for listing enabled or not
3190
- */
3191
2861
  list_enabled?: boolean;
3192
- /**
3193
- * - Type of custom field
3194
- */
3195
2862
  type?: string;
3196
2863
  supported_validations?: SupportedValidationsSchema[];
3197
2864
  };
3198
2865
  /** @returns {Url} */
3199
2866
  declare function Url(): Url;
3200
2867
  type Url = {
3201
- /**
3202
- * - Name data type of custom field
3203
- */
3204
2868
  name?: string;
3205
- /**
3206
- * - Flag for listing enabled or not
3207
- */
3208
2869
  list_enabled?: boolean;
3209
- /**
3210
- * - Type of custom field
3211
- */
3212
2870
  type?: string;
3213
- /**
3214
- * - List of
3215
- * validations available for the field
3216
- */
3217
2871
  supported_validations?: SupportedValidationsSchema[];
3218
2872
  };
3219
2873
  /** @returns {Metaobject} */
3220
2874
  declare function Metaobject(): Metaobject;
3221
2875
  type Metaobject = {
3222
- /**
3223
- * - Name of Custom Object
3224
- */
3225
2876
  name?: string;
3226
- /**
3227
- * - Whether the field is allowed to have
3228
- * multiple list items
3229
- */
3230
2877
  list_enabled?: boolean;
3231
- /**
3232
- * - Category of Custom Object Definition that
3233
- * Custom Object belongs to
3234
- */
3235
2878
  category?: string;
3236
- /**
3237
- * - Type of Custom Object Definition
3238
- */
3239
2879
  type?: string;
3240
2880
  supported_validations?: SupportedValidationsSchema[];
3241
2881
  };
3242
2882
  /** @returns {Product} */
3243
2883
  declare function Product(): Product;
3244
2884
  type Product = {
3245
- /**
3246
- * - Name of Product
3247
- */
3248
2885
  name?: string;
3249
- /**
3250
- * - Whether the field is allowed to have
3251
- * multiple list items
3252
- */
3253
2886
  list_enabled?: boolean;
3254
- /**
3255
- * - Category of Custom Object Definition that
3256
- * Product is associated with
3257
- */
3258
2887
  category?: string;
3259
- /**
3260
- * - Custom Object Definition that Product is associated with
3261
- */
3262
2888
  type?: string;
3263
2889
  supported_validations?: SupportedValidationsSchema[];
2890
+ scope?: string[];
3264
2891
  };
3265
2892
  /** @returns {CustomObjectEntry} */
3266
2893
  declare function CustomObjectEntry(): CustomObjectEntry;
3267
2894
  type CustomObjectEntry = {
3268
- /**
3269
- * - Unique system generated id
3270
- */
3271
- id?: string;
3272
- /**
3273
- * - Name of Custom Object definition
3274
- */
2895
+ _id?: string;
3275
2896
  name?: string;
3276
- /**
3277
- * - Type of Custom Object Definition
3278
- */
3279
2897
  type?: string;
3280
- /**
3281
- * - Updation time of a Custom Object
3282
- */
3283
2898
  updated_at?: string;
3284
- /**
3285
- * - Number of entries against the Custom
3286
- * Object definition
3287
- */
3288
2899
  entries_count?: number;
3289
- /**
3290
- * - Number of fields against a Custom Object definition
3291
- */
3292
2900
  fields_count?: number;
3293
2901
  };
3294
2902
  /** @returns {CustomObjectDefinitionsSchema} */
@@ -3300,65 +2908,20 @@ type CustomObjectDefinitionsSchema = {
3300
2908
  /** @returns {CustomObjectEntryFieldSchema} */
3301
2909
  declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
3302
2910
  type CustomObjectEntryFieldSchema = {
3303
- /**
3304
- * - This is namespace for a custom field definition
3305
- */
3306
- namespace?: string;
3307
- /**
3308
- * - This is slug for a custom field definition
3309
- */
3310
- slug?: string;
3311
- };
3312
- /** @returns {CustomObjectEntryFieldSchemaWithoutID} */
3313
- declare function CustomObjectEntryFieldSchemaWithoutID(): CustomObjectEntryFieldSchemaWithoutID;
3314
- type CustomObjectEntryFieldSchemaWithoutID = {
3315
- /**
3316
- * - Custom fields belonging to a custom object
3317
- */
3318
- slug?: string;
3319
- /**
3320
- * - Value of custom field inside a custom object
3321
- */
3322
- value?: any;
2911
+ definition_id?: string;
3323
2912
  };
3324
2913
  /** @returns {CustomObjectRequestSchema} */
3325
2914
  declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
3326
2915
  type CustomObjectRequestSchema = {
3327
- /**
3328
- * - Flag to denote status of Custom Object
3329
- */
3330
2916
  status?: string;
3331
- /**
3332
- * - This is slug for a custom field definition
3333
- */
3334
2917
  slug?: string;
3335
- /**
3336
- * - List of custom fields
3337
- */
2918
+ definition_id?: string;
3338
2919
  fields?: CustomObjectEntryFieldSchema[];
3339
2920
  };
3340
- /** @returns {CustomObjectRequestSchemaWithoutId} */
3341
- declare function CustomObjectRequestSchemaWithoutId(): CustomObjectRequestSchemaWithoutId;
3342
- type CustomObjectRequestSchemaWithoutId = {
3343
- /**
3344
- * - Status of the custom object entry.
3345
- */
3346
- status?: string;
3347
- /**
3348
- * - List of custom fields
3349
- */
3350
- fields?: CustomObjectEntryFieldSchemaWithoutID[];
3351
- };
3352
2921
  /** @returns {CustomObjectBulkSchema} */
3353
2922
  declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
3354
2923
  type CustomObjectBulkSchema = {
3355
- /**
3356
- * - Full URL for the bulk operations data
3357
- */
3358
2924
  url?: string;
3359
- /**
3360
- * - Total records in the upload.
3361
- */
3362
2925
  total_records?: number;
3363
2926
  };
3364
2927
  /** @returns {ActionPage} */
@@ -3378,13 +2941,6 @@ type ActionPage = {
3378
2941
  url?: string;
3379
2942
  type: PageType;
3380
2943
  };
3381
- /**
3382
- * Enum: GenerationEntityType Used By: Content
3383
- *
3384
- * @returns {GenerationEntityType}
3385
- */
3386
- declare function GenerationEntityType(): GenerationEntityType;
3387
- type GenerationEntityType = "title" | "description";
3388
2944
  /**
3389
2945
  * Enum: PageType Used By: Content
3390
2946
  *