@datocms/cma-client 3.1.0 → 3.1.2

package/dist/esm/generated/SimpleSchemaTypes.d.ts

@@ -607,7 +607,7 @@ export declare type ItemInstancesTargetSchema = Item[];
  */
 export declare type ItemInstancesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+     * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
      */
     nested?: boolean;
     /**
@@ -677,7 +677,7 @@ export declare type ItemReferencesTargetSchema = Item[];
  */
 export declare type ItemReferencesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
+     * For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
      */
     nested?: boolean;
     /**
@@ -692,7 +692,7 @@ export declare type ItemReferencesHrefSchema = {
  */
 export declare type ItemSelfHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+     * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
      */
     nested?: boolean;
     /**
@@ -893,7 +893,7 @@ export declare type ItemVersionInstancesTargetSchema = ItemVersion[];
  */
 export declare type ItemVersionInstancesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
+     * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
      */
     nested?: boolean;
     /**
@@ -1024,7 +1024,7 @@ export declare type UploadReferencesTargetSchema = Item[];
  */
 export declare type UploadReferencesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
+     * For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
      */
     nested?: boolean;
     /**
@@ -4817,6 +4817,18 @@ export declare type JobData = {
  * </details>
  *
  * <details>
+ * <summary>Single Block (<code>single_block</code>)</summary>
+ *
+ * | Property                       | Value                                           |
+ * | ------------------------------ | ----------------------------------------------- |
+ * | Code                           | `single_block`                                  |
+ * | Built-in editors for the field | `framed_single_block`, `frameless_single_block` |
+ * | Required validators            | `single_block_blocks`                           |
+ * | Other validators available     | `required`                                      |
+ *
+ * </details>
+ *
+ * <details>
  * <summary>Structured text (<code>structured_text</code>)</summary>
  *
  * | Property                       | Value                                             |
@@ -5118,6 +5130,17 @@ export declare type JobData = {
  *
  * Only accept references to block records of the specified block models.
  *
+ * | Parameter    | Type                    | Required | Description                     |
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
+ * | `item_types` | `Array<Block Model ID>` | ✅        | Set of allowed Block Model IDs |
+ *
+ * </details>
+ *
+ * <details>
+ * <summary><code>single_block_blocks</code></summary>
+ *
+ * Only accept references to block records of the specified block models.
+ *
  * | Parameter    | Type                    | Required | Description                    |
  * | ------------ | ----------------------- | -------- | ------------------------------ |
  * | `item_types` | `Array<Block Model ID>` | ✅        | Set of allowed Block Model IDs |
@@ -5337,10 +5360,10 @@ export declare type JobData = {
  *
  * Built-in editor for _seo_ fields.
  *
- * | Parameter  | Type            | Required | Description                                                                                                                                             |
- * | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `fields`   | `Array<String>` | ✅        | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
- * | `previews` | `Array<String>` | ✅        | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`  |
+ * | Parameter  | Type            | Required | Description                                                                                                                                                          |
+ * | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `fields`   | `Array<String>` | ✅        | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`              |
+ * | `previews` | `Array<String>` | ✅        | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
  *
  * </details>
  *
@@ -5356,6 +5379,17 @@ export declare type JobData = {
  * </details>
  *
  * <details>
+ * <summary><code>framed_single_block</code></summary>
+ *
+ * Built-in editor for _Single block_ fields.
+ *
+ * | Parameter         | Type      | Required | Description                                                |
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- |
+ * | `start_collapsed` | `Boolean` |          | Whether you want block record collapsed by default or not |
+ *
+ * </details>
+ *
+ * <details>
  * <summary><code>structured_text</code></summary>
  *
  * Built-in editor for _Structured text_ fields.
@@ -5399,7 +5433,7 @@ export declare type Field = {
     /**
      * Type of input
      */
-    field_type: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
+    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';
     /**
      * Whether the field needs to be multilanguage or not
      */
@@ -5501,7 +5535,7 @@ export declare type FieldAttributes = {
     /**
      * Type of input
      */
-    field_type: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
+    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';
     /**
      * Whether the field needs to be multilanguage or not
      */
@@ -5606,7 +5640,7 @@ export declare type FieldCreateSchema = {
     /**
      * Type of input
      */
-    field_type: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
+    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';
     /**
      * Field API key
      */
@@ -5773,7 +5807,7 @@ export declare type FieldUpdateSchema = {
     /**
      * Type of input
      */
-    field_type?: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
+    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';
     /**
      * Field hint
      */
@@ -9094,35 +9128,31 @@ export declare type PublicInfo = {
      * Specifies the color-scheme for the project
      */
     theme: {
-        primary_color?: {
+        primary_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
             [k: string]: unknown;
         };
-        light_color?: {
+        light_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        accent_color?: {
+        accent_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        dark_color?: {
+        dark_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        [k: string]: unknown;
     };
     /**
      * Additional information (only returned on authenticated requests)
@@ -9176,35 +9206,31 @@ export declare type PublicInfoAttributes = {
      * Specifies the color-scheme for the project
      */
     theme: {
-        primary_color?: {
+        primary_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
             [k: string]: unknown;
         };
-        light_color?: {
+        light_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        accent_color?: {
+        accent_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        dark_color?: {
+        dark_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        [k: string]: unknown;
     };
     /**
      * Additional information (only returned on authenticated requests)
@@ -9490,39 +9516,42 @@ export declare type Site = {
      * Specifies the theme to use in administrative area
      */
     theme: {
+        /**
+         * If type is monochromatic, the hue will determine the color palette. Dark color is a legacy property, and it won't be used on the interface
+         */
+        type: 'custom' | 'monochromatic';
+        /**
+         * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
+         */
+        hue: number | null;
         primary_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         light_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         accent_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         dark_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         /**
-         * The site logo
+         * The upload ID that is used as the logo for the project
          */
         logo: string | null;
-        [k: string]: unknown;
     };
     /**
      * Specifies default global settings
@@ -9675,39 +9704,42 @@ export declare type SiteAttributes = {
      * Specifies the theme to use in administrative area
      */
     theme: {
+        /**
+         * If type is monochromatic, the hue will determine the color palette. Dark color is a legacy property, and it won't be used on the interface
+         */
+        type: 'custom' | 'monochromatic';
+        /**
+         * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
+         */
+        hue: number | null;
         primary_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         light_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         accent_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         dark_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         /**
-         * The site logo
+         * The upload ID that is used as the logo for the project
          */
         logo: string | null;
-        [k: string]: unknown;
     };
     /**
      * Specifies default global settings
@@ -9813,42 +9845,53 @@ export declare type SiteUpdateSchema = {
      * Site name
      */
     name?: string;
-    /**
-     * Specifies the theme to use in administrative area
-     */
     theme?: {
+        /**
+         * Type of theme color palette
+         */
+        type: 'monochromatic';
+        /**
+         * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
+         */
+        hue: number | null;
+        /**
+         * The upload ID that is used as the logo for the project
+         */
+        logo: string | null;
+        [k: string]: unknown;
+    } | {
+        /**
+         * Type of theme color palette
+         */
+        type?: 'custom';
+        /**
+         * The upload ID that is used as the logo for the project
+         */
+        logo: string | null;
         primary_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         light_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
         accent_color: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        dark_color: {
+        dark_color?: {
             red: number;
             green: number;
             blue: number;
             alpha: number;
-            [k: string]: unknown;
         };
-        /**
-         * The site logo
-         */
-        logo: string | null;
         [k: string]: unknown;
     };
     /**