@datocms/cma-client 3.1.1 → 3.1.3

package/src/generated/SimpleSchemaTypes.ts

@@ -425,6 +425,14 @@ export type ItemTypeCreateHrefSchema = {
    * Skip the creation of a menu item linked to the model
    */
   skip_menu_item_creation?: boolean;
+  /**
+   * Explicitely specify the ID of the menu item that will be linked to the model
+   */
+  menu_item_id?: string;
+  /**
+   * Explicitely specify the ID of the schema menu item that will be linked to the model
+   */
+  schema_menu_item_id?: string;
   [k: string]: unknown;
 };
 /**
@@ -609,7 +617,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 +687,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 +702,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 +903,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 +1034,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;
   /**
@@ -1397,6 +1405,32 @@ export type SsoSettingsIdentity = string;
  * via the `definition` "type".
  */
 export type SsoSettingsType = 'sso_settings';
+/**
+ * ID
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type EmojiSuggestionsIdentity = string;
+/**
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type EmojiSuggestionsType = 'emoji_suggestions';
+/**
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type EmojiSuggestionsSelfHrefSchema = {
+  /**
+   * The term for which we are seeking suggestions for emojis
+   */
+  term?: string;
+  [k: string]: unknown;
+};
 /**
  * ID
  *
@@ -1666,6 +1700,7 @@ export type DatoApi = {
   form_data?: FormData;
   sso_group?: SsoGroup;
   sso_settings?: SsoSettings;
+  emoji_suggestions?: EmojiSuggestions;
   white_label_settings?: WhiteLabelSettings;
   public_info?: PublicInfo;
   daily_usage?: DailyUsage;
@@ -3703,6 +3738,10 @@ export type SitePlan = {
    * Maximum size in bytes for a single file upload
    */
   maximum_single_upload_bytes: number;
+  /**
+   * Maximum size (in bytes) for a record, including its block records
+   */
+  item_byte_size: number;
   /**
    * Available extra packets
    */
@@ -3937,6 +3976,10 @@ export type SitePlanAttributes = {
    * Maximum size in bytes for a single file upload
    */
   maximum_single_upload_bytes: number;
+  /**
+   * Maximum size (in bytes) for a record, including its block records
+   */
+  item_byte_size: number;
   /**
    * Available extra packets
    */
@@ -5093,6 +5136,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 +5449,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 +5679,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 +5698,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 +5753,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 +5880,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 +6012,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 +6210,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
    */
@@ -9636,6 +9717,45 @@ export type SsoSettingsUpdateSchema = {
   default_role?: RoleData;
 };
 
+/**
+ * The entity suggests several emojis that are connected to a specific term
+ *
+ * This interface was referenced by `DatoApi`'s JSON-Schema
+ * via the `definition` "emoji_suggestions".
+ */
+export type EmojiSuggestions = {
+  id: EmojiSuggestionsIdentity;
+  type: EmojiSuggestionsType;
+  /**
+   * Emojis connected to a specific term
+   */
+  emojis: string[];
+};
+export type EmojiSuggestionsSelfTargetSchema = EmojiSuggestions;
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type EmojiSuggestionsData = {
+  type: EmojiSuggestionsType;
+  id: EmojiSuggestionsIdentity;
+};
+
+/**
+ * JSON API attributes
+ *
+ * This interface was referenced by `EmojiSuggestions`'s JSON-Schema
+ * via the `definition` "attributes".
+ */
+export type EmojiSuggestionsAttributes = {
+  /**
+   * Emojis connected to a specific term
+   */
+  emojis: string[];
+};
+
 /**
  * Represents the white-label settings of the current DatoCMS project
  *
@@ -10119,6 +10239,37 @@ export type Site = {
    * If enabled, blocks schema changes of primary environment
    */
   force_use_of_sandbox_environments: boolean;
+  /**
+   * Allows setting default parameters for assets served through the CDN
+   */
+  assets_cdn_default_settings: {
+    /**
+     * Allows setting default parameters for optimizing images served by the CDN
+     */
+    image: {
+      /**
+       * Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.
+       */
+      q?: number;
+      /**
+       * The auto parameter helps automating a baseline level of optimization. Specify one or more settings
+       */
+      auto?: ('compress' | 'format' | 'enhance' | 'true' | 'redeye')[];
+      /**
+       * Specifies the color space of the output image
+       */
+      cs?: 'srgb' | 'adobergb1998' | 'tinysrgb' | 'strip';
+    };
+    /**
+     * Allows setting default parameters for optimizing videos served by the CDN
+     */
+    video: {
+      /**
+       * When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code
+       */
+      disable_serving_raw_videos?: boolean;
+    };
+  };
   /**
    * Specifies the theme to use in administrative area
    */
@@ -10210,6 +10361,7 @@ export type SiteActivateImprovedHexManagementTargetSchema = Site;
 export type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = Site;
 export type SiteActivateImprovedGqlVisibilityControlTargetSchema = Site;
 export type SiteActivateImprovedBooleanFieldsTargetSchema = Site;
+export type SiteUpdateAssetsCdnDefaultSettingsTargetSchema = Site;
 /**
  * Meta attributes
  *
@@ -10237,6 +10389,10 @@ export type SiteMeta = {
    * Whether the Improved boolean fields option is active or not
    */
   improved_boolean_fields: boolean;
+  /**
+   * Whether the site has custom upload storage settings
+   */
+  custom_upload_storage_settings?: boolean;
 };
 
 /**
@@ -10309,6 +10465,37 @@ export type SiteAttributes = {
    * If enabled, blocks schema changes of primary environment
    */
   force_use_of_sandbox_environments: boolean;
