@datocms/cma-client 1.3.1 → 1.3.3

package/resources.json

@@ -1364,7 +1364,8 @@
           "type": "item",
           "attributes": "*",
           "relationships": [
-            "item_type"
+            "item_type",
+            "creator"
           ]
         },
         "queryParamsRequired": false,
@@ -1384,7 +1385,8 @@
           "type": "item",
           "attributes": "*",
           "relationships": [
-            "item_type"
+            "item_type",
+            "creator"
           ]
         },
         "queryParamsRequired": false,
@@ -3295,8 +3297,35 @@
         "comment": "Activate improved timezone management",
         "queryParamsRequired": false,
         "responseType": "SiteActivateImprovedTimezoneManagementJobSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
         "name": "activateImprovedTimezoneManagement",
         "rawName": "rawActivateImprovedTimezoneManagement"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_hex_management",
+        "rel": "activate_improved_hex_management",
+        "urlTemplate": "/site/activate-improved-hex-management",
+        "method": "PUT",
+        "comment": "Activate improved hex management",
+        "queryParamsRequired": false,
+        "responseType": "SiteActivateImprovedHexManagementTargetSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "name": "activateImprovedHexManagement",
+        "rawName": "rawActivateImprovedHexManagement"
+      },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_gql_multilocale_fields",
+        "rel": "activate_improved_gql_multilocale_fields",
+        "urlTemplate": "/site/activate-improved-gql-multilocale-fields",
+        "method": "PUT",
+        "comment": "Activate improved GraphQL multi-locale fields option",
+        "queryParamsRequired": false,
+        "responseType": "SiteActivateImprovedGqlMultilocaleFieldsTargetSchema",
+        "deprecated": "This API call is to be considered private and might change without notice",
+        "name": "activateImprovedGqlMultilocaleFields",
+        "rawName": "rawActivateImprovedGqlMultilocaleFields"
       }
     ],
     "namespace": "site",

package/src/generated/Client.ts

