@datocms/cma-client 6.3.0 → 6.4.0

package/dist/cjs/generated/Client.js

@@ -90,7 +90,7 @@ class Client {
         return this.config.baseUrl || Client.defaultBaseUrl;
     }
     request(options) {
-        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v6.3.0', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
+        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v6.4.0', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
                 ? { 'X-Environment': this.config.environment }
                 : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
                 return this.jobResultsFetcher

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

@@ -3095,9 +3095,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 +3120,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 +3146,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 +3194,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 +3233,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 +3259,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 +3328,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 +3384,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 +6788,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 +6872,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 +8838,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 +8913,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 +8986,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 +9047,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 +9240,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 +9254,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 +9302,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 +9316,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 +10993,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 +11017,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 +11340,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 +11364,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/dist/esm/generated/Client.js

@@ -59,7 +59,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.4.0',
             baseUrl: this.baseUrl,
             preCallStack: new Error().stack,
             extraHeaders: {

package/dist/esm/generated/RawApiTypes.d.ts

@@ -2688,9 +2688,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
      */
@@ -2722,7 +2722,7 @@ export type UserRelationships = {
  */
 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;
 };
@@ -2815,7 +2815,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;
     /**
@@ -2869,7 +2869,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;
 };
@@ -2964,13 +2964,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
@@ -6620,9 +6620,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;
     };
     /**
@@ -9207,13 +9207,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: {
@@ -9292,7 +9292,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;
             /**
@@ -9364,7 +9364,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;
             /**
@@ -9564,9 +9564,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;
     };
     /**
@@ -9578,13 +9578,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
      */
@@ -11425,7 +11425,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;
     /**
@@ -11449,11 +11449,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;
     /**