+  /**
+   * Allows setting default parameters for assets served through the CDN
+   */
+  assets_cdn_default_settings: {
+    /**
+     * Allows setting default parameters for optimizing images served by the CDN
+     */
+    image: {
+      /**
+       * Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.
+       */
+      q?: number;
+      /**
+       * The auto parameter helps automating a baseline level of optimization. Specify one or more settings
+       */
+      auto?: ('compress' | 'format' | 'enhance' | 'true' | 'redeye')[];
+      /**
+       * Specifies the color space of the output image
+       */
+      cs?: 'srgb' | 'adobergb1998' | 'tinysrgb' | 'strip';
+    };
+    /**
+     * Allows setting default parameters for optimizing videos served by the CDN
+     */
+    video: {
+      /**
+       * When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code
+       */
+      disable_serving_raw_videos?: boolean;
+    };
+  };
   /**
    * Specifies the theme to use in administrative area
    */
@@ -10549,6 +10736,49 @@ export type SiteUpdateSchema = {
      * Whether the Improved boolean fields option is active or not
      */
     improved_boolean_fields?: boolean;
+    /**
+     * Whether the site has custom upload storage settings
+     */
+    custom_upload_storage_settings?: boolean;
+  };
+};
+
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `update_assets_cdn_default_settings.schema` link.
+ */
+export type SiteUpdateAssetsCdnDefaultSettingsSchema = {
+  type?: string;
+  /**
+   * Allows setting default parameters for assets served through the CDN
+   */
+  assets_cdn_default_settings: {
+    /**
+     * Allows setting default parameters for optimizing images served by the CDN
+     */
+    image: {
+      /**
+       * Controls the output quality of lossy file formats (jpg, pjpg, webp, avif, or jxr). Valid values are in the range 0 – 100 and the default is 75.
+       */
+      q?: number;
+      /**
+       * The auto parameter helps automating a baseline level of optimization. Specify one or more settings
+       */
+      auto?: ('compress' | 'format' | 'enhance' | 'true' | 'redeye')[];
+      /**
+       * Specifies the color space of the output image
+       */
+      cs?: 'srgb' | 'adobergb1998' | 'tinysrgb' | 'strip';
+    };
+    /**
+     * Allows setting default parameters for optimizing videos served by the CDN
+     */
+    video: {
+      /**
+       * When true, attempting to retrieve raw video files directly instead of their optimized counterparts will result in a HTTP 422 status code
+       */
+      disable_serving_raw_videos?: boolean;
+    };
   };
 };
 

package/src/generated/resources/EmojiSuggestions.ts

@@ -0,0 +1,46 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class EmojiSuggestions extends BaseResource {
+  static readonly TYPE = 'emoji_suggestions' as const;
+
+  /**
+   * Retrieve emoji suggestions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/emoji-suggestions/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  find(queryParams?: SimpleSchemaTypes.EmojiSuggestionsSelfHrefSchema) {
+    return this.rawFind(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EmojiSuggestionsSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve emoji suggestions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/emoji-suggestions/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawFind(
+    queryParams?: SchemaTypes.EmojiSuggestionsSelfHrefSchema,
+  ): Promise<SchemaTypes.EmojiSuggestionsSelfTargetSchema> {
+    return this.client.request<SchemaTypes.EmojiSuggestionsSelfTargetSchema>({
+      method: 'GET',
+      url: '/emoji-suggestions',
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/Site.ts

@@ -275,4 +275,55 @@ export default class Site extends BaseResource {
       },
     );
   }
+
+  /**
+   * Update CDN settings default assets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update_assets_cdn_default_settings
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  updateAssetsCdnDefaultSettings(
+    body: SimpleSchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema,
+  ) {
+    return this.rawUpdateAssetsCdnDefaultSettings(
+      Utils.serializeRequestBody<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema>(
+        body,
+        {
+          type: 'assets-cdn-default-settings',
+          attributes: ['assets_cdn_default_settings'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update CDN settings default assets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update_assets_cdn_default_settings
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawUpdateAssetsCdnDefaultSettings(
+    body: SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsSchema,
+  ): Promise<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema> {
+    return this.client.request<SchemaTypes.SiteUpdateAssetsCdnDefaultSettingsTargetSchema>(
+      {
+        method: 'PUT',
+        url: '/site/assets-cdn-default-settings',
+        body,
+      },
+    );
+  }
 }

package/src/generated/resources/index.ts

@@ -32,6 +32,7 @@ export { default as SiteInvitation } from './SiteInvitation';
 export { default as EditingSession } from './EditingSession';
 export { default as SsoGroup } from './SsoGroup';
 export { default as SsoSettings } from './SsoSettings';
+export { default as EmojiSuggestions } from './EmojiSuggestions';
 export { default as WhiteLabelSettings } from './WhiteLabelSettings';
 export { default as PublicInfo } from './PublicInfo';
 export { default as DailyUsage } from './DailyUsage';