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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (265) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -2
  3. package/sdk/application/ApplicationClient.js +20 -0
  4. package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.js +3 -5
  6. package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
  7. package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
  8. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
  9. package/sdk/application/Cart/CartApplicationValidator.js +0 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
  12. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  13. package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
  14. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
  16. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  17. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  18. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  19. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
  22. package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
  23. package/sdk/application/Content/ContentApplicationClient.js +0 -246
  24. package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
  25. package/sdk/application/Content/ContentApplicationModel.js +565 -817
  26. package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
  27. package/sdk/application/Content/ContentApplicationValidator.js +0 -41
  28. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  29. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  30. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  31. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  32. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
  33. package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
  34. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
  35. package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
  36. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
  37. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
  38. package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
  39. package/sdk/application/Order/OrderApplicationClient.js +8 -32
  40. package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
  41. package/sdk/application/Order/OrderApplicationModel.js +816 -824
  42. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
  43. package/sdk/application/Order/OrderApplicationValidator.js +0 -8
  44. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
  45. package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
  46. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
  47. package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
  48. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
  49. package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
  50. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
  51. package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
  52. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  53. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  54. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  55. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  56. package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
  57. package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
  58. package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
  59. package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
  60. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
  62. package/sdk/application/User/UserApplicationClient.d.ts +0 -33
  63. package/sdk/application/User/UserApplicationClient.js +0 -239
  64. package/sdk/application/User/UserApplicationModel.d.ts +753 -768
  65. package/sdk/application/User/UserApplicationModel.js +731 -755
  66. package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
  67. package/sdk/application/User/UserApplicationValidator.js +0 -36
  68. package/sdk/common/Clickstream.d.ts +1 -0
  69. package/sdk/common/Clickstream.js +254 -0
  70. package/sdk/common/Utility.js +1 -4
  71. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
  72. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
  73. package/sdk/partner/PartnerClient.d.ts +0 -6
  74. package/sdk/partner/PartnerClient.js +0 -9
  75. package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
  76. package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
  77. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
  78. package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
  79. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
  80. package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
  81. package/sdk/partner/index.d.ts +0 -3
  82. package/sdk/partner/index.js +0 -6
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  86. package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
  87. package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
  88. package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
  89. package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
  90. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
  91. package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
  92. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
  94. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
  96. package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
  97. package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
  98. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
  108. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  109. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
  112. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
  114. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
  115. package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
  121. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
  124. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
  125. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
  126. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
  127. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
  128. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
  129. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
  130. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
  131. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
  132. package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
  133. package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
  134. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
  137. package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
  141. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
  145. package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
  147. package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
  148. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
  149. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
  150. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  151. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  152. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
  153. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
  154. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
  155. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
  156. package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
  157. package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
  159. package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  161. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  162. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
  163. package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
  164. package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
  165. package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
  166. package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
  167. package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
  168. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  169. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  170. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
  172. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
  174. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
  175. package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
  176. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
  177. package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
  178. package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
  179. package/sdk/platform/PlatformApplicationClient.js +4 -4
  180. package/sdk/platform/PlatformClient.d.ts +2 -4
  181. package/sdk/platform/PlatformClient.js +4 -8
  182. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  183. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +989 -1588
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +977 -1695
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  195. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  196. package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
  197. package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
  198. package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
  199. package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
  200. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
  201. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
  206. package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
  207. package/sdk/platform/User/UserPlatformModel.js +428 -679
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
  214. package/sdk/platform/index.d.ts +1 -1
  215. package/sdk/platform/index.js +2 -2
  216. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  217. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  218. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  219. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  220. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  221. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  222. package/sdk/public/PublicClient.d.ts +0 -4
  223. package/sdk/public/PublicClient.js +0 -8
  224. package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
  225. package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
  226. package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
  227. package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
  228. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
  229. package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
  230. package/sdk/public/index.d.ts +0 -2
  231. package/sdk/public/index.js +0 -4
  232. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
  233. package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
  234. package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
  235. package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
  236. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
  237. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
  238. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
  239. package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
  240. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
  241. package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
  242. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
  243. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
  244. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
  245. package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
  246. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
  247. package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
  248. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
  249. package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
  250. package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
  251. package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
  252. package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
  253. package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
  254. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
  255. package/sdk/public/Billing/BillingPublicClient.js +0 -116
  256. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
  257. package/sdk/public/Billing/BillingPublicModel.js +0 -96
  258. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
  259. package/sdk/public/Billing/BillingPublicValidator.js +0 -19
  260. package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
  261. package/sdk/public/Content/ContentPublicClient.js +0 -114
  262. package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
  263. package/sdk/public/Content/ContentPublicModel.js +0 -60
  264. package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
  265. package/sdk/public/Content/ContentPublicValidator.js +0 -19
@@ -1,35 +1,75 @@
1
1
  export = ContentPlatformModel;
2
2
  /**
3
- * @typedef Action
4
- * @property {ActionPage} [page]
5
- * @property {ActionPage} [popup]
3
+ * @typedef GenerateSEOContent
4
+ * @property {string} [text]
5
+ * @property {string} [existing_text]
6
+ * @property {string[]} [keywords]
6
7
  * @property {string} [type]
7
8
  */
8
9
  /**
9
- * @typedef ActionPage
10
- * @property {Object} [params]
11
- * @property {Object} [query]
12
- * @property {PageType} type
13
- * @property {string} [url]
10
+ * @typedef GeneratedSEOContent
11
+ * @property {string} [title]
12
+ * @property {string} [description]
14
13
  */
15
14
  /**
16
- * @typedef AdminAnnouncementSchema
15
+ * @typedef ApplicationLegal
16
+ * @property {string} [application]
17
+ * @property {string} [tnc]
18
+ * @property {string} [policy]
19
+ * @property {string} [shipping]
20
+ * @property {string} [returns]
21
+ * @property {ApplicationLegalFAQ[]} [faq]
17
22
  * @property {string} [_id]
18
- * @property {ScheduleSchema} [_schedule]
19
- * @property {string} [announcement]
23
+ * @property {string} [updated_at]
24
+ * @property {string} [created_at]
25
+ */
26
+ /**
27
+ * @typedef ApplicationLegalFAQ
28
+ * @property {string} [question]
29
+ * @property {string} [answer]
30
+ */
31
+ /**
32
+ * @typedef PathMappingSchema
33
+ * @property {string} [application]
34
+ * @property {string} [_id]
35
+ * @property {string} [redirect_from]
36
+ * @property {string} [redirect_to]
37
+ * @property {string} [updated_at]
38
+ * @property {string} [created_at]
39
+ * @property {PathSourceSchema} [__source]
40
+ */
41
+ /**
42
+ * @typedef PathSourceSchema
43
+ * @property {string} [type]
44
+ * @property {string} [id]
45
+ */
46
+ /**
47
+ * @typedef SeoComponent
48
+ * @property {SeoSchema} [seo]
49
+ */
50
+ /**
51
+ * @typedef SeoSchema
20
52
  * @property {string} [app]
21
- * @property {AnnouncementAuthorSchema} [author]
53
+ * @property {string} [_id]
54
+ * @property {string} [robots_txt]
55
+ * @property {boolean} [sitemap_enabled]
56
+ * @property {boolean} [cannonical_enabled]
57
+ * @property {CustomMetaTag[]} [custom_meta_tags]
58
+ * @property {Detail} [details]
22
59
  * @property {string} [created_at]
23
- * @property {EditorMeta} [editor_meta]
24
- * @property {string} [modified_at]
25
- * @property {AnnouncementPageSchema[]} [pages]
26
- * @property {string[]} [platforms]
27
- * @property {string} [title]
60
+ * @property {string} [updated_at]
28
61
  */
29
62
  /**
30
- * @typedef AnnouncementAuthorSchema
31
- * @property {string} [created_by]
32
- * @property {string} [modified_by]
63
+ * @typedef CustomMetaTag
64
+ * @property {string} [name]
65
+ * @property {string} [content]
66
+ * @property {string} [_id]
67
+ */
68
+ /**
69
+ * @typedef Detail
70
+ * @property {string} [title]
71
+ * @property {string} [description]
72
+ * @property {string} [image_url]
33
73
  */
34
74
  /**
35
75
  * @typedef AnnouncementPageSchema
@@ -37,21 +77,53 @@ export = ContentPlatformModel;
37
77
  * @property {string} [type]
38
78
  */
39
79
  /**
40
- * @typedef ApplicationLegal
80
+ * @typedef EditorMeta
81
+ * @property {string} [foreground_color]
82
+ * @property {string} [background_color]
83
+ * @property {string} [content_type]
84
+ * @property {string} [content]
85
+ */
86
+ /**
87
+ * @typedef AnnouncementAuthorSchema
88
+ * @property {string} [created_by]
89
+ * @property {string} [modified_by]
90
+ */
91
+ /**
92
+ * @typedef AdminAnnouncementSchema
41
93
  * @property {string} [_id]
42
- * @property {string} [application]
94
+ * @property {string[]} [platforms]
95
+ * @property {string} [title]
96
+ * @property {string} [announcement]
97
+ * @property {AnnouncementPageSchema[]} [pages]
98
+ * @property {EditorMeta} [editor_meta]
99
+ * @property {AnnouncementAuthorSchema} [author]
43
100
  * @property {string} [created_at]
44
- * @property {ApplicationLegalFAQ[]} [faq]
45
- * @property {string} [policy]
46
- * @property {string} [returns]
47
- * @property {string} [shipping]
48
- * @property {string} [tnc]
49
- * @property {string} [updated_at]
101
+ * @property {string} [app]
102
+ * @property {string} [modified_at]
103
+ * @property {ScheduleSchema} [_schedule]
50
104
  */
51
105
  /**
52
- * @typedef ApplicationLegalFAQ
53
- * @property {string} [answer]
54
- * @property {string} [question]
106
+ * @typedef ScheduleSchema
107
+ * @property {string} [cron]
108
+ * @property {string} [start]
109
+ * @property {string} [end]
110
+ * @property {number} [duration]
111
+ * @property {NextSchedule[]} [next_schedule]
112
+ */
113
+ /**
114
+ * @typedef NextSchedule
115
+ * @property {string} [start]
116
+ * @property {string} [end]
117
+ */
118
+ /**
119
+ * @typedef BlogGetResponse
120
+ * @property {BlogSchema[]} [items]
121
+ * @property {Page} [page]
122
+ */
123
+ /**
124
+ * @typedef ResourceContent
125
+ * @property {string} [type]
126
+ * @property {string} [value]
55
127
  */
56
128
  /**
57
129
  * @typedef Asset
@@ -66,1109 +138,523 @@ export = ContentPlatformModel;
66
138
  * @property {string} [name]
67
139
  */
68
140
  /**
69
- * @typedef BlogGetResponse
70
- * @property {BlogSchema[]} [items]
71
- * @property {Page} [page]
72
- */
73
- /**
74
- * @typedef BlogRequest
141
+ * @typedef BlogSchema
142
+ * @property {string} [_id]
75
143
  * @property {Object} [_custom_json]
76
- * @property {CronSchedule} [_schedule]
77
144
  * @property {string} [application]
145
+ * @property {boolean} [archived]
78
146
  * @property {Author} [author]
79
147
  * @property {ResourceContent[]} [content]
80
148
  * @property {Asset} [feature_image]
81
149
  * @property {boolean} [published]
82
150
  * @property {string} [reading_time]
83
- * @property {SEO} [seo]
84
151
  * @property {string} [slug]
85
152
  * @property {string[]} [tags]
153
+ * @property {SEO} [seo]
154
+ * @property {CronSchedule} [_schedule]
86
155
  * @property {string} [title]
156
+ * @property {DateMeta} [date_meta]
87
157
  */
88
158
  /**
89
- * @typedef BlogSchema
90
- * @property {Object} [_custom_json]
91
- * @property {string} [_id]
92
- * @property {CronSchedule} [_schedule]
159
+ * @typedef SEO
160
+ * @property {string} [description]
161
+ * @property {SEOImage} [image]
162
+ * @property {string} [title]
163
+ */
164
+ /**
165
+ * @typedef SEOImage
166
+ * @property {string} [url]
167
+ */
168
+ /**
169
+ * @typedef DateMeta
170
+ * @property {string} [created_on]
171
+ * @property {string} [modified_on]
172
+ */
173
+ /**
174
+ * @typedef BlogRequest
93
175
  * @property {string} [application]
94
- * @property {boolean} [archived]
176
+ * @property {Object} [_custom_json]
95
177
  * @property {Author} [author]
96
178
  * @property {ResourceContent[]} [content]
97
- * @property {DateMeta} [date_meta]
98
179
  * @property {Asset} [feature_image]
99
180
  * @property {boolean} [published]
100
181
  * @property {string} [reading_time]
101
- * @property {SEO} [seo]
102
182
  * @property {string} [slug]
103
183
  * @property {string[]} [tags]
104
184
  * @property {string} [title]
185
+ * @property {SEO} [seo]
186
+ * @property {CronSchedule} [_schedule]
105
187
  */
106
188
  /**
107
- * @typedef BooleanType
108
- * @property {string} [category]
109
- * @property {boolean} [list_enabled]
110
- * @property {string} [name]
111
- * @property {SupportedValidationsSchema[]} [supported_validations]
112
- * @property {string} [type]
189
+ * @typedef GetAnnouncementListSchema
190
+ * @property {AdminAnnouncementSchema[]} [items]
191
+ * @property {Page} [page]
113
192
  */
114
193
  /**
115
- * @typedef CategoryRequestSchema
116
- * @property {string} [slug]
117
- * @property {string} [title]
194
+ * @typedef CreateAnnouncementSchema
195
+ * @property {string} [message]
196
+ * @property {AdminAnnouncementSchema} [data]
118
197
  */
119
198
  /**
120
- * @typedef CategorySchema
121
- * @property {Object} [_custom_json]
122
- * @property {string} [_id]
199
+ * @typedef DataLoaderResponseSchema
123
200
  * @property {string} [application]
124
- * @property {string[]} [children]
125
- * @property {string} [description]
126
- * @property {string} [icon_url]
127
- * @property {number} [index]
128
- * @property {string} [slug]
129
- * @property {string} [title]
130
- */
131
- /**
132
- * @typedef ChildrenSchema
201
+ * @property {string} [company]
133
202
  * @property {string} [_id]
134
- * @property {string} [answer]
135
- * @property {string} [application]
136
- * @property {string} [question]
137
- * @property {string} [slug]
138
- */
139
- /**
140
- * @typedef CommonError
141
- * @property {string} [message]
203
+ * @property {string} [name]
204
+ * @property {string} [service]
205
+ * @property {string} [operation_id]
206
+ * @property {string} [type]
207
+ * @property {string} [url]
208
+ * @property {string} [content]
209
+ * @property {DataLoaderSourceSchema} [__source]
142
210
  */
143
211
  /**
144
- * @typedef ConfigurationSchema
145
- * @property {number} [duration]
146
- * @property {number} [sleep_time]
147
- * @property {string} [slide_direction]
148
- * @property {boolean} [start_on_launch]
212
+ * @typedef DataLoaderResetResponseSchema
213
+ * @property {boolean} [reset]
149
214
  */
150
215
  /**
151
- * @typedef ContactSchema
152
- * @property {EmailSchema} [email]
153
- * @property {PhoneSchema} [phone]
216
+ * @typedef LocaleLanguage
217
+ * @property {Language} [hi]
218
+ * @property {Language} [ar]
219
+ * @property {Language} [en_us]
154
220
  */
155
221
  /**
156
- * @typedef ContentAPIError
157
- * @property {string} [code]
158
- * @property {string} [exception]
159
- * @property {string} [info]
160
- * @property {string} [message]
161
- * @property {Object} [meta]
162
- * @property {string} [request_id]
163
- * @property {string} [stack_trace]
164
- * @property {number} [status]
222
+ * @typedef Language
223
+ * @property {string} [display]
165
224
  */
166
225
  /**
167
- * @typedef CreateAnnouncementSchema
168
- * @property {AdminAnnouncementSchema} [data]
169
- * @property {string} [message]
226
+ * @typedef Action
227
+ * @property {ActionPage} [page]
228
+ * @property {ActionPage} [popup]
229
+ * @property {string} [type]
170
230
  */
171
231
  /**
172
- * @typedef CreatedBySchema
173
- * @property {string} [id]
232
+ * @typedef ActionPage
233
+ * @property {Object} [params]
234
+ * @property {Object} [query]
235
+ * @property {string} [url]
236
+ * @property {PageType} type
174
237
  */
175
238
  /**
176
- * @typedef CreateFaqCategoryRequestSchema
177
- * @property {CategoryRequestSchema} [category]
178
- */
179
- /**
180
- * @typedef CreateFaqCategorySchema
181
- * @property {CategorySchema} [category]
182
- */
183
- /**
184
- * @typedef CreateFaqResponseSchema
185
- * @property {FaqSchema} [faq]
186
- */
187
- /**
188
- * @typedef CreateFaqSchema
189
- * @property {FAQ} [faq]
239
+ * @typedef NavigationReference
240
+ * @property {string[]} [acl]
241
+ * @property {string[]} [tags]
242
+ * @property {LocaleLanguage} [_locale_language]
243
+ * @property {string} [image]
244
+ * @property {string} [type]
245
+ * @property {Action} [action]
246
+ * @property {boolean} [active]
247
+ * @property {string} [display]
248
+ * @property {number} [sort_order]
249
+ * @property {NavigationReference[]} [sub_navigation]
190
250
  */
