@datocms/cma-client 3.1.7-alpha.0 → 3.1.7-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -129,7 +129,7 @@ var Client = /** @class */ (function () {
129
129
  });
130
130
  Client.prototype.request = function (options) {
131
131
  var _this = this;
132
- return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.7-alpha.0', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
132
+ return (0, rest_client_utils_1.request)(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.7-alpha.1', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
133
133
  ? { 'X-Environment': this.config.environment }
134
134
  : {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
135
135
  return _this.jobResultsFetcher
@@ -103,7 +103,7 @@ var Client = /** @class */ (function () {
103
103
  });
104
104
  Client.prototype.request = function (options) {
105
105
  var _this = this;
106
- return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.7-alpha.0', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
106
+ return request(__assign(__assign(__assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v3.1.7-alpha.1', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: __assign(__assign(__assign({}, (this.config.extraHeaders || {})), (this.config.environment
107
107
  ? { 'X-Environment': this.config.environment }
108
108
  : {})), { 'X-API-Version': '3' }), fetchJobResult: function (jobId) {
109
109
  return _this.jobResultsFetcher
@@ -8285,49 +8285,49 @@ export type BuildTrigger = {
8285
8285
  */
8286
8286
  export type BuildTriggerAttributes = {
8287
8287
  /**
8288
- * Name of the environment
8288
+ * Name of the build trigger
8289
8289
  */
8290
8290
  name: string;
8291
8291
  /**
8292
- * The deploy adapter
8292
+ * The type of build trigger
8293
8293
  */
8294
- adapter: string;
8294
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8295
8295
  /**
8296
- * Additional configuration for deploy
8296
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8297
8297
  */
8298
8298
  adapter_settings: {
8299
8299
  [k: string]: unknown;
8300
8300
  };
8301
8301
  /**
8302
- * Timestamp of the last deploy
8302
+ * Timestamp of the last build
8303
8303
  */
8304
8304
  last_build_completed_at: string | null;
8305
8305
  /**
8306
- * Status of last deploy
8306
+ * Status of last build
8307
8307
  */
8308
8308
  build_status: string;
8309
8309
  /**
8310
- * Unique token of the webhook
8310
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8311
8311
  */
8312
8312
  webhook_token?: string;
8313
8313
  /**
8314
- * Notification webhook URL
8314
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8315
8315
  */
8316
8316
  webhook_url: string;
8317
8317
  /**
8318
- * Status of site scraper
8318
+ * Status of Site Search for the frontend
8319
8319
  */
8320
8320
  indexing_status: string;
8321
8321
  /**
8322
- * Public url of the site
8322
+ * 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
8323
8323
  */
8324
8324
  frontend_url: string | null;
8325
8325
  /**
8326
- * Deploy on scheduled publication
8326
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8327
8327
  */
8328
8328
  autotrigger_on_scheduled_publications: boolean;
8329
8329
  /**
8330
- * Enable scraper on the site
8330
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8331
8331
  */
8332
8332
  indexing_enabled: boolean;
8333
8333
  };
@@ -8354,31 +8354,31 @@ export type BuildTriggerCreateSchema = {
8354
8354
  type: BuildTriggerType;
8355
8355
  attributes: {
8356
8356
  /**
8357
- * Name of the environment
8357
+ * Name of the build trigger
8358
8358
  */
8359
8359
  name: string;
8360
8360
  /**
8361
- * Unique token of the webhook
8361
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8362
8362
  */
8363
8363
  webhook_token?: string;
8364
8364
  /**
8365
- * The deploy adapter
8365
+ * The type of build trigger
8366
8366
  */
8367
- adapter: string;
8367
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8368
8368
  /**
8369
- * Enable scraper on the site
8369
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8370
8370
  */
8371
8371
  indexing_enabled: boolean;
8372
8372
  /**
8373
- * Public url of the site
8373
+ * 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
8374
8374
  */
8375
8375
  frontend_url: string | null;
8376
8376
  /**
8377
- * Deploy on scheduled publication
8377
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8378
8378
  */
8379
8379
  autotrigger_on_scheduled_publications: boolean;
8380
8380
  /**
8381
- * Additional configuration for deploy
8381
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8382
8382
  */
8383
8383
  adapter_settings: {
8384
8384
  [k: string]: unknown;
@@ -8403,27 +8403,27 @@ export type BuildTriggerUpdateSchema = {
8403
8403
  id: BuildTriggerIdentity;
8404
8404
  attributes: {
8405
8405
  /**
8406
- * Name of the environment
8406
+ * Name of the build trigger
8407
8407
  */
8408
8408
  name?: string;
8409
8409
  /**
8410
- * The deploy adapter
8410
+ * The type of build trigger
8411
8411
  */
8412
- adapter?: string;
8412
+ adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8413
8413
  /**
8414
- * Enable scraper on the site
8414
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8415
8415
  */
8416
8416
  indexing_enabled?: boolean;
8417
8417
  /**
8418
- * Public url of the site
8418
+ * 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
8419
8419
  */
8420
8420
  frontend_url?: string | null;
8421
8421
  /**
8422
- * Deploy on scheduled publication
8422
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8423
8423
  */
8424
8424
  autotrigger_on_scheduled_publications?: boolean;
8425
8425
  /**
8426
- * Additional configuration for deploy
8426
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8427
8427
  */
8428
8428
  adapter_settings?: {
8429
8429
  [k: string]: unknown;
@@ -8197,49 +8197,49 @@ export type BuildTrigger = {
8197
8197
  id: BuildTriggerIdentity;
8198
8198
  type: BuildTriggerType;
8199
8199
  /**
8200
- * Name of the environment
8200
+ * Name of the build trigger
8201
8201
  */
8202
8202
  name: string;
8203
8203
  /**
8204
- * The deploy adapter
8204
+ * The type of build trigger
8205
8205
  */
8206
- adapter: string;
8206
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8207
8207
  /**
8208
- * Additional configuration for deploy
8208
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8209
8209
  */
8210
8210
  adapter_settings: {
8211
8211
  [k: string]: unknown;
8212
8212
  };
8213
8213
  /**
8214
- * Timestamp of the last deploy
8214
+ * Timestamp of the last build
8215
8215
  */
8216
8216
  last_build_completed_at: string | null;
8217
8217
  /**
8218
- * Status of last deploy
8218
+ * Status of last build
8219
8219
  */
8220
8220
  build_status: string;
8221
8221
  /**
8222
- * Unique token of the webhook
8222
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8223
8223
  */
8224
8224
  webhook_token?: string;
8225
8225
  /**
8226
- * Notification webhook URL
8226
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8227
8227
  */
8228
8228
  webhook_url: string;
8229
8229
  /**
8230
- * Status of site scraper
8230
+ * Status of Site Search for the frontend
8231
8231
  */
8232
8232
  indexing_status: string;
8233
8233
  /**
8234
- * Public url of the site
8234
+ * 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
8235
8235
  */
8236
8236
  frontend_url: string | null;
8237
8237
  /**
8238
- * Deploy on scheduled publication
8238
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8239
8239
  */
8240
8240
  autotrigger_on_scheduled_publications: boolean;
8241
8241
  /**
8242
- * Enable scraper on the site
8242
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8243
8243
  */
8244
8244
  indexing_enabled: boolean;
8245
8245
  };
@@ -8255,49 +8255,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
8255
8255
  */
8256
8256
  export type BuildTriggerAttributes = {
8257
8257
  /**
8258
- * Name of the environment
8258
+ * Name of the build trigger
8259
8259
  */
8260
8260
  name: string;
8261
8261
  /**
8262
- * The deploy adapter
8262
+ * The type of build trigger
8263
8263
  */
8264
- adapter: string;
8264
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8265
8265
  /**
8266
- * Additional configuration for deploy
8266
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8267
8267
  */
8268
8268
  adapter_settings: {
8269
8269
  [k: string]: unknown;
8270
8270
  };
8271
8271
  /**
8272
- * Timestamp of the last deploy
8272
+ * Timestamp of the last build
8273
8273
  */
8274
8274
  last_build_completed_at: string | null;
8275
8275
  /**
8276
- * Status of last deploy
8276
+ * Status of last build
8277
8277
  */
8278
8278
  build_status: string;
8279
8279
  /**
8280
- * Unique token of the webhook
8280
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8281
8281
  */
8282
8282
  webhook_token?: string;
8283
8283
  /**
8284
- * Notification webhook URL
8284
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8285
8285
  */
8286
8286
  webhook_url: string;
8287
8287
  /**
8288
- * Status of site scraper
8288
+ * Status of Site Search for the frontend
8289
8289
  */
8290
8290
  indexing_status: string;
8291
8291
  /**
8292
- * Public url of the site
8292
+ * 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
8293
8293
  */
8294
8294
  frontend_url: string | null;
8295
8295
  /**
8296
- * Deploy on scheduled publication
8296
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8297
8297
  */
8298
8298
  autotrigger_on_scheduled_publications: boolean;
8299
8299
  /**
8300
- * Enable scraper on the site
8300
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8301
8301
  */
8302
8302
  indexing_enabled: boolean;
8303
8303
  };
@@ -8308,31 +8308,31 @@ export type BuildTriggerAttributes = {
8308
8308
  export type BuildTriggerCreateSchema = {
8309
8309
  type?: BuildTriggerType;
8310
8310
  /**
8311
- * Name of the environment
8311
+ * Name of the build trigger
8312
8312
  */
8313
8313
  name: string;
8314
8314
  /**
8315
- * Unique token of the webhook
8315
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8316
8316
  */
8317
8317
  webhook_token?: string;
8318
8318
  /**
8319
- * The deploy adapter
8319
+ * The type of build trigger
8320
8320
  */
8321
- adapter: string;
8321
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8322
8322
  /**
8323
- * Enable scraper on the site
8323
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8324
8324
  */
8325
8325
  indexing_enabled: boolean;
8326
8326
  /**
8327
- * Public url of the site
8327
+ * 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
8328
8328
  */
8329
8329
  frontend_url: string | null;
8330
8330
  /**
8331
- * Deploy on scheduled publication
8331
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8332
8332
  */
8333
8333
  autotrigger_on_scheduled_publications: boolean;
8334
8334
  /**
8335
- * Additional configuration for deploy
8335
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8336
8336
  */
8337
8337
  adapter_settings: {
8338
8338
  [k: string]: unknown;
@@ -8346,27 +8346,27 @@ export type BuildTriggerUpdateSchema = {
8346
8346
  id?: BuildTriggerIdentity;
8347
8347
  type?: BuildTriggerType;
8348
8348
  /**
8349
- * Name of the environment
8349
+ * Name of the build trigger
8350
8350
  */
8351
8351
  name?: string;
8352
8352
  /**
8353
- * The deploy adapter
8353
+ * The type of build trigger
8354
8354
  */
8355
- adapter?: string;
8355
+ adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8356
8356
  /**
8357
- * Enable scraper on the site
8357
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8358
8358
  */
8359
8359
  indexing_enabled?: boolean;
8360
8360
  /**
8361
- * Public url of the site
8361
+ * 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
8362
8362
  */
8363
8363
  frontend_url?: string | null;
8364
8364
  /**
8365
- * Deploy on scheduled publication
8365
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8366
8366
  */
8367
8367
  autotrigger_on_scheduled_publications?: boolean;
8368
8368
  /**
8369
- * Additional configuration for deploy
8369
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8370
8370
  */
8371
8371
  adapter_settings?: {
8372
8372
  [k: string]: unknown;
@@ -8285,49 +8285,49 @@ export type BuildTrigger = {
8285
8285
  */
8286
8286
  export type BuildTriggerAttributes = {
8287
8287
  /**
8288
- * Name of the environment
8288
+ * Name of the build trigger
8289
8289
  */
8290
8290
  name: string;
8291
8291
  /**
8292
- * The deploy adapter
8292
+ * The type of build trigger
8293
8293
  */
8294
- adapter: string;
8294
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8295
8295
  /**
8296
- * Additional configuration for deploy
8296
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8297
8297
  */
8298
8298
  adapter_settings: {
8299
8299
  [k: string]: unknown;
8300
8300
  };
8301
8301
  /**
8302
- * Timestamp of the last deploy
8302
+ * Timestamp of the last build
8303
8303
  */
8304
8304
  last_build_completed_at: string | null;
8305
8305
  /**
8306
- * Status of last deploy
8306
+ * Status of last build
8307
8307
  */
8308
8308
  build_status: string;
8309
8309
  /**
8310
- * Unique token of the webhook
8310
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8311
8311
  */
8312
8312
  webhook_token?: string;
8313
8313
  /**
8314
- * Notification webhook URL
8314
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8315
8315
  */
8316
8316
  webhook_url: string;
8317
8317
  /**
8318
- * Status of site scraper
8318
+ * Status of Site Search for the frontend
8319
8319
  */
8320
8320
  indexing_status: string;
8321
8321
  /**
8322
- * Public url of the site
8322
+ * 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
8323
8323
  */
8324
8324
  frontend_url: string | null;
8325
8325
  /**
8326
- * Deploy on scheduled publication
8326
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8327
8327
  */
8328
8328
  autotrigger_on_scheduled_publications: boolean;
8329
8329
  /**
8330
- * Enable scraper on the site
8330
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8331
8331
  */
8332
8332
  indexing_enabled: boolean;
8333
8333
  };
@@ -8354,31 +8354,31 @@ export type BuildTriggerCreateSchema = {
8354
8354
  type: BuildTriggerType;
8355
8355
  attributes: {
8356
8356
  /**
8357
- * Name of the environment
8357
+ * Name of the build trigger
8358
8358
  */
8359
8359
  name: string;
8360
8360
  /**
8361
- * Unique token of the webhook
8361
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8362
8362
  */
8363
8363
  webhook_token?: string;
8364
8364
  /**
8365
- * The deploy adapter
8365
+ * The type of build trigger
8366
8366
  */
8367
- adapter: string;
8367
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8368
8368
  /**
8369
- * Enable scraper on the site
8369
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8370
8370
  */
8371
8371
  indexing_enabled: boolean;
8372
8372
  /**
8373
- * Public url of the site
8373
+ * 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
8374
8374
  */
8375
8375
  frontend_url: string | null;
8376
8376
  /**
8377
- * Deploy on scheduled publication
8377
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8378
8378
  */
8379
8379
  autotrigger_on_scheduled_publications: boolean;
8380
8380
  /**
8381
- * Additional configuration for deploy
8381
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8382
8382
  */
8383
8383
  adapter_settings: {
8384
8384
  [k: string]: unknown;
@@ -8403,27 +8403,27 @@ export type BuildTriggerUpdateSchema = {
8403
8403
  id: BuildTriggerIdentity;
8404
8404
  attributes: {
8405
8405
  /**
8406
- * Name of the environment
8406
+ * Name of the build trigger
8407
8407
  */
8408
8408
  name?: string;
8409
8409
  /**
8410
- * The deploy adapter
8410
+ * The type of build trigger
8411
8411
  */
8412
- adapter?: string;
8412
+ adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8413
8413
  /**
8414
- * Enable scraper on the site
8414
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8415
8415
  */
8416
8416
  indexing_enabled?: boolean;
8417
8417
  /**
8418
- * Public url of the site
8418
+ * 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
8419
8419
  */
8420
8420
  frontend_url?: string | null;
8421
8421
  /**
8422
- * Deploy on scheduled publication
8422
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8423
8423
  */
8424
8424
  autotrigger_on_scheduled_publications?: boolean;
8425
8425
  /**
8426
- * Additional configuration for deploy
8426
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8427
8427
  */
8428
8428
  adapter_settings?: {
8429
8429
  [k: string]: unknown;
@@ -8197,49 +8197,49 @@ export type BuildTrigger = {
8197
8197
  id: BuildTriggerIdentity;
8198
8198
  type: BuildTriggerType;
8199
8199
  /**
8200
- * Name of the environment
8200
+ * Name of the build trigger
8201
8201
  */
8202
8202
  name: string;
8203
8203
  /**
8204
- * The deploy adapter
8204
+ * The type of build trigger
8205
8205
  */
8206
- adapter: string;
8206
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8207
8207
  /**
8208
- * Additional configuration for deploy
8208
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8209
8209
  */
8210
8210
  adapter_settings: {
8211
8211
  [k: string]: unknown;
8212
8212
  };
8213
8213
  /**
8214
- * Timestamp of the last deploy
8214
+ * Timestamp of the last build
8215
8215
  */
8216
8216
  last_build_completed_at: string | null;
8217
8217
  /**
8218
- * Status of last deploy
8218
+ * Status of last build
8219
8219
  */
8220
8220
  build_status: string;
8221
8221
  /**
8222
- * Unique token of the webhook
8222
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8223
8223
  */
8224
8224
  webhook_token?: string;
8225
8225
  /**
8226
- * Notification webhook URL
8226
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8227
8227
  */
8228
8228
  webhook_url: string;
8229
8229
  /**
8230
- * Status of site scraper
8230
+ * Status of Site Search for the frontend
8231
8231
  */
8232
8232
  indexing_status: string;
8233
8233
  /**
8234
- * Public url of the site
8234
+ * 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
8235
8235
  */
8236
8236
  frontend_url: string | null;
8237
8237
  /**
8238
- * Deploy on scheduled publication
8238
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8239
8239
  */
8240
8240
  autotrigger_on_scheduled_publications: boolean;
8241
8241
  /**
8242
- * Enable scraper on the site
8242
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8243
8243
  */
8244
8244
  indexing_enabled: boolean;
8245
8245
  };
@@ -8255,49 +8255,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
8255
8255
  */
8256
8256
  export type BuildTriggerAttributes = {
8257
8257
  /**
8258
- * Name of the environment
8258
+ * Name of the build trigger
8259
8259
  */
8260
8260
  name: string;
8261
8261
  /**
8262
- * The deploy adapter
8262
+ * The type of build trigger
8263
8263
  */
8264
- adapter: string;
8264
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8265
8265
  /**
8266
- * Additional configuration for deploy
8266
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8267
8267
  */
8268
8268
  adapter_settings: {
8269
8269
  [k: string]: unknown;
8270
8270
  };
8271
8271
  /**
8272
- * Timestamp of the last deploy
8272
+ * Timestamp of the last build
8273
8273
  */
8274
8274
  last_build_completed_at: string | null;
8275
8275
  /**
8276
- * Status of last deploy
8276
+ * Status of last build
8277
8277
  */
8278
8278
  build_status: string;
8279
8279
  /**
8280
- * Unique token of the webhook
8280
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8281
8281
  */
8282
8282
  webhook_token?: string;
8283
8283
  /**
8284
- * Notification webhook URL
8284
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8285
8285
  */
8286
8286
  webhook_url: string;
8287
8287
  /**
8288
- * Status of site scraper
8288
+ * Status of Site Search for the frontend
8289
8289
  */
8290
8290
  indexing_status: string;
8291
8291
  /**
8292
- * Public url of the site
8292
+ * 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
8293
8293
  */
8294
8294
  frontend_url: string | null;
8295
8295
  /**
8296
- * Deploy on scheduled publication
8296
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8297
8297
  */
8298
8298
  autotrigger_on_scheduled_publications: boolean;
8299
8299
  /**
8300
- * Enable scraper on the site
8300
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8301
8301
  */
8302
8302
  indexing_enabled: boolean;
8303
8303
  };
@@ -8308,31 +8308,31 @@ export type BuildTriggerAttributes = {
8308
8308
  export type BuildTriggerCreateSchema = {
8309
8309
  type?: BuildTriggerType;
8310
8310
  /**
8311
- * Name of the environment
8311
+ * Name of the build trigger
8312
8312
  */
8313
8313
  name: string;
8314
8314
  /**
8315
- * Unique token of the webhook
8315
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8316
8316
  */
8317
8317
  webhook_token?: string;
8318
8318
  /**
8319
- * The deploy adapter
8319
+ * The type of build trigger
8320
8320
  */
8321
- adapter: string;
8321
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8322
8322
  /**
8323
- * Enable scraper on the site
8323
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8324
8324
  */
8325
8325
  indexing_enabled: boolean;
8326
8326
  /**
8327
- * Public url of the site
8327
+ * 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
8328
8328
  */
8329
8329
  frontend_url: string | null;
8330
8330
  /**
8331
- * Deploy on scheduled publication
8331
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8332
8332
  */
8333
8333
  autotrigger_on_scheduled_publications: boolean;
8334
8334
  /**
8335
- * Additional configuration for deploy
8335
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8336
8336
  */
8337
8337
  adapter_settings: {
8338
8338
  [k: string]: unknown;
@@ -8346,27 +8346,27 @@ export type BuildTriggerUpdateSchema = {
8346
8346
  id?: BuildTriggerIdentity;
8347
8347
  type?: BuildTriggerType;
8348
8348
  /**
8349
- * Name of the environment
8349
+ * Name of the build trigger
8350
8350
  */
8351
8351
  name?: string;
8352
8352
  /**
8353
- * The deploy adapter
8353
+ * The type of build trigger
8354
8354
  */
8355
- adapter?: string;
8355
+ adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8356
8356
  /**
8357
- * Enable scraper on the site
8357
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8358
8358
  */
8359
8359
  indexing_enabled?: boolean;
8360
8360
  /**
8361
- * Public url of the site
8361
+ * 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
8362
8362
  */
8363
8363
  frontend_url?: string | null;
8364
8364
  /**
8365
- * Deploy on scheduled publication
8365
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8366
8366
  */
8367
8367
  autotrigger_on_scheduled_publications?: boolean;
8368
8368
  /**
8369
- * Additional configuration for deploy
8369
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8370
8370
  */
8371
8371
  adapter_settings?: {
8372
8372
  [k: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datocms/cma-client",
3
- "version": "3.1.7-alpha.0",
3
+ "version": "3.1.7-alpha.1",
4
4
  "description": "JS client for DatoCMS REST Content Management API",
5
5
  "keywords": [
6
6
  "datocms",
@@ -41,8 +41,8 @@
41
41
  "uuid": "^9.0.1"
42
42
  },
43
43
  "devDependencies": {
44
- "@datocms/dashboard-client": "^3.1.7-alpha.0",
44
+ "@datocms/dashboard-client": "^3.1.7-alpha.1",
45
45
  "@types/uuid": "^9.0.7"
46
46
  },
47
- "gitHead": "424ca1286e80cf36a527964ced60de0069784d75"
47
+ "gitHead": "dbdf058508daf88d1fa324124f033fc50fc22517"
48
48
  }
@@ -139,7 +139,7 @@ export class Client {
139
139
  ...this.config,
140
140
  ...options,
141
141
  logFn: this.config.logFn || console.log,
142
- userAgent: '@datocms/cma-client v3.1.7-alpha.0',
142
+ userAgent: '@datocms/cma-client v3.1.7-alpha.1',
143
143
  baseUrl: this.baseUrl,
144
144
  preCallStack: new Error().stack,
145
145
  extraHeaders: {
@@ -8922,49 +8922,49 @@ export type BuildTrigger = {
8922
8922
  */
8923
8923
  export type BuildTriggerAttributes = {
8924
8924
  /**
8925
- * Name of the environment
8925
+ * Name of the build trigger
8926
8926
  */
8927
8927
  name: string;
8928
8928
  /**
8929
- * The deploy adapter
8929
+ * The type of build trigger
8930
8930
  */
8931
- adapter: string;
8931
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8932
8932
  /**
8933
- * Additional configuration for deploy
8933
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8934
8934
  */
8935
8935
  adapter_settings: {
8936
8936
  [k: string]: unknown;
8937
8937
  };
8938
8938
  /**
8939
- * Timestamp of the last deploy
8939
+ * Timestamp of the last build
8940
8940
  */
8941
8941
  last_build_completed_at: string | null;
8942
8942
  /**
8943
- * Status of last deploy
8943
+ * Status of last build
8944
8944
  */
8945
8945
  build_status: string;
8946
8946
  /**
8947
- * Unique token of the webhook
8947
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8948
8948
  */
8949
8949
  webhook_token?: string;
8950
8950
  /**
8951
- * Notification webhook URL
8951
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8952
8952
  */
8953
8953
  webhook_url: string;
8954
8954
  /**
8955
- * Status of site scraper
8955
+ * Status of Site Search for the frontend
8956
8956
  */
8957
8957
  indexing_status: string;
8958
8958
  /**
8959
- * Public url of the site
8959
+ * 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
8960
8960
  */
8961
8961
  frontend_url: string | null;
8962
8962
  /**
8963
- * Deploy on scheduled publication
8963
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8964
8964
  */
8965
8965
  autotrigger_on_scheduled_publications: boolean;
8966
8966
  /**
8967
- * Enable scraper on the site
8967
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8968
8968
  */
8969
8969
  indexing_enabled: boolean;
8970
8970
  };
@@ -8994,31 +8994,37 @@ export type BuildTriggerCreateSchema = {
8994
8994
  type: BuildTriggerType;
8995
8995
  attributes: {
8996
8996
  /**
8997
- * Name of the environment
8997
+ * Name of the build trigger
8998
8998
  */
8999
8999
  name: string;
9000
9000
  /**
9001
- * Unique token of the webhook
9001
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
9002
9002
  */
9003
9003
  webhook_token?: string;
9004
9004
  /**
9005
- * The deploy adapter
9005
+ * The type of build trigger
9006
9006
  */
9007
- adapter: string;
9007
+ adapter:
9008
+ | 'custom'
9009
+ | 'netlify'
9010
+ | 'vercel'
9011
+ | 'circle_ci'
9012
+ | 'gitlab'
9013
+ | 'travis';
9008
9014
  /**
9009
- * Enable scraper on the site
9015
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9010
9016
  */
9011
9017
  indexing_enabled: boolean;
9012
9018
  /**
9013
- * Public url of the site
9019
+ * 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
9014
9020
  */
9015
9021
  frontend_url: string | null;
9016
9022
  /**
9017
- * Deploy on scheduled publication
9023
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
9018
9024
  */
9019
9025
  autotrigger_on_scheduled_publications: boolean;
9020
9026
  /**
9021
- * Additional configuration for deploy
9027
+ * Additional settings for the build trigger. The value depends on the `adapter`.
9022
9028
  */
9023
9029
  adapter_settings: {
9024
9030
  [k: string]: unknown;
@@ -9045,27 +9051,33 @@ export type BuildTriggerUpdateSchema = {
9045
9051
  id: BuildTriggerIdentity;
9046
9052
  attributes: {
9047
9053
  /**
9048
- * Name of the environment
9054
+ * Name of the build trigger
9049
9055
  */
9050
9056
  name?: string;
9051
9057
  /**
9052
- * The deploy adapter
9058
+ * The type of build trigger
9053
9059
  */
9054
- adapter?: string;
9060
+ adapter?:
9061
+ | 'custom'
9062
+ | 'netlify'
9063
+ | 'vercel'
9064
+ | 'circle_ci'
9065
+ | 'gitlab'
9066
+ | 'travis';
9055
9067
  /**
9056
- * Enable scraper on the site
9068
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9057
9069
  */
9058
9070
  indexing_enabled?: boolean;
9059
9071
  /**
9060
- * Public url of the site
9072
+ * 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
9061
9073
  */
9062
9074
  frontend_url?: string | null;
9063
9075
  /**
9064
- * Deploy on scheduled publication
9076
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
9065
9077
  */
9066
9078
  autotrigger_on_scheduled_publications?: boolean;
9067
9079
  /**
9068
- * Additional configuration for deploy
9080
+ * Additional settings for the build trigger. The value depends on the `adapter`.
9069
9081
  */
9070
9082
  adapter_settings?: {
9071
9083
  [k: string]: unknown;
@@ -8787,49 +8787,49 @@ export type BuildTrigger = {
8787
8787
  id: BuildTriggerIdentity;
8788
8788
  type: BuildTriggerType;
8789
8789
  /**
8790
- * Name of the environment
8790
+ * Name of the build trigger
8791
8791
  */
8792
8792
  name: string;
8793
8793
  /**
8794
- * The deploy adapter
8794
+ * The type of build trigger
8795
8795
  */
8796
- adapter: string;
8796
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8797
8797
  /**
8798
- * Additional configuration for deploy
8798
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8799
8799
  */
8800
8800
  adapter_settings: {
8801
8801
  [k: string]: unknown;
8802
8802
  };
8803
8803
  /**
8804
- * Timestamp of the last deploy
8804
+ * Timestamp of the last build
8805
8805
  */
8806
8806
  last_build_completed_at: string | null;
8807
8807
  /**
8808
- * Status of last deploy
8808
+ * Status of last build
8809
8809
  */
8810
8810
  build_status: string;
8811
8811
  /**
8812
- * Unique token of the webhook
8812
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8813
8813
  */
8814
8814
  webhook_token?: string;
8815
8815
  /**
8816
- * Notification webhook URL
8816
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8817
8817
  */
8818
8818
  webhook_url: string;
8819
8819
  /**
8820
- * Status of site scraper
8820
+ * Status of Site Search for the frontend
8821
8821
  */
8822
8822
  indexing_status: string;
8823
8823
  /**
8824
- * Public url of the site
8824
+ * 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
8825
8825
  */
8826
8826
  frontend_url: string | null;
8827
8827
  /**
8828
- * Deploy on scheduled publication
8828
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8829
8829
  */
8830
8830
  autotrigger_on_scheduled_publications: boolean;
8831
8831
  /**
8832
- * Enable scraper on the site
8832
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8833
8833
  */
8834
8834
  indexing_enabled: boolean;
8835
8835
  };
@@ -8845,49 +8845,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
8845
8845
  */
8846
8846
  export type BuildTriggerAttributes = {
8847
8847
  /**
8848
- * Name of the environment
8848
+ * Name of the build trigger
8849
8849
  */
8850
8850
  name: string;
8851
8851
  /**
8852
- * The deploy adapter
8852
+ * The type of build trigger
8853
8853
  */
8854
- adapter: string;
8854
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8855
8855
  /**
8856
- * Additional configuration for deploy
8856
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8857
8857
  */
8858
8858
  adapter_settings: {
8859
8859
  [k: string]: unknown;
8860
8860
  };
8861
8861
  /**
8862
- * Timestamp of the last deploy
8862
+ * Timestamp of the last build
8863
8863
  */
8864
8864
  last_build_completed_at: string | null;
8865
8865
  /**
8866
- * Status of last deploy
8866
+ * Status of last build
8867
8867
  */
8868
8868
  build_status: string;
8869
8869
  /**
8870
- * Unique token of the webhook
8870
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8871
8871
  */
8872
8872
  webhook_token?: string;
8873
8873
  /**
8874
- * Notification webhook URL
8874
+ * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8875
8875
  */
8876
8876
  webhook_url: string;
8877
8877
  /**
8878
- * Status of site scraper
8878
+ * Status of Site Search for the frontend
8879
8879
  */
8880
8880
  indexing_status: string;
8881
8881
  /**
8882
- * Public url of the site
8882
+ * 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
8883
8883
  */
8884
8884
  frontend_url: string | null;
8885
8885
  /**
8886
- * Deploy on scheduled publication
8886
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8887
8887
  */
8888
8888
  autotrigger_on_scheduled_publications: boolean;
8889
8889
  /**
8890
- * Enable scraper on the site
8890
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8891
8891
  */
8892
8892
  indexing_enabled: boolean;
8893
8893
  };
@@ -8899,31 +8899,31 @@ export type BuildTriggerAttributes = {
8899
8899
  export type BuildTriggerCreateSchema = {
8900
8900
  type?: BuildTriggerType;
8901
8901
  /**
8902
- * Name of the environment
8902
+ * Name of the build trigger
8903
8903
  */
8904
8904
  name: string;
8905
8905
  /**
8906
- * Unique token of the webhook
8906
+ * Unique token for the webhook (it's the same token present in `webhook_url`)
8907
8907
  */
8908
8908
  webhook_token?: string;
8909
8909
  /**
8910
- * The deploy adapter
8910
+ * The type of build trigger
8911
8911
  */
8912
- adapter: string;
8912
+ adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8913
8913
  /**
8914
- * Enable scraper on the site
8914
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8915
8915
  */
8916
8916
  indexing_enabled: boolean;
8917
8917
  /**
8918
- * Public url of the site
8918
+ * 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
8919
8919
  */
8920
8920
  frontend_url: string | null;
8921
8921
  /**
8922
- * Deploy on scheduled publication
8922
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8923
8923
  */
8924
8924
  autotrigger_on_scheduled_publications: boolean;
8925
8925
  /**
8926
- * Additional configuration for deploy
8926
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8927
8927
  */
8928
8928
  adapter_settings: {
8929
8929
  [k: string]: unknown;
@@ -8938,27 +8938,27 @@ export type BuildTriggerUpdateSchema = {
8938
8938
  id?: BuildTriggerIdentity;
8939
8939
  type?: BuildTriggerType;
8940
8940
  /**
8941
- * Name of the environment
8941
+ * Name of the build trigger
8942
8942
  */
8943
8943
  name?: string;
8944
8944
  /**
8945
- * The deploy adapter
8945
+ * The type of build trigger
8946
8946
  */
8947
- adapter?: string;
8947
+ adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8948
8948
  /**
8949
- * Enable scraper on the site
8949
+ * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8950
8950
  */
8951
8951
  indexing_enabled?: boolean;
8952
8952
  /**
8953
- * Public url of the site
8953
+ * 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
8954
8954
  */
8955
8955
  frontend_url?: string | null;
8956
8956
  /**
8957
- * Deploy on scheduled publication
8957
+ * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8958
8958
  */
8959
8959
  autotrigger_on_scheduled_publications?: boolean;
8960
8960
  /**
8961
- * Additional configuration for deploy
8961
+ * Additional settings for the build trigger. The value depends on the `adapter`.
8962
8962
  */
8963
8963
  adapter_settings?: {
8964
8964
  [k: string]: unknown;