@datocms/cma-client 6.3.0 → 6.7.0

package/resources.json

@@ -1074,6 +1074,7 @@
         "comment": "List all models/block models",
         "urlPlaceholders": [],
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeInstancesTargetSchema",
         "name": "list",
@@ -1101,6 +1102,7 @@
           "relType": "ItemTypeData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeSelfTargetSchema",
         "name": "find",
@@ -1183,6 +1185,7 @@
           "relType": "ItemTypeData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeReferencingHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeReferencingTargetSchema",
         "name": "referencing",
@@ -1334,6 +1337,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldInstancesTargetSchema",
         "name": "list",
@@ -1356,6 +1360,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldReferencingHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldReferencingTargetSchema",
         "name": "referencing",
@@ -1378,6 +1383,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldRelatedHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldRelatedTargetSchema",
         "deprecated": "This API call is to be considered private and might change without notice",
@@ -1406,6 +1412,7 @@
           "relType": "FieldData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "FieldSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldSelfTargetSchema",
         "name": "find",
@@ -1563,6 +1570,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldsetInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldsetInstancesTargetSchema",
         "name": "list",
@@ -1590,6 +1598,7 @@
           "relType": "FieldsetData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "FieldsetSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldsetSelfTargetSchema",
         "name": "find",
@@ -2272,7 +2281,7 @@
         "rel": "validate_existing",
         "urlTemplate": "/items/${itemId}/validate",
         "method": "POST",