191
251
  /**
192
- * @typedef CreateTagRequestSchema
193
- * @property {CreateTagSchema[]} [tags]
252
+ * @typedef ConfigurationSchema
253
+ * @property {number} [sleep_time]
254
+ * @property {boolean} [start_on_launch]
255
+ * @property {number} [duration]
256
+ * @property {string} [slide_direction]
194
257
  */
195
258
  /**
196
- * @typedef CreateTagSchema
197
- * @property {string} [_id]
198
- * @property {Object} [attributes]
199
- * @property {string} [content]
200
- * @property {string} [name]
201
- * @property {Object[]} [pages]
202
- * @property {string} [position]
203
- * @property {string} [sub_type]
259
+ * @typedef SlideshowMedia
204
260
  * @property {string} [type]
205
261
  * @property {string} [url]
206
- */
207
- /**
208
- * @typedef CronSchedule
209
- * @property {string} [cron]
262
+ * @property {string} [bg_color]
210
263
  * @property {number} [duration]
211
- * @property {string} [end]
212
- * @property {string} [start]
213
- */
214
- /**
215
- * @typedef CustomDataDeleteSchema
216
- * @property {string} [message]
217
- * @property {boolean} [success]
264
+ * @property {boolean} [auto_decide_duration]
265
+ * @property {Action} [action]
218
266
  */
219
267
  /**
220
- * @typedef CustomField
221
- * @property {string} [definition_id]
222
- * @property {Object[]} [value]
268
+ * @typedef UpdateHandpickedSchema
269
+ * @property {HandpickedTagSchema} [tag]
223
270
  */
224
271
  /**
225
- * @typedef CustomFieldDefinitionDetailResSchema
226
- * @property {string} [_id]
227
- * @property {string} [application_id]
228
- * @property {string} [company_id]
229
- * @property {string} [created_at]
230
- * @property {string} [created_by]
231
- * @property {string} [creator]
232
- * @property {string} [description]
233
- * @property {boolean} [is_deleted]
234
- * @property {string} [key]
235
- * @property {boolean} [multi_value]
272
+ * @typedef HandpickedTagSchema
273
+ * @property {string} [position]
274
+ * @property {Object} [attributes]
236
275
  * @property {string} [name]
237
- * @property {string} [namespace]
238
- * @property {boolean} [required]
239
- * @property {string} [resource]
276
+ * @property {string} [url]
240
277
  * @property {string} [type]
241
- * @property {string} [updated_at]
242
- * @property {string} [updated_by]
243
- * @property {Object[]} [validations]
278
+ * @property {string} [sub_type]
279
+ * @property {string} [content]
244
280
  */
245
281
  /**
246
- * @typedef CustomFieldDefinitionRequestSchema
247
- * @property {string} [description]
248
- * @property {string} [key]
249
- * @property {boolean} [multi_value]
282
+ * @typedef RemoveHandpickedSchema
283
+ * @property {string[]} [tags]
284
+ */
285
+ /**
286
+ * @typedef CreateTagSchema
250
287
  * @property {string} [name]
251
- * @property {string} [namespace]
252
- * @property {string} [resource]
288
+ * @property {string} [sub_type]
289
+ * @property {string} [_id]
253
290
  * @property {string} [type]
254
- * @property {FieldValidations[]} [validations]
291
+ * @property {string} [url]
292
+ * @property {string} [position]
293
+ * @property {Object} [attributes]
294
+ * @property {Object[]} [pages]
295
+ * @property {string} [content]
255
296
  */
256
297
  /**
257
- * @typedef CustomFieldDefinitionsSchema
258
- * @property {FieldDefinitionSchema[]} [items]
259
- * @property {Page} [page]
298
+ * @typedef CreateTagRequestSchema
299
+ * @property {CreateTagSchema[]} [tags]
260
300
  */
261
301
  /**
262
- * @typedef CustomFieldRequestSchema
263
- * @property {CustomField[]} [fields]
302
+ * @typedef DataLoaderSchema
303
+ * @property {string} [name]
304
+ * @property {string} [service]
305
+ * @property {string} [operation_id]
306
+ * @property {string} [type]
307
+ * @property {string} [url]
308
+ * @property {string} [content]
309
+ * @property {DataLoaderSourceSchema} [__source]
310
+ * @property {string} [_id]
264
311
  */
265
312
  /**
266
- * @typedef CustomFieldSchema
267
- * @property {string} [_id]
268
- * @property {string} [company_id]
269
- * @property {string} [created_at]
270
- * @property {string} [created_by]
271
- * @property {string} [creator]
272
- * @property {string} [definition_id]
273
- * @property {boolean} [has_invalid_values]
274
- * @property {Object[]} [invalid_value_errors]
275
- * @property {boolean} [is_deleted]
276
- * @property {string} [key]
277
- * @property {boolean} [multi_value]
278
- * @property {string} [namespace]
279
- * @property {string} [resource]
280
- * @property {string} [resource_id]
313
+ * @typedef DataLoaderSourceSchema
281
314
  * @property {string} [type]
282
- * @property {string} [updated_at]
283
- * @property {CustomFieldValue[]} [value]
315
+ * @property {string} [id]
284
316
  */
285
317
  /**
286
- * @typedef CustomFieldsResponseByResourceIdSchema
287
- * @property {CustomFieldSchema[]} [items]
318
+ * @typedef DataLoadersSchema
319
+ * @property {DataLoaderSchema[]} [items]
288
320
  */
289
321
  /**
290
- * @typedef CustomFieldsResponseSchema
291
- * @property {CustomFieldSchema[]} [items]
292
- * @property {Page} [page]
322
+ * @typedef TagDeleteSuccessResponse
323
+ * @property {boolean} [success]
293
324
  */
294
325
  /**
295
- * @typedef CustomFieldTypeSchema
296
- * @property {BooleanType} [boolean_type]
297
- * @property {Date} [date]
298
- * @property {Datetime} [datetime]
299
- * @property {Dropdown} [dropdown]
300
- * @property {File} [file]
301
- * @property {FloatType} [float_type]
302
- * @property {Integer} [integer]
303
- * @property {Json} [json]
304
- * @property {Metaobject} [metaobject]
305
- * @property {Product} [product]
306
- * @property {StringMultiLine} [string_multi_line]
307
- * @property {StringSingleLine} [string_single_line]
308
- * @property {Url} [url]
326
+ * @typedef ContentAPIError
327
+ * @property {string} [message]
328
+ * @property {number} [status]
329
+ * @property {string} [code]
330
+ * @property {string} [exception]
331
+ * @property {string} [info]
332
+ * @property {string} [request_id]
333
+ * @property {string} [stack_trace]
334
+ * @property {Object} [meta]
309
335
  */
310
336
  /**
311
- * @typedef CustomFieldValue
312
- * @property {Object} [value]
337
+ * @typedef CommonError
338
+ * @property {string} [message]
313
339
  */
314
340
  /**
315
- * @typedef CustomMetaTag
341
+ * @typedef CategorySchema
342
+ * @property {number} [index]
343
+ * @property {string} [title]
344
+ * @property {string} [description]
345
+ * @property {string[]} [children]
316
346
  * @property {string} [_id]
317
- * @property {string} [content]
318
- * @property {string} [name]
319
- */
320
- /**
321
- * @typedef CustomObjectBulkEntry
322
- * @property {CustomObjectJobSchema[]} [items]
323
- * @property {Page} [page]
347
+ * @property {string} [slug]
348
+ * @property {string} [application]
349
+ * @property {string} [icon_url]
350
+ * @property {Object} [_custom_json]
324
351
  */
325
352
  /**
326
- * @typedef CustomObjectBulkEntryInitiateDownload
327
- * @property {string} [message]
328
- * @property {string} [task_id]
353
+ * @typedef ChildrenSchema
354
+ * @property {string} [question]
355
+ * @property {string} [answer]
356
+ * @property {string} [slug]
357
+ * @property {string} [application]
358
+ * @property {string} [_id]
329
359
  */
330
360
  /**
331
- * @typedef CustomObjectBulkSchema
332
- * @property {number} [total_records]
333
- * @property {string} [url]
361
+ * @typedef CategoryRequestSchema
362
+ * @property {string} [slug]
363
+ * @property {string} [title]
334
364
  */
335
365
  /**
336
- * @typedef CustomObjectByIdSchema
366
+ * @typedef FAQCategorySchema
367
+ * @property {number} [index]
368
+ * @property {string} [title]
369
+ * @property {string} [description]
370
+ * @property {ChildrenSchema[]} [children]
337
371
  * @property {string} [_id]
338
- * @property {CustomObjectListItemDefinationSchema} [definition]
339
- * @property {string} [display_name]
340
- * @property {CustomObjectFieldSchema[]} [fields]
341
- * @property {Object[]} [references]
342
- * @property {string} [status]
372
+ * @property {string} [slug]
373
+ * @property {string} [application]
374
+ * @property {string} [icon_url]
375
+ * @property {Object} [_custom_json]
343
376
  */
344
377
  /**
345
- * @typedef CustomObjectCustomFieldDefinitionResSchema
378
+ * @typedef FaqSchema
379
+ * @property {string} [slug]
380
+ * @property {string} [application]
346
381
  * @property {string} [_id]
347
- * @property {string} [company_id]
348
- * @property {string} [created_at]
349
- * @property {string} [created_by]
350
- * @property {string} [creator]
351
- * @property {string} [description]
352
- * @property {boolean} [is_deleted]
353
- * @property {string} [key]
354
- * @property {string} [metaobject_definition_id]
355
- * @property {boolean} [multi_value]
356
- * @property {string} [name]
357
- * @property {string} [namespace]
358
- * @property {boolean} [required]
359
- * @property {string} [resource]
360
- * @property {string} [type]
361
- * @property {string} [updated_at]
362
- * @property {FieldValidations[]} [validations]
382
+ * @property {string} [question]
383
+ * @property {string} [answer]
384
+ * @property {string[]} [tags]
363
385
  */
364
386
  /**
365
- * @typedef CustomObjectCustomFieldDefinitions
366
- * @property {string} [action]
367
- * @property {string} [description]
368
- * @property {string} [id]
369
- * @property {string} [key]
370
- * @property {boolean} [multi_value]
371
- * @property {string} [name]
372
- * @property {boolean} [required]
373
- * @property {string} [type]
374
- * @property {FieldValidations[]} [validations]
387
+ * @typedef FAQ
388
+ * @property {string} [slug]
389
+ * @property {string} [question]
390
+ * @property {string} [answer]
375
391
  */
376
392
  /**
377
- * @typedef CustomObjectDefinitionDeleteResponseSchema
378
- * @property {string} [message]
379
- * @property {boolean} [success]
393
+ * @typedef CreateFaqResponseSchema
394
+ * @property {FaqSchema} [faq]
380
395
  */
381
396
  /**
382
- * @typedef CustomObjectDefinitionRequestSchema
383
- * @property {string} [description]
384
- * @property {string} [display_name_key]
385
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
386
- * @property {string} [name]
387
- * @property {string} [type]
397
+ * @typedef CreateFaqSchema
398
+ * @property {FAQ} [faq]
388
399
  */
389
400
  /**
390
- * @typedef CustomObjectDefinitionSchema
391
- * @property {string} [_id]
392
- * @property {string} [created_by]
393
- * @property {string} [creator]
394
- * @property {string} [description]
395
- * @property {string} [display_name_key]
396
- * @property {CustomObjectCustomFieldDefinitionResSchema[]} [field_definitions]
397
- * @property {string} [name]
398
- * @property {string} [type]
399
- * @property {string} [updated_by]
401
+ * @typedef GetFaqSchema
402
+ * @property {FaqSchema[]} [faqs]
400
403
  */
401
404
  /**
402
- * @typedef CustomObjectDefinitionsSchema
403
- * @property {CustomObjectEntry[]} [items]
404
- * @property {Page} [page]
405
+ * @typedef UpdateFaqCategoryRequestSchema
406
+ * @property {CategorySchema} [category]
405
407
  */
406
408
  /**
407
- * @typedef CustomObjectDefinitionUpdateRequestSchema
408
- * @property {string} [description]
409
- * @property {string} [display_name_key]
410
- * @property {CustomObjectCustomFieldDefinitions[]} [field_definitions]
411
- * @property {string} [name]
412
- * @property {string} [type]
409
+ * @typedef CreateFaqCategoryRequestSchema
410
+ * @property {CategoryRequestSchema} [category]
413
411
  */
414
412
  /**
415
- * @typedef CustomObjectEntry
416
- * @property {string} [_id]
417
- * @property {number} [entries_count]
418
- * @property {number} [fields_count]
419
- * @property {string} [name]
420
- * @property {string} [type]
421
- * @property {string} [updated_at]
413
+ * @typedef CreateFaqCategorySchema
414
+ * @property {CategorySchema} [category]
422
415
  */
423
416
  /**
424
- * @typedef CustomObjectEntryBulkUploadResponse
425
- * @property {number} [total_records]
426
- * @property {string} [url]
417
+ * @typedef GetFaqCategoriesSchema
418
+ * @property {CategorySchema[]} [categories]
427
419
  */
428
420
  /**
429
- * @typedef CustomObjectEntryFieldSchema
430
- * @property {string} [definition_id]
431
- * @property {Object[]} [value]
421
+ * @typedef GetFaqCategoryBySlugSchema
422
+ * @property {FAQCategorySchema} [category]
432
423
  */
433
424
  /**
434
- * @typedef CustomObjectFieldSchema
435
- * @property {string} [_id]
436
- * @property {string} [definition_id]
437
- * @property {string} [key]
438
- * @property {string} [type]
439
- * @property {Object[]} [value]
425
+ * @typedef Page
426
+ * @property {number} [item_total]
427
+ * @property {string} [next_id]
428
+ * @property {boolean} [has_previous]
429
+ * @property {boolean} [has_next]
430
+ * @property {number} [current]
431
+ * @property {string} type
432
+ * @property {number} [size]
440
433
  */
441
434
  /**
442
- * @typedef CustomObjectJobSchema
443
- * @property {string} [_id]
444
- * @property {string} [action_type]
445
- * @property {string} [company_id]
446
- * @property {string} [created_at]
447
- * @property {string} [created_by]
448
- * @property {string} [creator]
449
- * @property {string} [entity]
450
- * @property {number} [error_count]
451
- * @property {string[]} [error_jobs]
452
- * @property {string} [error_url]
453
- * @property {string[]} [errors_occured]
454
- * @property {number} [finished_count]
455
- * @property {string[]} [finished_jobs]
456
- * @property {string[]} [jobs]
457
- * @property {CustomObjectMetaSchema} [meta]
458
- * @property {string} [status]
459
- * @property {number} [success_count]
460
- * @property {number} [total_jobs]
461
- * @property {string} [updated_at]
462
- * @property {string} [url]
435
+ * @typedef LandingPageGetResponse
436
+ * @property {LandingPageSchema[]} [items]
437
+ * @property {Page} [page]
463
438
  */
464
439
  /**
465
- * @typedef CustomObjectListItemDefinationSchema
440
+ * @typedef LandingPageSchema
441
+ * @property {string} [slug]
442
+ * @property {Action} [action]
443
+ * @property {string[]} [platform]
444
+ * @property {CreatedBySchema} [created_by]
445
+ * @property {DateMeta} [date_meta]
466
446
  * @property {string} [_id]
467
- * @property {string} [name]
468
- * @property {string} [type]
447
+ * @property {string} [application]
448
+ * @property {boolean} [archived]
449
+ * @property {Object} [_custom_json]
469
450
  */
470
451
  /**
471
- * @typedef CustomObjectListItemSchema
472
- * @property {string} [_id]
473
- * @property {CustomObjectListItemDefinationSchema} [definition]
474
- * @property {string} [definition_id]
475
- * @property {string} [display_name]
476
- * @property {number} [references]
477
- * @property {string} [status]
478
- * @property {string} [updated_at]
452
+ * @typedef DefaultNavigationResponse
453
+ * @property {NavigationSchema[]} [items]
479
454
  */
480
455
  /**
481
- * @typedef CustomObjectMetaSchema
482
- * @property {string} [mo_defintion_type]
483
- * @property {number} [mo_error_count]
484
- * @property {number} [mo_success_count]
485
- * @property {number} [mo_total_count]
456
+ * @typedef NavigationGetResponse
457
+ * @property {NavigationSchema[]} [items]
458
+ * @property {Page} [page]
486
459
  */
487
460
  /**
488
- * @typedef CustomObjectRequestSchema
489
- * @property {string} [definition_id]
490
- * @property {CustomObjectEntryFieldSchema[]} [fields]
491
- * @property {string} [status]
461
+ * @typedef Orientation
462
+ * @property {string[]} [portrait]
463
+ * @property {string[]} [landscape]
492
464
  */
