@datocms/cma-client 3.1.0 → 3.1.2

package/src/generated/SchemaTypes.ts

@@ -509,7 +509,7 @@ export type BuildTriggerType = 'build_trigger';
  */
 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;
   /**
@@ -574,7 +574,7 @@ export type ItemInstancesHrefSchema = {
  */
 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;
   /**
@@ -589,7 +589,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;
   /**
@@ -664,7 +664,7 @@ export type ItemVersionIdentity = string;
  */
 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;
   /**
@@ -864,7 +864,7 @@ export type UploadBatchDestroyHrefSchema = {
  */
 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;
   /**
@@ -4645,6 +4645,18 @@ export type ItemTypeDestroyJobSchema = {
  * </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                                             |
@@ -4946,6 +4958,17 @@ export type ItemTypeDestroyJobSchema = {
  *
  * 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 |
@@ -5165,10 +5188,10 @@ export type ItemTypeDestroyJobSchema = {
  *
  * 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>
  *
@@ -5184,6 +5207,17 @@ export type ItemTypeDestroyJobSchema = {
  * </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.
@@ -5239,25 +5273,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
    */
@@ -5385,25 +5420,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
        */
@@ -5613,25 +5649,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
        */
@@ -10139,35 +10176,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)
@@ -10508,39 +10541,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
@@ -10705,44 +10741,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
        */