@datocms/cma-client 1.2.12 → 1.3.2

package/src/generated/SchemaTypes.ts

@@ -382,7 +382,7 @@ export type ItemTypeCreateHrefSchema = {
   /**
    * Skip the creation of a menu item linked to the model
    */
-  skip_menu_item_creation?: string;
+  skip_menu_item_creation?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -410,7 +410,7 @@ export type ItemTypeDestroyHrefSchema = {
   /**
    * Skip the deletion of the menu items linked to the model
    */
-  skip_menu_items_deletion?: string;
+  skip_menu_items_deletion?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -530,7 +530,7 @@ export type ItemInstancesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Attributes to filter records
    */
@@ -553,6 +553,10 @@ export type ItemInstancesHrefSchema = {
     fields?: {
       [k: string]: unknown;
     };
+    /**
+     * When set, only valid records are included in the results.
+     */
+    only_valid?: string;
     [k: string]: unknown;
   };
   /**
@@ -591,7 +595,7 @@ export type ItemReferencesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
    */
-  nested?: 'true';
+  nested?: boolean;
   /**
    * Retrieve only the selected type of version that is linked to the record; current, published or both
    */
@@ -606,7 +610,7 @@ export type ItemSelfHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
    */
@@ -651,7 +655,7 @@ export type ItemPublishHrefSchema = {
   /**
    * If the record references other draft records, force a recursive publication
    */
-  recursive?: string;
+  recursive?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -662,7 +666,7 @@ export type ItemUnpublishHrefSchema = {
   /**
    * If the record is referenced by other published records, unpublish them recursively
    */
-  recursive?: string;
+  recursive?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -690,7 +694,7 @@ export type ItemVersionInstancesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Attributes to manage results pagination
    */
@@ -803,7 +807,7 @@ export type UploadReferencesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Retrieve only the selected type of version that is linked to the upload; current, published or both
    */
@@ -904,7 +908,7 @@ export type SearchResultInstancesHrefSchema = {
     /**
      * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
      */
-    fuzzy?: string;
+    fuzzy?: boolean;
     /**
      * Text to search
      */
@@ -936,13 +940,13 @@ export type EnvironmentForkHrefSchema = {
   /**
    * Whether the call should immediately return a pending environment, or wait for the completion of the fork
    */
-  immediate_return?: string;
+  immediate_return?: boolean;
   /**
    * Performing a fast fork reduces processing time, but it also prevents writing to the source environment during the process
    */
-  fast?: string;
+  fast?: boolean;
   /**
-   * Force the fork, even if there are collaborators editing some records
+   * Force the start of fast fork, even if there are collaborators editing some records
    */
   force?: boolean;
   [k: string]: unknown;
@@ -3274,6 +3278,10 @@ export type SitePlanAttributes = {
    * Maximum number of clients connected at the same time to the Realtime Updates API. The limit is per-project
    */
   concurrent_realtime_connections: number;
+  /**
+   * The maximum GraphQL query complexity a client can perform on our CDA.
+   */
+  gql_complexity: number;
   /**
    * Period (in minutes) in which bursts of changes made to the same record by the same user (or API token) will be grouped into a single one
    */
@@ -4135,7 +4143,7 @@ export type ItemTypeDestroyJobSchema = {
 };
 
 /**
- * DatoCMS offers a number of different fields that you can combine togheter to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
+ * DatoCMS offers a number of different fields that you can combine together to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
  *
  * ### Different field types require different settings
  *
@@ -4732,6 +4740,17 @@ export type ItemTypeDestroyJobSchema = {
  * </details>
  *
  * <details>
+ * <summary><code>sanitization</code></summary>
+ *
+ * Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
+ *
+ * | Parameter                      | Type      | Required | Description                                                  |
+ * | ------------------------------ | --------- | -------- | ------------------------------------------------------------ |
+ * | `sanitize_before_validation`   | `Boolean` | ✅       | Content is actively sanitized before applying the validation |
+ *
+ * </details>
+ *
+ * <details>
  * <summary><code>structured_text_blocks</code></summary>
  *
  * Only accept references to block records of the specified block models.
@@ -6426,6 +6445,17 @@ export type ItemValidateNewSchema = {
       item_type: {
         data: ItemTypeData;
       };
+      /**
+       * The entity (account/collaborator/access token/sso user) who created the record. It must be an object with `type` (e.g. 'account') and `id` properties.
+       */
+      creator?: {
+        data:
+          | AccountData
+          | AccessTokenData
+          | UserData
+          | SsoUserData
+          | OrganizationData;
+      };
     };
   };
 };
@@ -6495,6 +6525,17 @@ export type ItemCreateSchema = {
       item_type: {
         data: ItemTypeData;
       };
+      /**
+       * The entity (account/collaborator/access token/sso user) who created the record. It must be an object with `type` (e.g. 'account') and `id` properties.
+       */
+      creator?: {
+        data:
+          | AccountData
+          | AccessTokenData
+          | UserData
+          | SsoUserData
+          | OrganizationData;
+      };
     };
   };
 };
@@ -7114,6 +7155,10 @@ export type UploadAttributes = {
    * Blurhash for the asset
    */
   blurhash: string | null;
+  /**
+   * Base64 encoded ThumbHash for the asset
+   */
+  thumbhash: string | null;
   /**
    * Public Mux playback ID. Used with stream.mux.com to create the source URL for a video player.
    */
@@ -10192,6 +10237,10 @@ export type SiteMeta = {
    * Whether the Improved API Timezone Management option is active or not
    */
   improved_timezone_management: boolean;
+  /**
+   * Whether the Improved API Hex Management option is active or not
+   */
+  improved_hex_management: boolean;
 };
 
 /**
@@ -10330,6 +10379,10 @@ export type SiteUpdateSchema = {
        * Whether the Improved API Timezone Management option is active or not
        */
       improved_timezone_management?: boolean;
+      /**
+       * Whether the Improved API Hex Management option is active or not
+       */
+      improved_hex_management?: boolean;
     };
     relationships?: {
       sso_default_role?: {
@@ -10371,6 +10424,14 @@ export type SiteActivateImprovedTimezoneManagementJobSchema = {
   data: Site;
 };
 
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `activate_improved_hex_management.targetSchema` link.
+ */
+export type SiteActivateImprovedHexManagementTargetSchema = {
+  data: Site;
+};
+
 /**
  * Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
  *

package/src/generated/SimpleSchemaTypes.ts

@@ -422,7 +422,7 @@ export type ItemTypeCreateHrefSchema = {
   /**
    * Skip the creation of a menu item linked to the model
    */
-  skip_menu_item_creation?: string;
+  skip_menu_item_creation?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -455,7 +455,7 @@ export type ItemTypeDestroyHrefSchema = {
   /**
    * Skip the deletion of the menu items linked to the model
    */
-  skip_menu_items_deletion?: string;
+  skip_menu_items_deletion?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -625,7 +625,7 @@ export type ItemInstancesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Attributes to filter records
    */
@@ -648,6 +648,10 @@ export type ItemInstancesHrefSchema = {
     fields?: {
       [k: string]: unknown;
     };
+    /**
+     * When set, only valid records are included in the results.
+     */
+    only_valid?: string;
     [k: string]: unknown;
   };
   /**
@@ -691,7 +695,7 @@ export type ItemReferencesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
    */
-  nested?: 'true';
+  nested?: boolean;
   /**
    * Retrieve only the selected type of version that is linked to the record; current, published or both
    */
@@ -706,7 +710,7 @@ export type ItemSelfHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
    */
@@ -766,7 +770,7 @@ export type ItemPublishHrefSchema = {
   /**
    * If the record references other draft records, force a recursive publication
    */
-  recursive?: string;
+  recursive?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -777,7 +781,7 @@ export type ItemUnpublishHrefSchema = {
   /**
    * If the record is referenced by other published records, unpublish them recursively
    */
-  recursive?: string;
+  recursive?: boolean;
   [k: string]: unknown;
 };
 /**
@@ -835,7 +839,7 @@ export type ItemVersionInstancesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields. If set, returns full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Attributes to manage results pagination
    */
@@ -968,7 +972,7 @@ export type UploadReferencesHrefSchema = {
   /**
    * For Modular Content fields and Structured Text fields, return full payload for nested blocks instead of IDs
    */
-  nested?: string;
+  nested?: boolean;
   /**
    * Retrieve only the selected type of version that is linked to the upload; current, published or both
    */
@@ -1084,7 +1088,7 @@ export type SearchResultInstancesHrefSchema = {
     /**
      * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
      */
-    fuzzy?: string;
+    fuzzy?: boolean;
     /**
      * Text to search
      */
@@ -1121,13 +1125,13 @@ export type EnvironmentForkHrefSchema = {
   /**
    * Whether the call should immediately return a pending environment, or wait for the completion of the fork
    */
-  immediate_return?: string;
+  immediate_return?: boolean;
   /**
    * Performing a fast fork reduces processing time, but it also prevents writing to the source environment during the process
    */
-  fast?: string;
+  fast?: boolean;
   /**
-   * Force the fork, even if there are collaborators editing some records
+   * Force the start of fast fork, even if there are collaborators editing some records
    */
   force?: boolean;
   [k: string]: unknown;
@@ -3674,6 +3678,10 @@ export type SitePlan = {
    * Maximum number of clients connected at the same time to the Realtime Updates API. The limit is per-project
    */
   concurrent_realtime_connections: number;
+  /**
+   * The maximum GraphQL query complexity a client can perform on our CDA.
+   */
+  gql_complexity: number;
   /**
    * Period (in minutes) in which bursts of changes made to the same record by the same user (or API token) will be grouped into a single one
    */
@@ -3900,6 +3908,10 @@ export type SitePlanAttributes = {
    * Maximum number of clients connected at the same time to the Realtime Updates API. The limit is per-project
    */
   concurrent_realtime_connections: number;
+  /**
+   * The maximum GraphQL query complexity a client can perform on our CDA.
+   */
+  gql_complexity: number;
   /**
    * Period (in minutes) in which bursts of changes made to the same record by the same user (or API token) will be grouped into a single one
    */
@@ -4660,7 +4672,7 @@ export type JobData = {
 };
 
 /**
- * DatoCMS offers a number of different fields that you can combine togheter to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
+ * DatoCMS offers a number of different fields that you can combine together to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
  *
  * ### Different field types require different settings
  *
@@ -5257,6 +5269,17 @@ export type JobData = {
  * </details>
  *
  * <details>
+ * <summary><code>sanitization</code></summary>
+ *
+ * Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
+ *
+ * | Parameter                      | Type      | Required | Description                                                  |
+ * | ------------------------------ | --------- | -------- | ------------------------------------------------------------ |
+ * | `sanitize_before_validation`   | `Boolean` | ✅       | Content is actively sanitized before applying the validation |
+ *
+ * </details>
+ *
+ * <details>
  * <summary><code>structured_text_blocks</code></summary>
  *
  * Only accept references to block records of the specified block models.
@@ -6844,6 +6867,12 @@ export type ItemValidateExistingSchema = {
 export type ItemValidateNewSchema = {
   type?: ItemType1;
   item_type: ItemTypeData;
+  creator?:
+    | AccountData
+    | AccessTokenData
+    | UserData
+    | SsoUserData
+    | OrganizationData;
   [k: string]: unknown;
 };
 
@@ -6854,6 +6883,12 @@ export type ItemValidateNewSchema = {
 export type ItemCreateSchema = {
   type?: ItemType1;
   item_type: ItemTypeData;
+  creator?:
+    | AccountData
+    | AccessTokenData
+    | UserData
+    | SsoUserData
+    | OrganizationData;
   /**
    * Meta information regarding the record
    */
@@ -7184,6 +7219,10 @@ export type Upload = {
    * Blurhash for the asset
    */
   blurhash: string | null;
+  /**
+   * Base64 encoded ThumbHash for the asset
+   */
+  thumbhash: string | null;
   /**
    * Public Mux playback ID. Used with stream.mux.com to create the source URL for a video player.
    */
@@ -7370,6 +7409,10 @@ export type UploadAttributes = {
    * Blurhash for the asset
    */
   blurhash: string | null;
+  /**
+   * Base64 encoded ThumbHash for the asset
+   */
+  thumbhash: string | null;
   /**
    * Public Mux playback ID. Used with stream.mux.com to create the source URL for a video player.
    */
@@ -9874,6 +9917,7 @@ export type Site = {
 export type SiteSelfTargetSchema = Site;
 export type SiteUpdateJobSchema = Site;
 export type SiteActivateImprovedTimezoneManagementJobSchema = Site;
+export type SiteActivateImprovedHexManagementTargetSchema = Site;
 /**
  * Meta attributes
  *
@@ -9885,6 +9929,10 @@ export type SiteMeta = {
    * Whether the Improved API Timezone Management option is active or not
    */
   improved_timezone_management: boolean;
+  /**
+   * Whether the Improved API Hex Management option is active or not
+   */
+  improved_hex_management: boolean;
 };
 
 /**
@@ -10157,6 +10205,10 @@ export type SiteUpdateSchema = {
      * Whether the Improved API Timezone Management option is active or not
      */
     improved_timezone_management?: boolean;
+    /**
+     * Whether the Improved API Hex Management option is active or not
+     */
+    improved_hex_management?: boolean;
   };
 };
 

package/src/generated/resources/Item.ts

@@ -148,7 +148,7 @@ export default class Item extends BaseResource {
       Utils.serializeRequestBody<SchemaTypes.ItemValidateNewSchema>(body, {
         type: 'item',
         attributes: '*',
-        relationships: ['item_type'],
+        relationships: ['item_type', 'creator'],
       }),
     );
   }
@@ -184,7 +184,7 @@ export default class Item extends BaseResource {
       Utils.serializeRequestBody<SchemaTypes.ItemCreateSchema>(body, {
         type: 'item',
         attributes: '*',
-        relationships: ['item_type'],
+        relationships: ['item_type', 'creator'],
       }),
     ).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemCreateTargetSchema>(

package/src/generated/resources/Site.ts

@@ -122,4 +122,37 @@ export default class Site extends BaseResource {
       },
     );
   }
+
+  /**
+   * Activate improved hex management
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_hex_management
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  activateImprovedHexManagement() {
+    return this.rawActivateImprovedHexManagement().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteActivateImprovedHexManagementTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Activate improved hex management
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_hex_management
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawActivateImprovedHexManagement(): Promise<SchemaTypes.SiteActivateImprovedHexManagementTargetSchema> {
+    return this.client.request<SchemaTypes.SiteActivateImprovedHexManagementTargetSchema>(
+      {
+        method: 'PUT',
+        url: '/site/activate-improved-hex-management',
+      },
+    );
+  }
 }