493
465
  /**
494
- * @typedef CustomObjectSchema
495
- * @property {string} [_id]
496
- * @property {string} [application_id]
497
- * @property {string} [company_id]
498
- * @property {string} [created_by]
499
- * @property {string} [creator]
500
- * @property {string} [definition_id]
501
- * @property {string} [display_name]
502
- * @property {CustomFieldSchema[]} [fields]
503
- * @property {string} [status]
504
- * @property {string} [type]
505
- * @property {string} [updated_by]
506
- */
507
- /**
508
- * @typedef CustomObjectsSchema
509
- * @property {CustomObjectListItemSchema[]} [items]
510
- * @property {Page} [page]
511
- */
512
- /**
513
- * @typedef DataLoaderResetResponseSchema
514
- * @property {boolean} [reset]
515
- */
516
- /**
517
- * @typedef DataLoaderResponseSchema
518
- * @property {DataLoaderSourceSchema} [__source]
466
+ * @typedef NavigationSchema
519
467
  * @property {string} [_id]
520
468
  * @property {string} [application]
521
- * @property {string} [company]
522
- * @property {string} [content]
469
+ * @property {boolean} [archived]
523
470
  * @property {string} [name]
524
- * @property {string} [operation_id]
525
- * @property {string} [service]
526
- * @property {string} [type]
527
- * @property {string} [url]
471
+ * @property {string} [slug]
472
+ * @property {string[]} [platform]
473
+ * @property {CreatedBySchema} [created_by]
474
+ * @property {DateMeta} [date_meta]
475
+ * @property {Orientation} [orientation]
476
+ * @property {number} [version]
477
+ * @property {NavigationReference[]} [navigation]
528
478
  */
529
479
  /**
530
- * @typedef DataLoaderSchema
531
- * @property {DataLoaderSourceSchema} [__source]
532
- * @property {string} [_id]
533
- * @property {string} [content]
480
+ * @typedef NavigationRequest
534
481
  * @property {string} [name]
535
- * @property {string} [operation_id]
536
- * @property {string} [service]
537
- * @property {string} [type]
538
- * @property {string} [url]
482
+ * @property {string} [slug]
483
+ * @property {string[]} [platform]
484
+ * @property {Orientation} [orientation]
485
+ * @property {NavigationReference[]} [navigation]
539
486
  */
540
487
  /**
541
- * @typedef DataLoaderSourceSchema
542
- * @property {string} [id]
543
- * @property {string} [type]
488
+ * @typedef PageGetResponse
489
+ * @property {PageSchema[]} [items]
490
+ * @property {Page} [page]
544
491
  */
545
492
  /**
546
- * @typedef DataLoadersSchema
547
- * @property {DataLoaderSchema[]} [items]
493
+ * @typedef PageSpec
494
+ * @property {PageSpecItem[]} [specifications]
548
495
  */
549
496
  /**
550
- * @typedef Date
551
- * @property {string} [category]
552
- * @property {boolean} [list_enabled]
553
- * @property {string} [name]
554
- * @property {SupportedValidationsSchema[]} [supported_validations]
555
- * @property {string} [type]
497
+ * @typedef PageSpecParam
498
+ * @property {string} [key]
499
+ * @property {boolean} [required]
556
500
  */
557
501
  /**
558
- * @typedef DateMeta
559
- * @property {string} [created_on]
560
- * @property {string} [modified_on]
502
+ * @typedef PageSpecItem
503
+ * @property {string} [page_type]
504
+ * @property {string} [display_name]
505
+ * @property {PageSpecParam[]} [params]
506
+ * @property {PageSpecParam[]} [query]
561
507
  */
562
508
  /**
563
- * @typedef Datetime
564
- * @property {string} [category]
565
- * @property {boolean} [list_enabled]
566
- * @property {string} [name]
567
- * @property {SupportedValidationsSchema[]} [supported_validations]
509
+ * @typedef PageSchema
510
+ * @property {string} [_id]
511
+ * @property {string} [application]
512
+ * @property {string[]} [component_ids] - Components can be used to store
513
+ * multiple components
514
+ * @property {Object[]} [content]
515
+ * @property {string} [content_path]
516
+ * @property {CreatedBySchema} [created_by]
517
+ * @property {DateMeta} [date_meta]
518
+ * @property {string} [description]
519
+ * @property {Asset} [feature_image]
520
+ * @property {Object[]} [page_meta]
521
+ * @property {ScheduleSchema} [_schedule]
522
+ * @property {Object} [_custom_json]
523
+ * @property {string} [orientation]
524
+ * @property {string} [platform]
525
+ * @property {boolean} [published]
526
+ * @property {string} [slug]
527
+ * @property {string[]} [tags]
528
+ * @property {string} [title]
568
529
  * @property {string} [type]
530
+ * @property {SEO} [seo]
531
+ * @property {Object} [visibility]
532
+ * @property {boolean} [archived]
569
533
  */
570
534
  /**
571
- * @typedef DefaultNavigationResponse
572
- * @property {NavigationSchema[]} [items]
573
- */
574
- /**
575
- * @typedef DefaultSchemaComponent
576
- * @property {DefaultSEOSchemaMarkupTemplate[]} [items]
577
- */
578
- /**
579
- * @typedef DefaultSEOSchemaMarkupTemplate
580
- * @property {string} [page_type]
581
- * @property {string} [schema]
582
- * @property {Object} [target_json]
535
+ * @typedef CreatedBySchema
536
+ * @property {string} [id]
583
537
  */
584
538
  /**
585
- * @typedef Detail
586
- * @property {string} [description]
587
- * @property {string} [image_url]
539
+ * @typedef PageRequest
540
+ * @property {CronSchedule} [_schedule]
541
+ * @property {string} [application]
542
+ * @property {Author} [author]
543
+ * @property {Object} [_custom_json]
544
+ * @property {string} [orientation]
545
+ * @property {Object[]} [content]
546
+ * @property {Asset} [feature_image]
547
+ * @property {boolean} [published]
548
+ * @property {string} [reading_time]
549
+ * @property {string} [slug]
550
+ * @property {string[]} [tags]
551
+ * @property {SEO} [seo]
588
552
  * @property {string} [title]
589
553
  */
590
554
  /**
591
- * @typedef Dropdown
592
- * @property {string} [category]
593
- * @property {boolean} [list_enabled]
594
- * @property {string} [name]
595
- * @property {SupportedValidationsSchema[]} [supported_validations]
596
- * @property {string} [type]
597
- */
598
- /**
599
- * @typedef EditorMeta
600
- * @property {string} [background_color]
601
- * @property {string} [content]
602
- * @property {string} [content_type]
603
- * @property {string} [foreground_color]
555
+ * @typedef CronSchedule
556
+ * @property {string} [cron]
557
+ * @property {string} [start]
558
+ * @property {string} [end]
559
+ * @property {number} [duration]
604
560
  */
605
561
  /**
606
- * @typedef EmailProperties
607
- * @property {string} [key]
608
- * @property {string} [value]
562
+ * @typedef PagePublishRequest
563
+ * @property {boolean} [publish]
609
564
  */
610
565
  /**
611
- * @typedef EmailSchema
612
- * @property {boolean} [active]
613
- * @property {EmailProperties[]} [email]
566
+ * @typedef PageMetaSchema
567
+ * @property {NavigationSchema[]} [system_pages]
568
+ * @property {PageSchema[]} [custom_pages]
569
+ * @property {string} [application_id]
614
570
  */
615
571
  /**
616
- * @typedef FAQ
617
- * @property {string} [answer]
618
- * @property {string} [question]
619
- * @property {string} [slug]
572
+ * @typedef SlideshowGetResponse
573
+ * @property {SlideshowSchema[]} [items]
574
+ * @property {Page} [page]
620
575
  */
621
576
  /**
622
- * @typedef FAQCategorySchema
623
- * @property {Object} [_custom_json]
577
+ * @typedef SlideshowSchema
624
578
  * @property {string} [_id]
625
- * @property {string} [application]
626
- * @property {ChildrenSchema[]} [children]
627
- * @property {string} [description]
628
- * @property {string} [icon_url]
629
- * @property {number} [index]
630
579
  * @property {string} [slug]
631
- * @property {string} [title]
580
+ * @property {DateMeta} [date_meta]
581
+ * @property {string} [application]
582
+ * @property {string} [platform]
583
+ * @property {ConfigurationSchema} [configuration]
584
+ * @property {SlideshowMedia[]} [media]
585
+ * @property {boolean} [active]
586
+ * @property {boolean} [archived]
587
+ * @property {Object} [_custom_json]
632
588
  */
633
589
  /**
634
- * @typedef FaqSchema
635
- * @property {string} [_id]
636
- * @property {string} [answer]
637
- * @property {string} [application]
638
- * @property {string} [question]
590
+ * @typedef SlideshowRequest
639
591
  * @property {string} [slug]
640
- * @property {string[]} [tags]
592
+ * @property {string} [platform]
593
+ * @property {ConfigurationSchema} [configuration]
594
+ * @property {SlideshowMedia} [media]
595
+ * @property {boolean} [active]
641
596
  */
642
597
  /**
643
- * @typedef FieldDefinitionSchema
598
+ * @typedef Support
599
+ * @property {boolean} [created]
644
600
  * @property {string} [_id]
645
- * @property {string} [company_id]
601
+ * @property {string} [config_type]
602
+ * @property {string} [application]
646
603
  * @property {string} [created_at]
647
- * @property {string} [created_by]
648
- * @property {string} [creator]
649
- * @property {string} [description]
650
- * @property {number} [invalid_fields_count]
651
- * @property {boolean} [is_deleted]
652
- * @property {string} [key]
653
- * @property {boolean} [multi_value]
654
- * @property {string} [name]
655
- * @property {string} [namespace]
656
- * @property {boolean} [required]
657
- * @property {string} [resource]
658
- * @property {string} [type]
659
- * @property {string} [type_name]
660
604
  * @property {string} [updated_at]
661
- * @property {string} [updated_by]
662
- * @property {FieldValidations[]} [validations]
663
- */
664
- /**
665
- * @typedef FieldValidations
666
- * @property {string} [name]
667
- * @property {string} [type]
668
- * @property {Object} [value]
669
- */
670
- /**
671
- * @typedef File
672
- * @property {string} [category]
673
- * @property {boolean} [list_enabled]
674
- * @property {string} [name]
675
- * @property {SupportedValidationsSchema[]} [supported_validations]
676
- * @property {string} [type]
677
- */
678
- /**
679
- * @typedef FloatType
680
- * @property {string} [category]
681
- * @property {boolean} [list_enabled]
682
- * @property {string} [name]
683
- * @property {SupportedValidationsSchema[]} [supported_validations]
684
- * @property {string} [type]
605
+ * @property {ContactSchema} [contact]
685
606
  */
686
607
  /**
687
- * @typedef GeneratedSEOContent
688
- * @property {string} [description]
689
- * @property {string} [title]
608
+ * @typedef PhoneProperties
609
+ * @property {string} [key]
610
+ * @property {string} [code]
611
+ * @property {string} [number]
690
612
  */
691
613
  /**
692
- * @typedef GenerateSEOContent
693
- * @property {string} [existing_text]
694
- * @property {string[]} [keywords]
695
- * @property {string} [text]
696
- * @property {string} [type]
614
+ * @typedef PhoneSchema
615
+ * @property {boolean} [active]
616
+ * @property {PhoneProperties[]} [phone]
697
617
  */
698
618
  /**
699
- * @typedef GetAnnouncementListSchema
700
- * @property {AdminAnnouncementSchema[]} [items]
701
- * @property {Page} [page]
619
+ * @typedef EmailProperties
620
+ * @property {string} [key]
621
+ * @property {string} [value]
702
622
  */
703
623
  /**
704
- * @typedef GetFaqCategoriesSchema
705
- * @property {CategorySchema[]} [categories]
624
+ * @typedef EmailSchema
625
+ * @property {boolean} [active]
626
+ * @property {EmailProperties[]} [email]
706
627
  */
707
628
  /**
708
- * @typedef GetFaqCategoryBySlugSchema
709
- * @property {FAQCategorySchema} [category]
629
+ * @typedef ContactSchema
630
+ * @property {PhoneSchema} [phone]
631
+ * @property {EmailSchema} [email]
710
632
  */
711
633
  /**
712
- * @typedef GetFaqSchema
713
- * @property {FaqSchema[]} [faqs]
634
+ * @typedef TagsSchema
635
+ * @property {string} [application]
636
+ * @property {string} [_id]
637
+ * @property {TagSchema[]} [tags]
714
638
  */
715
639
  /**
716
- * @typedef HandpickedTagSchema
717
- * @property {Object} [attributes]
718
- * @property {string} [content]
640
+ * @typedef TagSchema
719
641
  * @property {string} [name]
720
- * @property {string} [position]
721
- * @property {string} [sub_type]
722
- * @property {string} [type]
723
642
  * @property {string} [url]
724
- */
725
- /**
726
- * @typedef Integer
727
- * @property {string} [category]
728
- * @property {boolean} [list_enabled]
729
- * @property {string} [name]
730
- * @property {SupportedValidationsSchema[]} [supported_validations]
731
643
  * @property {string} [type]
644
+ * @property {string} [sub_type]
645
+ * @property {string} [_id]
646
+ * @property {string} [position]
647
+ * @property {Object} [attributes]
648
+ * @property {string} [content]
649
+ * @property {Object[]} [pages]
650
+ * @property {TagSourceSchema} [__source]
732
651
  */
733
652
  /**
734
- * @typedef Json
735
- * @property {string} [category]
736
- * @property {boolean} [list_enabled]
737
- * @property {string} [name]
738
- * @property {SupportedValidationsSchema[]} [supported_validations]
653
+ * @typedef TagSourceSchema
739
654
  * @property {string} [type]
655
+ * @property {string} [id]
740
656
  */