@@ -133,7 +133,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v1.3.1',
+      userAgent: '@datocms/cma-client v1.3.3',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {

package/src/generated/SchemaTypes.ts

@@ -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;
   };
   /**
@@ -619,7 +623,7 @@ export type ItemSelfHrefSchema = {
  */
 export type ItemBatchDestroyHrefSchema = {
   /**
-   * IDs of records to delete, comma separated
+   * IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -629,7 +633,7 @@ export type ItemBatchDestroyHrefSchema = {
  */
 export type ItemBatchPublishHrefSchema = {
   /**
-   * IDs of records to publish, comma separated
+   * IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -639,7 +643,7 @@ export type ItemBatchPublishHrefSchema = {
  */
 export type ItemBatchUnpublishHrefSchema = {
   /**
-   * IDs of records to unpublish, comma separated
+   * IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -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;
+      };
     };
   };
 };
@@ -6745,7 +6786,7 @@ export type ItemBulkPublishSchema = {
     type: 'item_bulk_publish_operation';
     relationships: {
       /**
-       * Records to publish
+       * Records to publish (a maximum of 200 records are allowed per request)
        */
       items: {
         data: ItemData[];
@@ -6787,7 +6828,7 @@ export type ItemBulkUnpublishSchema = {
     type: 'item_bulk_unpublish_operation';
     relationships: {
       /**
-       * Records to unpublish
+       * Records to unpublish (a maximum of 200 records are allowed per request)
        */
       items: {
         data: ItemData[];
@@ -6829,7 +6870,7 @@ export type ItemBulkDestroySchema = {
     type: 'item_bulk_destroy_operation';
     relationships: {
       /**
-       * Records to delete
+       * Records to delete (a maximum of 200 records are allowed per request)
        */
       items: {
         data: ItemData[];
@@ -6877,7 +6918,7 @@ export type ItemBulkMoveToStageSchema = {
     };
     relationships: {
       /**
-       * Records to move
+       * Records to move (a maximum of 200 records are allowed per request)
        */
       items: {
         data: ItemData[];
@@ -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,14 @@ 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;
+  /**
+   * Whether the Improved GraphQL multi-locale fields option is active or not
+   */
+  improved_gql_multilocale_fields: boolean;
 };
 
 /**
@@ -10330,6 +10383,14 @@ 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;
+      /**
+       * Whether the Improved GraphQL multi-locale fields option is active or not
+       */
+      improved_gql_multilocale_fields?: boolean;
     };
     relationships?: {
       sso_default_role?: {
@@ -10371,6 +10432,22 @@ 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;
+};
+
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `activate_improved_gql_multilocale_fields.targetSchema` link.
+ */
+export type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = {
+  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

@@ -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;
   };
   /**
@@ -724,7 +728,7 @@ export type ItemBatchDestroyJobSchema = unknown[];
  */
 export type ItemBatchDestroyHrefSchema = {
   /**
-   * IDs of records to delete, comma separated
+   * IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -739,7 +743,7 @@ export type ItemBatchPublishJobSchema = unknown[];
  */
 export type ItemBatchPublishHrefSchema = {
   /**
-   * IDs of records to publish, comma separated
+   * IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -754,7 +758,7 @@ export type ItemBatchUnpublishJobSchema = unknown[];
  */
 export type ItemBatchUnpublishHrefSchema = {
   /**
-   * IDs of records to unpublish, comma separated
+   * IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
    */
   'filter[ids]': string;
 };
@@ -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,8 @@ export type Site = {
 export type SiteSelfTargetSchema = Site;
 export type SiteUpdateJobSchema = Site;
 export type SiteActivateImprovedTimezoneManagementJobSchema = Site;
+export type SiteActivateImprovedHexManagementTargetSchema = Site;
+export type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = Site;
 /**
  * Meta attributes
  *
@@ -9885,6 +9930,14 @@ 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;
+  /**
+   * Whether the Improved GraphQL multi-locale fields option is active or not
+   */
+  improved_gql_multilocale_fields: boolean;
 };
 
 /**
@@ -10157,6 +10210,14 @@ 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;
+    /**
+     * Whether the Improved GraphQL multi-locale fields option is active or not
+     */
+    improved_gql_multilocale_fields?: 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

@@ -97,6 +97,8 @@ export default class Site extends BaseResource {
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
    */
   activateImprovedTimezoneManagement() {
     return this.rawActivateImprovedTimezoneManagement().then((body) =>
@@ -113,6 +115,8 @@ export default class Site extends BaseResource {
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
    */
   rawActivateImprovedTimezoneManagement(): Promise<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema> {
     return this.client.request<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>(
@@ -122,4 +126,78 @@ 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}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  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}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawActivateImprovedHexManagement(): Promise<SchemaTypes.SiteActivateImprovedHexManagementTargetSchema> {
+    return this.client.request<SchemaTypes.SiteActivateImprovedHexManagementTargetSchema>(
+      {
+        method: 'PUT',
+        url: '/site/activate-improved-hex-management',
+      },
+    );
+  }
+
+  /**
+   * Activate improved GraphQL multi-locale fields option
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_gql_multilocale_fields
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  activateImprovedGqlMultilocaleFields() {
+    return this.rawActivateImprovedGqlMultilocaleFields().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteActivateImprovedGqlMultilocaleFieldsTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Activate improved GraphQL multi-locale fields option
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_gql_multilocale_fields
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawActivateImprovedGqlMultilocaleFields(): Promise<SchemaTypes.SiteActivateImprovedGqlMultilocaleFieldsTargetSchema> {
+    return this.client.request<SchemaTypes.SiteActivateImprovedGqlMultilocaleFieldsTargetSchema>(
+      {
+        method: 'PUT',
+        url: '/site/activate-improved-gql-multilocale-fields',
+      },
+    );
+  }
 }

package/src/resources/Role.ts

@@ -30,11 +30,11 @@ function sameRule(
   obj1: Record<string, unknown>,
   obj2: Record<string, unknown>,
 ): boolean {
-  for (const key in Object.keys(obj1)) {
+  for (const key in obj1) {
     if (!sameValue(obj1[key], obj2[key])) return false;
   }
 
-  for (const key in Object.keys(obj2)) {
+  for (const key in obj2) {
     if (!sameValue(obj1[key], obj2[key])) return false;
   }