@datocms/cma-client 3.1.1 → 3.1.2
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 +46 -12
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +47 -13
- package/dist/types/generated/SchemaTypes.d.ts +46 -12
- package/dist/types/generated/SimpleSchemaTypes.d.ts +47 -13
- package/package.json +2 -2
- package/src/generated/Client.ts +1 -1
- package/src/generated/SchemaTypes.ts +79 -42
- package/src/generated/SimpleSchemaTypes.ts +91 -53
|
@@ -128,7 +128,7 @@ var Client = /** @class */ (function () {
|
|
|
128
128
|
});
|
|
129
129
|
Client.prototype.request = function (options) {
|
|
130
130
|
var _this = this;
|
|
131
|
-
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.
|
|
131
|
+
return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.2', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
132
132
|
? { 'X-Environment': this.config.environment }
|
|
133
133
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
134
134
|
return _this.jobResultsFetcher
|
|
@@ -102,7 +102,7 @@ var Client = /** @class */ (function () {
|
|
|
102
102
|
});
|
|
103
103
|
Client.prototype.request = function (options) {
|
|
104
104
|
var _this = this;
|
|
105
|
-
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.
|
|
105
|
+
return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.2', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
|
|
106
106
|
? { 'X-Environment': this.config.environment }
|
|
107
107
|
: {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
|
|
108
108
|
return _this.jobResultsFetcher
|
|
@@ -507,7 +507,7 @@ export declare type BuildTriggerType = 'build_trigger';
|
|
|
507
507
|
*/
|
|
508
508
|
export declare type ItemInstancesHrefSchema = {
|
|
509
509
|
/**
|
|
510
|
-
* For Modular Content
|
|
510
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
511
511
|
*/
|
|
512
512
|
nested?: boolean;
|
|
513
513
|
/**
|
|
@@ -572,7 +572,7 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
572
572
|
*/
|
|
573
573
|
export declare type ItemReferencesHrefSchema = {
|
|
574
574
|
/**
|
|
575
|
-
* For Modular Content
|
|
575
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
576
576
|
*/
|
|
577
577
|
nested?: boolean;
|
|
578
578
|
/**
|
|
@@ -587,7 +587,7 @@ export declare type ItemReferencesHrefSchema = {
|
|
|
587
587
|
*/
|
|
588
588
|
export declare type ItemSelfHrefSchema = {
|
|
589
589
|
/**
|
|
590
|
-
* For Modular Content
|
|
590
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
591
591
|
*/
|
|
592
592
|
nested?: boolean;
|
|
593
593
|
/**
|
|
@@ -662,7 +662,7 @@ export declare type ItemVersionIdentity = string;
|
|
|
662
662
|
*/
|
|
663
663
|
export declare type ItemVersionInstancesHrefSchema = {
|
|
664
664
|
/**
|
|
665
|
-
* For Modular Content
|
|
665
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
666
666
|
*/
|
|
667
667
|
nested?: boolean;
|
|
668
668
|
/**
|
|
@@ -862,7 +862,7 @@ export declare type UploadBatchDestroyHrefSchema = {
|
|
|
862
862
|
*/
|
|
863
863
|
export declare type UploadReferencesHrefSchema = {
|
|
864
864
|
/**
|
|
865
|
-
* For Modular Content
|
|
865
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
866
866
|
*/
|
|
867
867
|
nested?: boolean;
|
|
868
868
|
/**
|
|
@@ -4367,6 +4367,18 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4367
4367
|
* </details>
|
|
4368
4368
|
*
|
|
4369
4369
|
* <details>
|
|
4370
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
4371
|
+
*
|
|
4372
|
+
* | Property | Value |
|
|
4373
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
4374
|
+
* | Code | `single_block` |
|
|
4375
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
4376
|
+
* | Required validators | `single_block_blocks` |
|
|
4377
|
+
* | Other validators available | `required` |
|
|
4378
|
+
*
|
|
4379
|
+
* </details>
|
|
4380
|
+
*
|
|
4381
|
+
* <details>
|
|
4370
4382
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4371
4383
|
*
|
|
4372
4384
|
* | Property | Value |
|
|
@@ -4668,6 +4680,17 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4668
4680
|
*
|
|
4669
4681
|
* Only accept references to block records of the specified block models.
|
|
4670
4682
|
*
|
|
4683
|
+
* | Parameter | Type | Required | Description |
|
|
4684
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4685
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4686
|
+
*
|
|
4687
|
+
* </details>
|
|
4688
|
+
*
|
|
4689
|
+
* <details>
|
|
4690
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
4691
|
+
*
|
|
4692
|
+
* Only accept references to block records of the specified block models.
|
|
4693
|
+
*
|
|
4671
4694
|
* | Parameter | Type | Required | Description |
|
|
4672
4695
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4673
4696
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -4887,10 +4910,10 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4887
4910
|
*
|
|
4888
4911
|
* Built-in editor for _seo_ fields.
|
|
4889
4912
|
*
|
|
4890
|
-
* | Parameter | Type | Required | Description
|
|
4891
|
-
* | ---------- | --------------- | -------- |
|
|
4892
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
4893
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
4913
|
+
* | Parameter | Type | Required | Description |
|
|
4914
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4915
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
4916
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
4894
4917
|
*
|
|
4895
4918
|
* </details>
|
|
4896
4919
|
*
|
|
@@ -4906,6 +4929,17 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4906
4929
|
* </details>
|
|
4907
4930
|
*
|
|
4908
4931
|
* <details>
|
|
4932
|
+
* <summary><code>framed_single_block</code></summary>
|
|
4933
|
+
*
|
|
4934
|
+
* Built-in editor for _Single block_ fields.
|
|
4935
|
+
*
|
|
4936
|
+
* | Parameter | Type | Required | Description |
|
|
4937
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4938
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
4939
|
+
*
|
|
4940
|
+
* </details>
|
|
4941
|
+
*
|
|
4942
|
+
* <details>
|
|
4909
4943
|
* <summary><code>structured_text</code></summary>
|
|
4910
4944
|
*
|
|
4911
4945
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -4959,7 +4993,7 @@ export declare type FieldAttributes = {
|
|
|
4959
4993
|
/**
|
|
4960
4994
|
* Type of input
|
|
4961
4995
|
*/
|
|
4962
|
-
field_type: '
|
|
4996
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
4963
4997
|
/**
|
|
4964
4998
|
* Whether the field needs to be multilanguage or not
|
|
4965
4999
|
*/
|
|
@@ -5079,7 +5113,7 @@ export declare type FieldCreateSchema = {
|
|
|
5079
5113
|
/**
|
|
5080
5114
|
* Type of input
|
|
5081
5115
|
*/
|
|
5082
|
-
field_type: '
|
|
5116
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5083
5117
|
/**
|
|
5084
5118
|
* Field API key
|
|
5085
5119
|
*/
|
|
@@ -5275,7 +5309,7 @@ export declare type FieldUpdateSchema = {
|
|
|
5275
5309
|
/**
|
|
5276
5310
|
* Type of input
|
|
5277
5311
|
*/
|
|
5278
|
-
field_type?: '
|
|
5312
|
+
field_type?: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5279
5313
|
/**
|
|
5280
5314
|
* Field hint
|
|
5281
5315
|
*/
|
|
@@ -607,7 +607,7 @@ export declare type ItemInstancesTargetSchema = Item[];
|
|
|
607
607
|
*/
|
|
608
608
|
export declare type ItemInstancesHrefSchema = {
|
|
609
609
|
/**
|
|
610
|
-
* For Modular Content
|
|
610
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
611
611
|
*/
|
|
612
612
|
nested?: boolean;
|
|
613
613
|
/**
|
|
@@ -677,7 +677,7 @@ export declare type ItemReferencesTargetSchema = Item[];
|
|
|
677
677
|
*/
|
|
678
678
|
export declare type ItemReferencesHrefSchema = {
|
|
679
679
|
/**
|
|
680
|
-
* For Modular Content
|
|
680
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
681
681
|
*/
|
|
682
682
|
nested?: boolean;
|
|
683
683
|
/**
|
|
@@ -692,7 +692,7 @@ export declare type ItemReferencesHrefSchema = {
|
|
|
692
692
|
*/
|
|
693
693
|
export declare type ItemSelfHrefSchema = {
|
|
694
694
|
/**
|
|
695
|
-
* For Modular Content
|
|
695
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
696
696
|
*/
|
|
697
697
|
nested?: boolean;
|
|
698
698
|
/**
|
|
@@ -893,7 +893,7 @@ export declare type ItemVersionInstancesTargetSchema = ItemVersion[];
|
|
|
893
893
|
*/
|
|
894
894
|
export declare type ItemVersionInstancesHrefSchema = {
|
|
895
895
|
/**
|
|
896
|
-
* For Modular Content
|
|
896
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
897
897
|
*/
|
|
898
898
|
nested?: boolean;
|
|
899
899
|
/**
|
|
@@ -1024,7 +1024,7 @@ export declare type UploadReferencesTargetSchema = Item[];
|
|
|
1024
1024
|
*/
|
|
1025
1025
|
export declare type UploadReferencesHrefSchema = {
|
|
1026
1026
|
/**
|
|
1027
|
-
* For Modular Content
|
|
1027
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
1028
1028
|
*/
|
|
1029
1029
|
nested?: boolean;
|
|
1030
1030
|
/**
|
|
@@ -4817,6 +4817,18 @@ export declare type JobData = {
|
|
|
4817
4817
|
* </details>
|
|
4818
4818
|
*
|
|
4819
4819
|
* <details>
|
|
4820
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
4821
|
+
*
|
|
4822
|
+
* | Property | Value |
|
|
4823
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
4824
|
+
* | Code | `single_block` |
|
|
4825
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
4826
|
+
* | Required validators | `single_block_blocks` |
|
|
4827
|
+
* | Other validators available | `required` |
|
|
4828
|
+
*
|
|
4829
|
+
* </details>
|
|
4830
|
+
*
|
|
4831
|
+
* <details>
|
|
4820
4832
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4821
4833
|
*
|
|
4822
4834
|
* | Property | Value |
|
|
@@ -5118,6 +5130,17 @@ export declare type JobData = {
|
|
|
5118
5130
|
*
|
|
5119
5131
|
* Only accept references to block records of the specified block models.
|
|
5120
5132
|
*
|
|
5133
|
+
* | Parameter | Type | Required | Description |
|
|
5134
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5135
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5136
|
+
*
|
|
5137
|
+
* </details>
|
|
5138
|
+
*
|
|
5139
|
+
* <details>
|
|
5140
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
5141
|
+
*
|
|
5142
|
+
* Only accept references to block records of the specified block models.
|
|
5143
|
+
*
|
|
5121
5144
|
* | Parameter | Type | Required | Description |
|
|
5122
5145
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5123
5146
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -5337,10 +5360,10 @@ export declare type JobData = {
|
|
|
5337
5360
|
*
|
|
5338
5361
|
* Built-in editor for _seo_ fields.
|
|
5339
5362
|
*
|
|
5340
|
-
* | Parameter | Type | Required | Description
|
|
5341
|
-
* | ---------- | --------------- | -------- |
|
|
5342
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5343
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
5363
|
+
* | Parameter | Type | Required | Description |
|
|
5364
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5365
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5366
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5344
5367
|
*
|
|
5345
5368
|
* </details>
|
|
5346
5369
|
*
|
|
@@ -5356,6 +5379,17 @@ export declare type JobData = {
|
|
|
5356
5379
|
* </details>
|
|
5357
5380
|
*
|
|
5358
5381
|
* <details>
|
|
5382
|
+
* <summary><code>framed_single_block</code></summary>
|
|
5383
|
+
*
|
|
5384
|
+
* Built-in editor for _Single block_ fields.
|
|
5385
|
+
*
|
|
5386
|
+
* | Parameter | Type | Required | Description |
|
|
5387
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
5388
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
5389
|
+
*
|
|
5390
|
+
* </details>
|
|
5391
|
+
*
|
|
5392
|
+
* <details>
|
|
5359
5393
|
* <summary><code>structured_text</code></summary>
|
|
5360
5394
|
*
|
|
5361
5395
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -5399,7 +5433,7 @@ export declare type Field = {
|
|
|
5399
5433
|
/**
|
|
5400
5434
|
* Type of input
|
|
5401
5435
|
*/
|
|
5402
|
-
field_type: '
|
|
5436
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5403
5437
|
/**
|
|
5404
5438
|
* Whether the field needs to be multilanguage or not
|
|
5405
5439
|
*/
|
|
@@ -5501,7 +5535,7 @@ export declare type FieldAttributes = {
|
|
|
5501
5535
|
/**
|
|
5502
5536
|
* Type of input
|
|
5503
5537
|
*/
|
|
5504
|
-
field_type: '
|
|
5538
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5505
5539
|
/**
|
|
5506
5540
|
* Whether the field needs to be multilanguage or not
|
|
5507
5541
|
*/
|
|
@@ -5606,7 +5640,7 @@ export declare type FieldCreateSchema = {
|
|
|
5606
5640
|
/**
|
|
5607
5641
|
* Type of input
|
|
5608
5642
|
*/
|
|
5609
|
-
field_type: '
|
|
5643
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5610
5644
|
/**
|
|
5611
5645
|
* Field API key
|
|
5612
5646
|
*/
|
|
@@ -5773,7 +5807,7 @@ export declare type FieldUpdateSchema = {
|
|
|
5773
5807
|
/**
|
|
5774
5808
|
* Type of input
|
|
5775
5809
|
*/
|
|
5776
|
-
field_type?: '
|
|
5810
|
+
field_type?: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5777
5811
|
/**
|
|
5778
5812
|
* Field hint
|
|
5779
5813
|
*/
|
|
@@ -507,7 +507,7 @@ export declare type BuildTriggerType = 'build_trigger';
|
|
|
507
507
|
*/
|
|
508
508
|
export declare type ItemInstancesHrefSchema = {
|
|
509
509
|
/**
|
|
510
|
-
* For Modular Content
|
|
510
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
511
511
|
*/
|
|
512
512
|
nested?: boolean;
|
|
513
513
|
/**
|
|
@@ -572,7 +572,7 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
572
572
|
*/
|
|
573
573
|
export declare type ItemReferencesHrefSchema = {
|
|
574
574
|
/**
|
|
575
|
-
* For Modular Content
|
|
575
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
576
576
|
*/
|
|
577
577
|
nested?: boolean;
|
|
578
578
|
/**
|
|
@@ -587,7 +587,7 @@ export declare type ItemReferencesHrefSchema = {
|
|
|
587
587
|
*/
|
|
588
588
|
export declare type ItemSelfHrefSchema = {
|
|
589
589
|
/**
|
|
590
|
-
* For Modular Content
|
|
590
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
591
591
|
*/
|
|
592
592
|
nested?: boolean;
|
|
593
593
|
/**
|
|
@@ -662,7 +662,7 @@ export declare type ItemVersionIdentity = string;
|
|
|
662
662
|
*/
|
|
663
663
|
export declare type ItemVersionInstancesHrefSchema = {
|
|
664
664
|
/**
|
|
665
|
-
* For Modular Content
|
|
665
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
666
666
|
*/
|
|
667
667
|
nested?: boolean;
|
|
668
668
|
/**
|
|
@@ -862,7 +862,7 @@ export declare type UploadBatchDestroyHrefSchema = {
|
|
|
862
862
|
*/
|
|
863
863
|
export declare type UploadReferencesHrefSchema = {
|
|
864
864
|
/**
|
|
865
|
-
* For Modular Content
|
|
865
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
866
866
|
*/
|
|
867
867
|
nested?: boolean;
|
|
868
868
|
/**
|
|
@@ -4367,6 +4367,18 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4367
4367
|
* </details>
|
|
4368
4368
|
*
|
|
4369
4369
|
* <details>
|
|
4370
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
4371
|
+
*
|
|
4372
|
+
* | Property | Value |
|
|
4373
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
4374
|
+
* | Code | `single_block` |
|
|
4375
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
4376
|
+
* | Required validators | `single_block_blocks` |
|
|
4377
|
+
* | Other validators available | `required` |
|
|
4378
|
+
*
|
|
4379
|
+
* </details>
|
|
4380
|
+
*
|
|
4381
|
+
* <details>
|
|
4370
4382
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4371
4383
|
*
|
|
4372
4384
|
* | Property | Value |
|
|
@@ -4668,6 +4680,17 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4668
4680
|
*
|
|
4669
4681
|
* Only accept references to block records of the specified block models.
|
|
4670
4682
|
*
|
|
4683
|
+
* | Parameter | Type | Required | Description |
|
|
4684
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4685
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4686
|
+
*
|
|
4687
|
+
* </details>
|
|
4688
|
+
*
|
|
4689
|
+
* <details>
|
|
4690
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
4691
|
+
*
|
|
4692
|
+
* Only accept references to block records of the specified block models.
|
|
4693
|
+
*
|
|
4671
4694
|
* | Parameter | Type | Required | Description |
|
|
4672
4695
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4673
4696
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -4887,10 +4910,10 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4887
4910
|
*
|
|
4888
4911
|
* Built-in editor for _seo_ fields.
|
|
4889
4912
|
*
|
|
4890
|
-
* | Parameter | Type | Required | Description
|
|
4891
|
-
* | ---------- | --------------- | -------- |
|
|
4892
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
4893
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
4913
|
+
* | Parameter | Type | Required | Description |
|
|
4914
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4915
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
4916
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
4894
4917
|
*
|
|
4895
4918
|
* </details>
|
|
4896
4919
|
*
|
|
@@ -4906,6 +4929,17 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4906
4929
|
* </details>
|
|
4907
4930
|
*
|
|
4908
4931
|
* <details>
|
|
4932
|
+
* <summary><code>framed_single_block</code></summary>
|
|
4933
|
+
*
|
|
4934
|
+
* Built-in editor for _Single block_ fields.
|
|
4935
|
+
*
|
|
4936
|
+
* | Parameter | Type | Required | Description |
|
|
4937
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4938
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
4939
|
+
*
|
|
4940
|
+
* </details>
|
|
4941
|
+
*
|
|
4942
|
+
* <details>
|
|
4909
4943
|
* <summary><code>structured_text</code></summary>
|
|
4910
4944
|
*
|
|
4911
4945
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -4959,7 +4993,7 @@ export declare type FieldAttributes = {
|
|
|
4959
4993
|
/**
|
|
4960
4994
|
* Type of input
|
|
4961
4995
|
*/
|
|
4962
|
-
field_type: '
|
|
4996
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
4963
4997
|
/**
|
|
4964
4998
|
* Whether the field needs to be multilanguage or not
|
|
4965
4999
|
*/
|
|
@@ -5079,7 +5113,7 @@ export declare type FieldCreateSchema = {
|
|
|
5079
5113
|
/**
|
|
5080
5114
|
* Type of input
|
|
5081
5115
|
*/
|
|
5082
|
-
field_type: '
|
|
5116
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5083
5117
|
/**
|
|
5084
5118
|
* Field API key
|
|
5085
5119
|
*/
|
|
@@ -5275,7 +5309,7 @@ export declare type FieldUpdateSchema = {
|
|
|
5275
5309
|
/**
|
|
5276
5310
|
* Type of input
|
|
5277
5311
|
*/
|
|
5278
|
-
field_type?: '
|
|
5312
|
+
field_type?: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5279
5313
|
/**
|
|
5280
5314
|
* Field hint
|
|
5281
5315
|
*/
|
|
@@ -607,7 +607,7 @@ export declare type ItemInstancesTargetSchema = Item[];
|
|
|
607
607
|
*/
|
|
608
608
|
export declare type ItemInstancesHrefSchema = {
|
|
609
609
|
/**
|
|
610
|
-
* For Modular Content
|
|
610
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
611
611
|
*/
|
|
612
612
|
nested?: boolean;
|
|
613
613
|
/**
|
|
@@ -677,7 +677,7 @@ export declare type ItemReferencesTargetSchema = Item[];
|
|
|
677
677
|
*/
|
|
678
678
|
export declare type ItemReferencesHrefSchema = {
|
|
679
679
|
/**
|
|
680
|
-
* For Modular Content
|
|
680
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
681
681
|
*/
|
|
682
682
|
nested?: boolean;
|
|
683
683
|
/**
|
|
@@ -692,7 +692,7 @@ export declare type ItemReferencesHrefSchema = {
|
|
|
692
692
|
*/
|
|
693
693
|
export declare type ItemSelfHrefSchema = {
|
|
694
694
|
/**
|
|
695
|
-
* For Modular Content
|
|
695
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
696
696
|
*/
|
|
697
697
|
nested?: boolean;
|
|
698
698
|
/**
|
|
@@ -893,7 +893,7 @@ export declare type ItemVersionInstancesTargetSchema = ItemVersion[];
|
|
|
893
893
|
*/
|
|
894
894
|
export declare type ItemVersionInstancesHrefSchema = {
|
|
895
895
|
/**
|
|
896
|
-
* For Modular Content
|
|
896
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
897
897
|
*/
|
|
898
898
|
nested?: boolean;
|
|
899
899
|
/**
|
|
@@ -1024,7 +1024,7 @@ export declare type UploadReferencesTargetSchema = Item[];
|
|
|
1024
1024
|
*/
|
|
1025
1025
|
export declare type UploadReferencesHrefSchema = {
|
|
1026
1026
|
/**
|
|
1027
|
-
* For Modular Content
|
|
1027
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
1028
1028
|
*/
|
|
1029
1029
|
nested?: boolean;
|
|
1030
1030
|
/**
|
|
@@ -4817,6 +4817,18 @@ export declare type JobData = {
|
|
|
4817
4817
|
* </details>
|
|
4818
4818
|
*
|
|
4819
4819
|
* <details>
|
|
4820
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
4821
|
+
*
|
|
4822
|
+
* | Property | Value |
|
|
4823
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
4824
|
+
* | Code | `single_block` |
|
|
4825
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
4826
|
+
* | Required validators | `single_block_blocks` |
|
|
4827
|
+
* | Other validators available | `required` |
|
|
4828
|
+
*
|
|
4829
|
+
* </details>
|
|
4830
|
+
*
|
|
4831
|
+
* <details>
|
|
4820
4832
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4821
4833
|
*
|
|
4822
4834
|
* | Property | Value |
|
|
@@ -5118,6 +5130,17 @@ export declare type JobData = {
|
|
|
5118
5130
|
*
|
|
5119
5131
|
* Only accept references to block records of the specified block models.
|
|
5120
5132
|
*
|
|
5133
|
+
* | Parameter | Type | Required | Description |
|
|
5134
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5135
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5136
|
+
*
|
|
5137
|
+
* </details>
|
|
5138
|
+
*
|
|
5139
|
+
* <details>
|
|
5140
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
5141
|
+
*
|
|
5142
|
+
* Only accept references to block records of the specified block models.
|
|
5143
|
+
*
|
|
5121
5144
|
* | Parameter | Type | Required | Description |
|
|
5122
5145
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5123
5146
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -5337,10 +5360,10 @@ export declare type JobData = {
|
|
|
5337
5360
|
*
|
|
5338
5361
|
* Built-in editor for _seo_ fields.
|
|
5339
5362
|
*
|
|
5340
|
-
* | Parameter | Type | Required | Description
|
|
5341
|
-
* | ---------- | --------------- | -------- |
|
|
5342
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5343
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
5363
|
+
* | Parameter | Type | Required | Description |
|
|
5364
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5365
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5366
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5344
5367
|
*
|
|
5345
5368
|
* </details>
|
|
5346
5369
|
*
|
|
@@ -5356,6 +5379,17 @@ export declare type JobData = {
|
|
|
5356
5379
|
* </details>
|
|
5357
5380
|
*
|
|
5358
5381
|
* <details>
|
|
5382
|
+
* <summary><code>framed_single_block</code></summary>
|
|
5383
|
+
*
|
|
5384
|
+
* Built-in editor for _Single block_ fields.
|
|
5385
|
+
*
|
|
5386
|
+
* | Parameter | Type | Required | Description |
|
|
5387
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
5388
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
5389
|
+
*
|
|
5390
|
+
* </details>
|
|
5391
|
+
*
|
|
5392
|
+
* <details>
|
|
5359
5393
|
* <summary><code>structured_text</code></summary>
|
|
5360
5394
|
*
|
|
5361
5395
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -5399,7 +5433,7 @@ export declare type Field = {
|
|
|
5399
5433
|
/**
|
|
5400
5434
|
* Type of input
|
|
5401
5435
|
*/
|
|
5402
|
-
field_type: '
|
|
5436
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5403
5437
|
/**
|
|
5404
5438
|
* Whether the field needs to be multilanguage or not
|
|
5405
5439
|
*/
|
|
@@ -5501,7 +5535,7 @@ export declare type FieldAttributes = {
|
|
|
5501
5535
|
/**
|
|
5502
5536
|
* Type of input
|
|
5503
5537
|
*/
|
|
5504
|
-
field_type: '
|
|
5538
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5505
5539
|
/**
|
|
5506
5540
|
* Whether the field needs to be multilanguage or not
|
|
5507
5541
|
*/
|
|
@@ -5606,7 +5640,7 @@ export declare type FieldCreateSchema = {
|
|
|
5606
5640
|
/**
|
|
5607
5641
|
* Type of input
|
|
5608
5642
|
*/
|
|
5609
|
-
field_type: '
|
|
5643
|
+
field_type: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5610
5644
|
/**
|
|
5611
5645
|
* Field API key
|
|
5612
5646
|
*/
|
|
@@ -5773,7 +5807,7 @@ export declare type FieldUpdateSchema = {
|
|
|
5773
5807
|
/**
|
|
5774
5808
|
* Type of input
|
|
5775
5809
|
*/
|
|
5776
|
-
field_type?: '
|
|
5810
|
+
field_type?: 'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'rich_text' | 'seo' | 'single_block' | 'slug' | 'string' | 'structured_text' | 'text' | 'video';
|
|
5777
5811
|
/**
|
|
5778
5812
|
* Field hint
|
|
5779
5813
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datocms/cma-client",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.2",
|
|
4
4
|
"description": "JS client for DatoCMS REST Content Management API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -44,5 +44,5 @@
|
|
|
44
44
|
"@datocms/dashboard-client": "^3.1.1",
|
|
45
45
|
"@types/uuid": "^9.0.7"
|
|
46
46
|
},
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "d99b6e44be7023fa4b79d6754d26fae1fa014102"
|
|
48
48
|
}
|
package/src/generated/Client.ts
CHANGED
|
@@ -137,7 +137,7 @@ export class Client {
|
|
|
137
137
|
...this.config,
|
|
138
138
|
...options,
|
|
139
139
|
logFn: this.config.logFn || console.log,
|
|
140
|
-
userAgent: '@datocms/cma-client v3.1.
|
|
140
|
+
userAgent: '@datocms/cma-client v3.1.2',
|
|
141
141
|
baseUrl: this.baseUrl,
|
|
142
142
|
preCallStack: new Error().stack,
|
|
143
143
|
extraHeaders: {
|
|
@@ -509,7 +509,7 @@ export type BuildTriggerType = 'build_trigger';
|
|
|
509
509
|
*/
|
|
510
510
|
export type ItemInstancesHrefSchema = {
|
|
511
511
|
/**
|
|
512
|
-
* For Modular Content
|
|
512
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
513
513
|
*/
|
|
514
514
|
nested?: boolean;
|
|
515
515
|
/**
|
|
@@ -574,7 +574,7 @@ export type ItemInstancesHrefSchema = {
|
|
|
574
574
|
*/
|
|
575
575
|
export type ItemReferencesHrefSchema = {
|
|
576
576
|
/**
|
|
577
|
-
* For Modular Content
|
|
577
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
578
578
|
*/
|
|
579
579
|
nested?: boolean;
|
|
580
580
|
/**
|
|
@@ -589,7 +589,7 @@ export type ItemReferencesHrefSchema = {
|
|
|
589
589
|
*/
|
|
590
590
|
export type ItemSelfHrefSchema = {
|
|
591
591
|
/**
|
|
592
|
-
* For Modular Content
|
|
592
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
593
593
|
*/
|
|
594
594
|
nested?: boolean;
|
|
595
595
|
/**
|
|
@@ -664,7 +664,7 @@ export type ItemVersionIdentity = string;
|
|
|
664
664
|
*/
|
|
665
665
|
export type ItemVersionInstancesHrefSchema = {
|
|
666
666
|
/**
|
|
667
|
-
* For Modular Content
|
|
667
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
668
668
|
*/
|
|
669
669
|
nested?: boolean;
|
|
670
670
|
/**
|
|
@@ -864,7 +864,7 @@ export type UploadBatchDestroyHrefSchema = {
|
|
|
864
864
|
*/
|
|
865
865
|
export type UploadReferencesHrefSchema = {
|
|
866
866
|
/**
|
|
867
|
-
* For Modular Content
|
|
867
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
868
868
|
*/
|
|
869
869
|
nested?: boolean;
|
|
870
870
|
/**
|
|
@@ -4645,6 +4645,18 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4645
4645
|
* </details>
|
|
4646
4646
|
*
|
|
4647
4647
|
* <details>
|
|
4648
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
4649
|
+
*
|
|
4650
|
+
* | Property | Value |
|
|
4651
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
4652
|
+
* | Code | `single_block` |
|
|
4653
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
4654
|
+
* | Required validators | `single_block_blocks` |
|
|
4655
|
+
* | Other validators available | `required` |
|
|
4656
|
+
*
|
|
4657
|
+
* </details>
|
|
4658
|
+
*
|
|
4659
|
+
* <details>
|
|
4648
4660
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
4649
4661
|
*
|
|
4650
4662
|
* | Property | Value |
|
|
@@ -4946,6 +4958,17 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4946
4958
|
*
|
|
4947
4959
|
* Only accept references to block records of the specified block models.
|
|
4948
4960
|
*
|
|
4961
|
+
* | Parameter | Type | Required | Description |
|
|
4962
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4963
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4964
|
+
*
|
|
4965
|
+
* </details>
|
|
4966
|
+
*
|
|
4967
|
+
* <details>
|
|
4968
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
4969
|
+
*
|
|
4970
|
+
* Only accept references to block records of the specified block models.
|
|
4971
|
+
*
|
|
4949
4972
|
* | Parameter | Type | Required | Description |
|
|
4950
4973
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4951
4974
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -5165,10 +5188,10 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
5165
5188
|
*
|
|
5166
5189
|
* Built-in editor for _seo_ fields.
|
|
5167
5190
|
*
|
|
5168
|
-
* | Parameter | Type | Required | Description
|
|
5169
|
-
* | ---------- | --------------- | -------- |
|
|
5170
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5171
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
5191
|
+
* | Parameter | Type | Required | Description |
|
|
5192
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5193
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5194
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5172
5195
|
*
|
|
5173
5196
|
* </details>
|
|
5174
5197
|
*
|
|
@@ -5184,6 +5207,17 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
5184
5207
|
* </details>
|
|
5185
5208
|
*
|
|
5186
5209
|
* <details>
|
|
5210
|
+
* <summary><code>framed_single_block</code></summary>
|
|
5211
|
+
*
|
|
5212
|
+
* Built-in editor for _Single block_ fields.
|
|
5213
|
+
*
|
|
5214
|
+
* | Parameter | Type | Required | Description |
|
|
5215
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
5216
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
5217
|
+
*
|
|
5218
|
+
* </details>
|
|
5219
|
+
*
|
|
5220
|
+
* <details>
|
|
5187
5221
|
* <summary><code>structured_text</code></summary>
|
|
5188
5222
|
*
|
|
5189
5223
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -5239,25 +5273,26 @@ export type FieldAttributes = {
|
|
|
5239
5273
|
* Type of input
|
|
5240
5274
|
*/
|
|
5241
5275
|
field_type:
|
|
5242
|
-
| 'string'
|
|
5243
|
-
| 'text'
|
|
5244
5276
|
| 'boolean'
|
|
5245
|
-
| '
|
|
5246
|
-
| 'float'
|
|
5277
|
+
| 'color'
|
|
5247
5278
|
| 'date'
|
|
5248
5279
|
| 'date_time'
|
|
5249
|
-
| 'color'
|
|
5250
|
-
| 'json'
|
|
5251
|
-
| 'lat_lon'
|
|
5252
|
-
| 'seo'
|
|
5253
|
-
| 'slug'
|
|
5254
|
-
| 'video'
|
|
5255
5280
|
| 'file'
|
|
5281
|
+
| 'float'
|
|
5256
5282
|
| 'gallery'
|
|
5283
|
+
| 'integer'
|
|
5284
|
+
| 'json'
|
|
5285
|
+
| 'lat_lon'
|
|
5257
5286
|
| 'link'
|
|
5258
5287
|
| 'links'
|
|
5259
5288
|
| 'rich_text'
|
|
5260
|
-
| '
|
|
5289
|
+
| 'seo'
|
|
5290
|
+
| 'single_block'
|
|
5291
|
+
| 'slug'
|
|
5292
|
+
| 'string'
|
|
5293
|
+
| 'structured_text'
|
|
5294
|
+
| 'text'
|
|
5295
|
+
| 'video';
|
|
5261
5296
|
/**
|
|
5262
5297
|
* Whether the field needs to be multilanguage or not
|
|
5263
5298
|
*/
|
|
@@ -5385,25 +5420,26 @@ export type FieldCreateSchema = {
|
|
|
5385
5420
|
* Type of input
|
|
5386
5421
|
*/
|
|
5387
5422
|
field_type:
|
|
5388
|
-
| 'string'
|
|
5389
|
-
| 'text'
|
|
5390
5423
|
| 'boolean'
|
|
5391
|
-
| '
|
|
5392
|
-
| 'float'
|
|
5424
|
+
| 'color'
|
|
5393
5425
|
| 'date'
|
|
5394
5426
|
| 'date_time'
|
|
5395
|
-
| 'color'
|
|
5396
|
-
| 'json'
|
|
5397
|
-
| 'lat_lon'
|
|
5398
|
-
| 'seo'
|
|
5399
|
-
| 'slug'
|
|
5400
|
-
| 'video'
|
|
5401
5427
|
| 'file'
|
|
5428
|
+
| 'float'
|
|
5402
5429
|
| 'gallery'
|
|
5430
|
+
| 'integer'
|
|
5431
|
+
| 'json'
|
|
5432
|
+
| 'lat_lon'
|
|
5403
5433
|
| 'link'
|
|
5404
5434
|
| 'links'
|
|
5405
5435
|
| 'rich_text'
|
|
5406
|
-
| '
|
|
5436
|
+
| 'seo'
|
|
5437
|
+
| 'single_block'
|
|
5438
|
+
| 'slug'
|
|
5439
|
+
| 'string'
|
|
5440
|
+
| 'structured_text'
|
|
5441
|
+
| 'text'
|
|
5442
|
+
| 'video';
|
|
5407
5443
|
/**
|
|
5408
5444
|
* Field API key
|
|
5409
5445
|
*/
|
|
@@ -5613,25 +5649,26 @@ export type FieldUpdateSchema = {
|
|
|
5613
5649
|
* Type of input
|
|
5614
5650
|
*/
|
|
5615
5651
|
field_type?:
|
|
5616
|
-
| 'string'
|
|
5617
|
-
| 'text'
|
|
5618
5652
|
| 'boolean'
|
|
5619
|
-
| '
|
|
5620
|
-
| 'float'
|
|
5653
|
+
| 'color'
|
|
5621
5654
|
| 'date'
|
|
5622
5655
|
| 'date_time'
|
|
5623
|
-
| 'color'
|
|
5624
|
-
| 'json'
|
|
5625
|
-
| 'lat_lon'
|
|
5626
|
-
| 'seo'
|
|
5627
|
-
| 'slug'
|
|
5628
|
-
| 'video'
|
|
5629
5656
|
| 'file'
|
|
5657
|
+
| 'float'
|
|
5630
5658
|
| 'gallery'
|
|
5659
|
+
| 'integer'
|
|
5660
|
+
| 'json'
|
|
5661
|
+
| 'lat_lon'
|
|
5631
5662
|
| 'link'
|
|
5632
5663
|
| 'links'
|
|
5633
5664
|
| 'rich_text'
|
|
5634
|
-
| '
|
|
5665
|
+
| 'seo'
|
|
5666
|
+
| 'single_block'
|
|
5667
|
+
| 'slug'
|
|
5668
|
+
| 'string'
|
|
5669
|
+
| 'structured_text'
|
|
5670
|
+
| 'text'
|
|
5671
|
+
| 'video';
|
|
5635
5672
|
/**
|
|
5636
5673
|
* Field hint
|
|
5637
5674
|
*/
|
|
@@ -609,7 +609,7 @@ export type ItemInstancesTargetSchema = Item[];
|
|
|
609
609
|
*/
|
|
610
610
|
export type ItemInstancesHrefSchema = {
|
|
611
611
|
/**
|
|
612
|
-
* For Modular Content
|
|
612
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
613
613
|
*/
|
|
614
614
|
nested?: boolean;
|
|
615
615
|
/**
|
|
@@ -679,7 +679,7 @@ export type ItemReferencesTargetSchema = Item[];
|
|
|
679
679
|
*/
|
|
680
680
|
export type ItemReferencesHrefSchema = {
|
|
681
681
|
/**
|
|
682
|
-
* For Modular Content
|
|
682
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
683
683
|
*/
|
|
684
684
|
nested?: boolean;
|
|
685
685
|
/**
|
|
@@ -694,7 +694,7 @@ export type ItemReferencesHrefSchema = {
|
|
|
694
694
|
*/
|
|
695
695
|
export type ItemSelfHrefSchema = {
|
|
696
696
|
/**
|
|
697
|
-
* For Modular Content
|
|
697
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
698
698
|
*/
|
|
699
699
|
nested?: boolean;
|
|
700
700
|
/**
|
|
@@ -895,7 +895,7 @@ export type ItemVersionInstancesTargetSchema = ItemVersion[];
|
|
|
895
895
|
*/
|
|
896
896
|
export type ItemVersionInstancesHrefSchema = {
|
|
897
897
|
/**
|
|
898
|
-
* For Modular Content
|
|
898
|
+
* For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
|
|
899
899
|
*/
|
|
900
900
|
nested?: boolean;
|
|
901
901
|
/**
|
|
@@ -1026,7 +1026,7 @@ export type UploadReferencesTargetSchema = Item[];
|
|
|
1026
1026
|
*/
|
|
1027
1027
|
export type UploadReferencesHrefSchema = {
|
|
1028
1028
|
/**
|
|
1029
|
-
* For Modular Content
|
|
1029
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
1030
1030
|
*/
|
|
1031
1031
|
nested?: boolean;
|
|
1032
1032
|
/**
|
|
@@ -5093,6 +5093,18 @@ export type JobData = {
|
|
|
5093
5093
|
* </details>
|
|
5094
5094
|
*
|
|
5095
5095
|
* <details>
|
|
5096
|
+
* <summary>Single Block (<code>single_block</code>)</summary>
|
|
5097
|
+
*
|
|
5098
|
+
* | Property | Value |
|
|
5099
|
+
* | ------------------------------ | ----------------------------------------------- |
|
|
5100
|
+
* | Code | `single_block` |
|
|
5101
|
+
* | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
|
|
5102
|
+
* | Required validators | `single_block_blocks` |
|
|
5103
|
+
* | Other validators available | `required` |
|
|
5104
|
+
*
|
|
5105
|
+
* </details>
|
|
5106
|
+
*
|
|
5107
|
+
* <details>
|
|
5096
5108
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
5097
5109
|
*
|
|
5098
5110
|
* | Property | Value |
|
|
@@ -5394,6 +5406,17 @@ export type JobData = {
|
|
|
5394
5406
|
*
|
|
5395
5407
|
* Only accept references to block records of the specified block models.
|
|
5396
5408
|
*
|
|
5409
|
+
* | Parameter | Type | Required | Description |
|
|
5410
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5411
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
5412
|
+
*
|
|
5413
|
+
* </details>
|
|
5414
|
+
*
|
|
5415
|
+
* <details>
|
|
5416
|
+
* <summary><code>single_block_blocks</code></summary>
|
|
5417
|
+
*
|
|
5418
|
+
* Only accept references to block records of the specified block models.
|
|
5419
|
+
*
|
|
5397
5420
|
* | Parameter | Type | Required | Description |
|
|
5398
5421
|
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
5399
5422
|
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
@@ -5613,10 +5636,10 @@ export type JobData = {
|
|
|
5613
5636
|
*
|
|
5614
5637
|
* Built-in editor for _seo_ fields.
|
|
5615
5638
|
*
|
|
5616
|
-
* | Parameter | Type | Required | Description
|
|
5617
|
-
* | ---------- | --------------- | -------- |
|
|
5618
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5619
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`
|
|
5639
|
+
* | Parameter | Type | Required | Description |
|
|
5640
|
+
* | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5641
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5642
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5620
5643
|
*
|
|
5621
5644
|
* </details>
|
|
5622
5645
|
*
|
|
@@ -5632,6 +5655,17 @@ export type JobData = {
|
|
|
5632
5655
|
* </details>
|
|
5633
5656
|
*
|
|
5634
5657
|
* <details>
|
|
5658
|
+
* <summary><code>framed_single_block</code></summary>
|
|
5659
|
+
*
|
|
5660
|
+
* Built-in editor for _Single block_ fields.
|
|
5661
|
+
*
|
|
5662
|
+
* | Parameter | Type | Required | Description |
|
|
5663
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
5664
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block record collapsed by default or not |
|
|
5665
|
+
*
|
|
5666
|
+
* </details>
|
|
5667
|
+
*
|
|
5668
|
+
* <details>
|
|
5635
5669
|
* <summary><code>structured_text</code></summary>
|
|
5636
5670
|
*
|
|
5637
5671
|
* Built-in editor for _Structured text_ fields.
|
|
@@ -5676,25 +5710,26 @@ export type Field = {
|
|
|
5676
5710
|
* Type of input
|
|
5677
5711
|
*/
|
|
5678
5712
|
field_type:
|
|
5679
|
-
| 'string'
|
|
5680
|
-
| 'text'
|
|
5681
5713
|
| 'boolean'
|
|
5682
|
-
| '
|
|
5683
|
-
| 'float'
|
|
5714
|
+
| 'color'
|
|
5684
5715
|
| 'date'
|
|
5685
5716
|
| 'date_time'
|
|
5686
|
-
| 'color'
|
|
5687
|
-
| 'json'
|
|
5688
|
-
| 'lat_lon'
|
|
5689
|
-
| 'seo'
|
|
5690
|
-
| 'slug'
|
|
5691
|
-
| 'video'
|
|
5692
5717
|
| 'file'
|
|
5718
|
+
| 'float'
|
|
5693
5719
|
| 'gallery'
|
|
5720
|
+
| 'integer'
|
|
5721
|
+
| 'json'
|
|
5722
|
+
| 'lat_lon'
|
|
5694
5723
|
| 'link'
|
|
5695
5724
|
| 'links'
|
|
5696
5725
|
| 'rich_text'
|
|
5697
|
-
| '
|
|
5726
|
+
| 'seo'
|
|
5727
|
+
| 'single_block'
|
|
5728
|
+
| 'slug'
|
|
5729
|
+
| 'string'
|
|
5730
|
+
| 'structured_text'
|
|
5731
|
+
| 'text'
|
|
5732
|
+
| 'video';
|
|
5698
5733
|
/**
|
|
5699
5734
|
* Whether the field needs to be multilanguage or not
|
|
5700
5735
|
*/
|
|
@@ -5802,25 +5837,26 @@ export type FieldAttributes = {
|
|
|
5802
5837
|
* Type of input
|
|
5803
5838
|
*/
|
|
5804
5839
|
field_type:
|
|
5805
|
-
| 'string'
|
|
5806
|
-
| 'text'
|
|
5807
5840
|
| 'boolean'
|
|
5808
|
-
| '
|
|
5809
|
-
| 'float'
|
|
5841
|
+
| 'color'
|
|
5810
5842
|
| 'date'
|
|
5811
5843
|
| 'date_time'
|
|
5812
|
-
| 'color'
|
|
5813
|
-
| 'json'
|
|
5814
|
-
| 'lat_lon'
|
|
5815
|
-
| 'seo'
|
|
5816
|
-
| 'slug'
|
|
5817
|
-
| 'video'
|
|
5818
5844
|
| 'file'
|
|
5845
|
+
| 'float'
|
|
5819
5846
|
| 'gallery'
|
|
5847
|
+
| 'integer'
|
|
5848
|
+
| 'json'
|
|
5849
|
+
| 'lat_lon'
|
|
5820
5850
|
| 'link'
|
|
5821
5851
|
| 'links'
|
|
5822
5852
|
| 'rich_text'
|
|
5823
|
-
| '
|
|
5853
|
+
| 'seo'
|
|
5854
|
+
| 'single_block'
|
|
5855
|
+
| 'slug'
|
|
5856
|
+
| 'string'
|
|
5857
|
+
| 'structured_text'
|
|
5858
|
+
| 'text'
|
|
5859
|
+
| 'video';
|
|
5824
5860
|
/**
|
|
5825
5861
|
* Whether the field needs to be multilanguage or not
|
|
5826
5862
|
*/
|
|
@@ -5933,25 +5969,26 @@ export type FieldCreateSchema = {
|
|
|
5933
5969
|
* Type of input
|
|
5934
5970
|
*/
|
|
5935
5971
|
field_type:
|
|
5936
|
-
| 'string'
|
|
5937
|
-
| 'text'
|
|
5938
5972
|
| 'boolean'
|
|
5939
|
-
| '
|
|
5940
|
-
| 'float'
|
|
5973
|
+
| 'color'
|
|
5941
5974
|
| 'date'
|
|
5942
5975
|
| 'date_time'
|
|
5943
|
-
| 'color'
|
|
5944
|
-
| 'json'
|
|
5945
|
-
| 'lat_lon'
|
|
5946
|
-
| 'seo'
|
|
5947
|
-
| 'slug'
|
|
5948
|
-
| 'video'
|
|
5949
5976
|
| 'file'
|
|
5977
|
+
| 'float'
|
|
5950
5978
|
| 'gallery'
|
|
5979
|
+
| 'integer'
|
|
5980
|
+
| 'json'
|
|
5981
|
+
| 'lat_lon'
|
|
5951
5982
|
| 'link'
|
|
5952
5983
|
| 'links'
|
|
5953
5984
|
| 'rich_text'
|
|
5954
|
-
| '
|
|
5985
|
+
| 'seo'
|
|
5986
|
+
| 'single_block'
|
|
5987
|
+
| 'slug'
|
|
5988
|
+
| 'string'
|
|
5989
|
+
| 'structured_text'
|
|
5990
|
+
| 'text'
|
|
5991
|
+
| 'video';
|
|
5955
5992
|
/**
|
|
5956
5993
|
* Field API key
|
|
5957
5994
|
*/
|
|
@@ -6130,25 +6167,26 @@ export type FieldUpdateSchema = {
|
|
|
6130
6167
|
* Type of input
|
|
6131
6168
|
*/
|
|
6132
6169
|
field_type?:
|
|
6133
|
-
| 'string'
|
|
6134
|
-
| 'text'
|
|
6135
6170
|
| 'boolean'
|
|
6136
|
-
| '
|
|
6137
|
-
| 'float'
|
|
6171
|
+
| 'color'
|
|
6138
6172
|
| 'date'
|
|
6139
6173
|
| 'date_time'
|
|
6140
|
-
| 'color'
|
|
6141
|
-
| 'json'
|
|
6142
|
-
| 'lat_lon'
|
|
6143
|
-
| 'seo'
|
|
6144
|
-
| 'slug'
|
|
6145
|
-
| 'video'
|
|
6146
6174
|
| 'file'
|
|
6175
|
+
| 'float'
|
|
6147
6176
|
| 'gallery'
|
|
6177
|
+
| 'integer'
|
|
6178
|
+
| 'json'
|
|
6179
|
+
| 'lat_lon'
|
|
6148
6180
|
| 'link'
|
|
6149
6181
|
| 'links'
|
|
6150
6182
|
| 'rich_text'
|
|
6151
|
-
| '
|
|
6183
|
+
| 'seo'
|
|
6184
|
+
| 'single_block'
|
|
6185
|
+
| 'slug'
|
|
6186
|
+
| 'string'
|
|
6187
|
+
| 'structured_text'
|
|
6188
|
+
| 'text'
|
|
6189
|
+
| 'video';
|
|
6152
6190
|
/**
|
|
6153
6191
|
* Field hint
|
|
6154
6192
|
*/
|