-        "comment": "Validates an existing record field",
+        "comment": "Validate an existing record",
         "urlPlaceholders": [
           {
             "variableName": "itemId",
@@ -2306,7 +2315,7 @@
         "rel": "validate_new",
         "urlTemplate": "/items/validate",
         "method": "POST",
-        "comment": "Validates a record field",
+        "comment": "Validate a new record",
         "urlPlaceholders": [],
         "requestBodyType": "ItemValidateNewSchema",
         "optionalRequestBody": false,

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.
@@ -2046,6 +2208,13 @@ 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.
@@ -2055,6 +2224,18 @@ 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`.
    */
   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;
+    account?: AccountSparseFieldset;
+    organization?: OrganizationSparseFieldset;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**
@@ -3377,9 +3558,9 @@ export type User = {
    */
   email: string;
   /**
-   * Whether 2-factor authentication is active for this account or not
+   * Whether 2-factor authentication is active for this account or not. It returns `null` if the credentials you are using cannot manage the collaborators of the project.
    */
-  is_2fa_active: boolean;
+  is_2fa_active: boolean | null;
   /**
    * Full name
    */
@@ -3402,7 +3583,7 @@ export type UserDestroyTargetSchema = User;
  */
 export type UserMeta = {
   /**
-   * Date of last reading/interaction
+   * Date of last reading/interaction. It returns `null` if the credentials you are using cannot manage the collaborators of the project.
    */
   last_access: string | null;
 };
@@ -3428,9 +3609,9 @@ export type UserAttributes = {
    */
   email: string;
   /**
-   * Whether 2-factor authentication is active for this account or not
+   * Whether 2-factor authentication is active for this account or not. It returns `null` if the credentials you are using cannot manage the collaborators of the project.
    */
-  is_2fa_active: boolean;
+  is_2fa_active: boolean | null;
   /**
    * Full name
    */
@@ -3476,7 +3657,7 @@ export type SsoUser = {
    */
   username: string;
   /**
-   * Identity provider ID
+   * Identity provider ID. It returns `null` if the credentials you are using cannot manage the SSO users of the project.
    */
   external_id: string | null;
   /**
@@ -3515,7 +3696,7 @@ export type SsoGroupData = {
  */
 export type SsoUserMeta = {
   /**
-   * Date of last reading/interaction
+   * Date of last reading/interaction. It returns `null` if the credentials you are using cannot manage the SSO users of the project.
    */
   last_access: string | null;
 };
@@ -3541,7 +3722,7 @@ export type SsoUserAttributes = {
    */
   username: string;
   /**
-   * Identity provider ID
+   * Identity provider ID. It returns `null` if the credentials you are using cannot manage the SSO users of the project.
    */
   external_id: string | null;
   /**
@@ -3610,9 +3791,10 @@ export type AccessToken = {
    */
   hardcoded_type: null | string;
   /**
-   * When this API token was last used to access the Content Management API
+   * When this API token was last used to access the Content Management API. It returns `null` if the credentials you are using cannot manage the API tokens of the project.
    */
   last_cma_access:
+    | null
     | 'today'
     | 'yesterday'
     | 'this_week'
@@ -3621,9 +3803,10 @@ export type AccessToken = {
     | 'last_month'
     | 'never';
   /**
-   * When this API token was last used to access the Content Delivery API
+   * When this API token was last used to access the Content Delivery API. It returns `null` if the credentials you are using cannot manage the API tokens of the project.
    */
   last_cda_access:
+    | null
     | 'today'
     | 'yesterday'
     | 'this_week'
@@ -3680,9 +3863,10 @@ export type AccessTokenAttributes = {
    */
   hardcoded_type: null | string;
   /**
-   * When this API token was last used to access the Content Management API
+   * When this API token was last used to access the Content Management API. It returns `null` if the credentials you are using cannot manage the API tokens of the project.
    */
   last_cma_access:
+    | null
     | 'today'
     | 'yesterday'
     | 'this_week'
@@ -3691,9 +3875,10 @@ export type AccessTokenAttributes = {
     | 'last_month'
     | 'never';
   /**
-   * When this API token was last used to access the Content Delivery API
+   * When this API token was last used to access the Content Delivery API. It returns `null` if the credentials you are using cannot manage the API tokens of the project.
    */
   last_cda_access:
+    | null
     | 'today'
     | 'yesterday'
     | 'this_week'
@@ -7228,9 +7413,9 @@ 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.
+   * 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.
    */
-  parameters: {
+  parameters: null | {
     [k: string]: unknown;
   };
   /**
@@ -7333,9 +7518,9 @@ 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.
+   * 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.
    */
-  parameters: {
+  parameters: null | {
     [k: string]: unknown;
   };
   /**
@@ -9447,13 +9632,13 @@ export type Webhook = {
    */
   http_basic_user: string | null;
   /**
-   * HTTP Basic Authorization password
+   * HTTP Basic Authorization password. It is `null` when the webhook has no basic auth, or when the credentials you are using cannot manage the webhooks of the project.
    */
   http_basic_password: string | null;
   /**
-   * Additional headers that will be sent
+   * Additional headers that will be sent. It returns `null` if the credentials you are using cannot manage the webhooks of the project.
    */
-  headers: {
+  headers: null | {
     [k: string]: string;
   };
   events: {
@@ -9549,13 +9734,13 @@ export type WebhookAttributes = {
    */
   http_basic_user: string | null;
   /**
-   * HTTP Basic Authorization password
+   * HTTP Basic Authorization password. It is `null` when the webhook has no basic auth, or when the credentials you are using cannot manage the webhooks of the project.
    */
   http_basic_password: string | null;
   /**
-   * Additional headers that will be sent
+   * Additional headers that will be sent. It returns `null` if the credentials you are using cannot manage the webhooks of the project.
    */
-  headers: {
+  headers: null | {
     [k: string]: string;
   };
   events: {
@@ -9676,7 +9861,7 @@ export type WebhookCreateSchema = {
    */
   http_basic_user: string | null;
   /**
-   * HTTP Basic Authorization password
+   * HTTP Basic Authorization password. It is `null` when the webhook has no basic auth, or when the credentials you are using cannot manage the webhooks of the project.
    */
   http_basic_password: string | null;
   /**
@@ -9764,7 +9949,7 @@ export type WebhookUpdateSchema = {
    */
   http_basic_user?: string | null;
   /**
-   * HTTP Basic Authorization password
+   * HTTP Basic Authorization password. It is `null` when the webhook has no basic auth, or when the credentials you are using cannot manage the webhooks of the project.
    */
   http_basic_password?: string | null;
   /**
@@ -9995,9 +10180,9 @@ export type BuildTrigger = {
    */
   adapter: 'custom' | 'netlify' | 'vercel' | 'gitlab';
   /**
-   * Additional settings for the build trigger. The value depends on the `adapter`.
+   * Additional settings for the build trigger. The value depends on the `adapter`. It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  adapter_settings: {
+  adapter_settings: null | {
     [k: string]: unknown;
   };
   /**
@@ -10009,13 +10194,13 @@ export type BuildTrigger = {
    */
   build_status: string;
   /**
-   * Unique token for the webhook (it's the same token present in `webhook_url`)
+   * Unique token for the webhook (it's the same token present in `webhook_url`). It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  webhook_token?: string;
+  webhook_token: null | string;
   /**
-   * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
+   * The URL of the webhook your service has to call when the build completes to report it's status (success or error). It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  webhook_url: string;
+  webhook_url: null | string;
   /**
    * Status of Site Search for the frontend
    */
@@ -10057,9 +10242,9 @@ export type BuildTriggerAttributes = {
    */
   adapter: 'custom' | 'netlify' | 'vercel' | 'gitlab';
   /**
-   * Additional settings for the build trigger. The value depends on the `adapter`.
+   * Additional settings for the build trigger. The value depends on the `adapter`. It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  adapter_settings: {
+  adapter_settings: null | {
     [k: string]: unknown;
   };
   /**
@@ -10071,13 +10256,13 @@ export type BuildTriggerAttributes = {
    */
   build_status: string;
   /**
-   * Unique token for the webhook (it's the same token present in `webhook_url`)
+   * Unique token for the webhook (it's the same token present in `webhook_url`). It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  webhook_token?: string;
+  webhook_token: null | string;
   /**
-   * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
+   * The URL of the webhook your service has to call when the build completes to report it's status (success or error). It returns `null` if the credentials you are using cannot manage the build triggers of the project.
    */
-  webhook_url: string;
+  webhook_url: null | string;
   /**
    * Status of Site Search for the frontend
    */
@@ -11766,7 +11951,7 @@ export type Site = {
    */
   imgix_host: string | null;
   /**
-   * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
+   * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   internal_domain: string | null;
   /**
@@ -11790,11 +11975,11 @@ export type Site = {
    */
   last_data_change_at: null | string;
   /**
-   * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
+   * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   require_2fa: boolean | null;
   /**
-   * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
+   * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   ip_tracking_enabled: boolean | null;
   /**
@@ -12113,7 +12298,7 @@ export type SiteAttributes = {
    */
   imgix_host: string | null;
   /**
-   * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
+   * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   internal_domain: string | null;
   /**
@@ -12137,11 +12322,11 @@ export type SiteAttributes = {
    */
   last_data_change_at: null | string;
   /**
-   * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
+   * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   require_2fa: boolean | null;
   /**
-   * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
+   * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot read the configuration of the project.
    */
   ip_tracking_enabled: boolean | null;
   /**

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.3.0',
+      userAgent: '@datocms/cma-client v6.7.0',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {