@datocms/cma-client 6.4.0 → 6.8.0

package/src/generated/ApiTypes.ts

@@ -297,6 +297,13 @@ export type AccountIdentity = string;
  * via the `definition` "type".
  */
 export type AccountType = 'account';
+/**
+ * Attributes and relationships to return for each `account` that this endpoint returns.
+ *
+ * This interface was referenced by `Account`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type AccountSparseFieldset = string;
 /**
  * ID of organization
  *
@@ -312,6 +319,13 @@ export type OrganizationIdentity = string;
  * via the `definition` "type".
  */
 export type OrganizationType = 'organization';
+/**
+ * Attributes and relationships to return for each `organization` that this endpoint returns.
+ *
+ * This interface was referenced by `Organization`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type OrganizationSparseFieldset = string;
 /**
  * This interface was referenced by `User`'s JSON-Schema
  * via the `me.hrefSchema` link.
@@ -602,6 +616,13 @@ export type FieldsetIdentity = string;
  * via the `definition` "type".
  */
 export type WorkflowType = 'workflow';
+/**
+ * Attributes and relationships to return for each `item_type` that this endpoint returns.
+ *
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemTypeSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `create.hrefSchema` link.
@@ -626,6 +647,42 @@ export type ItemTypeCreateHrefSchema = {
  * via the `instances.targetSchema` link.
  */
 export type ItemTypeInstancesTargetSchema = ItemType[];
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type ItemTypeInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type ItemTypeSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `field` that this endpoint returns.
+ *
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `destroy.hrefSchema` link.
@@ -642,6 +699,20 @@ export type ItemTypeDestroyHrefSchema = {
  * via the `referencing.targetSchema` link.
  */
 export type ItemTypeReferencingTargetSchema = ItemType[];
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type ItemTypeReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `reorder_fields_and_fieldsets.schema` link.
@@ -670,21 +741,112 @@ export type ItemTypeReorderFieldsAndFieldsetsSchema = (
  * via the `instances.targetSchema` link.
  */
 export type FieldInstancesTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `referencing.targetSchema` link.
  */
 export type FieldReferencingTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type FieldReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `related.targetSchema` link.
  */
 export type FieldRelatedTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `related.hrefSchema` link.
+ */
+export type FieldRelatedHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `fieldset` that this endpoint returns.
+ *
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldsetSparseFieldset = string;
 /**
  * This interface was referenced by `Fieldset`'s JSON-Schema
  * via the `instances.targetSchema` link.
  */
 export type FieldsetInstancesTargetSchema = Fieldset[];
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldsetInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldsetSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `reorder_fields_and_fieldsets.jobSchema` link.
@@ -953,6 +1115,13 @@ export type SearchIndexEventInstancesHrefSchema = {
     | 'event_type_desc';
   [k: string]: unknown;
 };
+/**
+ * Attributes and relationships to return for each `item` that this endpoint returns.
+ *
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemSparseFieldset = string;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.targetSchema` link.
@@ -2046,15 +2215,35 @@ export type SiteIdentity = string;
  * via the `definition` "type".
  */
 export type SiteType = 'site';
+/**
+ * Attributes and relationships to return for each `site` that this endpoint returns.
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type SiteSparseFieldset = string;
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
  */
 export type SiteSelfHrefSchema = {
   /**
-   * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
+   * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`, `owner`.
    */
   include?: string;
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    site?: SiteSparseFieldset;
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    fieldset?: FieldsetSparseFieldset;
+    item?: ItemSparseFieldset;
+    account?: AccountSparseFieldset;
+    organization?: OrganizationSparseFieldset;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**
@@ -7232,7 +7421,7 @@ export type Plugin = {
    */
   url: string;
   /**
-   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. It returns `null` if the credentials you are using cannot edit the schema of the project.
+   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns `null`.
    */
   parameters: null | {
     [k: string]: unknown;
@@ -7337,7 +7526,7 @@ export type PluginAttributes = {
    */
   url: string;
   /**
-   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. It returns `null` if the credentials you are using cannot edit the schema of the project.
+   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns `null`.
    */
   parameters: null | {
     [k: string]: unknown;
@@ -7955,6 +8144,12 @@ export type ItemValidateExistingSchema<
     | UserData
     | SsoUserData
     | OrganizationData;
+  /**
+   * Accepted so you can validate the same payload you will send to update the record, but ignored
+   */
+  meta?: {
+    [k: string]: unknown;
+  };
   __itemTypeId?: D['itemTypeId'];
 } & ToItemAttributesInRequest<D>;
 /**
@@ -7964,6 +8159,7 @@ export type ItemValidateExistingSchema<
 export type ItemValidateNewSchema<
   D extends ItemTypeDefinition = ItemTypeDefinition,
 > = {
+  id?: ItemIdentity;
   type?: ItemType1;
   item_type: ItemTypeData<D>;
   creator?:
@@ -7972,6 +8168,12 @@ export type ItemValidateNewSchema<
     | UserData
     | SsoUserData
     | OrganizationData;
+  /**
+   * Accepted so you can validate the same payload you will send to create the record, but ignored
+   */
+  meta?: {
+    [k: string]: unknown;
+  };
   __itemTypeId?: D['itemTypeId'];
 } & ToItemAttributesInRequest<D>;
 /**

package/src/generated/Client.ts

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

package/src/generated/RawApiTypes.ts

@@ -264,6 +264,13 @@ export type AccountType = 'account';
  * via the `definition` "id".
  */
 export type AccountIdentity = string;
+/**
+ * Attributes and relationships to return for each `account` that this endpoint returns.
+ *
+ * This interface was referenced by `Account`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type AccountSparseFieldset = string;
 /**
  * This interface was referenced by `Organization`'s JSON-Schema
  * via the `definition` "type".
@@ -279,6 +286,13 @@ export type OrganizationType = 'organization';
  * via the `definition` "id".
  */
 export type OrganizationIdentity = string;
+/**
+ * Attributes and relationships to return for each `organization` that this endpoint returns.
+ *
+ * This interface was referenced by `Organization`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type OrganizationSparseFieldset = string;
 /**
  * This interface was referenced by `User`'s JSON-Schema
  * via the `me.hrefSchema` link.
@@ -495,6 +509,13 @@ export type FieldsetIdentity = string;
  * via the `definition` "type".
  */
 export type WorkflowType = 'workflow';
+/**
+ * Attributes and relationships to return for each `item_type` that this endpoint returns.
+ *
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemTypeSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `create.hrefSchema` link.
@@ -514,6 +535,42 @@ export type ItemTypeCreateHrefSchema = {
   schema_menu_item_id?: string;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type ItemTypeInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type ItemTypeSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `field` that this endpoint returns.
+ *
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `destroy.hrefSchema` link.
@@ -525,6 +582,111 @@ export type ItemTypeDestroyHrefSchema = {
   skip_menu_items_deletion?: boolean;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type ItemTypeReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type FieldReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `related.hrefSchema` link.
+ */
+export type FieldRelatedHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `fieldset` that this endpoint returns.
+ *
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldsetSparseFieldset = string;
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldsetInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldsetSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Session`'s JSON-Schema
  * via the `definition` "type".
@@ -758,6 +920,13 @@ export type SearchIndexEventInstancesHrefSchema = {
     | 'event_type_desc';
   [k: string]: unknown;
 };
+/**
+ * Attributes and relationships to return for each `item` that this endpoint returns.
+ *
+ * This interface was referenced by `Item`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemSparseFieldset = string;
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.hrefSchema` link.
@@ -1656,15 +1825,35 @@ export type SiteType = 'site';
  * via the `definition` "id".
  */
 export type SiteIdentity = string;
+/**
+ * Attributes and relationships to return for each `site` that this endpoint returns.
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type SiteSparseFieldset = string;
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
  */
 export type SiteSelfHrefSchema = {
   /**
-   * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
+   * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`, `owner`.
    */
   include?: string;
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    site?: SiteSparseFieldset;
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    fieldset?: FieldsetSparseFieldset;
+    item?: ItemSparseFieldset;
+    account?: AccountSparseFieldset;
+    organization?: OrganizationSparseFieldset;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**
@@ -3603,6 +3792,10 @@ export type AuditLogEventQueryTargetSchema = {
      * If the response request exceeds the response payload limit DatoCMS will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results
      */
     next_token: null | string;
+    /**
+     * Events are searched from the most recent backwards. When a next_token is returned, this is the ISO 8601 datetime the search has reached so far: all events that occurred after it have already been examined, and the remaining results are older. Null when the search is complete
+     */
+    scanned_until: null | string;
   };
 };
 /**
@@ -6954,7 +7147,7 @@ export type PluginAttributes = {
    */
   url: string;
   /**
-   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. It returns `null` if the credentials you are using cannot edit the schema of the project.
+   * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns `null`.
    */
   parameters: null | {
     [k: string]: unknown;
@@ -7637,6 +7830,12 @@ export type ItemValidateExistingSchema<
      * The JSON data associated to the record
      */
     attributes: ToItemAttributesInRequest<D>;
+    /**
+     * Accepted so you can validate the same payload you will send to update the record, but ignored
+     */
+    meta?: {
+      [k: string]: unknown;
+    };
     relationships?: {
       /**
        * The record's model
@@ -7668,10 +7867,17 @@ export type ItemValidateNewSchema<
 > = {
   data: {
     type: ItemType1;
+    id?: ItemIdentity;
     /**
      * The JSON data associated to the record
      */
     attributes: ToItemAttributesInRequest<D>;
+    /**
+     * Accepted so you can validate the same payload you will send to create the record, but ignored
+     */
+    meta?: {
+      [k: string]: unknown;
+    };
     relationships: {
       /**
        * The record's model