@datocms/cma-client 2.2.2 → 2.2.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/dist/cjs/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +26 -26
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +26 -26
- package/dist/types/generated/SchemaTypes.d.ts +26 -26
- package/dist/types/generated/SimpleSchemaTypes.d.ts +26 -26
- package/package.json +3 -3
- package/src/generated/Client.ts +1 -1
- package/src/generated/SchemaTypes.ts +26 -26
- package/src/generated/SimpleSchemaTypes.ts +26 -26
|
@@ -4672,7 +4672,7 @@ export declare type JobData = {
|
|
|
4672
4672
|
* </details>
|
|
4673
4673
|
*
|
|
4674
4674
|
* <details>
|
|
4675
|
-
* <summary>SEO (<code>seo</code>)</summary>
|
|
4675
|
+
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4676
4676
|
*
|
|
4677
4677
|
* | Property | Value |
|
|
4678
4678
|
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -4814,7 +4814,7 @@ export declare type JobData = {
|
|
|
4814
4814
|
*
|
|
4815
4815
|
* | Parameter | Type | Required | Description |
|
|
4816
4816
|
* | --------- | --------------- | -------- | --------------------- |
|
|
4817
|
-
* | `values` | `Array<String>` | ✅
|
|
4817
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4818
4818
|
*
|
|
4819
4819
|
* </details>
|
|
4820
4820
|
*
|
|
@@ -4899,7 +4899,7 @@ export declare type JobData = {
|
|
|
4899
4899
|
*
|
|
4900
4900
|
* | Parameter | Type | Required | Description |
|
|
4901
4901
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4902
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4902
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4903
4903
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4904
4904
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4905
4905
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -4928,7 +4928,7 @@ export declare type JobData = {
|
|
|
4928
4928
|
*
|
|
4929
4929
|
* | Parameter | Type | Required | Description |
|
|
4930
4930
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4931
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4931
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4932
4932
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4933
4933
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4934
4934
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -5003,7 +5003,7 @@ export declare type JobData = {
|
|
|
5003
5003
|
* <details>
|
|
5004
5004
|
* <summary><code>required_seo_fields</code></summary>
|
|
5005
5005
|
*
|
|
5006
|
-
* SEO field
|
|
5006
|
+
* SEO field has to specify one or more properties, or it won't be valid.
|
|
5007
5007
|
*
|
|
5008
5008
|
* | Parameter | Type | Required | Description |
|
|
5009
5009
|
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
@@ -5051,7 +5051,7 @@ export declare type JobData = {
|
|
|
5051
5051
|
*
|
|
5052
5052
|
* | Parameter | Type | Required | Description |
|
|
5053
5053
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5054
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
5054
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5055
5055
|
*
|
|
5056
5056
|
* </details>
|
|
5057
5057
|
*
|
|
@@ -5060,9 +5060,9 @@ export declare type JobData = {
|
|
|
5060
5060
|
*
|
|
5061
5061
|
* Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
|
|
5062
5062
|
*
|
|
5063
|
-
* | Parameter
|
|
5064
|
-
* |
|
|
5065
|
-
* | `sanitize_before_validation`
|
|
5063
|
+
* | Parameter | Type | Required | Description |
|
|
5064
|
+
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
5065
|
+
* | `sanitize_before_validation` | `Boolean` | ✅ | Content is actively sanitized before applying the validation |
|
|
5066
5066
|
*
|
|
5067
5067
|
* </details>
|
|
5068
5068
|
*
|
|
@@ -5073,7 +5073,7 @@ export declare type JobData = {
|
|
|
5073
5073
|
*
|
|
5074
5074
|
* | Parameter | Type | Required | Description |
|
|
5075
5075
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5076
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
5076
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5077
5077
|
*
|
|
5078
5078
|
* </details>
|
|
5079
5079
|
*
|
|
@@ -5084,7 +5084,7 @@ export declare type JobData = {
|
|
|
5084
5084
|
*
|
|
5085
5085
|
* | Parameter | Type | Required | Description |
|
|
5086
5086
|
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
5087
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
5087
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
5088
5088
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
5089
5089
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
5090
5090
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -5129,7 +5129,7 @@ export declare type JobData = {
|
|
|
5129
5129
|
*
|
|
5130
5130
|
* | Parameter | Type | Required | Description |
|
|
5131
5131
|
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
5132
|
-
* | `title_field_id` | `Field ID` | ✅
|
|
5132
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
5133
5133
|
*
|
|
5134
5134
|
* </details>
|
|
5135
5135
|
*
|
|
@@ -5151,8 +5151,8 @@ export declare type JobData = {
|
|
|
5151
5151
|
*
|
|
5152
5152
|
* | Parameter | Type | Required | Description |
|
|
5153
5153
|
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
5154
|
-
* | `positive_radio` | `{ label: string, hint?: string }` | ✅
|
|
5155
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅
|
|
5154
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
5155
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
5156
5156
|
*
|
|
5157
5157
|
* </details>
|
|
5158
5158
|
*
|
|
@@ -5163,7 +5163,7 @@ export declare type JobData = {
|
|
|
5163
5163
|
*
|
|
5164
5164
|
* | Parameter | Type | Required | Description |
|
|
5165
5165
|
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
5166
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5166
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
5167
5167
|
*
|
|
5168
5168
|
* </details>
|
|
5169
5169
|
*
|
|
@@ -5174,7 +5174,7 @@ export declare type JobData = {
|
|
|
5174
5174
|
*
|
|
5175
5175
|
* | Parameter | Type | Required | Description |
|
|
5176
5176
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5177
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5177
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5178
5178
|
*
|
|
5179
5179
|
* </details>
|
|
5180
5180
|
*
|
|
@@ -5185,7 +5185,7 @@ export declare type JobData = {
|
|
|
5185
5185
|
*
|
|
5186
5186
|
* | Parameter | Type | Required | Description |
|
|
5187
5187
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5188
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5188
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5189
5189
|
*
|
|
5190
5190
|
* </details>
|
|
5191
5191
|
*
|
|
@@ -5196,7 +5196,7 @@ export declare type JobData = {
|
|
|
5196
5196
|
*
|
|
5197
5197
|
* | Parameter | Type | Required | Description |
|
|
5198
5198
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5199
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5199
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5200
5200
|
*
|
|
5201
5201
|
* </details>
|
|
5202
5202
|
*
|
|
@@ -5207,7 +5207,7 @@ export declare type JobData = {
|
|
|
5207
5207
|
*
|
|
5208
5208
|
* | Parameter | Type | Required | Description |
|
|
5209
5209
|
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
5210
|
-
* | `heading` | `Boolean` | ✅
|
|
5210
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
5211
5211
|
*
|
|
5212
5212
|
* </details>
|
|
5213
5213
|
*
|
|
@@ -5218,7 +5218,7 @@ export declare type JobData = {
|
|
|
5218
5218
|
*
|
|
5219
5219
|
* | Parameter | Type | Required | Description |
|
|
5220
5220
|
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5221
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
5221
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
|
|
5222
5222
|
*
|
|
5223
5223
|
* </details>
|
|
5224
5224
|
*
|
|
@@ -5229,7 +5229,7 @@ export declare type JobData = {
|
|
|
5229
5229
|
*
|
|
5230
5230
|
* | Parameter | Type | Required | Description |
|
|
5231
5231
|
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5232
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
5232
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
|
|
5233
5233
|
*
|
|
5234
5234
|
* </details>
|
|
5235
5235
|
*
|
|
@@ -5247,8 +5247,8 @@ export declare type JobData = {
|
|
|
5247
5247
|
*
|
|
5248
5248
|
* | Parameter | Type | Required | Description |
|
|
5249
5249
|
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
5250
|
-
* | `enable_alpha` | `Boolean` | ✅
|
|
5251
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅
|
|
5250
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
5251
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
5252
5252
|
*
|
|
5253
5253
|
* </details>
|
|
5254
5254
|
*
|
|
@@ -5281,9 +5281,9 @@ export declare type JobData = {
|
|
|
5281
5281
|
*
|
|
5282
5282
|
* | Parameter | Type | Required | Description |
|
|
5283
5283
|
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5284
|
-
* | `nodes` | `Array<String>` | ✅
|
|
5285
|
-
* | `marks` | `Array<String>` | ✅
|
|
5286
|
-
* | `heading_levels` | `Array<Integer>` | ✅
|
|
5284
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
5285
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
5286
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
5287
5287
|
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
5288
5288
|
* | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
|
|
5289
5289
|
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datocms/cma-client",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.4",
|
|
4
4
|
"description": "JS client for DatoCMS REST Content Management API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"@datocms/rest-client-utils": "^1.3.3"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
|
-
"@datocms/dashboard-client": "^2.2.
|
|
43
|
+
"@datocms/dashboard-client": "^2.2.4"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "21b449369c7e9cce0c78ab3e7d73034403667889"
|
|
46
46
|
}
|
package/src/generated/Client.ts
CHANGED
|
@@ -133,7 +133,7 @@ export class Client {
|
|
|
133
133
|
...this.config,
|
|
134
134
|
...options,
|
|
135
135
|
logFn: this.config.logFn || console.log,
|
|
136
|
-
userAgent: '@datocms/cma-client v2.2.
|
|
136
|
+
userAgent: '@datocms/cma-client v2.2.4',
|
|
137
137
|
baseUrl: this.baseUrl,
|
|
138
138
|
preCallStack: new Error().stack,
|
|
139
139
|
extraHeaders: {
|
|
@@ -4418,7 +4418,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4418
4418
|
* </details>
|
|
4419
4419
|
*
|
|
4420
4420
|
* <details>
|
|
4421
|
-
* <summary>SEO (<code>seo</code>)</summary>
|
|
4421
|
+
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4422
4422
|
*
|
|
4423
4423
|
* | Property | Value |
|
|
4424
4424
|
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -4560,7 +4560,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4560
4560
|
*
|
|
4561
4561
|
* | Parameter | Type | Required | Description |
|
|
4562
4562
|
* | --------- | --------------- | -------- | --------------------- |
|
|
4563
|
-
* | `values` | `Array<String>` | ✅
|
|
4563
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4564
4564
|
*
|
|
4565
4565
|
* </details>
|
|
4566
4566
|
*
|
|
@@ -4645,7 +4645,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4645
4645
|
*
|
|
4646
4646
|
* | Parameter | Type | Required | Description |
|
|
4647
4647
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4648
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4648
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4649
4649
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4650
4650
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4651
4651
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -4674,7 +4674,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4674
4674
|
*
|
|
4675
4675
|
* | Parameter | Type | Required | Description |
|
|
4676
4676
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4677
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4677
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4678
4678
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4679
4679
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4680
4680
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -4749,7 +4749,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4749
4749
|
* <details>
|
|
4750
4750
|
* <summary><code>required_seo_fields</code></summary>
|
|
4751
4751
|
*
|
|
4752
|
-
* SEO field
|
|
4752
|
+
* SEO field has to specify one or more properties, or it won't be valid.
|
|
4753
4753
|
*
|
|
4754
4754
|
* | Parameter | Type | Required | Description |
|
|
4755
4755
|
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
@@ -4797,7 +4797,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4797
4797
|
*
|
|
4798
4798
|
* | Parameter | Type | Required | Description |
|
|
4799
4799
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4800
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4800
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4801
4801
|
*
|
|
4802
4802
|
* </details>
|
|
4803
4803
|
*
|
|
@@ -4806,9 +4806,9 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4806
4806
|
*
|
|
4807
4807
|
* Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
|
|
4808
4808
|
*
|
|
4809
|
-
* | Parameter
|
|
4810
|
-
* |
|
|
4811
|
-
* | `sanitize_before_validation`
|
|
4809
|
+
* | Parameter | Type | Required | Description |
|
|
4810
|
+
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
4811
|
+
* | `sanitize_before_validation` | `Boolean` | ✅ | Content is actively sanitized before applying the validation |
|
|
4812
4812
|
*
|
|
4813
4813
|
* </details>
|
|
4814
4814
|
*
|
|
@@ -4819,7 +4819,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4819
4819
|
*
|
|
4820
4820
|
* | Parameter | Type | Required | Description |
|
|
4821
4821
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4822
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4822
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4823
4823
|
*
|
|
4824
4824
|
* </details>
|
|
4825
4825
|
*
|
|
@@ -4830,7 +4830,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4830
4830
|
*
|
|
4831
4831
|
* | Parameter | Type | Required | Description |
|
|
4832
4832
|
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4833
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4833
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4834
4834
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4835
4835
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4836
4836
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -4875,7 +4875,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4875
4875
|
*
|
|
4876
4876
|
* | Parameter | Type | Required | Description |
|
|
4877
4877
|
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4878
|
-
* | `title_field_id` | `Field ID` | ✅
|
|
4878
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
4879
4879
|
*
|
|
4880
4880
|
* </details>
|
|
4881
4881
|
*
|
|
@@ -4897,8 +4897,8 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4897
4897
|
*
|
|
4898
4898
|
* | Parameter | Type | Required | Description |
|
|
4899
4899
|
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4900
|
-
* | `positive_radio` | `{ label: string, hint?: string }` | ✅
|
|
4901
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅
|
|
4900
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
4901
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
4902
4902
|
*
|
|
4903
4903
|
* </details>
|
|
4904
4904
|
*
|
|
@@ -4909,7 +4909,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4909
4909
|
*
|
|
4910
4910
|
* | Parameter | Type | Required | Description |
|
|
4911
4911
|
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4912
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4912
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
4913
4913
|
*
|
|
4914
4914
|
* </details>
|
|
4915
4915
|
*
|
|
@@ -4920,7 +4920,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4920
4920
|
*
|
|
4921
4921
|
* | Parameter | Type | Required | Description |
|
|
4922
4922
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4923
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4923
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4924
4924
|
*
|
|
4925
4925
|
* </details>
|
|
4926
4926
|
*
|
|
@@ -4931,7 +4931,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4931
4931
|
*
|
|
4932
4932
|
* | Parameter | Type | Required | Description |
|
|
4933
4933
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4934
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4934
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4935
4935
|
*
|
|
4936
4936
|
* </details>
|
|
4937
4937
|
*
|
|
@@ -4942,7 +4942,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4942
4942
|
*
|
|
4943
4943
|
* | Parameter | Type | Required | Description |
|
|
4944
4944
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4945
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4945
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4946
4946
|
*
|
|
4947
4947
|
* </details>
|
|
4948
4948
|
*
|
|
@@ -4953,7 +4953,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4953
4953
|
*
|
|
4954
4954
|
* | Parameter | Type | Required | Description |
|
|
4955
4955
|
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4956
|
-
* | `heading` | `Boolean` | ✅
|
|
4956
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
4957
4957
|
*
|
|
4958
4958
|
* </details>
|
|
4959
4959
|
*
|
|
@@ -4964,7 +4964,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4964
4964
|
*
|
|
4965
4965
|
* | Parameter | Type | Required | Description |
|
|
4966
4966
|
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4967
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4967
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
|
|
4968
4968
|
*
|
|
4969
4969
|
* </details>
|
|
4970
4970
|
*
|
|
@@ -4975,7 +4975,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4975
4975
|
*
|
|
4976
4976
|
* | Parameter | Type | Required | Description |
|
|
4977
4977
|
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4978
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4978
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
|
|
4979
4979
|
*
|
|
4980
4980
|
* </details>
|
|
4981
4981
|
*
|
|
@@ -4993,8 +4993,8 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4993
4993
|
*
|
|
4994
4994
|
* | Parameter | Type | Required | Description |
|
|
4995
4995
|
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4996
|
-
* | `enable_alpha` | `Boolean` | ✅
|
|
4997
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅
|
|
4996
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
4997
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
4998
4998
|
*
|
|
4999
4999
|
* </details>
|
|
5000
5000
|
*
|
|
@@ -5027,9 +5027,9 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
5027
5027
|
*
|
|
5028
5028
|
* | Parameter | Type | Required | Description |
|
|
5029
5029
|
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5030
|
-
* | `nodes` | `Array<String>` | ✅
|
|
5031
|
-
* | `marks` | `Array<String>` | ✅
|
|
5032
|
-
* | `heading_levels` | `Array<Integer>` | ✅
|
|
5030
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
5031
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
5032
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
5033
5033
|
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
5034
5034
|
* | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
|
|
5035
5035
|
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|
|
@@ -4943,7 +4943,7 @@ export type JobData = {
|
|
|
4943
4943
|
* </details>
|
|
4944
4944
|
*
|
|
4945
4945
|
* <details>
|
|
4946
|
-
* <summary>SEO (<code>seo</code>)</summary>
|
|
4946
|
+
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4947
4947
|
*
|
|
4948
4948
|
* | Property | Value |
|
|
4949
4949
|
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -5085,7 +5085,7 @@ export type JobData = {
|
|
|
5085
5085
|
*
|
|
5086
5086
|
* | Parameter | Type | Required | Description |
|
|
5087
5087
|
* | --------- | --------------- | -------- | --------------------- |
|
|
5088
|
-
* | `values` | `Array<String>` | ✅
|
|
5088
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
5089
5089
|
*
|
|
5090
5090
|
* </details>
|
|
5091
5091
|
*
|
|
@@ -5170,7 +5170,7 @@ export type JobData = {
|
|
|
5170
5170
|
*
|
|
5171
5171
|
* | Parameter | Type | Required | Description |
|
|
5172
5172
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
5173
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
5173
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
5174
5174
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
5175
5175
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
5176
5176
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -5199,7 +5199,7 @@ export type JobData = {
|
|
|
5199
5199
|
*
|
|
5200
5200
|
* | Parameter | Type | Required | Description |
|
|
5201
5201
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
5202
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
5202
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
5203
5203
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
5204
5204
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
5205
5205
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -5274,7 +5274,7 @@ export type JobData = {
|
|
|
5274
5274
|
* <details>
|
|
5275
5275
|
* <summary><code>required_seo_fields</code></summary>
|
|
5276
5276
|
*
|
|
5277
|
-
* SEO field
|
|
5277
|
+
* SEO field has to specify one or more properties, or it won't be valid.
|
|
5278
5278
|
*
|
|
5279
5279
|
* | Parameter | Type | Required | Description |
|
|
5280
5280
|
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
@@ -5322,7 +5322,7 @@ export type JobData = {
|
|
|
5322
5322
|
*
|
|
5323
5323
|
* | Parameter | Type | Required | Description |
|
|
5324
5324
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5325
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
5325
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5326
5326
|
*
|
|
5327
5327
|
* </details>
|
|
5328
5328
|
*
|
|
@@ -5331,9 +5331,9 @@ export type JobData = {
|
|
|
5331
5331
|
*
|
|
5332
5332
|
* Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
|
|
5333
5333
|
*
|
|
5334
|
-
* | Parameter
|
|
5335
|
-
* |
|
|
5336
|
-
* | `sanitize_before_validation`
|
|
5334
|
+
* | Parameter | Type | Required | Description |
|
|
5335
|
+
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
5336
|
+
* | `sanitize_before_validation` | `Boolean` | ✅ | Content is actively sanitized before applying the validation |
|
|
5337
5337
|
*
|
|
5338
5338
|
* </details>
|
|
5339
5339
|
*
|
|
@@ -5344,7 +5344,7 @@ export type JobData = {
|
|
|
5344
5344
|
*
|
|
5345
5345
|
* | Parameter | Type | Required | Description |
|
|
5346
5346
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5347
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
5347
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5348
5348
|
*
|
|
5349
5349
|
* </details>
|
|
5350
5350
|
*
|
|
@@ -5355,7 +5355,7 @@ export type JobData = {
|
|
|
5355
5355
|
*
|
|
5356
5356
|
* | Parameter | Type | Required | Description |
|
|
5357
5357
|
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
5358
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
5358
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
5359
5359
|
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
5360
5360
|
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
5361
5361
|
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
@@ -5400,7 +5400,7 @@ export type JobData = {
|
|
|
5400
5400
|
*
|
|
5401
5401
|
* | Parameter | Type | Required | Description |
|
|
5402
5402
|
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
5403
|
-
* | `title_field_id` | `Field ID` | ✅
|
|
5403
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
5404
5404
|
*
|
|
5405
5405
|
* </details>
|
|
5406
5406
|
*
|
|
@@ -5422,8 +5422,8 @@ export type JobData = {
|
|
|
5422
5422
|
*
|
|
5423
5423
|
* | Parameter | Type | Required | Description |
|
|
5424
5424
|
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
5425
|
-
* | `positive_radio` | `{ label: string, hint?: string }` | ✅
|
|
5426
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅
|
|
5425
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
5426
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
5427
5427
|
*
|
|
5428
5428
|
* </details>
|
|
5429
5429
|
*
|
|
@@ -5434,7 +5434,7 @@ export type JobData = {
|
|
|
5434
5434
|
*
|
|
5435
5435
|
* | Parameter | Type | Required | Description |
|
|
5436
5436
|
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
5437
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5437
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
5438
5438
|
*
|
|
5439
5439
|
* </details>
|
|
5440
5440
|
*
|
|
@@ -5445,7 +5445,7 @@ export type JobData = {
|
|
|
5445
5445
|
*
|
|
5446
5446
|
* | Parameter | Type | Required | Description |
|
|
5447
5447
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5448
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5448
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5449
5449
|
*
|
|
5450
5450
|
* </details>
|
|
5451
5451
|
*
|
|
@@ -5456,7 +5456,7 @@ export type JobData = {
|
|
|
5456
5456
|
*
|
|
5457
5457
|
* | Parameter | Type | Required | Description |
|
|
5458
5458
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5459
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5459
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5460
5460
|
*
|
|
5461
5461
|
* </details>
|
|
5462
5462
|
*
|
|
@@ -5467,7 +5467,7 @@ export type JobData = {
|
|
|
5467
5467
|
*
|
|
5468
5468
|
* | Parameter | Type | Required | Description |
|
|
5469
5469
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
5470
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
5470
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
5471
5471
|
*
|
|
5472
5472
|
* </details>
|
|
5473
5473
|
*
|
|
@@ -5478,7 +5478,7 @@ export type JobData = {
|
|
|
5478
5478
|
*
|
|
5479
5479
|
* | Parameter | Type | Required | Description |
|
|
5480
5480
|
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
5481
|
-
* | `heading` | `Boolean` | ✅
|
|
5481
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
5482
5482
|
*
|
|
5483
5483
|
* </details>
|
|
5484
5484
|
*
|
|
@@ -5489,7 +5489,7 @@ export type JobData = {
|
|
|
5489
5489
|
*
|
|
5490
5490
|
* | Parameter | Type | Required | Description |
|
|
5491
5491
|
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5492
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
5492
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
|
|
5493
5493
|
*
|
|
5494
5494
|
* </details>
|
|
5495
5495
|
*
|
|
@@ -5500,7 +5500,7 @@ export type JobData = {
|
|
|
5500
5500
|
*
|
|
5501
5501
|
* | Parameter | Type | Required | Description |
|
|
5502
5502
|
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5503
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
5503
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
|
|
5504
5504
|
*
|
|
5505
5505
|
* </details>
|
|
5506
5506
|
*
|
|
@@ -5518,8 +5518,8 @@ export type JobData = {
|
|
|
5518
5518
|
*
|
|
5519
5519
|
* | Parameter | Type | Required | Description |
|
|
5520
5520
|
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
5521
|
-
* | `enable_alpha` | `Boolean` | ✅
|
|
5522
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅
|
|
5521
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
5522
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
5523
5523
|
*
|
|
5524
5524
|
* </details>
|
|
5525
5525
|
*
|
|
@@ -5552,9 +5552,9 @@ export type JobData = {
|
|
|
5552
5552
|
*
|
|
5553
5553
|
* | Parameter | Type | Required | Description |
|
|
5554
5554
|
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5555
|
-
* | `nodes` | `Array<String>` | ✅
|
|
5556
|
-
* | `marks` | `Array<String>` | ✅
|
|
5557
|
-
* | `heading_levels` | `Array<Integer>` | ✅
|
|
5555
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
5556
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
5557
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
5558
5558
|
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
5559
5559
|
* | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
|
|
5560
5560
|
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|