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