@datocms/cma-client 3.1.0 → 3.1.2

package/src/generated/SimpleSchemaTypes.ts

@@ -609,7 +609,7 @@ export type ItemInstancesTargetSchema = Item[];
  */
 export 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;
   /**
@@ -679,7 +679,7 @@ export type ItemReferencesTargetSchema = Item[];
  */
 export 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;
   /**
@@ -694,7 +694,7 @@ export type ItemReferencesHrefSchema = {
  */
 export 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;
   /**
@@ -895,7 +895,7 @@ export type ItemVersionInstancesTargetSchema = ItemVersion[];
  */
 export 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;
   /**
@@ -1026,7 +1026,7 @@ export type UploadReferencesTargetSchema = Item[];
  */
 export 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;
   /**
@@ -5093,6 +5093,18 @@ export 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                                             |
@@ -5394,6 +5406,17 @@ export 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 |
@@ -5613,10 +5636,10 @@ export 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>
  *
@@ -5632,6 +5655,17 @@ export 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.
@@ -5676,25 +5710,26 @@ export type Field = {
    * Type of input
    */
   field_type:
-    | 'string'
-    | 'text'
     | 'boolean'
-    | 'integer'
-    | 'float'
+    | 'color'
     | 'date'
     | 'date_time'
-    | 'color'
-    | 'json'
-    | 'lat_lon'
-    | 'seo'
-    | 'slug'
-    | 'video'
     | 'file'
+    | 'float'
     | 'gallery'
+    | 'integer'
+    | 'json'
+    | 'lat_lon'
     | 'link'
     | 'links'
     | 'rich_text'
-    | 'structured_text';
+    | 'seo'
+    | 'single_block'
+    | 'slug'
+    | 'string'
+    | 'structured_text'
+    | 'text'
+    | 'video';
   /**
    * Whether the field needs to be multilanguage or not
    */
@@ -5802,25 +5837,26 @@ export type FieldAttributes = {
    * Type of input
    */
   field_type:
-    | 'string'
-    | 'text'
     | 'boolean'
-    | 'integer'
-    | 'float'
+    | 'color'
     | 'date'
     | 'date_time'
-    | 'color'
-    | 'json'
-    | 'lat_lon'
-    | 'seo'
-    | 'slug'
-    | 'video'
     | 'file'
+    | 'float'
     | 'gallery'
+    | 'integer'
+    | 'json'
+    | 'lat_lon'
     | 'link'
     | 'links'
     | 'rich_text'
-    | 'structured_text';
+    | 'seo'
+    | 'single_block'
+    | 'slug'
+    | 'string'
+    | 'structured_text'
+    | 'text'
+    | 'video';
   /**
    * Whether the field needs to be multilanguage or not
    */
@@ -5933,25 +5969,26 @@ export type FieldCreateSchema = {
    * Type of input
    */
   field_type:
-    | 'string'
-    | 'text'
     | 'boolean'
-    | 'integer'
-    | 'float'
+    | 'color'
     | 'date'
     | 'date_time'
-    | 'color'
-    | 'json'
-    | 'lat_lon'
-    | 'seo'
-    | 'slug'
-    | 'video'
     | 'file'
+    | 'float'
     | 'gallery'
+    | 'integer'
+    | 'json'
+    | 'lat_lon'
     | 'link'
     | 'links'
     | 'rich_text'
-    | 'structured_text';
+    | 'seo'
+    | 'single_block'
+    | 'slug'
+    | 'string'
+    | 'structured_text'
+    | 'text'
+    | 'video';
   /**
    * Field API key
    */
@@ -6130,25 +6167,26 @@ export type FieldUpdateSchema = {
    * Type of input
    */
   field_type?:
-    | 'string'
-    | 'text'
     | 'boolean'
-    | 'integer'
-    | 'float'
+    | 'color'
     | 'date'
     | 'date_time'
-    | 'color'
-    | 'json'
-    | 'lat_lon'
-    | 'seo'
-    | 'slug'
-    | 'video'
     | 'file'
+    | 'float'
     | 'gallery'
+    | 'integer'
+    | 'json'
+    | 'lat_lon'
     | 'link'
     | 'links'
     | 'rich_text'
-    | 'structured_text';
+    | 'seo'
+    | 'single_block'
+    | 'slug'
+    | 'string'
+    | 'structured_text'
+    | 'text'
+    | 'video';
   /**
    * Field hint
    */
@@ -9722,35 +9760,31 @@ export 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)
@@ -9805,35 +9839,31 @@ export 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)
@@ -10131,39 +10161,42 @@ export 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
@@ -10318,39 +10351,42 @@ export 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
@@ -10458,44 +10494,57 @@ export type SiteUpdateSchema = {
    * Site name
    */
   name?: string;
-  /**
-   * Specifies the theme to use in administrative area
-   */
-  theme?: {
-    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
-     */
-    logo: string | null;
-    [k: string]: unknown;
-  };
+  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;
+        };
+        light_color: {
+          red: number;
+          green: number;
+          blue: number;
+          alpha: number;
+        };
+        accent_color: {
+          red: number;
+          green: number;
+          blue: number;
+          alpha: number;
+        };
+        dark_color?: {
+          red: number;
+          green: number;
+          blue: number;
+          alpha: number;
+        };
+        [k: string]: unknown;
+      };
   /**
    * Available locales
    */