741
- /**
742
- * @typedef LandingPageGetResponse
743
- * @property {LandingPageSchema[]} [items]
744
- * @property {Page} [page]
745
- */
746
- /**
747
- * @typedef LandingPageSchema
748
- * @property {Object} [_custom_json]
749
- * @property {string} [_id]
750
- * @property {Action} [action]
751
- * @property {string} [application]
752
- * @property {boolean} [archived]
753
- * @property {CreatedBySchema} [created_by]
754
- * @property {DateMeta} [date_meta]
755
- * @property {string[]} [platform]
756
- * @property {string} [slug]
757
- */
758
- /**
759
- * @typedef Language
760
- * @property {string} [display]
761
- */
762
- /**
763
- * @typedef LocaleLanguage
764
- * @property {Language} [ar]
765
- * @property {Language} [en_us]
766
- * @property {Language} [hi]
767
- */
768
- /**
769
- * @typedef Metaobject
770
- * @property {string} [category]
771
- * @property {boolean} [list_enabled]
772
- * @property {string} [name]
773
- * @property {SupportedValidationsSchema[]} [supported_validations]
774
- * @property {string} [type]
775
- */
776
- /**
777
- * @typedef NavigationGetResponse
778
- * @property {NavigationSchema[]} [items]
779
- * @property {Page} [page]
780
- */
781
- /**
782
- * @typedef NavigationReference
783
- * @property {LocaleLanguage} [_locale_language]
784
- * @property {string[]} [acl]
785
- * @property {Action} [action]
786
- * @property {boolean} [active]
787
- * @property {string} [display]
788
- * @property {string} [image]
789
- * @property {number} [sort_order]
790
- * @property {NavigationReference[]} [sub_navigation]
791
- * @property {string[]} [tags]
792
- * @property {string} [type]
793
- */
794
- /**
795
- * @typedef NavigationRequest
796
- * @property {string} [name]
797
- * @property {NavigationReference[]} [navigation]
798
- * @property {Orientation} [orientation]
799
- * @property {string[]} [platform]
800
- * @property {string} [slug]
801
- */
802
- /**
803
- * @typedef NavigationSchema
804
- * @property {string} [_id]
805
- * @property {string} [application]
806
- * @property {boolean} [archived]
807
- * @property {CreatedBySchema} [created_by]
808
- * @property {DateMeta} [date_meta]
809
- * @property {string} [name]
810
- * @property {NavigationReference[]} [navigation]
811
- * @property {Orientation} [orientation]
812
- * @property {string[]} [platform]
813
- * @property {string} [slug]
814
- * @property {number} [version]
815
- */
816
- /**
817
- * @typedef NextSchedule
818
- * @property {string} [end]
819
- * @property {string} [start]
820
- */
821
- /**
822
- * @typedef Orientation
823
- * @property {string[]} [landscape]
824
- * @property {string[]} [portrait]
825
- */
826
- /**
827
- * @typedef Page
828
- * @property {number} [current]
829
- * @property {boolean} [has_next]
830
- * @property {boolean} [has_previous]
831
- * @property {number} [item_total]
832
- * @property {string} [next_id]
833
- * @property {number} [size]
834
- * @property {string} type
835
- */
836
- /**
837
- * @typedef PageGetResponse
838
- * @property {PageSchema[]} [items]
839
- * @property {Page} [page]
840
- */
841
- /**
842
- * @typedef PageMetaSchema
843
- * @property {string} [application_id]
844
- * @property {PageSchema[]} [custom_pages]
845
- * @property {NavigationSchema[]} [system_pages]
846
- */
847
- /**
848
- * @typedef PagePublishRequest
849
- * @property {boolean} [publish]
850
- */
851
- /**
852
- * @typedef PageRequest
853
- * @property {Object} [_custom_json]
854
- * @property {CronSchedule} [_schedule]
855
- * @property {string} [application]
856
- * @property {Author} [author]
857
- * @property {Object[]} [content]
858
- * @property {Asset} [feature_image]
859
- * @property {string} [orientation]
860
- * @property {boolean} [published]
861
- * @property {string} [reading_time]
862
- * @property {SEO} [seo]
863
- * @property {string} [slug]
864
- * @property {string[]} [tags]
865
- * @property {string} [title]
866
- */
867
- /**
868
- * @typedef PageSchema
869
- * @property {Object} [_custom_json]
870
- * @property {string} [_id]
871
- * @property {ScheduleSchema} [_schedule]
872
- * @property {string} [application]
873
- * @property {boolean} [archived]
874
- * @property {string[]} [component_ids] - Components can be used to store
875
- * multiple components
876
- * @property {Object[]} [content]
877
- * @property {string} [content_path]
878
- * @property {CreatedBySchema} [created_by]
879
- * @property {DateMeta} [date_meta]
880
- * @property {string} [description]
881
- * @property {Asset} [feature_image]
882
- * @property {string} [orientation]
883
- * @property {Object[]} [page_meta]
884
- * @property {string} [platform]
885
- * @property {boolean} [published]
886
- * @property {SEO} [seo]
887
- * @property {string} [slug]
888
- * @property {string[]} [tags]
889
- * @property {string} [title]
890
- * @property {string} [type]
891
- * @property {Object} [visibility]
892
- */
893
- /**
894
- * @typedef PageSpec
895
- * @property {PageSpecItem[]} [specifications]
896
- */
897
- /**
898
- * @typedef PageSpecItem
899
- * @property {string} [display_name]
900
- * @property {string} [page_type]
901
- * @property {PageSpecParam[]} [params]
902
- * @property {PageSpecParam[]} [query]
903
- */
904
- /**
905
- * @typedef PageSpecParam
906
- * @property {string} [key]
907
- * @property {boolean} [required]
908
- */
909
- /**
910
- * @typedef PathMappingSchema
911
- * @property {PathSourceSchema} [__source]
912
- * @property {string} [_id]
913
- * @property {string} [application]
914
- * @property {string} [created_at]
915
- * @property {string} [redirect_from]
916
- * @property {string} [redirect_to]
917
- * @property {string} [updated_at]
918
- */
919
- /**
920
- * @typedef PathSourceSchema
921
- * @property {string} [id]
922
- * @property {string} [type]
923
- */
924
- /**
925
- * @typedef PhoneProperties
926
- * @property {string} [code]
927
- * @property {string} [key]
928
- * @property {string} [number]
929
- */
930
- /**
931
- * @typedef PhoneSchema
932
- * @property {boolean} [active]
933
- * @property {PhoneProperties[]} [phone]
934
- */
935
- /**
936
- * @typedef Product
937
- * @property {string} [category]
938
- * @property {boolean} [list_enabled]
939
- * @property {string} [name]
940
- * @property {SupportedValidationsSchema[]} [supported_validations]
941
- * @property {string} [type]
942
- */
943
- /**
944
- * @typedef RemoveHandpickedSchema
945
- * @property {string[]} [tags]
946
- */
947
- /**
948
- * @typedef ResourceContent
949
- * @property {string} [type]
950
- * @property {string} [value]
951
- */
952
- /**
953
- * @typedef ResourceSchema
954
- * @property {number} [definitions_count] - Number of definitions
955
- * @property {string} [key] - Resource key
956
- * @property {string} [name] - Resource name
957
- */
958
- /**
959
- * @typedef ResourcesSchema
960
- * @property {ResourceSchema[]} [resources]
961
- */
962
- /**
963
- * @typedef ScheduleSchema
964
- * @property {string} [cron]
965
- * @property {number} [duration]
966
- * @property {string} [end]
967
- * @property {NextSchedule[]} [next_schedule]
968
- * @property {string} [start]
969
- */
970
- /**
971
- * @typedef SEO
972
- * @property {SEObreadcrumb[]} [breadcrumb]
973
- * @property {string} [canonical_url]
974
- * @property {string} [description]
975
- * @property {SEOImage} [image]
976
- * @property {SEOMetaItem[]} [meta_tags]
977
- * @property {SEOSitemap} [sitemap]
978
- * @property {string} [title]
979
- */
980
- /**
981
- * @typedef SEObreadcrumb
982
- * @property {Action} [action]
983
- * @property {string} [url]
984
- */
985
- /**
986
- * @typedef SeoComponent
987
- * @property {SeoSchema} [seo]
988
- */
989
- /**
990
- * @typedef SEOImage
991
- * @property {string} [url]
992
- */
993
- /**
994
- * @typedef SEOMetaItem
995
- * @property {SEOMetaItems[]} [items]
996
- * @property {string} [title]
997
- */
998
- /**
999
- * @typedef SEOMetaItems
1000
- * @property {string} [key]
1001
- * @property {string} [value]
1002
- */
1003
- /**
1004
- * @typedef SeoSchema
1005
- * @property {string} [_id]
1006
- * @property {string} [additional_sitemap]
1007
- * @property {string} [app]
1008
- * @property {boolean} [cannonical_enabled]
1009
- * @property {string} [created_at]
1010
- * @property {CustomMetaTag[]} [custom_meta_tags]
1011
- * @property {Detail} [details]
1012
- * @property {string} [robots_txt]
1013
- * @property {boolean} [sitemap_enabled]
1014
- * @property {string} [updated_at]
1015
- */
1016
- /**
1017
- * @typedef SeoSchemaComponent
1018
- * @property {SEOSchemaMarkupTemplate[]} [items]
1019
- * @property {Page} [page]
1020
- */
1021
- /**
1022
- * @typedef SEOSchemaMarkupTemplate
1023
- * @property {boolean} [active]
1024
- * @property {string} [application]
1025
- * @property {string} [created_at]
1026
- * @property {string} [description]
1027
- * @property {string} [id]
1028
- * @property {string} [page_type]
1029
- * @property {string} [schema]
1030
- * @property {Object} [target_json]
1031
- * @property {string} [title]
1032
- * @property {string} [updated_at]
1033
- */
1034
- /**
1035
- * @typedef SEOSchemaMarkupTemplateRequestBody
1036
- * @property {boolean} [active]
1037
- * @property {string} [created_at]
1038
- * @property {string} [description]
1039
- * @property {string} [page_type]
1040
- * @property {string} [schema]
1041
- * @property {Object} [target_json]
1042
- * @property {string} [title]
1043
- * @property {string} [updated_at]
1044
- */
1045
- /**
1046
- * @typedef SEOSitemap
1047
- * @property {string} [frequency]
1048
- * @property {number} [priority]
1049
- */
1050
- /**
1051
- * @typedef SlideshowGetResponse
1052
- * @property {SlideshowSchema[]} [items]
1053
- * @property {Page} [page]
1054
- */
1055
- /**
1056
- * @typedef SlideshowMedia
1057
- * @property {Action} [action]
1058
- * @property {boolean} [auto_decide_duration]
1059
- * @property {string} [bg_color]
1060
- * @property {number} [duration]
1061
- * @property {string} [type]
1062
- * @property {string} [url]
1063
- */
1064
- /**
1065
- * @typedef SlideshowRequest
1066
- * @property {boolean} [active]
1067
- * @property {ConfigurationSchema} [configuration]
1068
- * @property {SlideshowMedia} [media]
1069
- * @property {string} [platform]
1070
- * @property {string} [slug]
1071
- */
1072
- /**
1073
- * @typedef SlideshowSchema
1074
- * @property {Object} [_custom_json]
1075
- * @property {string} [_id]
1076
- * @property {boolean} [active]
1077
- * @property {string} [application]
1078
- * @property {boolean} [archived]
1079
- * @property {ConfigurationSchema} [configuration]
1080
- * @property {DateMeta} [date_meta]
1081
- * @property {SlideshowMedia[]} [media]
1082
- * @property {string} [platform]
1083
- * @property {string} [slug]
1084
- */
1085
- /**
1086
- * @typedef StringMultiLine
1087
- * @property {string} [category]
1088
- * @property {boolean} [list_enabled]
1089
- * @property {string} [name]
1090
- * @property {SupportedValidationsSchema[]} [supported_validations]
1091
- * @property {string} [type]
1092
- */
1093
- /**
1094
- * @typedef StringSingleLine
1095
- * @property {string} [category]
1096
- * @property {boolean} [list_enabled]
1097
- * @property {string} [name]
1098
- * @property {SupportedValidationsSchema[]} [supported_validations]
1099
- * @property {string} [type]
1100
- */
1101
- /**
1102
- * @typedef Support
1103
- * @property {string} [_id]
1104
- * @property {string} [application]
1105
- * @property {string} [config_type]
1106
- * @property {ContactSchema} [contact]
1107
- * @property {boolean} [created]
1108
- * @property {string} [created_at]
1109
- * @property {string} [updated_at]
1110
- */
1111
- /**
1112
- * @typedef SupportedValidationsMetaExampleSchema
1113
- * @property {string} [name]
1114
- * @property {string} [value]
1115
- */
1116
- /**
1117
- * @typedef SupportedValidationsMetaSchema
1118
- * @property {SupportedValidationsMetaExampleSchema[]} [examples]
1119
- */
1120
- /**
1121
- * @typedef SupportedValidationsSchema
1122
- * @property {string} [display]
1123
- * @property {SupportedValidationsMetaSchema} [meta]
1124
- * @property {string} [name]
1125
- * @property {boolean} [required]
1126
- * @property {string} [type]
1127
- */
1128
- /**
1129
- * @typedef TagDeleteSuccessResponse
1130
- * @property {boolean} [success]
1131
- */
1132
- /**
1133
- * @typedef TagSchema
1134
- * @property {TagSourceSchema} [__source]
1135
- * @property {string} [_id]
1136
- * @property {Object} [attributes]
1137
- * @property {string} [content]
1138
- * @property {string} [name]
1139
- * @property {Object[]} [pages]
1140
- * @property {string} [position]
1141
- * @property {string} [sub_type]
1142
- * @property {string} [type]
1143
- * @property {string} [url]
1144
- */
1145
- /**
1146
- * @typedef TagSourceSchema
1147
- * @property {string} [id]
1148
- * @property {string} [type]
1149
- */
1150
- /**
1151
- * @typedef TagsSchema
1152
- * @property {string} [_id]
1153
- * @property {string} [application]
1154
- * @property {TagSchema[]} [tags]
1155
- */
1156
- /**
1157
- * @typedef UpdateFaqCategoryRequestSchema
1158
- * @property {CategorySchema} [category]
1159
- */
1160
- /**
1161
- * @typedef UpdateHandpickedSchema
1162
- * @property {HandpickedTagSchema} [tag]
1163
- */
1164
- /**
1165
- * @typedef Url
1166
- * @property {boolean} [list_enabled]
1167
- * @property {string} [name]
1168
- * @property {SupportedValidationsSchema[]} [supported_validations]
1169
- * @property {string} [type]
1170
- */
1171
- /** @typedef {"title" | "description"} GenerationEntityType */
657
+ /** @typedef {"title" | "description"} GenerationEntityType */
1172
658
  /**
1173
659
  * @typedef {| "about-us"
1174
660
  * | "addresses"
@@ -1220,797 +706,480 @@ export = ContentPlatformModel;
1220
706
  declare class ContentPlatformModel {
1221
707
  }
1222
708
  declare namespace ContentPlatformModel {
1223
- export { Action, ActionPage, AdminAnnouncementSchema, AnnouncementAuthorSchema, AnnouncementPageSchema, ApplicationLegal, ApplicationLegalFAQ, Asset, Author, BlogGetResponse, BlogRequest, BlogSchema, BooleanType, CategoryRequestSchema, CategorySchema, ChildrenSchema, CommonError, ConfigurationSchema, ContactSchema, ContentAPIError, CreateAnnouncementSchema, CreatedBySchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, CreateFaqResponseSchema, CreateFaqSchema, CreateTagRequestSchema, CreateTagSchema, CronSchedule, CustomDataDeleteSchema, CustomField, CustomFieldDefinitionDetailResSchema, CustomFieldDefinitionRequestSchema, CustomFieldDefinitionsSchema, CustomFieldRequestSchema, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, CustomFieldsResponseSchema, CustomFieldTypeSchema, CustomFieldValue, CustomMetaTag, CustomObjectBulkEntry, CustomObjectBulkEntryInitiateDownload, CustomObjectBulkSchema, CustomObjectByIdSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionDeleteResponseSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionsSchema, CustomObjectDefinitionUpdateRequestSchema, CustomObjectEntry, CustomObjectEntryBulkUploadResponse, CustomObjectEntryFieldSchema, CustomObjectFieldSchema, CustomObjectJobSchema, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectMetaSchema, CustomObjectRequestSchema, CustomObjectSchema, CustomObjectsSchema, DataLoaderResetResponseSchema, DataLoaderResponseSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, Date, DateMeta, Datetime, DefaultNavigationResponse, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, Detail, Dropdown, EditorMeta, EmailProperties, EmailSchema, FAQ, FAQCategorySchema, FaqSchema, FieldDefinitionSchema, FieldValidations, File, FloatType, GeneratedSEOContent, GenerateSEOContent, GetAnnouncementListSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, GetFaqSchema, HandpickedTagSchema, Integer, Json, LandingPageGetResponse, LandingPageSchema, Language, LocaleLanguage, Metaobject, NavigationGetResponse, NavigationReference, NavigationRequest, NavigationSchema, NextSchedule, Orientation, Page, PageGetResponse, PageMetaSchema, PagePublishRequest, PageRequest, PageSchema, PageSpec, PageSpecItem, PageSpecParam, PathMappingSchema, PathSourceSchema, PhoneProperties, PhoneSchema, Product, RemoveHandpickedSchema, ResourceContent, ResourceSchema, ResourcesSchema, ScheduleSchema, SEO, SEObreadcrumb, SeoComponent, SEOImage, SEOMetaItem, SEOMetaItems, SeoSchema, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, SEOSitemap, SlideshowGetResponse, SlideshowMedia, SlideshowRequest, SlideshowSchema, StringMultiLine, StringSingleLine, Support, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, TagDeleteSuccessResponse, TagSchema, TagSourceSchema, TagsSchema, UpdateFaqCategoryRequestSchema, UpdateHandpickedSchema, Url, GenerationEntityType, PageType };
709
+ export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, ScheduleSchema, NextSchedule, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, ActionPage, NavigationReference, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, 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, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, GenerationEntityType, PageType };
1224
710
  }
1225
- /** @returns {Action} */
1226
- declare function Action(): Action;
1227
- type Action = {
1228
- page?: ActionPage;
1229
- popup?: ActionPage;
711
+ /** @returns {GenerateSEOContent} */
712
+ declare function GenerateSEOContent(): GenerateSEOContent;
713
+ type GenerateSEOContent = {
714
+ text?: string;
715
+ existing_text?: string;
716
+ keywords?: string[];
1230
717
  type?: string;
1231
718
  };
1232
- /** @returns {ActionPage} */
1233
- declare function ActionPage(): ActionPage;
1234
- type ActionPage = {
1235
- params?: any;
1236
- query?: any;
1237
- type: PageType;
1238
- url?: string;
1239
- };
1240
- /** @returns {AdminAnnouncementSchema} */
1241
- declare function AdminAnnouncementSchema(): AdminAnnouncementSchema;
1242
- type AdminAnnouncementSchema = {
1243
- _id?: string;
1244
- _schedule?: ScheduleSchema;
1245
- announcement?: string;
1246
- app?: string;
1247
- author?: AnnouncementAuthorSchema;
1248
- created_at?: string;
1249
- editor_meta?: EditorMeta;
1250
- modified_at?: string;
1251
- pages?: AnnouncementPageSchema[];
1252
- platforms?: string[];
719
+ /** @returns {GeneratedSEOContent} */
720
+ declare function GeneratedSEOContent(): GeneratedSEOContent;
721
+ type GeneratedSEOContent = {
1253
722
  title?: string;
1254
- };
1255
- /** @returns {AnnouncementAuthorSchema} */
1256
- declare function AnnouncementAuthorSchema(): AnnouncementAuthorSchema;
1257
- type AnnouncementAuthorSchema = {
1258
- created_by?: string;
1259
- modified_by?: string;
1260
- };
1261
- /** @returns {AnnouncementPageSchema} */
1262
- declare function AnnouncementPageSchema(): AnnouncementPageSchema;
1263
- type AnnouncementPageSchema = {
1264
- page_slug?: string;
1265
- type?: string;
723
+ description?: string;
1266
724
  };
1267
725
  /** @returns {ApplicationLegal} */
1268
726
  declare function ApplicationLegal(): ApplicationLegal;
1269
727
  type ApplicationLegal = {
1270
- _id?: string;
1271
728
  application?: string;
1272
- created_at?: string;
1273
- faq?: ApplicationLegalFAQ[];
729
+ tnc?: string;
1274
730
  policy?: string;
1275
- returns?: string;
1276
731
  shipping?: string;
1277
- tnc?: string;
732
+ returns?: string;
733
+ faq?: ApplicationLegalFAQ[];
734
+ _id?: string;
1278
735
  updated_at?: string;
736
+ created_at?: string;
1279
737
  };
1280
738
  /** @returns {ApplicationLegalFAQ} */
1281
739
  declare function ApplicationLegalFAQ(): ApplicationLegalFAQ;
1282
740
  type ApplicationLegalFAQ = {
1283
- answer?: string;
1284
741
  question?: string;
742
+ answer?: string;
1285
743
  };
1286
- /** @returns {Asset} */
1287
- declare function Asset(): Asset;
1288
- type Asset = {
1289
- aspect_ratio?: string;
1290
- id?: string;
1291
- secure_url?: string;
1292
- };
1293
- /** @returns {Author} */
1294
- declare function Author(): Author;
1295
- type Author = {
1296
- designation?: string;
1297
- id?: string;
1298
- name?: string;
1299
- };
1300
- /** @returns {BlogGetResponse} */
1301
- declare function BlogGetResponse(): BlogGetResponse;
1302
- type BlogGetResponse = {
1303
- items?: BlogSchema[];
1304
- page?: Page;
1305
- };
1306
- /** @returns {BlogRequest} */
1307
- declare function BlogRequest(): BlogRequest;
1308
- type BlogRequest = {
1309
- _custom_json?: any;
1310
- _schedule?: CronSchedule;
744
+ /** @returns {PathMappingSchema} */
745
+ declare function PathMappingSchema(): PathMappingSchema;
746
+ type PathMappingSchema = {
1311
747
  application?: string;
1312
- author?: Author;
1313
- content?: ResourceContent[];
1314
- feature_image?: Asset;
1315
- published?: boolean;
1316
- reading_time?: string;
1317
- seo?: SEO;
1318
- slug?: string;
1319
- tags?: string[];
1320
- title?: string;
1321
- };
1322
- /** @returns {BlogSchema} */
1323
- declare function BlogSchema(): BlogSchema;
1324
- type BlogSchema = {
1325
- _custom_json?: any;
1326
748
  _id?: string;
1327
- _schedule?: CronSchedule;
1328
- application?: string;
1329
- archived?: boolean;
1330
- author?: Author;
1331
- content?: ResourceContent[];
1332
- date_meta?: DateMeta;
1333
- feature_image?: Asset;
1334
- published?: boolean;
1335
- reading_time?: string;
1336
- seo?: SEO;
1337
- slug?: string;
1338
- tags?: string[];
1339
- title?: string;
749
+ redirect_from?: string;
750
+ redirect_to?: string;
751
+ updated_at?: string;
752
+ created_at?: string;
753
+ __source?: PathSourceSchema;
1340
754
  };
1341
- /** @returns {BooleanType} */
1342
- declare function BooleanType(): BooleanType;
1343
- type BooleanType = {
1344
- category?: string;
1345
- list_enabled?: boolean;
1346
- name?: string;
1347
- supported_validations?: SupportedValidationsSchema[];
755
+ /** @returns {PathSourceSchema} */
756
+ declare function PathSourceSchema(): PathSourceSchema;
757
+ type PathSourceSchema = {
1348
758
  type?: string;
1349
- };
1350
- /** @returns {CategoryRequestSchema} */
1351
- declare function CategoryRequestSchema(): CategoryRequestSchema;
1352
- type CategoryRequestSchema = {
1353
- slug?: string;
1354
- title?: string;
1355
- };
1356
- /** @returns {CategorySchema} */
1357
- declare function CategorySchema(): CategorySchema;
1358
- type CategorySchema = {
1359
- _custom_json?: any;
1360
- _id?: string;
1361
- application?: string;
1362
- children?: string[];
1363
- description?: string;
1364
- icon_url?: string;
1365
- index?: number;
1366
- slug?: string;
1367
- title?: string;
1368
- };
1369
- /** @returns {ChildrenSchema} */
1370
- declare function ChildrenSchema(): ChildrenSchema;
1371
- type ChildrenSchema = {
1372
- _id?: string;
1373
- answer?: string;
1374
- application?: string;
1375
- question?: string;
1376
- slug?: string;
1377
- };
1378
- /** @returns {CommonError} */
1379
- declare function CommonError(): CommonError;
1380
- type CommonError = {
1381
- message?: string;
1382
- };
1383
- /** @returns {ConfigurationSchema} */
1384
- declare function ConfigurationSchema(): ConfigurationSchema;
1385
- type ConfigurationSchema = {
1386
- duration?: number;
1387
- sleep_time?: number;
1388
- slide_direction?: string;
1389
- start_on_launch?: boolean;
1390
- };
1391
- /** @returns {ContactSchema} */
1392
- declare function ContactSchema(): ContactSchema;
1393
- type ContactSchema = {
1394
- email?: EmailSchema;
1395
- phone?: PhoneSchema;
1396
- };
1397
- /** @returns {ContentAPIError} */
1398
- declare function ContentAPIError(): ContentAPIError;
1399
- type ContentAPIError = {
1400
- code?: string;
1401
- exception?: string;
1402
- info?: string;
1403
- message?: string;
1404
- meta?: any;
1405
- request_id?: string;
1406
- stack_trace?: string;
1407
- status?: number;
1408
- };
1409
- /** @returns {CreateAnnouncementSchema} */
1410
- declare function CreateAnnouncementSchema(): CreateAnnouncementSchema;
1411
- type CreateAnnouncementSchema = {
1412
- data?: AdminAnnouncementSchema;
1413
- message?: string;
1414
- };
1415
- /** @returns {CreatedBySchema} */
1416
- declare function CreatedBySchema(): CreatedBySchema;
1417
- type CreatedBySchema = {
1418
759
  id?: string;
1419
760
  };
1420
- /** @returns {CreateFaqCategoryRequestSchema} */
1421
- declare function CreateFaqCategoryRequestSchema(): CreateFaqCategoryRequestSchema;
1422
- type CreateFaqCategoryRequestSchema = {
1423
- category?: CategoryRequestSchema;
1424
- };
1425
- /** @returns {CreateFaqCategorySchema} */
1426
- declare function CreateFaqCategorySchema(): CreateFaqCategorySchema;
1427
- type CreateFaqCategorySchema = {
1428
- category?: CategorySchema;
1429
- };
1430
- /** @returns {CreateFaqResponseSchema} */
1431
- declare function CreateFaqResponseSchema(): CreateFaqResponseSchema;
1432
- type CreateFaqResponseSchema = {
1433
- faq?: FaqSchema;
1434
- };
1435
- /** @returns {CreateFaqSchema} */
1436
- declare function CreateFaqSchema(): CreateFaqSchema;
1437
- type CreateFaqSchema = {
1438
- faq?: FAQ;
1439
- };
1440
- /** @returns {CreateTagRequestSchema} */
1441
- declare function CreateTagRequestSchema(): CreateTagRequestSchema;
1442
- type CreateTagRequestSchema = {
1443
- tags?: CreateTagSchema[];
1444
- };
1445
- /** @returns {CreateTagSchema} */
1446
- declare function CreateTagSchema(): CreateTagSchema;
1447
- type CreateTagSchema = {
1448
- _id?: string;
1449
- attributes?: any;
1450
- content?: string;
1451
- name?: string;
1452
- pages?: any[];
1453
- position?: string;
1454
- sub_type?: string;
1455
- type?: string;
1456
- url?: string;
1457
- };
1458
- /** @returns {CronSchedule} */
1459
- declare function CronSchedule(): CronSchedule;
1460
- type CronSchedule = {
1461
- cron?: string;
1462
- duration?: number;
1463
- end?: string;
1464
- start?: string;
1465
- };
1466
- /** @returns {CustomDataDeleteSchema} */
1467
- declare function CustomDataDeleteSchema(): CustomDataDeleteSchema;
1468
- type CustomDataDeleteSchema = {
1469
- message?: string;
1470
- success?: boolean;
1471
- };
1472
- /** @returns {CustomField} */
1473
- declare function CustomField(): CustomField;
1474
- type CustomField = {
1475
- definition_id?: string;
1476
- value?: any[];
761
+ /** @returns {SeoComponent} */
762
+ declare function SeoComponent(): SeoComponent;
763
+ type SeoComponent = {
764
+ seo?: SeoSchema;
1477
765
  };
1478
- /** @returns {CustomFieldDefinitionDetailResSchema} */
1479
- declare function CustomFieldDefinitionDetailResSchema(): CustomFieldDefinitionDetailResSchema;
1480
- type CustomFieldDefinitionDetailResSchema = {
766
+ /** @returns {SeoSchema} */
767
+ declare function SeoSchema(): SeoSchema;
768
+ type SeoSchema = {
769
+ app?: string;
1481
770
  _id?: string;
1482
- application_id?: string;
1483
- company_id?: string;
771
+ robots_txt?: string;
772
+ sitemap_enabled?: boolean;
773
+ cannonical_enabled?: boolean;
774
+ custom_meta_tags?: CustomMetaTag[];
775
+ details?: Detail;
1484
776
  created_at?: string;
1485
- created_by?: string;
1486
- creator?: string;
1487
- description?: string;
1488
- is_deleted?: boolean;
1489
- key?: string;
1490
- multi_value?: boolean;
1491
- name?: string;
1492
- namespace?: string;
1493
- required?: boolean;
1494
- resource?: string;
1495
- type?: string;
1496
777
  updated_at?: string;
1497
- updated_by?: string;
1498
- validations?: any[];
1499
778
  };
1500
- /** @returns {CustomFieldDefinitionRequestSchema} */
1501
- declare function CustomFieldDefinitionRequestSchema(): CustomFieldDefinitionRequestSchema;
1502
- type CustomFieldDefinitionRequestSchema = {
1503
- description?: string;
1504
- key?: string;
1505
- multi_value?: boolean;
779
+ /** @returns {CustomMetaTag} */
780
+ declare function CustomMetaTag(): CustomMetaTag;
781
+ type CustomMetaTag = {
1506
782
  name?: string;
1507
- namespace?: string;
1508
- resource?: string;
783
+ content?: string;
784
+ _id?: string;
785
+ };
786
+ /** @returns {Detail} */
787
+ declare function Detail(): Detail;
788
+ type Detail = {
789
+ title?: string;
790
+ description?: string;
791
+ image_url?: string;
792
+ };
793
+ /** @returns {AnnouncementPageSchema} */
794
+ declare function AnnouncementPageSchema(): AnnouncementPageSchema;
795
+ type AnnouncementPageSchema = {
796
+ page_slug?: string;
1509
797
  type?: string;
1510
- validations?: FieldValidations[];
1511
798
  };
1512
- /** @returns {CustomFieldDefinitionsSchema} */
1513
- declare function CustomFieldDefinitionsSchema(): CustomFieldDefinitionsSchema;
1514
- type CustomFieldDefinitionsSchema = {
1515
- items?: FieldDefinitionSchema[];
1516
- page?: Page;
799
+ /** @returns {EditorMeta} */
800
+ declare function EditorMeta(): EditorMeta;
801
+ type EditorMeta = {
802
+ foreground_color?: string;
803
+ background_color?: string;
804
+ content_type?: string;
805
+ content?: string;
1517
806
  };
1518
- /** @returns {CustomFieldRequestSchema} */
1519
- declare function CustomFieldRequestSchema(): CustomFieldRequestSchema;
1520
- type CustomFieldRequestSchema = {
1521
- fields?: CustomField[];
807
+ /** @returns {AnnouncementAuthorSchema} */
808
+ declare function AnnouncementAuthorSchema(): AnnouncementAuthorSchema;
809
+ type AnnouncementAuthorSchema = {
810
+ created_by?: string;
811
+ modified_by?: string;
1522
812
  };
1523
- /** @returns {CustomFieldSchema} */
1524
- declare function CustomFieldSchema(): CustomFieldSchema;
1525
- type CustomFieldSchema = {
813
+ /** @returns {AdminAnnouncementSchema} */
814
+ declare function AdminAnnouncementSchema(): AdminAnnouncementSchema;
815
+ type AdminAnnouncementSchema = {
1526
816
  _id?: string;
1527
- company_id?: string;
817
+ platforms?: string[];
818
+ title?: string;
819
+ announcement?: string;
820
+ pages?: AnnouncementPageSchema[];
821
+ editor_meta?: EditorMeta;
822
+ author?: AnnouncementAuthorSchema;
1528
823
  created_at?: string;
1529
- created_by?: string;
1530
- creator?: string;
1531
- definition_id?: string;
1532
- has_invalid_values?: boolean;
1533
- invalid_value_errors?: any[];
1534
- is_deleted?: boolean;
1535
- key?: string;
1536
- multi_value?: boolean;
1537
- namespace?: string;
1538
- resource?: string;
1539
- resource_id?: string;
1540
- type?: string;
1541
- updated_at?: string;
1542
- value?: CustomFieldValue[];
824
+ app?: string;
825
+ modified_at?: string;
826
+ _schedule?: ScheduleSchema;
827
+ };
828
+ /** @returns {ScheduleSchema} */
829
+ declare function ScheduleSchema(): ScheduleSchema;
830
+ type ScheduleSchema = {
831
+ cron?: string;
832
+ start?: string;
833
+ end?: string;
834
+ duration?: number;
835
+ next_schedule?: NextSchedule[];
1543
836
  };
1544
- /** @returns {CustomFieldsResponseByResourceIdSchema} */
1545
- declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseByResourceIdSchema;
1546
- type CustomFieldsResponseByResourceIdSchema = {
1547
- items?: CustomFieldSchema[];
837
+ /** @returns {NextSchedule} */
838
+ declare function NextSchedule(): NextSchedule;
839
+ type NextSchedule = {
840
+ start?: string;
841
+ end?: string;
1548
842
  };
1549
- /** @returns {CustomFieldsResponseSchema} */
1550
- declare function CustomFieldsResponseSchema(): CustomFieldsResponseSchema;
1551
- type CustomFieldsResponseSchema = {
1552
- items?: CustomFieldSchema[];
843
+ /** @returns {BlogGetResponse} */
844
+ declare function BlogGetResponse(): BlogGetResponse;
845
+ type BlogGetResponse = {
846
+ items?: BlogSchema[];
1553
847
  page?: Page;
1554
848
  };
1555
- /** @returns {CustomFieldTypeSchema} */
1556
- declare function CustomFieldTypeSchema(): CustomFieldTypeSchema;
1557
- type CustomFieldTypeSchema = {
1558
- boolean_type?: BooleanType;
1559
- date?: Date;
1560
- datetime?: Datetime;
1561
- dropdown?: Dropdown;
1562
- file?: File;
1563
- float_type?: FloatType;
1564
- integer?: Integer;
1565
- json?: Json;
1566
- metaobject?: Metaobject;
1567
- product?: Product;
1568
- string_multi_line?: StringMultiLine;
1569
- string_single_line?: StringSingleLine;
1570
- url?: Url;
1571
- };
1572
- /** @returns {CustomFieldValue} */
1573
- declare function CustomFieldValue(): CustomFieldValue;
1574
- type CustomFieldValue = {
1575
- value?: any;
849
+ /** @returns {ResourceContent} */
850
+ declare function ResourceContent(): ResourceContent;
851
+ type ResourceContent = {
852
+ type?: string;
853
+ value?: string;
1576
854
  };
1577
- /** @returns {CustomMetaTag} */
1578
- declare function CustomMetaTag(): CustomMetaTag;
1579
- type CustomMetaTag = {
1580
- _id?: string;
1581
- content?: string;
855
+ /** @returns {Asset} */
856
+ declare function Asset(): Asset;
857
+ type Asset = {
858
+ aspect_ratio?: string;
859
+ id?: string;
860
+ secure_url?: string;
861
+ };
862
+ /** @returns {Author} */
863
+ declare function Author(): Author;
864
+ type Author = {
865
+ designation?: string;
866
+ id?: string;
1582
867
  name?: string;
1583
868
  };
1584
- /** @returns {CustomObjectBulkEntry} */
1585
- declare function CustomObjectBulkEntry(): CustomObjectBulkEntry;
1586
- type CustomObjectBulkEntry = {
1587
- items?: CustomObjectJobSchema[];
1588
- page?: Page;
869
+ /** @returns {BlogSchema} */
870
+ declare function BlogSchema(): BlogSchema;
871
+ type BlogSchema = {
872
+ _id?: string;
873
+ _custom_json?: any;
874
+ application?: string;
875
+ archived?: boolean;
876
+ author?: Author;
877
+ content?: ResourceContent[];
878
+ feature_image?: Asset;
879
+ published?: boolean;
880
+ reading_time?: string;
881
+ slug?: string;
882
+ tags?: string[];
883
+ seo?: SEO;
884
+ _schedule?: CronSchedule;
885
+ title?: string;
886
+ date_meta?: DateMeta;
1589
887
  };
1590
- /** @returns {CustomObjectBulkEntryInitiateDownload} */
1591
- declare function CustomObjectBulkEntryInitiateDownload(): CustomObjectBulkEntryInitiateDownload;
1592
- type CustomObjectBulkEntryInitiateDownload = {
1593
- message?: string;
1594
- task_id?: string;
888
+ /** @returns {SEO} */
889
+ declare function SEO(): SEO;
890
+ type SEO = {
891
+ description?: string;
892
+ image?: SEOImage;
893
+ title?: string;
1595
894
  };
1596
- /** @returns {CustomObjectBulkSchema} */
1597
- declare function CustomObjectBulkSchema(): CustomObjectBulkSchema;
1598
- type CustomObjectBulkSchema = {
1599
- total_records?: number;
895
+ /** @returns {SEOImage} */
896
+ declare function SEOImage(): SEOImage;
897
+ type SEOImage = {
1600
898
  url?: string;
1601
899
  };
1602
- /** @returns {CustomObjectByIdSchema} */
1603
- declare function CustomObjectByIdSchema(): CustomObjectByIdSchema;
1604
- type CustomObjectByIdSchema = {
1605
- _id?: string;
1606
- definition?: CustomObjectListItemDefinationSchema;
1607
- display_name?: string;
1608
- fields?: CustomObjectFieldSchema[];
1609
- references?: any[];
1610
- status?: string;
900
+ /** @returns {DateMeta} */
901
+ declare function DateMeta(): DateMeta;
902
+ type DateMeta = {
903
+ created_on?: string;
904
+ modified_on?: string;
1611
905
  };
1612
- /** @returns {CustomObjectCustomFieldDefinitionResSchema} */
1613
- declare function CustomObjectCustomFieldDefinitionResSchema(): CustomObjectCustomFieldDefinitionResSchema;
1614
- type CustomObjectCustomFieldDefinitionResSchema = {
1615
- _id?: string;
1616
- company_id?: string;
1617
- created_at?: string;
1618
- created_by?: string;
1619
- creator?: string;
1620
- description?: string;
1621
- is_deleted?: boolean;
1622
- key?: string;
1623
- metaobject_definition_id?: string;
1624
- multi_value?: boolean;
1625
- name?: string;
1626
- namespace?: string;
1627
- required?: boolean;
1628
- resource?: string;
1629
- type?: string;
1630
- updated_at?: string;
1631
- validations?: FieldValidations[];
906
+ /** @returns {BlogRequest} */
907
+ declare function BlogRequest(): BlogRequest;
908
+ type BlogRequest = {
909
+ application?: string;
910
+ _custom_json?: any;
911
+ author?: Author;
912
+ content?: ResourceContent[];
913
+ feature_image?: Asset;
914
+ published?: boolean;
915
+ reading_time?: string;
916
+ slug?: string;
917
+ tags?: string[];
918
+ title?: string;
919
+ seo?: SEO;
920
+ _schedule?: CronSchedule;
1632
921
  };
1633
- /** @returns {CustomObjectCustomFieldDefinitions} */
1634
- declare function CustomObjectCustomFieldDefinitions(): CustomObjectCustomFieldDefinitions;
1635
- type CustomObjectCustomFieldDefinitions = {
1636
- action?: string;
1637
- description?: string;
1638
- id?: string;
1639
- key?: string;
1640
- multi_value?: boolean;
1641
- name?: string;
1642
- required?: boolean;
1643
- type?: string;
1644
- validations?: FieldValidations[];
922
+ /** @returns {GetAnnouncementListSchema} */
923
+ declare function GetAnnouncementListSchema(): GetAnnouncementListSchema;
924
+ type GetAnnouncementListSchema = {
925
+ items?: AdminAnnouncementSchema[];
926
+ page?: Page;
1645
927
  };
1646
- /** @returns {CustomObjectDefinitionDeleteResponseSchema} */
1647
- declare function CustomObjectDefinitionDeleteResponseSchema(): CustomObjectDefinitionDeleteResponseSchema;
1648
- type CustomObjectDefinitionDeleteResponseSchema = {
928
+ /** @returns {CreateAnnouncementSchema} */
929
+ declare function CreateAnnouncementSchema(): CreateAnnouncementSchema;
930
+ type CreateAnnouncementSchema = {
1649
931
  message?: string;
1650
- success?: boolean;
1651
- };
1652
- /** @returns {CustomObjectDefinitionRequestSchema} */
1653
- declare function CustomObjectDefinitionRequestSchema(): CustomObjectDefinitionRequestSchema;
1654
- type CustomObjectDefinitionRequestSchema = {
1655
- description?: string;
1656
- display_name_key?: string;
1657
- field_definitions?: CustomObjectCustomFieldDefinitions[];
1658
- name?: string;
1659
- type?: string;
932
+ data?: AdminAnnouncementSchema;
1660
933
  };
1661
- /** @returns {CustomObjectDefinitionSchema} */
1662
- declare function CustomObjectDefinitionSchema(): CustomObjectDefinitionSchema;
1663
- type CustomObjectDefinitionSchema = {
934
+ /** @returns {DataLoaderResponseSchema} */
935
+ declare function DataLoaderResponseSchema(): DataLoaderResponseSchema;
936
+ type DataLoaderResponseSchema = {
937
+ application?: string;
938
+ company?: string;
1664
939
  _id?: string;
1665
- created_by?: string;
1666
- creator?: string;
1667
- description?: string;
1668
- display_name_key?: string;
1669
- field_definitions?: CustomObjectCustomFieldDefinitionResSchema[];
1670
940
  name?: string;
941
+ service?: string;
942
+ operation_id?: string;
1671
943
  type?: string;
1672
- updated_by?: string;
944
+ url?: string;
945
+ content?: string;
946
+ __source?: DataLoaderSourceSchema;
1673
947
  };
1674
- /** @returns {CustomObjectDefinitionsSchema} */
1675
- declare function CustomObjectDefinitionsSchema(): CustomObjectDefinitionsSchema;
1676
- type CustomObjectDefinitionsSchema = {
1677
- items?: CustomObjectEntry[];
1678
- page?: Page;
948
+ /** @returns {DataLoaderResetResponseSchema} */
949
+ declare function DataLoaderResetResponseSchema(): DataLoaderResetResponseSchema;
950
+ type DataLoaderResetResponseSchema = {
951
+ reset?: boolean;
1679
952
  };
1680
- /** @returns {CustomObjectDefinitionUpdateRequestSchema} */
1681
- declare function CustomObjectDefinitionUpdateRequestSchema(): CustomObjectDefinitionUpdateRequestSchema;
1682
- type CustomObjectDefinitionUpdateRequestSchema = {
1683
- description?: string;
1684
- display_name_key?: string;
1685
- field_definitions?: CustomObjectCustomFieldDefinitions[];
1686
- name?: string;
1687
- type?: string;
953
+ /** @returns {LocaleLanguage} */
954
+ declare function LocaleLanguage(): LocaleLanguage;
955
+ type LocaleLanguage = {
956
+ hi?: Language;
957
+ ar?: Language;
958
+ en_us?: Language;
1688
959
  };
1689
- /** @returns {CustomObjectEntry} */
1690
- declare function CustomObjectEntry(): CustomObjectEntry;
1691
- type CustomObjectEntry = {
1692
- _id?: string;
1693
- entries_count?: number;
1694
- fields_count?: number;
1695
- name?: string;
960
+ /** @returns {Language} */
961
+ declare function Language(): Language;
962
+ type Language = {
963
+ display?: string;
964
+ };
965
+ /** @returns {Action} */
966
+ declare function Action(): Action;
967
+ type Action = {
968
+ page?: ActionPage;
969
+ popup?: ActionPage;
1696
970
  type?: string;
1697
- updated_at?: string;
1698
971
  };
1699
- /** @returns {CustomObjectEntryBulkUploadResponse} */
1700
- declare function CustomObjectEntryBulkUploadResponse(): CustomObjectEntryBulkUploadResponse;
1701
- type CustomObjectEntryBulkUploadResponse = {
1702
- total_records?: number;
972
+ /** @returns {ActionPage} */
973
+ declare function ActionPage(): ActionPage;
974
+ type ActionPage = {
975
+ params?: any;
976
+ query?: any;
1703
977
  url?: string;
978
+ type: PageType;
1704
979
  };
1705
- /** @returns {CustomObjectEntryFieldSchema} */
1706
- declare function CustomObjectEntryFieldSchema(): CustomObjectEntryFieldSchema;
1707
- type CustomObjectEntryFieldSchema = {
1708
- definition_id?: string;
1709
- value?: any[];
1710
- };
1711
- /** @returns {CustomObjectFieldSchema} */
1712
- declare function CustomObjectFieldSchema(): CustomObjectFieldSchema;
1713
- type CustomObjectFieldSchema = {
1714
- _id?: string;
1715
- definition_id?: string;
1716
- key?: string;
980
+ /** @returns {NavigationReference} */
981
+ declare function NavigationReference(): NavigationReference;
982
+ type NavigationReference = {
983
+ acl?: string[];
984
+ tags?: string[];
985
+ _locale_language?: LocaleLanguage;
986
+ image?: string;
1717
987
  type?: string;
1718
- value?: any[];
988
+ action?: Action;
989
+ active?: boolean;
990
+ display?: string;
991
+ sort_order?: number;
992
+ sub_navigation?: NavigationReference[];
1719
993
  };
1720
- /** @returns {CustomObjectJobSchema} */
1721
- declare function CustomObjectJobSchema(): CustomObjectJobSchema;
1722
- type CustomObjectJobSchema = {
1723
- _id?: string;
1724
- action_type?: string;
1725
- company_id?: string;
1726
- created_at?: string;
1727
- created_by?: string;
1728
- creator?: string;
1729
- entity?: string;
1730
- error_count?: number;
1731
- error_jobs?: string[];
1732
- error_url?: string;
1733
- errors_occured?: string[];
1734
- finished_count?: number;
1735
- finished_jobs?: string[];
1736
- jobs?: string[];
1737
- meta?: CustomObjectMetaSchema;
1738
- status?: string;
1739
- success_count?: number;
1740
- total_jobs?: number;
1741
- updated_at?: string;
1742
- url?: string;
994
+ /** @returns {ConfigurationSchema} */
995
+ declare function ConfigurationSchema(): ConfigurationSchema;
996
+ type ConfigurationSchema = {
997
+ sleep_time?: number;
998
+ start_on_launch?: boolean;
999
+ duration?: number;
1000
+ slide_direction?: string;
1743
1001
  };
1744
- /** @returns {CustomObjectListItemDefinationSchema} */
1745
- declare function CustomObjectListItemDefinationSchema(): CustomObjectListItemDefinationSchema;
1746
- type CustomObjectListItemDefinationSchema = {
1747
- _id?: string;
1748
- name?: string;
1002
+ /** @returns {SlideshowMedia} */
1003
+ declare function SlideshowMedia(): SlideshowMedia;
1004
+ type SlideshowMedia = {
1749
1005
  type?: string;
1006
+ url?: string;
1007
+ bg_color?: string;
1008
+ duration?: number;
1009
+ auto_decide_duration?: boolean;
1010
+ action?: Action;
1750
1011
  };
1751
- /** @returns {CustomObjectListItemSchema} */
1752
- declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
1753
- type CustomObjectListItemSchema = {
1754
- _id?: string;
1755
- definition?: CustomObjectListItemDefinationSchema;
1756
- definition_id?: string;
1757
- display_name?: string;
1758
- references?: number;
1759
- status?: string;
1760
- updated_at?: string;
1012
+ /** @returns {UpdateHandpickedSchema} */
1013
+ declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
1014
+ type UpdateHandpickedSchema = {
1015
+ tag?: HandpickedTagSchema;
1761
1016
  };
1762
- /** @returns {CustomObjectMetaSchema} */
1763
- declare function CustomObjectMetaSchema(): CustomObjectMetaSchema;
1764
- type CustomObjectMetaSchema = {
1765
- mo_defintion_type?: string;
1766
- mo_error_count?: number;
1767
- mo_success_count?: number;
1768
- mo_total_count?: number;
1769
- };
1770
- /** @returns {CustomObjectRequestSchema} */
1771
- declare function CustomObjectRequestSchema(): CustomObjectRequestSchema;
1772
- type CustomObjectRequestSchema = {
1773
- definition_id?: string;
1774
- fields?: CustomObjectEntryFieldSchema[];
1775
- status?: string;
1776
- };
1777
- /** @returns {CustomObjectSchema} */
1778
- declare function CustomObjectSchema(): CustomObjectSchema;
1779
- type CustomObjectSchema = {
1780
- _id?: string;
1781
- application_id?: string;
1782
- company_id?: string;
1783
- created_by?: string;
1784
- creator?: string;
1785
- definition_id?: string;
1786
- display_name?: string;
1787
- fields?: CustomFieldSchema[];
1788
- status?: string;
1017
+ /** @returns {HandpickedTagSchema} */
1018
+ declare function HandpickedTagSchema(): HandpickedTagSchema;
1019
+ type HandpickedTagSchema = {
1020
+ position?: string;
1021
+ attributes?: any;
1022
+ name?: string;
1023
+ url?: string;
1789
1024
  type?: string;
1790
- updated_by?: string;
1791
- };
1792
- /** @returns {CustomObjectsSchema} */
1793
- declare function CustomObjectsSchema(): CustomObjectsSchema;
1794
- type CustomObjectsSchema = {
1795
- items?: CustomObjectListItemSchema[];
1796
- page?: Page;
1025
+ sub_type?: string;
1026
+ content?: string;
1797
1027
  };
1798
- /** @returns {DataLoaderResetResponseSchema} */
1799
- declare function DataLoaderResetResponseSchema(): DataLoaderResetResponseSchema;
1800
- type DataLoaderResetResponseSchema = {
1801
- reset?: boolean;
1028
+ /** @returns {RemoveHandpickedSchema} */
1029
+ declare function RemoveHandpickedSchema(): RemoveHandpickedSchema;
1030
+ type RemoveHandpickedSchema = {
1031
+ tags?: string[];
1802
1032
  };
1803
- /** @returns {DataLoaderResponseSchema} */
1804
- declare function DataLoaderResponseSchema(): DataLoaderResponseSchema;
1805
- type DataLoaderResponseSchema = {
1806
- __source?: DataLoaderSourceSchema;
1807
- _id?: string;
1808
- application?: string;
1809
- company?: string;
1810
- content?: string;
1033
+ /** @returns {CreateTagSchema} */
1034
+ declare function CreateTagSchema(): CreateTagSchema;
1035
+ type CreateTagSchema = {
1811
1036
  name?: string;
1812
- operation_id?: string;
1813
- service?: string;
1037
+ sub_type?: string;
1038
+ _id?: string;
1814
1039
  type?: string;
1815
1040
  url?: string;
1041
+ position?: string;
1042
+ attributes?: any;
1043
+ pages?: any[];
1044
+ content?: string;
1045
+ };
1046
+ /** @returns {CreateTagRequestSchema} */
1047
+ declare function CreateTagRequestSchema(): CreateTagRequestSchema;
1048
+ type CreateTagRequestSchema = {
1049
+ tags?: CreateTagSchema[];
1816
1050
  };
1817
1051
  /** @returns {DataLoaderSchema} */
1818
1052
  declare function DataLoaderSchema(): DataLoaderSchema;
1819
1053
  type DataLoaderSchema = {
1820
- __source?: DataLoaderSourceSchema;
1821
- _id?: string;
1822
- content?: string;
1823
1054
  name?: string;
1824
- operation_id?: string;
1825
1055
  service?: string;
1056
+ operation_id?: string;
1826
1057
  type?: string;
1827
1058
  url?: string;
1059
+ content?: string;
1060
+ __source?: DataLoaderSourceSchema;
1061
+ _id?: string;
1828
1062
  };
1829
1063
  /** @returns {DataLoaderSourceSchema} */
1830
1064
  declare function DataLoaderSourceSchema(): DataLoaderSourceSchema;
1831
1065
  type DataLoaderSourceSchema = {
1832
- id?: string;
1833
1066
  type?: string;
1067
+ id?: string;
1834
1068
  };
1835
1069
  /** @returns {DataLoadersSchema} */
1836
1070
  declare function DataLoadersSchema(): DataLoadersSchema;
1837
1071
  type DataLoadersSchema = {
1838
1072
  items?: DataLoaderSchema[];
1839
1073
  };
1840
- /** @returns {Date} */
1841
- declare function Date(): Date;
1842
- type Date = {
1843
- category?: string;
1844
- list_enabled?: boolean;
1845
- name?: string;
1846
- supported_validations?: SupportedValidationsSchema[];
1847
- type?: string;
1848
- };
1849
- /** @returns {DateMeta} */
1850
- declare function DateMeta(): DateMeta;
1851
- type DateMeta = {
1852
- created_on?: string;
1853
- modified_on?: string;
1854
- };
1855
- /** @returns {Datetime} */
1856
- declare function Datetime(): Datetime;
1857
- type Datetime = {
1858
- category?: string;
1859
- list_enabled?: boolean;
1860
- name?: string;
1861
- supported_validations?: SupportedValidationsSchema[];
1862
- type?: string;
1863
- };
1864
- /** @returns {DefaultNavigationResponse} */
1865
- declare function DefaultNavigationResponse(): DefaultNavigationResponse;
1866
- type DefaultNavigationResponse = {
1867
- items?: NavigationSchema[];
1074
+ /** @returns {TagDeleteSuccessResponse} */
1075
+ declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
1076
+ type TagDeleteSuccessResponse = {
1077
+ success?: boolean;
1868
1078
  };
1869
- /** @returns {DefaultSchemaComponent} */
1870
- declare function DefaultSchemaComponent(): DefaultSchemaComponent;
1871
- type DefaultSchemaComponent = {
1872
- items?: DefaultSEOSchemaMarkupTemplate[];
1079
+ /** @returns {ContentAPIError} */
1080
+ declare function ContentAPIError(): ContentAPIError;
1081
+ type ContentAPIError = {
1082
+ message?: string;
1083
+ status?: number;
1084
+ code?: string;
1085
+ exception?: string;
1086
+ info?: string;
1087
+ request_id?: string;
1088
+ stack_trace?: string;
1089
+ meta?: any;
1873
1090
  };
1874
- /** @returns {DefaultSEOSchemaMarkupTemplate} */
1875
- declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplate;
1876
- type DefaultSEOSchemaMarkupTemplate = {
1877
- page_type?: string;
1878
- schema?: string;
1879
- target_json?: any;
1091
+ /** @returns {CommonError} */
1092
+ declare function CommonError(): CommonError;
1093
+ type CommonError = {
1094
+ message?: string;
1880
1095
  };
1881
- /** @returns {Detail} */
1882
- declare function Detail(): Detail;
1883
- type Detail = {
1884
- description?: string;
1885
- image_url?: string;
1096
+ /** @returns {CategorySchema} */
1097
+ declare function CategorySchema(): CategorySchema;
1098
+ type CategorySchema = {
1099
+ index?: number;
1886
1100
  title?: string;
1101
+ description?: string;
1102
+ children?: string[];
1103
+ _id?: string;
1104
+ slug?: string;
1105
+ application?: string;
1106
+ icon_url?: string;
1107
+ _custom_json?: any;
1887
1108
  };
1888
- /** @returns {Dropdown} */
1889
- declare function Dropdown(): Dropdown;
1890
- type Dropdown = {
1891
- category?: string;
1892
- list_enabled?: boolean;
1893
- name?: string;
1894
- supported_validations?: SupportedValidationsSchema[];
1895
- type?: string;
1896
- };
1897
- /** @returns {EditorMeta} */
1898
- declare function EditorMeta(): EditorMeta;
1899
- type EditorMeta = {
1900
- background_color?: string;
1901
- content?: string;
1902
- content_type?: string;
1903
- foreground_color?: string;
1904
- };
1905
- /** @returns {EmailProperties} */
1906
- declare function EmailProperties(): EmailProperties;
1907
- type EmailProperties = {
1908
- key?: string;
1909
- value?: string;
1910
- };
1911
- /** @returns {EmailSchema} */
1912
- declare function EmailSchema(): EmailSchema;
1913
- type EmailSchema = {
1914
- active?: boolean;
1915
- email?: EmailProperties[];
1916
- };
1917
- /** @returns {FAQ} */
1918
- declare function FAQ(): FAQ;
1919
- type FAQ = {
1920
- answer?: string;
1109
+ /** @returns {ChildrenSchema} */
1110
+ declare function ChildrenSchema(): ChildrenSchema;
1111
+ type ChildrenSchema = {
1921
1112
  question?: string;
1113
+ answer?: string;
1114
+ slug?: string;
1115
+ application?: string;
1116
+ _id?: string;
1117
+ };
1118
+ /** @returns {CategoryRequestSchema} */
1119
+ declare function CategoryRequestSchema(): CategoryRequestSchema;
1120
+ type CategoryRequestSchema = {
1922
1121
  slug?: string;
1122
+ title?: string;
1923
1123
  };
1924
1124
  /** @returns {FAQCategorySchema} */
1925
1125
  declare function FAQCategorySchema(): FAQCategorySchema;
1926
1126
  type FAQCategorySchema = {
1927
- _custom_json?: any;
1127
+ index?: number;
1128
+ title?: string;
1129
+ description?: string;
1130
+ children?: ChildrenSchema[];
1928
1131
  _id?: string;
1132
+ slug?: string;
1929
1133
  application?: string;
1930
- children?: ChildrenSchema[];
1931
- description?: string;
1932
1134
  icon_url?: string;
1933
- index?: number;
1934
- slug?: string;
1935
- title?: string;
1135
+ _custom_json?: any;
1936
1136
  };
1937
1137
  /** @returns {FaqSchema} */
1938
1138
  declare function FaqSchema(): FaqSchema;
1939
1139
  type FaqSchema = {
1940
- _id?: string;
1941
- answer?: string;
1140
+ slug?: string;
1942
1141
  application?: string;
1142
+ _id?: string;
1943
1143
  question?: string;
1944
- slug?: string;
1144
+ answer?: string;
1945
1145
  tags?: string[];
1946
1146
  };
1947
- /** @returns {FieldDefinitionSchema} */
1948
- declare function FieldDefinitionSchema(): FieldDefinitionSchema;
1949
- type FieldDefinitionSchema = {
1950
- _id?: string;
1951
- company_id?: string;
1952
- created_at?: string;
1953
- created_by?: string;
1954
- creator?: string;
1955
- description?: string;
1956
- invalid_fields_count?: number;
1957
- is_deleted?: boolean;
1958
- key?: string;
1959
- multi_value?: boolean;
1960
- name?: string;
1961
- namespace?: string;
1962
- required?: boolean;
1963
- resource?: string;
1964
- type?: string;
1965
- type_name?: string;
1966
- updated_at?: string;
1967
- updated_by?: string;
1968
- validations?: FieldValidations[];
1147
+ /** @returns {FAQ} */
1148
+ declare function FAQ(): FAQ;
1149
+ type FAQ = {
1150
+ slug?: string;
1151
+ question?: string;
1152
+ answer?: string;
1969
1153
  };
1970
- /** @returns {FieldValidations} */
1971
- declare function FieldValidations(): FieldValidations;
1972
- type FieldValidations = {
1973
- name?: string;
1974
- type?: string;
1975
- value?: any;
1154
+ /** @returns {CreateFaqResponseSchema} */
1155
+ declare function CreateFaqResponseSchema(): CreateFaqResponseSchema;
1156
+ type CreateFaqResponseSchema = {
1157
+ faq?: FaqSchema;
1976
1158
  };
1977
- /** @returns {File} */
1978
- declare function File(): File;
1979
- type File = {
1980
- category?: string;
1981
- list_enabled?: boolean;
1982
- name?: string;
1983
- supported_validations?: SupportedValidationsSchema[];
1984
- type?: string;
1159
+ /** @returns {CreateFaqSchema} */
1160
+ declare function CreateFaqSchema(): CreateFaqSchema;
1161
+ type CreateFaqSchema = {
1162
+ faq?: FAQ;
1985
1163
  };
1986
- /** @returns {FloatType} */
1987
- declare function FloatType(): FloatType;
1988
- type FloatType = {
1989
- category?: string;
1990
- list_enabled?: boolean;
1991
- name?: string;
1992
- supported_validations?: SupportedValidationsSchema[];
1993
- type?: string;
1164
+ /** @returns {GetFaqSchema} */
1165
+ declare function GetFaqSchema(): GetFaqSchema;
1166
+ type GetFaqSchema = {
1167
+ faqs?: FaqSchema[];
1994
1168
  };
1995
- /** @returns {GeneratedSEOContent} */
1996
- declare function GeneratedSEOContent(): GeneratedSEOContent;
1997
- type GeneratedSEOContent = {
1998
- description?: string;
1999
- title?: string;
1169
+ /** @returns {UpdateFaqCategoryRequestSchema} */
1170
+ declare function UpdateFaqCategoryRequestSchema(): UpdateFaqCategoryRequestSchema;
1171
+ type UpdateFaqCategoryRequestSchema = {
1172
+ category?: CategorySchema;
2000
1173
  };
2001
- /** @returns {GenerateSEOContent} */
2002
- declare function GenerateSEOContent(): GenerateSEOContent;
2003
- type GenerateSEOContent = {
2004
- existing_text?: string;
2005
- keywords?: string[];
2006
- text?: string;
2007
- type?: string;
1174
+ /** @returns {CreateFaqCategoryRequestSchema} */
1175
+ declare function CreateFaqCategoryRequestSchema(): CreateFaqCategoryRequestSchema;
1176
+ type CreateFaqCategoryRequestSchema = {
1177
+ category?: CategoryRequestSchema;
2008
1178
  };
2009
- /** @returns {GetAnnouncementListSchema} */
2010
- declare function GetAnnouncementListSchema(): GetAnnouncementListSchema;
2011
- type GetAnnouncementListSchema = {
2012
- items?: AdminAnnouncementSchema[];
2013
- page?: Page;
1179
+ /** @returns {CreateFaqCategorySchema} */
1180
+ declare function CreateFaqCategorySchema(): CreateFaqCategorySchema;
1181
+ type CreateFaqCategorySchema = {
1182
+ category?: CategorySchema;
2014
1183
  };
2015
1184
  /** @returns {GetFaqCategoriesSchema} */
2016
1185
  declare function GetFaqCategoriesSchema(): GetFaqCategoriesSchema;
@@ -2019,42 +1188,19 @@ type GetFaqCategoriesSchema = {
2019
1188
  };
2020
1189
  /** @returns {GetFaqCategoryBySlugSchema} */
2021
1190
  declare function GetFaqCategoryBySlugSchema(): GetFaqCategoryBySlugSchema;
2022
- type GetFaqCategoryBySlugSchema = {
2023
- category?: FAQCategorySchema;
2024
- };
2025
- /** @returns {GetFaqSchema} */
2026
- declare function GetFaqSchema(): GetFaqSchema;
2027
- type GetFaqSchema = {
2028
- faqs?: FaqSchema[];
2029
- };
2030
- /** @returns {HandpickedTagSchema} */
2031
- declare function HandpickedTagSchema(): HandpickedTagSchema;
2032
- type HandpickedTagSchema = {
2033
- attributes?: any;
2034
- content?: string;
2035
- name?: string;
2036
- position?: string;
2037
- sub_type?: string;
2038
- type?: string;
2039
- url?: string;
2040
- };
2041
- /** @returns {Integer} */
2042
- declare function Integer(): Integer;
2043
- type Integer = {
2044
- category?: string;
2045
- list_enabled?: boolean;
2046
- name?: string;
2047
- supported_validations?: SupportedValidationsSchema[];
2048
- type?: string;
1191
+ type GetFaqCategoryBySlugSchema = {
1192
+ category?: FAQCategorySchema;
2049
1193
  };
2050
- /** @returns {Json} */
2051
- declare function Json(): Json;
2052
- type Json = {
2053
- category?: string;
2054
- list_enabled?: boolean;
2055
- name?: string;
2056
- supported_validations?: SupportedValidationsSchema[];
2057
- type?: string;
1194
+ /** @returns {Page} */
1195
+ declare function Page(): Page;
1196
+ type Page = {
1197
+ item_total?: number;
1198
+ next_id?: string;
1199
+ has_previous?: boolean;
1200
+ has_next?: boolean;
1201
+ current?: number;
1202
+ type: string;
1203
+ size?: number;
2058
1204
  };
2059
1205
  /** @returns {LandingPageGetResponse} */
2060
1206
  declare function LandingPageGetResponse(): LandingPageGetResponse;
@@ -2065,36 +1211,20 @@ type LandingPageGetResponse = {
2065
1211
  /** @returns {LandingPageSchema} */
2066
1212
  declare function LandingPageSchema(): LandingPageSchema;
2067
1213
  type LandingPageSchema = {
2068
- _custom_json?: any;
2069
- _id?: string;
1214
+ slug?: string;
2070
1215
  action?: Action;
2071
- application?: string;
2072
- archived?: boolean;
1216
+ platform?: string[];
2073
1217
  created_by?: CreatedBySchema;
2074
1218
  date_meta?: DateMeta;
2075
- platform?: string[];
2076
- slug?: string;
2077
- };
2078
- /** @returns {Language} */
2079
- declare function Language(): Language;
2080
- type Language = {
2081
- display?: string;
2082
- };
2083
- /** @returns {LocaleLanguage} */
2084
- declare function LocaleLanguage(): LocaleLanguage;
2085
- type LocaleLanguage = {
2086
- ar?: Language;
2087
- en_us?: Language;
2088
- hi?: Language;
1219
+ _id?: string;
1220
+ application?: string;
1221
+ archived?: boolean;
1222
+ _custom_json?: any;
2089
1223
  };
2090
- /** @returns {Metaobject} */
2091
- declare function Metaobject(): Metaobject;
2092
- type Metaobject = {
2093
- category?: string;
2094
- list_enabled?: boolean;
2095
- name?: string;
2096
- supported_validations?: SupportedValidationsSchema[];
2097
- type?: string;
1224
+ /** @returns {DefaultNavigationResponse} */
1225
+ declare function DefaultNavigationResponse(): DefaultNavigationResponse;
1226
+ type DefaultNavigationResponse = {
1227
+ items?: NavigationSchema[];
2098
1228
  };
2099
1229
  /** @returns {NavigationGetResponse} */
2100
1230
  declare function NavigationGetResponse(): NavigationGetResponse;
@@ -2102,28 +1232,11 @@ type NavigationGetResponse = {
2102
1232
  items?: NavigationSchema[];
2103
1233
  page?: Page;
2104
1234
  };
2105
- /** @returns {NavigationReference} */
2106
- declare function NavigationReference(): NavigationReference;
2107
- type NavigationReference = {
2108
- _locale_language?: LocaleLanguage;
2109
- acl?: string[];
2110
- action?: Action;
2111
- active?: boolean;
2112
- display?: string;
2113
- image?: string;
2114
- sort_order?: number;
2115
- sub_navigation?: NavigationReference[];
2116
- tags?: string[];
2117
- type?: string;
2118
- };
2119
- /** @returns {NavigationRequest} */
2120
- declare function NavigationRequest(): NavigationRequest;
2121
- type NavigationRequest = {
2122
- name?: string;
2123
- navigation?: NavigationReference[];
2124
- orientation?: Orientation;
2125
- platform?: string[];
2126
- slug?: string;
1235
+ /** @returns {Orientation} */
1236
+ declare function Orientation(): Orientation;
1237
+ type Orientation = {
1238
+ portrait?: string[];
1239
+ landscape?: string[];
2127
1240
  };
2128
1241
  /** @returns {NavigationSchema} */
2129
1242
  declare function NavigationSchema(): NavigationSchema;
@@ -2131,292 +1244,120 @@ type NavigationSchema = {
2131
1244
  _id?: string;
2132
1245
  application?: string;
2133
1246
  archived?: boolean;
2134
- created_by?: CreatedBySchema;
2135
- date_meta?: DateMeta;
2136
1247
  name?: string;
2137
- navigation?: NavigationReference[];
2138
- orientation?: Orientation;
2139
- platform?: string[];
2140
- slug?: string;
2141
- version?: number;
2142
- };
2143
- /** @returns {NextSchedule} */
2144
- declare function NextSchedule(): NextSchedule;
2145
- type NextSchedule = {
2146
- end?: string;
2147
- start?: string;
2148
- };
2149
- /** @returns {Orientation} */
2150
- declare function Orientation(): Orientation;
2151
- type Orientation = {
2152
- landscape?: string[];
2153
- portrait?: string[];
2154
- };
2155
- /** @returns {Page} */
2156
- declare function Page(): Page;
2157
- type Page = {
2158
- current?: number;
2159
- has_next?: boolean;
2160
- has_previous?: boolean;
2161
- item_total?: number;
2162
- next_id?: string;
2163
- size?: number;
2164
- type: string;
2165
- };
2166
- /** @returns {PageGetResponse} */
2167
- declare function PageGetResponse(): PageGetResponse;
2168
- type PageGetResponse = {
2169
- items?: PageSchema[];
2170
- page?: Page;
2171
- };
2172
- /** @returns {PageMetaSchema} */
2173
- declare function PageMetaSchema(): PageMetaSchema;
2174
- type PageMetaSchema = {
2175
- application_id?: string;
2176
- custom_pages?: PageSchema[];
2177
- system_pages?: NavigationSchema[];
2178
- };
2179
- /** @returns {PagePublishRequest} */
2180
- declare function PagePublishRequest(): PagePublishRequest;
2181
- type PagePublishRequest = {
2182
- publish?: boolean;
2183
- };
2184
- /** @returns {PageRequest} */
2185
- declare function PageRequest(): PageRequest;
2186
- type PageRequest = {
2187
- _custom_json?: any;
2188
- _schedule?: CronSchedule;
2189
- application?: string;
2190
- author?: Author;
2191
- content?: any[];
2192
- feature_image?: Asset;
2193
- orientation?: string;
2194
- published?: boolean;
2195
- reading_time?: string;
2196
- seo?: SEO;
2197
1248
  slug?: string;
2198
- tags?: string[];
2199
- title?: string;
2200
- };
2201
- /** @returns {PageSchema} */
2202
- declare function PageSchema(): PageSchema;
2203
- type PageSchema = {
2204
- _custom_json?: any;
2205
- _id?: string;
2206
- _schedule?: ScheduleSchema;
2207
- application?: string;
2208
- archived?: boolean;
2209
- /**
2210
- * - Components can be used to store
2211
- * multiple components
2212
- */
2213
- component_ids?: string[];
2214
- content?: any[];
2215
- content_path?: string;
1249
+ platform?: string[];
2216
1250
  created_by?: CreatedBySchema;
2217
1251
  date_meta?: DateMeta;
2218
- description?: string;
2219
- feature_image?: Asset;
2220
- orientation?: string;
2221
- page_meta?: any[];
2222
- platform?: string;
2223
- published?: boolean;
2224
- seo?: SEO;
2225
- slug?: string;
2226
- tags?: string[];
2227
- title?: string;
2228
- type?: string;
2229
- visibility?: any;
2230
- };
2231
- /** @returns {PageSpec} */
2232
- declare function PageSpec(): PageSpec;
2233
- type PageSpec = {
2234
- specifications?: PageSpecItem[];
2235
- };
2236
- /** @returns {PageSpecItem} */
2237
- declare function PageSpecItem(): PageSpecItem;
2238
- type PageSpecItem = {
2239
- display_name?: string;
2240
- page_type?: string;
2241
- params?: PageSpecParam[];
2242
- query?: PageSpecParam[];
2243
- };
2244
- /** @returns {PageSpecParam} */
2245
- declare function PageSpecParam(): PageSpecParam;
2246
- type PageSpecParam = {
2247
- key?: string;
2248
- required?: boolean;
2249
- };
2250
- /** @returns {PathMappingSchema} */
2251
- declare function PathMappingSchema(): PathMappingSchema;
2252
- type PathMappingSchema = {
2253
- __source?: PathSourceSchema;
2254
- _id?: string;
2255
- application?: string;
2256
- created_at?: string;
2257
- redirect_from?: string;
2258
- redirect_to?: string;
2259
- updated_at?: string;
2260
- };
2261
- /** @returns {PathSourceSchema} */
2262
- declare function PathSourceSchema(): PathSourceSchema;
2263
- type PathSourceSchema = {
2264
- id?: string;
2265
- type?: string;
2266
- };
2267
- /** @returns {PhoneProperties} */
2268
- declare function PhoneProperties(): PhoneProperties;
2269
- type PhoneProperties = {
2270
- code?: string;
2271
- key?: string;
2272
- number?: string;
2273
- };
2274
- /** @returns {PhoneSchema} */
2275
- declare function PhoneSchema(): PhoneSchema;
2276
- type PhoneSchema = {
2277
- active?: boolean;
2278
- phone?: PhoneProperties[];
2279
- };
2280
- /** @returns {Product} */
2281
- declare function Product(): Product;
2282
- type Product = {
2283
- category?: string;
2284
- list_enabled?: boolean;
2285
- name?: string;
2286
- supported_validations?: SupportedValidationsSchema[];
2287
- type?: string;
2288
- };
2289
- /** @returns {RemoveHandpickedSchema} */
2290
- declare function RemoveHandpickedSchema(): RemoveHandpickedSchema;
2291
- type RemoveHandpickedSchema = {
2292
- tags?: string[];
2293
- };
2294
- /** @returns {ResourceContent} */
2295
- declare function ResourceContent(): ResourceContent;
2296
- type ResourceContent = {
2297
- type?: string;
2298
- value?: string;
2299
- };
2300
- /** @returns {ResourceSchema} */
2301
- declare function ResourceSchema(): ResourceSchema;
2302
- type ResourceSchema = {
2303
- /**
2304
- * - Number of definitions
2305
- */
2306
- definitions_count?: number;
2307
- /**
2308
- * - Resource key
2309
- */
2310
- key?: string;
2311
- /**
2312
- * - Resource name
2313
- */
2314
- name?: string;
2315
- };
2316
- /** @returns {ResourcesSchema} */
2317
- declare function ResourcesSchema(): ResourcesSchema;
2318
- type ResourcesSchema = {
2319
- resources?: ResourceSchema[];
2320
- };
2321
- /** @returns {ScheduleSchema} */
2322
- declare function ScheduleSchema(): ScheduleSchema;
2323
- type ScheduleSchema = {
2324
- cron?: string;
2325
- duration?: number;
2326
- end?: string;
2327
- next_schedule?: NextSchedule[];
2328
- start?: string;
2329
- };
2330
- /** @returns {SEO} */
2331
- declare function SEO(): SEO;
2332
- type SEO = {
2333
- breadcrumb?: SEObreadcrumb[];
2334
- canonical_url?: string;
2335
- description?: string;
2336
- image?: SEOImage;
2337
- meta_tags?: SEOMetaItem[];
2338
- sitemap?: SEOSitemap;
2339
- title?: string;
2340
- };
2341
- /** @returns {SEObreadcrumb} */
2342
- declare function SEObreadcrumb(): SEObreadcrumb;
2343
- type SEObreadcrumb = {
2344
- action?: Action;
2345
- url?: string;
1252
+ orientation?: Orientation;
1253
+ version?: number;
1254
+ navigation?: NavigationReference[];
2346
1255
  };
2347
- /** @returns {SeoComponent} */
2348
- declare function SeoComponent(): SeoComponent;
2349
- type SeoComponent = {
2350
- seo?: SeoSchema;
1256
+ /** @returns {NavigationRequest} */
1257
+ declare function NavigationRequest(): NavigationRequest;
1258
+ type NavigationRequest = {
1259
+ name?: string;
1260
+ slug?: string;
1261
+ platform?: string[];
1262
+ orientation?: Orientation;
1263
+ navigation?: NavigationReference[];
2351
1264
  };
2352
- /** @returns {SEOImage} */
2353
- declare function SEOImage(): SEOImage;
2354
- type SEOImage = {
2355
- url?: string;
1265
+ /** @returns {PageGetResponse} */
1266
+ declare function PageGetResponse(): PageGetResponse;
1267
+ type PageGetResponse = {
1268
+ items?: PageSchema[];
1269
+ page?: Page;
2356
1270
  };
2357
- /** @returns {SEOMetaItem} */
2358
- declare function SEOMetaItem(): SEOMetaItem;
2359
- type SEOMetaItem = {
2360
- items?: SEOMetaItems[];
2361
- title?: string;
1271
+ /** @returns {PageSpec} */
1272
+ declare function PageSpec(): PageSpec;
1273
+ type PageSpec = {
1274
+ specifications?: PageSpecItem[];
2362
1275
  };
2363
- /** @returns {SEOMetaItems} */
2364
- declare function SEOMetaItems(): SEOMetaItems;
2365
- type SEOMetaItems = {
1276
+ /** @returns {PageSpecParam} */
1277
+ declare function PageSpecParam(): PageSpecParam;
1278
+ type PageSpecParam = {
2366
1279
  key?: string;
2367
- value?: string;
2368
- };
2369
- /** @returns {SeoSchema} */
2370
- declare function SeoSchema(): SeoSchema;
2371
- type SeoSchema = {
2372
- _id?: string;
2373
- additional_sitemap?: string;
2374
- app?: string;
2375
- cannonical_enabled?: boolean;
2376
- created_at?: string;
2377
- custom_meta_tags?: CustomMetaTag[];
2378
- details?: Detail;
2379
- robots_txt?: string;
2380
- sitemap_enabled?: boolean;
2381
- updated_at?: string;
1280
+ required?: boolean;
2382
1281
  };
2383
- /** @returns {SeoSchemaComponent} */
2384
- declare function SeoSchemaComponent(): SeoSchemaComponent;
2385
- type SeoSchemaComponent = {
2386
- items?: SEOSchemaMarkupTemplate[];
2387
- page?: Page;
1282
+ /** @returns {PageSpecItem} */
1283
+ declare function PageSpecItem(): PageSpecItem;
1284
+ type PageSpecItem = {
1285
+ page_type?: string;
1286
+ display_name?: string;
1287
+ params?: PageSpecParam[];
1288
+ query?: PageSpecParam[];
2388
1289
  };
2389
- /** @returns {SEOSchemaMarkupTemplate} */
2390
- declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
2391
- type SEOSchemaMarkupTemplate = {
2392
- active?: boolean;
1290
+ /** @returns {PageSchema} */
1291
+ declare function PageSchema(): PageSchema;
1292
+ type PageSchema = {
1293
+ _id?: string;
2393
1294
  application?: string;
2394
- created_at?: string;
1295
+ /**
1296
+ * - Components can be used to store
1297
+ * multiple components
1298
+ */
1299
+ component_ids?: string[];
1300
+ content?: any[];
1301
+ content_path?: string;
1302
+ created_by?: CreatedBySchema;
1303
+ date_meta?: DateMeta;
2395
1304
  description?: string;
2396
- id?: string;
2397
- page_type?: string;
2398
- schema?: string;
2399
- target_json?: any;
1305
+ feature_image?: Asset;
1306
+ page_meta?: any[];
1307
+ _schedule?: ScheduleSchema;
1308
+ _custom_json?: any;
1309
+ orientation?: string;
1310
+ platform?: string;
1311
+ published?: boolean;
1312
+ slug?: string;
1313
+ tags?: string[];
2400
1314
  title?: string;
2401
- updated_at?: string;
1315
+ type?: string;
1316
+ seo?: SEO;
1317
+ visibility?: any;
1318
+ archived?: boolean;
2402
1319
  };
2403
- /** @returns {SEOSchemaMarkupTemplateRequestBody} */
2404
- declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
2405
- type SEOSchemaMarkupTemplateRequestBody = {
2406
- active?: boolean;
2407
- created_at?: string;
2408
- description?: string;
2409
- page_type?: string;
2410
- schema?: string;
2411
- target_json?: any;
1320
+ /** @returns {CreatedBySchema} */
1321
+ declare function CreatedBySchema(): CreatedBySchema;
1322
+ type CreatedBySchema = {
1323
+ id?: string;
1324
+ };
1325
+ /** @returns {PageRequest} */
1326
+ declare function PageRequest(): PageRequest;
1327
+ type PageRequest = {
1328
+ _schedule?: CronSchedule;
1329
+ application?: string;
1330
+ author?: Author;
1331
+ _custom_json?: any;
1332
+ orientation?: string;
1333
+ content?: any[];
1334
+ feature_image?: Asset;
1335
+ published?: boolean;
1336
+ reading_time?: string;
1337
+ slug?: string;
1338
+ tags?: string[];
1339
+ seo?: SEO;
2412
1340
  title?: string;
2413
- updated_at?: string;
2414
1341
  };
2415
- /** @returns {SEOSitemap} */
2416
- declare function SEOSitemap(): SEOSitemap;
2417
- type SEOSitemap = {
2418
- frequency?: string;
2419
- priority?: number;
1342
+ /** @returns {CronSchedule} */
1343
+ declare function CronSchedule(): CronSchedule;
1344
+ type CronSchedule = {
1345
+ cron?: string;
1346
+ start?: string;
1347
+ end?: string;
1348
+ duration?: number;
1349
+ };
1350
+ /** @returns {PagePublishRequest} */
1351
+ declare function PagePublishRequest(): PagePublishRequest;
1352
+ type PagePublishRequest = {
1353
+ publish?: boolean;
1354
+ };
1355
+ /** @returns {PageMetaSchema} */
1356
+ declare function PageMetaSchema(): PageMetaSchema;
1357
+ type PageMetaSchema = {
1358
+ system_pages?: NavigationSchema[];
1359
+ custom_pages?: PageSchema[];
1360
+ application_id?: string;
2420
1361
  };
2421
1362
  /** @returns {SlideshowGetResponse} */
2422
1363
  declare function SlideshowGetResponse(): SlideshowGetResponse;
@@ -2424,137 +1365,97 @@ type SlideshowGetResponse = {
2424
1365
  items?: SlideshowSchema[];
2425
1366
  page?: Page;
2426
1367
  };
2427
- /** @returns {SlideshowMedia} */
2428
- declare function SlideshowMedia(): SlideshowMedia;
2429
- type SlideshowMedia = {
2430
- action?: Action;
2431
- auto_decide_duration?: boolean;
2432
- bg_color?: string;
2433
- duration?: number;
2434
- type?: string;
2435
- url?: string;
2436
- };
2437
- /** @returns {SlideshowRequest} */
2438
- declare function SlideshowRequest(): SlideshowRequest;
2439
- type SlideshowRequest = {
2440
- active?: boolean;
2441
- configuration?: ConfigurationSchema;
2442
- media?: SlideshowMedia;
2443
- platform?: string;
2444
- slug?: string;
2445
- };
2446
1368
  /** @returns {SlideshowSchema} */
2447
1369
  declare function SlideshowSchema(): SlideshowSchema;
2448
1370
  type SlideshowSchema = {
2449
- _custom_json?: any;
2450
1371
  _id?: string;
2451
- active?: boolean;
1372
+ slug?: string;
1373
+ date_meta?: DateMeta;
2452
1374
  application?: string;
2453
- archived?: boolean;
1375
+ platform?: string;
2454
1376
  configuration?: ConfigurationSchema;
2455
- date_meta?: DateMeta;
2456
1377
  media?: SlideshowMedia[];
2457
- platform?: string;
2458
- slug?: string;
2459
- };
2460
- /** @returns {StringMultiLine} */
2461
- declare function StringMultiLine(): StringMultiLine;
2462
- type StringMultiLine = {
2463
- category?: string;
2464
- list_enabled?: boolean;
2465
- name?: string;
2466
- supported_validations?: SupportedValidationsSchema[];
2467
- type?: string;
1378
+ active?: boolean;
1379
+ archived?: boolean;
1380
+ _custom_json?: any;
2468
1381
  };
2469
- /** @returns {StringSingleLine} */
2470
- declare function StringSingleLine(): StringSingleLine;
2471
- type StringSingleLine = {
2472
- category?: string;
2473
- list_enabled?: boolean;
2474
- name?: string;
2475
- supported_validations?: SupportedValidationsSchema[];
2476
- type?: string;
1382
+ /** @returns {SlideshowRequest} */
1383
+ declare function SlideshowRequest(): SlideshowRequest;
1384
+ type SlideshowRequest = {
1385
+ slug?: string;
1386
+ platform?: string;
1387
+ configuration?: ConfigurationSchema;
1388
+ media?: SlideshowMedia;
1389
+ active?: boolean;
2477
1390
  };
2478
1391
  /** @returns {Support} */
2479
1392
  declare function Support(): Support;
2480
1393
  type Support = {
1394
+ created?: boolean;
2481
1395
  _id?: string;
2482
- application?: string;
2483
1396
  config_type?: string;
2484
- contact?: ContactSchema;
2485
- created?: boolean;
1397
+ application?: string;
2486
1398
  created_at?: string;
2487
1399
  updated_at?: string;
1400
+ contact?: ContactSchema;
2488
1401
  };
2489
- /** @returns {SupportedValidationsMetaExampleSchema} */
2490
- declare function SupportedValidationsMetaExampleSchema(): SupportedValidationsMetaExampleSchema;
2491
- type SupportedValidationsMetaExampleSchema = {
2492
- name?: string;
1402
+ /** @returns {PhoneProperties} */
1403
+ declare function PhoneProperties(): PhoneProperties;
1404
+ type PhoneProperties = {
1405
+ key?: string;
1406
+ code?: string;
1407
+ number?: string;
1408
+ };
1409
+ /** @returns {PhoneSchema} */
1410
+ declare function PhoneSchema(): PhoneSchema;
1411
+ type PhoneSchema = {
1412
+ active?: boolean;
1413
+ phone?: PhoneProperties[];
1414
+ };
1415
+ /** @returns {EmailProperties} */
1416
+ declare function EmailProperties(): EmailProperties;
1417
+ type EmailProperties = {
1418
+ key?: string;
2493
1419
  value?: string;
2494
1420
  };
2495
- /** @returns {SupportedValidationsMetaSchema} */
2496
- declare function SupportedValidationsMetaSchema(): SupportedValidationsMetaSchema;
2497
- type SupportedValidationsMetaSchema = {
2498
- examples?: SupportedValidationsMetaExampleSchema[];
1421
+ /** @returns {EmailSchema} */
1422
+ declare function EmailSchema(): EmailSchema;
1423
+ type EmailSchema = {
1424
+ active?: boolean;
1425
+ email?: EmailProperties[];
2499
1426
  };
2500
- /** @returns {SupportedValidationsSchema} */
2501
- declare function SupportedValidationsSchema(): SupportedValidationsSchema;
2502
- type SupportedValidationsSchema = {
2503
- display?: string;
2504
- meta?: SupportedValidationsMetaSchema;
2505
- name?: string;
2506
- required?: boolean;
2507
- type?: string;
1427
+ /** @returns {ContactSchema} */
1428
+ declare function ContactSchema(): ContactSchema;
1429
+ type ContactSchema = {
1430
+ phone?: PhoneSchema;
1431
+ email?: EmailSchema;
2508
1432
  };
2509
- /** @returns {TagDeleteSuccessResponse} */
2510
- declare function TagDeleteSuccessResponse(): TagDeleteSuccessResponse;
2511
- type TagDeleteSuccessResponse = {
2512
- success?: boolean;
1433
+ /** @returns {TagsSchema} */
1434
+ declare function TagsSchema(): TagsSchema;
1435
+ type TagsSchema = {
1436
+ application?: string;
1437
+ _id?: string;
1438
+ tags?: TagSchema[];
2513
1439
  };
2514
1440
  /** @returns {TagSchema} */
2515
1441
  declare function TagSchema(): TagSchema;
2516
1442
  type TagSchema = {
2517
- __source?: TagSourceSchema;
1443
+ name?: string;
1444
+ url?: string;
1445
+ type?: string;
1446
+ sub_type?: string;
2518
1447
  _id?: string;
1448
+ position?: string;
2519
1449
  attributes?: any;
2520
1450
  content?: string;
2521
- name?: string;
2522
1451
  pages?: any[];
2523
- position?: string;
2524
- sub_type?: string;
2525
- type?: string;
2526
- url?: string;
1452
+ __source?: TagSourceSchema;
2527
1453
  };
2528
1454
  /** @returns {TagSourceSchema} */
2529
1455
  declare function TagSourceSchema(): TagSourceSchema;
2530
1456
  type TagSourceSchema = {
2531
- id?: string;
2532
- type?: string;
2533
- };
2534
- /** @returns {TagsSchema} */
2535
- declare function TagsSchema(): TagsSchema;
2536
- type TagsSchema = {
2537
- _id?: string;
2538
- application?: string;
2539
- tags?: TagSchema[];
2540
- };
2541
- /** @returns {UpdateFaqCategoryRequestSchema} */
2542
- declare function UpdateFaqCategoryRequestSchema(): UpdateFaqCategoryRequestSchema;
2543
- type UpdateFaqCategoryRequestSchema = {
2544
- category?: CategorySchema;
2545
- };
2546
- /** @returns {UpdateHandpickedSchema} */
2547
- declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
2548
- type UpdateHandpickedSchema = {
2549
- tag?: HandpickedTagSchema;
2550
- };
2551
- /** @returns {Url} */
2552
- declare function Url(): Url;
2553
- type Url = {
2554
- list_enabled?: boolean;
2555
- name?: string;
2556
- supported_validations?: SupportedValidationsSchema[];
2557
1457
  type?: string;
1458
+ id?: string;
2558
1459
  };
2559
1460
  /**
2560
1461
  * Enum: GenerationEntityType Used By: Content