@datocms/cma-client 1.1.2 → 1.1.4

package/src/generated/resources/BuildTrigger.ts

@@ -10,6 +10,9 @@ export default class BuildTrigger extends BaseResource {
    * List all build triggers for a site
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list() {
     return this.rawList().then((body) =>
@@ -23,6 +26,9 @@ export default class BuildTrigger extends BaseResource {
    * List all build triggers for a site
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(): Promise<SchemaTypes.BuildTriggerInstancesTargetSchema> {
     return this.client.request<SchemaTypes.BuildTriggerInstancesTargetSchema>({
@@ -35,6 +41,9 @@ export default class BuildTrigger extends BaseResource {
    * Retrieve a build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawFind(Utils.toId(buildTriggerId)).then((body) =>
@@ -48,6 +57,9 @@ export default class BuildTrigger extends BaseResource {
    * Retrieve a build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(
     buildTriggerId: string,
@@ -62,6 +74,9 @@ export default class BuildTrigger extends BaseResource {
    * Create build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   create(body: SimpleSchemaTypes.BuildTriggerCreateSchema) {
     return this.rawCreate(
@@ -89,6 +104,9 @@ export default class BuildTrigger extends BaseResource {
    * Create build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawCreate(
     body: SchemaTypes.BuildTriggerCreateSchema,
@@ -104,6 +122,9 @@ export default class BuildTrigger extends BaseResource {
    * Update build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   update(
     buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData,
@@ -135,6 +156,9 @@ export default class BuildTrigger extends BaseResource {
    * Update build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawUpdate(
     buildTriggerId: string,
@@ -151,6 +175,9 @@ export default class BuildTrigger extends BaseResource {
    * Trigger a deploy
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   trigger(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawTrigger(Utils.toId(buildTriggerId));
@@ -160,6 +187,9 @@ export default class BuildTrigger extends BaseResource {
    * Trigger a deploy
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawTrigger(buildTriggerId: string): Promise<void> {
     return this.client.request<void>({
@@ -172,6 +202,9 @@ export default class BuildTrigger extends BaseResource {
    * Abort a deploy and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   abort(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawAbort(Utils.toId(buildTriggerId));
@@ -181,6 +214,9 @@ export default class BuildTrigger extends BaseResource {
    * Abort a deploy and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawAbort(buildTriggerId: string): Promise<void> {
     return this.client.request<void>({
@@ -193,6 +229,9 @@ export default class BuildTrigger extends BaseResource {
    * Abort a site search spidering and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   abortIndexing(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawAbortIndexing(Utils.toId(buildTriggerId));
@@ -202,6 +241,9 @@ export default class BuildTrigger extends BaseResource {
    * Abort a site search spidering and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawAbortIndexing(buildTriggerId: string): Promise<void> {
     return this.client.request<void>({
@@ -214,6 +256,9 @@ export default class BuildTrigger extends BaseResource {
    * Trigger a new site search spidering of the website
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   reindex(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawReindex(Utils.toId(buildTriggerId));
@@ -223,6 +268,9 @@ export default class BuildTrigger extends BaseResource {
    * Trigger a new site search spidering of the website
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawReindex(buildTriggerId: string): Promise<void> {
     return this.client.request<void>({
@@ -235,6 +283,9 @@ export default class BuildTrigger extends BaseResource {
    * Delete a build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   destroy(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
     return this.rawDestroy(Utils.toId(buildTriggerId)).then((body) =>
@@ -248,6 +299,9 @@ export default class BuildTrigger extends BaseResource {
    * Delete a build trigger
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDestroy(
     buildTriggerId: string,

package/src/generated/resources/DailyUsage.ts

@@ -10,6 +10,9 @@ export default class DailyUsage extends BaseResource {
    * Retrieve project's daily usage info
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list() {
     return this.rawList().then((body) =>
@@ -23,6 +26,9 @@ export default class DailyUsage extends BaseResource {
    * Retrieve project's daily usage info
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(): Promise<SchemaTypes.DailyUsageInstancesTargetSchema> {
     return this.client.request<SchemaTypes.DailyUsageInstancesTargetSchema>({

package/src/generated/resources/EditingSession.ts

@@ -11,6 +11,9 @@ export default class EditingSession extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   list() {
@@ -26,6 +29,9 @@ export default class EditingSession extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawList(): Promise<SchemaTypes.EditingSessionInstancesTargetSchema> {
@@ -42,6 +48,9 @@ export default class EditingSession extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/update
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawUpdate(
@@ -60,6 +69,9 @@ export default class EditingSession extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   destroy(editingSessionId: string | SimpleSchemaTypes.EditingSessionData) {
@@ -75,6 +87,9 @@ export default class EditingSession extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawDestroy(

package/src/generated/resources/Environment.ts

@@ -10,6 +10,9 @@ export default class Environment extends BaseResource {
    * Fork an existing environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   fork(
     environmentId: string | SimpleSchemaTypes.EnvironmentData,
@@ -34,6 +37,9 @@ export default class Environment extends BaseResource {
    * Fork an existing environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFork(
     environmentId: string,
@@ -50,6 +56,9 @@ export default class Environment extends BaseResource {
    * Promote an environment to primary
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   promote(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
     return this.rawPromote(Utils.toId(environmentId)).then((body) =>
@@ -63,6 +72,9 @@ export default class Environment extends BaseResource {
    * Promote an environment to primary
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawPromote(
     environmentId: string,
@@ -77,6 +89,9 @@ export default class Environment extends BaseResource {
    * List all environments
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list() {
     return this.rawList().then((body) =>
@@ -90,6 +105,9 @@ export default class Environment extends BaseResource {
    * List all environments
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(): Promise<SchemaTypes.EnvironmentInstancesTargetSchema> {
     return this.client.request<SchemaTypes.EnvironmentInstancesTargetSchema>({
@@ -102,6 +120,9 @@ export default class Environment extends BaseResource {
    * Retrieve a environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
     return this.rawFind(Utils.toId(environmentId)).then((body) =>
@@ -115,6 +136,9 @@ export default class Environment extends BaseResource {
    * Retrieve a environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(
     environmentId: string,
@@ -129,6 +153,9 @@ export default class Environment extends BaseResource {
    * Delete a environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   destroy(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
     return this.rawDestroy(Utils.toId(environmentId)).then((body) =>
@@ -142,6 +169,9 @@ export default class Environment extends BaseResource {
    * Delete a environment
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDestroy(
     environmentId: string,

package/src/generated/resources/Field.ts

@@ -10,6 +10,9 @@ export default class Field extends BaseResource {
    * Create a new field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   create(
     itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
@@ -44,6 +47,9 @@ export default class Field extends BaseResource {
    * Create a new field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawCreate(
     itemTypeId: string,
@@ -60,6 +66,9 @@ export default class Field extends BaseResource {
    * Update a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   update(
     fieldId: string | SimpleSchemaTypes.FieldData,
@@ -95,6 +104,9 @@ export default class Field extends BaseResource {
    * Update a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawUpdate(
     fieldId: string,
@@ -111,6 +123,9 @@ export default class Field extends BaseResource {
    * List all fields
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
     return this.rawList(Utils.toId(itemTypeId)).then((body) =>
@@ -124,6 +139,9 @@ export default class Field extends BaseResource {
    * List all fields
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(itemTypeId: string): Promise<SchemaTypes.FieldInstancesTargetSchema> {
     return this.client.request<SchemaTypes.FieldInstancesTargetSchema>({
@@ -137,6 +155,9 @@ export default class Field extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   referencing(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
@@ -152,6 +173,9 @@ export default class Field extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawReferencing(
@@ -168,6 +192,9 @@ export default class Field extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   related(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
@@ -183,6 +210,9 @@ export default class Field extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
    *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   *
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawRelated(
@@ -198,6 +228,9 @@ export default class Field extends BaseResource {
    * Retrieve a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(fieldId: string | SimpleSchemaTypes.FieldData) {
     return this.rawFind(Utils.toId(fieldId)).then((body) =>
@@ -211,6 +244,9 @@ export default class Field extends BaseResource {
    * Retrieve a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(fieldId: string): Promise<SchemaTypes.FieldSelfTargetSchema> {
     return this.client.request<SchemaTypes.FieldSelfTargetSchema>({
@@ -223,6 +259,9 @@ export default class Field extends BaseResource {
    * Delete a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   destroy(fieldId: string | SimpleSchemaTypes.FieldData) {
     return this.rawDestroy(Utils.toId(fieldId)).then((body) =>
@@ -236,6 +275,9 @@ export default class Field extends BaseResource {
    * Delete a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDestroy(fieldId: string): Promise<SchemaTypes.FieldDestroyJobSchema> {
     return this.client.request<SchemaTypes.FieldDestroyJobSchema>({
@@ -248,6 +290,9 @@ export default class Field extends BaseResource {
    * Duplicate a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   duplicate(fieldId: string | SimpleSchemaTypes.FieldData) {
     return this.rawDuplicate(Utils.toId(fieldId)).then((body) =>
@@ -261,6 +306,9 @@ export default class Field extends BaseResource {
    * Duplicate a field
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDuplicate(fieldId: string): Promise<SchemaTypes.FieldDuplicateJobSchema> {
     return this.client.request<SchemaTypes.FieldDuplicateJobSchema>({

package/src/generated/resources/Fieldset.ts

@@ -10,6 +10,9 @@ export default class Fieldset extends BaseResource {
    * Create a new fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   create(
     itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
@@ -39,6 +42,9 @@ export default class Fieldset extends BaseResource {
    * Create a new fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawCreate(
     itemTypeId: string,
@@ -55,6 +61,9 @@ export default class Fieldset extends BaseResource {
    * Update a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   update(
     fieldsetId: string | SimpleSchemaTypes.FieldsetData,
@@ -85,6 +94,9 @@ export default class Fieldset extends BaseResource {
    * Update a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawUpdate(
     fieldsetId: string,
@@ -101,6 +113,9 @@ export default class Fieldset extends BaseResource {
    * List all fieldsets
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   list(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
     return this.rawList(Utils.toId(itemTypeId)).then((body) =>
@@ -114,6 +129,9 @@ export default class Fieldset extends BaseResource {
    * List all fieldsets
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawList(
     itemTypeId: string,
@@ -128,6 +146,9 @@ export default class Fieldset extends BaseResource {
    * Retrieve a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   find(fieldsetId: string | SimpleSchemaTypes.FieldsetData) {
     return this.rawFind(Utils.toId(fieldsetId)).then((body) =>
@@ -141,6 +162,9 @@ export default class Fieldset extends BaseResource {
    * Retrieve a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawFind(fieldsetId: string): Promise<SchemaTypes.FieldsetSelfTargetSchema> {
     return this.client.request<SchemaTypes.FieldsetSelfTargetSchema>({
@@ -153,6 +177,9 @@ export default class Fieldset extends BaseResource {
    * Delete a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   destroy(fieldsetId: string | SimpleSchemaTypes.FieldsetData) {
     return this.rawDestroy(Utils.toId(fieldsetId)).then((body) =>
@@ -166,6 +193,9 @@ export default class Fieldset extends BaseResource {
    * Delete a fieldset
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
    */
   rawDestroy(
     fieldsetId: string,