@datocms/cma-client 2.2.3 → 2.2.5
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
|
@@ -127,7 +127,7 @@ var Client = /** @class */ (function () {
|
|
|
127
127
|
});
|
|
128
128
|
Client.prototype.request = function (options) {
|
|
129
129
|
var _this = this;
|
|
130
|
-
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v2.2.
|
|
130
|
+
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v2.2.5', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
131
131
|
? { 'X-Environment': this.config.environment }
|
|
132
132
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
133
133
|
return _this.jobResultsFetcher
|
|
@@ -101,7 +101,7 @@ var Client = /** @class */ (function () {
|
|
|
101
101
|
});
|
|
102
102
|
Client.prototype.request = function (options) {
|
|
103
103
|
var _this = this;
|
|
104
|
-
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v2.2.
|
|
104
|
+
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v2.2.5', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
105
105
|
? { 'X-Environment': this.config.environment }
|
|
106
106
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
107
107
|
return _this.jobResultsFetcher
|
|
@@ -4151,7 +4151,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4151
4151
|
* </details>
|
|
4152
4152
|
*
|
|
4153
4153
|
* <details>
|
|
4154
|
-
* <summary>SEO (<code>seo</code>)</summary>
|
|
4154
|
+
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4155
4155
|
*
|
|
4156
4156
|
* | Property | Value |
|
|
4157
4157
|
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -4293,7 +4293,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4293
4293
|
*
|
|
4294
4294
|
* | Parameter | Type | Required | Description |
|
|
4295
4295
|
* | --------- | --------------- | -------- | --------------------- |
|
|
4296
|
-
* | `values` | `Array<String>` | ✅
|
|
4296
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4297
4297
|
*
|
|
4298
4298
|
* </details>
|
|
4299
4299
|
*
|
|
@@ -4378,7 +4378,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4378
4378
|
*
|
|
4379
4379
|
* | Parameter | Type | Required | Description |
|
|
4380
4380
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4381
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4381
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4382
4382
|
* | `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 |
|
|
4383
4383
|
* | `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 |
|
|
4384
4384
|
* | `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 |
|
|
@@ -4407,7 +4407,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4407
4407
|
*
|
|
4408
4408
|
* | Parameter | Type | Required | Description |
|
|
4409
4409
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4410
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4410
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4411
4411
|
* | `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 |
|
|
4412
4412
|
* | `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 |
|
|
4413
4413
|
* | `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 |
|
|
@@ -4482,7 +4482,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4482
4482
|
* <details>
|
|
4483
4483
|
* <summary><code>required_seo_fields</code></summary>
|
|
4484
4484
|
*
|
|
4485
|
-
* SEO field
|
|
4485
|
+
* SEO field has to specify one or more properties, or it won't be valid.
|
|
4486
4486
|
*
|
|
4487
4487
|
* | Parameter | Type | Required | Description |
|
|
4488
4488
|
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
@@ -4530,7 +4530,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4530
4530
|
*
|
|
4531
4531
|
* | Parameter | Type | Required | Description |
|
|
4532
4532
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4533
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4533
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4534
4534
|
*
|
|
4535
4535
|
* </details>
|
|
4536
4536
|
*
|
|
@@ -4539,9 +4539,9 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4539
4539
|
*
|
|
4540
4540
|
* Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
|
|
4541
4541
|
*
|
|
4542
|
-
* | Parameter
|
|
4543
|
-
* |
|
|
4544
|
-
* | `sanitize_before_validation`
|
|
4542
|
+
* | Parameter | Type | Required | Description |
|
|
4543
|
+
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
4544
|
+
* | `sanitize_before_validation` | `Boolean` | ✅ | Content is actively sanitized before applying the validation |
|
|
4545
4545
|
*
|
|
4546
4546
|
* </details>
|
|
4547
4547
|
*
|
|
@@ -4552,7 +4552,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4552
4552
|
*
|
|
4553
4553
|
* | Parameter | Type | Required | Description |
|
|
4554
4554
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4555
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4555
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4556
4556
|
*
|
|
4557
4557
|
* </details>
|
|
4558
4558
|
*
|
|
@@ -4563,7 +4563,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4563
4563
|
*
|
|
4564
4564
|
* | Parameter | Type | Required | Description |
|
|
4565
4565
|
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4566
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4566
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4567
4567
|
* | `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 |
|
|
4568
4568
|
* | `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 |
|
|
4569
4569
|
* | `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 |
|
|
@@ -4608,7 +4608,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4608
4608
|
*
|
|
4609
4609
|
* | Parameter | Type | Required | Description |
|
|
4610
4610
|
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4611
|
-
* | `title_field_id` | `Field ID` | ✅
|
|
4611
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
4612
4612
|
*
|
|
4613
4613
|
* </details>
|
|
4614
4614
|
*
|
|
@@ -4630,8 +4630,8 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4630
4630
|
*
|
|
4631
4631
|
* | Parameter | Type | Required | Description |
|
|
4632
4632
|
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4633
|
-
* | `positive_radio` | `{ label: string, hint?: string }` | ✅
|
|
4634
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅
|
|
4633
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
4634
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
4635
4635
|
*
|
|
4636
4636
|
* </details>
|
|
4637
4637
|
*
|
|
@@ -4642,7 +4642,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4642
4642
|
*
|
|
4643
4643
|
* | Parameter | Type | Required | Description |
|
|
4644
4644
|
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4645
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4645
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
4646
4646
|
*
|
|
4647
4647
|
* </details>
|
|
4648
4648
|
*
|
|
@@ -4653,7 +4653,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4653
4653
|
*
|
|
4654
4654
|
* | Parameter | Type | Required | Description |
|
|
4655
4655
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4656
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4656
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4657
4657
|
*
|
|
4658
4658
|
* </details>
|
|
4659
4659
|
*
|
|
@@ -4664,7 +4664,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4664
4664
|
*
|
|
4665
4665
|
* | Parameter | Type | Required | Description |
|
|
4666
4666
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4667
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4667
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4668
4668
|
*
|
|
4669
4669
|
* </details>
|
|
4670
4670
|
*
|
|
@@ -4675,7 +4675,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4675
4675
|
*
|
|
4676
4676
|
* | Parameter | Type | Required | Description |
|
|
4677
4677
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4678
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4678
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4679
4679
|
*
|
|
4680
4680
|
* </details>
|
|
4681
4681
|
*
|
|
@@ -4686,7 +4686,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4686
4686
|
*
|
|
4687
4687
|
* | Parameter | Type | Required | Description |
|
|
4688
4688
|
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4689
|
-
* | `heading` | `Boolean` | ✅
|
|
4689
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
4690
4690
|
*
|
|
4691
4691
|
* </details>
|
|
4692
4692
|
*
|
|
@@ -4697,7 +4697,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4697
4697
|
*
|
|
4698
4698
|
* | Parameter | Type | Required | Description |
|
|
4699
4699
|
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4700
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4700
|
+
* | `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"` |
|
|
4701
4701
|
*
|
|
4702
4702
|
* </details>
|
|
4703
4703
|
*
|
|
@@ -4708,7 +4708,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4708
4708
|
*
|
|
4709
4709
|
* | Parameter | Type | Required | Description |
|
|
4710
4710
|
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4711
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4711
|
+
* | `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"` |
|
|
4712
4712
|
*
|
|
4713
4713
|
* </details>
|
|
4714
4714
|
*
|
|
@@ -4726,8 +4726,8 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4726
4726
|
*
|
|
4727
4727
|
* | Parameter | Type | Required | Description |
|
|
4728
4728
|
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4729
|
-
* | `enable_alpha` | `Boolean` | ✅
|
|
4730
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅
|
|
4729
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
4730
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
4731
4731
|
*
|
|
4732
4732
|
* </details>
|
|
4733
4733
|
*
|
|
@@ -4760,9 +4760,9 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4760
4760
|
*
|
|
4761
4761
|
* | Parameter | Type | Required | Description |
|
|
4762
4762
|
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4763
|
-
* | `nodes` | `Array<String>` | ✅
|
|
4764
|
-
* | `marks` | `Array<String>` | ✅
|
|
4765
|
-
* | `heading_levels` | `Array<Integer>` | ✅
|
|
4763
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
4764
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
4765
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
4766
4766
|
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
4767
4767
|
* | `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 |
|
|
4768
4768
|
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|
|
@@ -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 |
|
|
@@ -4151,7 +4151,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4151
4151
|
* </details>
|
|
4152
4152
|
*
|
|
4153
4153
|
* <details>
|
|
4154
|
-
* <summary>SEO (<code>seo</code>)</summary>
|
|
4154
|
+
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4155
4155
|
*
|
|
4156
4156
|
* | Property | Value |
|
|
4157
4157
|
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
@@ -4293,7 +4293,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4293
4293
|
*
|
|
4294
4294
|
* | Parameter | Type | Required | Description |
|
|
4295
4295
|
* | --------- | --------------- | -------- | --------------------- |
|
|
4296
|
-
* | `values` | `Array<String>` | ✅
|
|
4296
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4297
4297
|
*
|
|
4298
4298
|
* </details>
|
|
4299
4299
|
*
|
|
@@ -4378,7 +4378,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4378
4378
|
*
|
|
4379
4379
|
* | Parameter | Type | Required | Description |
|
|
4380
4380
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4381
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4381
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4382
4382
|
* | `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 |
|
|
4383
4383
|
* | `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 |
|
|
4384
4384
|
* | `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 |
|
|
@@ -4407,7 +4407,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4407
4407
|
*
|
|
4408
4408
|
* | Parameter | Type | Required | Description |
|
|
4409
4409
|
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4410
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4410
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4411
4411
|
* | `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 |
|
|
4412
4412
|
* | `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 |
|
|
4413
4413
|
* | `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 |
|
|
@@ -4482,7 +4482,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4482
4482
|
* <details>
|
|
4483
4483
|
* <summary><code>required_seo_fields</code></summary>
|
|
4484
4484
|
*
|
|
4485
|
-
* SEO field
|
|
4485
|
+
* SEO field has to specify one or more properties, or it won't be valid.
|
|
4486
4486
|
*
|
|
4487
4487
|
* | Parameter | Type | Required | Description |
|
|
4488
4488
|
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
@@ -4530,7 +4530,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4530
4530
|
*
|
|
4531
4531
|
* | Parameter | Type | Required | Description |
|
|
4532
4532
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4533
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4533
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4534
4534
|
*
|
|
4535
4535
|
* </details>
|
|
4536
4536
|
*
|
|
@@ -4539,9 +4539,9 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4539
4539
|
*
|
|
4540
4540
|
* Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
|
|
4541
4541
|
*
|
|
4542
|
-
* | Parameter
|
|
4543
|
-
* |
|
|
4544
|
-
* | `sanitize_before_validation`
|
|
4542
|
+
* | Parameter | Type | Required | Description |
|
|
4543
|
+
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
4544
|
+
* | `sanitize_before_validation` | `Boolean` | ✅ | Content is actively sanitized before applying the validation |
|
|
4545
4545
|
*
|
|
4546
4546
|
* </details>
|
|
4547
4547
|
*
|
|
@@ -4552,7 +4552,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4552
4552
|
*
|
|
4553
4553
|
* | Parameter | Type | Required | Description |
|
|
4554
4554
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4555
|
-
* | `item_types` | `Array<Block Model ID>` | ✅
|
|
4555
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4556
4556
|
*
|
|
4557
4557
|
* </details>
|
|
4558
4558
|
*
|
|
@@ -4563,7 +4563,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4563
4563
|
*
|
|
4564
4564
|
* | Parameter | Type | Required | Description |
|
|
4565
4565
|
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4566
|
-
* | `item_types` | `Array<Model ID>` | ✅
|
|
4566
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4567
4567
|
* | `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 |
|
|
4568
4568
|
* | `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 |
|
|
4569
4569
|
* | `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 |
|
|
@@ -4608,7 +4608,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4608
4608
|
*
|
|
4609
4609
|
* | Parameter | Type | Required | Description |
|
|
4610
4610
|
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4611
|
-
* | `title_field_id` | `Field ID` | ✅
|
|
4611
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
4612
4612
|
*
|
|
4613
4613
|
* </details>
|
|
4614
4614
|
*
|
|
@@ -4630,8 +4630,8 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4630
4630
|
*
|
|
4631
4631
|
* | Parameter | Type | Required | Description |
|
|
4632
4632
|
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4633
|
-
* | `positive_radio` | `{ label: string, hint?: string }` | ✅
|
|
4634
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅
|
|
4633
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
4634
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
4635
4635
|
*
|
|
4636
4636
|
* </details>
|
|
4637
4637
|
*
|
|
@@ -4642,7 +4642,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4642
4642
|
*
|
|
4643
4643
|
* | Parameter | Type | Required | Description |
|
|
4644
4644
|
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4645
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4645
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
4646
4646
|
*
|
|
4647
4647
|
* </details>
|
|
4648
4648
|
*
|
|
@@ -4653,7 +4653,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4653
4653
|
*
|
|
4654
4654
|
* | Parameter | Type | Required | Description |
|
|
4655
4655
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4656
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4656
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4657
4657
|
*
|
|
4658
4658
|
* </details>
|
|
4659
4659
|
*
|
|
@@ -4664,7 +4664,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4664
4664
|
*
|
|
4665
4665
|
* | Parameter | Type | Required | Description |
|
|
4666
4666
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4667
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4667
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4668
4668
|
*
|
|
4669
4669
|
* </details>
|
|
4670
4670
|
*
|
|
@@ -4675,7 +4675,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4675
4675
|
*
|
|
4676
4676
|
* | Parameter | Type | Required | Description |
|
|
4677
4677
|
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4678
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅
|
|
4678
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4679
4679
|
*
|
|
4680
4680
|
* </details>
|
|
4681
4681
|
*
|
|
@@ -4686,7 +4686,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4686
4686
|
*
|
|
4687
4687
|
* | Parameter | Type | Required | Description |
|
|
4688
4688
|
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4689
|
-
* | `heading` | `Boolean` | ✅
|
|
4689
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
4690
4690
|
*
|
|
4691
4691
|
* </details>
|
|
4692
4692
|
*
|
|
@@ -4697,7 +4697,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4697
4697
|
*
|
|
4698
4698
|
* | Parameter | Type | Required | Description |
|
|
4699
4699
|
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4700
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4700
|
+
* | `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"` |
|
|
4701
4701
|
*
|
|
4702
4702
|
* </details>
|
|
4703
4703
|
*
|
|
@@ -4708,7 +4708,7 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4708
4708
|
*
|
|
4709
4709
|
* | Parameter | Type | Required | Description |
|
|
4710
4710
|
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4711
|
-
* | `toolbar` | `Array<String>` | ✅
|
|
4711
|
+
* | `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"` |
|
|
4712
4712
|
*
|
|
4713
4713
|
* </details>
|
|
4714
4714
|
*
|
|
@@ -4726,8 +4726,8 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4726
4726
|
*
|
|
4727
4727
|
* | Parameter | Type | Required | Description |
|
|
4728
4728
|
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4729
|
-
* | `enable_alpha` | `Boolean` | ✅
|
|
4730
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅
|
|
4729
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
4730
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
4731
4731
|
*
|
|
4732
4732
|
* </details>
|
|
4733
4733
|
*
|
|
@@ -4760,9 +4760,9 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4760
4760
|
*
|
|
4761
4761
|
* | Parameter | Type | Required | Description |
|
|
4762
4762
|
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4763
|
-
* | `nodes` | `Array<String>` | ✅
|
|
4764
|
-
* | `marks` | `Array<String>` | ✅
|
|
4765
|
-
* | `heading_levels` | `Array<Integer>` | ✅
|
|
4763
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
4764
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
4765
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
4766
4766
|
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
4767
4767
|
* | `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 |
|
|
4768
4768
|
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|