@datocms/cma-client 6.3.0 → 6.7.0

package/dist/types/generated/ApiTypes.d.ts

@@ -248,6 +248,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
  *
@@ -263,6 +270,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.
@@ -553,6 +567,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.
@@ -577,6 +598,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.
@@ -593,6 +650,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.
@@ -618,21 +689,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.
@@ -1904,6 +2066,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.
@@ -1913,6 +2082,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;
 };
 /**
@@ -3095,9 +3276,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
      */
@@ -3120,7 +3301,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;
 };
@@ -3146,9 +3327,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
      */
@@ -3194,7 +3375,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;
     /**
@@ -3233,7 +3414,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;
 };
@@ -3259,7 +3440,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;
     /**
@@ -3328,13 +3509,13 @@ 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: 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
+    last_cma_access: null | 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | '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: 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
+    last_cda_access: null | 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
     role: RoleData | null;
 };
 export type AccessTokenCreateTargetSchema = AccessToken;
@@ -3384,13 +3565,13 @@ 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: 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
+    last_cma_access: null | 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | '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: 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
+    last_cda_access: null | 'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'never';
 };
 /**
  * JSON API links
@@ -6788,9 +6969,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;
     };
     /**
@@ -6872,9 +7053,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;
     };
     /**
@@ -8838,13 +9019,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: {
@@ -8913,13 +9094,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: {
@@ -8986,7 +9167,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;
     /**
@@ -9047,7 +9228,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;
     /**
@@ -9240,9 +9421,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;
     };
     /**
@@ -9254,13 +9435,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
      */
@@ -9302,9 +9483,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;
     };
     /**
@@ -9316,13 +9497,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
      */
@@ -10993,7 +11174,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;
     /**
@@ -11017,11 +11198,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;
     /**
@@ -11340,7 +11521,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;
     /**
@@ -11364,11 +11545,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;
     /**