@datocms/cma-client 3.1.5 → 3.1.6

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

@@ -8285,49 +8285,49 @@ export type BuildTrigger = {
  */
 export type BuildTriggerAttributes = {
     /**
-     * Name of the environment
+     * Name of the build trigger
      */
     name: string;
     /**
-     * The deploy adapter
+     * The type of build trigger
      */
-    adapter: string;
+    adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
     /**
-     * Additional configuration for deploy
+     * Additional settings for the build trigger. The value depends on the `adapter`.
      */
     adapter_settings: {
         [k: string]: unknown;
     };
     /**
-     * Timestamp of the last deploy
+     * Timestamp of the last build
      */
     last_build_completed_at: string | null;
     /**
-     * Status of last deploy
+     * Status of last build
      */
     build_status: string;
     /**
-     * Unique token of the webhook
+     * Unique token for the webhook (it's the same token present in `webhook_url`)
      */
     webhook_token?: string;
     /**
-     * Notification webhook URL
+     * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
      */
     webhook_url: string;
     /**
-     * Status of site scraper
+     * Status of Site Search for the frontend
      */
     indexing_status: string;
     /**
-     * Public url of the site
+     * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
      */
     frontend_url: string | null;
     /**
-     * Deploy on scheduled publication
+     * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
      */
     autotrigger_on_scheduled_publications: boolean;
     /**
-     * Enable scraper on the site
+     * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
      */
     indexing_enabled: boolean;
 };
@@ -8354,31 +8354,31 @@ export type BuildTriggerCreateSchema = {
         type: BuildTriggerType;
         attributes: {
             /**
-             * Name of the environment
+             * Name of the build trigger
              */
             name: string;
             /**
-             * Unique token of the webhook
+             * Unique token for the webhook (it's the same token present in `webhook_url`)
              */
             webhook_token?: string;
             /**
-             * The deploy adapter
+             * The type of build trigger
              */
-            adapter: string;
+            adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
             /**
-             * Enable scraper on the site
+             * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
              */
             indexing_enabled: boolean;
             /**
-             * Public url of the site
+             * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
              */
             frontend_url: string | null;
             /**
-             * Deploy on scheduled publication
+             * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
              */
             autotrigger_on_scheduled_publications: boolean;
             /**
-             * Additional configuration for deploy
+             * Additional settings for the build trigger. The value depends on the `adapter`.
              */
             adapter_settings: {
                 [k: string]: unknown;
@@ -8403,27 +8403,27 @@ export type BuildTriggerUpdateSchema = {
         id: BuildTriggerIdentity;
         attributes: {
             /**
-             * Name of the environment
+             * Name of the build trigger
              */
             name?: string;
             /**
-             * The deploy adapter
+             * The type of build trigger
              */
-            adapter?: string;
+            adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
             /**
-             * Enable scraper on the site
+             * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
              */
             indexing_enabled?: boolean;
             /**
-             * Public url of the site
+             * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
              */
             frontend_url?: string | null;
             /**
-             * Deploy on scheduled publication
+             * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
              */
             autotrigger_on_scheduled_publications?: boolean;
             /**
-             * Additional configuration for deploy
+             * Additional settings for the build trigger. The value depends on the `adapter`.
              */
             adapter_settings?: {
                 [k: string]: unknown;

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

@@ -8197,49 +8197,49 @@ export type BuildTrigger = {
     id: BuildTriggerIdentity;
     type: BuildTriggerType;
     /**
-     * Name of the environment
+     * Name of the build trigger
      */
     name: string;
     /**
-     * The deploy adapter
+     * The type of build trigger
      */
-    adapter: string;
+    adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
     /**
-     * Additional configuration for deploy
+     * Additional settings for the build trigger. The value depends on the `adapter`.
      */
     adapter_settings: {
         [k: string]: unknown;
     };
     /**
-     * Timestamp of the last deploy
+     * Timestamp of the last build
      */
     last_build_completed_at: string | null;
     /**
-     * Status of last deploy
+     * Status of last build
      */
     build_status: string;
     /**
-     * Unique token of the webhook
+     * Unique token for the webhook (it's the same token present in `webhook_url`)
      */
     webhook_token?: string;
     /**
-     * Notification webhook URL
+     * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
      */
     webhook_url: string;
     /**
-     * Status of site scraper
+     * Status of Site Search for the frontend
      */
     indexing_status: string;
     /**
-     * Public url of the site
+     * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
      */
     frontend_url: string | null;
     /**
-     * Deploy on scheduled publication
+     * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
      */
     autotrigger_on_scheduled_publications: boolean;
     /**
-     * Enable scraper on the site
+     * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
      */
     indexing_enabled: boolean;
 };
@@ -8255,49 +8255,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
  */
 export type BuildTriggerAttributes = {
     /**
-     * Name of the environment
+     * Name of the build trigger
      */
     name: string;
     /**
-     * The deploy adapter
+     * The type of build trigger
      */
-    adapter: string;
+    adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
     /**
-     * Additional configuration for deploy
+     * Additional settings for the build trigger. The value depends on the `adapter`.
      */
     adapter_settings: {
         [k: string]: unknown;
     };
     /**
-     * Timestamp of the last deploy
+     * Timestamp of the last build
      */
     last_build_completed_at: string | null;
     /**
-     * Status of last deploy
+     * Status of last build
      */
     build_status: string;
     /**
-     * Unique token of the webhook
+     * Unique token for the webhook (it's the same token present in `webhook_url`)
      */
     webhook_token?: string;
     /**
-     * Notification webhook URL
+     * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
      */
     webhook_url: string;
     /**
-     * Status of site scraper
+     * Status of Site Search for the frontend
      */
     indexing_status: string;
     /**
-     * Public url of the site
+     * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
      */
     frontend_url: string | null;
     /**
-     * Deploy on scheduled publication
+     * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
      */
     autotrigger_on_scheduled_publications: boolean;
     /**
-     * Enable scraper on the site
+     * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
      */
     indexing_enabled: boolean;
 };
@@ -8308,31 +8308,31 @@ export type BuildTriggerAttributes = {
 export type BuildTriggerCreateSchema = {
     type?: BuildTriggerType;
     /**
-     * Name of the environment
+     * Name of the build trigger
      */
     name: string;
     /**
-     * Unique token of the webhook
+     * Unique token for the webhook (it's the same token present in `webhook_url`)
      */
     webhook_token?: string;
     /**
-     * The deploy adapter
+     * The type of build trigger
      */
-    adapter: string;
+    adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
     /**
-     * Enable scraper on the site
+     * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
      */
     indexing_enabled: boolean;
     /**
-     * Public url of the site
+     * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
      */
     frontend_url: string | null;
     /**
-     * Deploy on scheduled publication
+     * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
      */
     autotrigger_on_scheduled_publications: boolean;
     /**
-     * Additional configuration for deploy
+     * Additional settings for the build trigger. The value depends on the `adapter`.
      */
     adapter_settings: {
         [k: string]: unknown;
@@ -8346,27 +8346,27 @@ export type BuildTriggerUpdateSchema = {
     id?: BuildTriggerIdentity;
     type?: BuildTriggerType;
     /**
-     * Name of the environment
+     * Name of the build trigger
      */
     name?: string;
     /**
-     * The deploy adapter
+     * The type of build trigger
      */
-    adapter?: string;
+    adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
     /**
-     * Enable scraper on the site
+     * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
      */
     indexing_enabled?: boolean;
     /**
-     * Public url of the site
+     * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
      */
     frontend_url?: string | null;
     /**
-     * Deploy on scheduled publication
+     * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
      */
     autotrigger_on_scheduled_publications?: boolean;
     /**
-     * Additional configuration for deploy
+     * Additional settings for the build trigger. The value depends on the `adapter`.
      */
     adapter_settings?: {
         [k: string]: unknown;

package/dist/types/idUtils.d.ts

@@ -0,0 +1,2 @@
+export declare function isValidId(id: string): boolean;
+export declare function generateId(): string;

package/dist/types/index.d.ts

@@ -1,9 +1,9 @@
-export { ApiError, TimeoutError, LogLevel } from '@datocms/rest-client-utils';
+export { ApiError, LogLevel, TimeoutError } from '@datocms/rest-client-utils';
+export * from './buildBlockRecord';
+export * from './buildClient';
 export { Client } from './generated/Client';
-export * as Resources from './generated/resources';
 export type { ClientConfigOptions } from './generated/Client';
-export * from './buildClient';
-export * from './buildBlockRecord';
-export * from './generateId';
+export * as Resources from './generated/resources';
 export * as SchemaTypes from './generated/SchemaTypes';
 export * as SimpleSchemaTypes from './generated/SimpleSchemaTypes';
+export * from './idUtils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -44,5 +44,5 @@
     "@datocms/dashboard-client": "^3.1.5",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "889c19a9678129b7b8883d0ee5ee0b281faf4568"
+  "gitHead": "50c01cc9c09388be009dc67643222a1af7d7b31e"
 }

package/src/generated/Client.ts

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

package/src/generated/SchemaTypes.ts

@@ -8922,49 +8922,49 @@ export type BuildTrigger = {
  */
 export type BuildTriggerAttributes = {
   /**
-   * Name of the environment
+   * Name of the build trigger
    */
   name: string;
   /**
-   * The deploy adapter
+   * The type of build trigger
    */
-  adapter: string;
+  adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
   /**
-   * Additional configuration for deploy
+   * Additional settings for the build trigger. The value depends on the `adapter`.
    */
   adapter_settings: {
     [k: string]: unknown;
   };
   /**
-   * Timestamp of the last deploy
+   * Timestamp of the last build
    */
   last_build_completed_at: string | null;
   /**
-   * Status of last deploy
+   * Status of last build
    */
   build_status: string;
   /**
-   * Unique token of the webhook
+   * Unique token for the webhook (it's the same token present in `webhook_url`)
    */
   webhook_token?: string;
   /**
-   * Notification webhook URL
+   * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
    */
   webhook_url: string;
   /**
-   * Status of site scraper
+   * Status of Site Search for the frontend
    */
   indexing_status: string;
   /**
-   * Public url of the site
+   * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
    */
   frontend_url: string | null;
   /**
-   * Deploy on scheduled publication
+   * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
    */
   autotrigger_on_scheduled_publications: boolean;
   /**
-   * Enable scraper on the site
+   * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
    */
   indexing_enabled: boolean;
 };
@@ -8994,31 +8994,37 @@ export type BuildTriggerCreateSchema = {
     type: BuildTriggerType;
     attributes: {
       /**
-       * Name of the environment
+       * Name of the build trigger
        */
       name: string;
       /**
-       * Unique token of the webhook
+       * Unique token for the webhook (it's the same token present in `webhook_url`)
        */
       webhook_token?: string;
       /**
-       * The deploy adapter
+       * The type of build trigger
        */
-      adapter: string;
+      adapter:
+        | 'custom'
+        | 'netlify'
+        | 'vercel'
+        | 'circle_ci'
+        | 'gitlab'
+        | 'travis';
       /**
-       * Enable scraper on the site
+       * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
        */
       indexing_enabled: boolean;
       /**
-       * Public url of the site
+       * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
        */
       frontend_url: string | null;
       /**
-       * Deploy on scheduled publication
+       * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
        */
       autotrigger_on_scheduled_publications: boolean;
       /**
-       * Additional configuration for deploy
+       * Additional settings for the build trigger. The value depends on the `adapter`.
        */
       adapter_settings: {
         [k: string]: unknown;
@@ -9045,27 +9051,33 @@ export type BuildTriggerUpdateSchema = {
     id: BuildTriggerIdentity;
     attributes: {
       /**
-       * Name of the environment
+       * Name of the build trigger
        */
       name?: string;
       /**
-       * The deploy adapter
+       * The type of build trigger
        */
-      adapter?: string;
+      adapter?:
+        | 'custom'
+        | 'netlify'
+        | 'vercel'
+        | 'circle_ci'
+        | 'gitlab'
+        | 'travis';
       /**
-       * Enable scraper on the site
+       * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
        */
       indexing_enabled?: boolean;
       /**
-       * Public url of the site
+       * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
        */
       frontend_url?: string | null;
       /**
-       * Deploy on scheduled publication
+       * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
        */
       autotrigger_on_scheduled_publications?: boolean;
       /**
-       * Additional configuration for deploy
+       * Additional settings for the build trigger. The value depends on the `adapter`.
        */
       adapter_settings?: {
         [k: string]: unknown;