@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3

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