@datocms/cma-client 1.1.1 → 1.1.3

package/dist/types/generated/resources/BuildTrigger.d.ts

@@ -7,108 +7,162 @@ 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(): Promise<SimpleSchemaTypes.BuildTriggerInstancesTargetSchema>;
     /**
      * 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>;
     /**
      * 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): Promise<SimpleSchemaTypes.BuildTrigger>;
     /**
      * 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): Promise<SchemaTypes.BuildTriggerSelfTargetSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.BuildTrigger>;
     /**
      * 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): Promise<SchemaTypes.BuildTriggerCreateTargetSchema>;
     /**
      * 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, body: SimpleSchemaTypes.BuildTriggerUpdateSchema): Promise<SimpleSchemaTypes.BuildTrigger>;
     /**
      * Update build trigger
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(buildTriggerId: string, body: SchemaTypes.BuildTriggerUpdateSchema): Promise<SchemaTypes.BuildTriggerUpdateTargetSchema>;
     /**
      * 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): Promise<void>;
     /**
      * 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>;
     /**
      * 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): Promise<void>;
     /**
      * 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>;
     /**
      * 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): Promise<void>;
     /**
      * 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>;
     /**
      * 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): Promise<void>;
     /**
      * 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>;
     /**
      * 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): Promise<SimpleSchemaTypes.BuildTrigger>;
     /**
      * 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): Promise<SchemaTypes.BuildTriggerDestroyTargetSchema>;
 }

package/dist/types/generated/resources/DailyUsage.d.ts

@@ -7,12 +7,18 @@ 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(): Promise<SimpleSchemaTypes.DailyUsageInstancesTargetSchema>;
     /**
      * 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>;
 }

package/dist/types/generated/resources/EditingSession.d.ts

@@ -8,6 +8,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(): Promise<SimpleSchemaTypes.EditingSessionInstancesTargetSchema>;
@@ -16,6 +19,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>;
@@ -24,6 +30,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(editingSessionId: string, body: SchemaTypes.EditingSessionUpdateSchema): Promise<SchemaTypes.EditingSessionUpdateTargetSchema>;
@@ -32,6 +41,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): Promise<SimpleSchemaTypes.EditingSession>;
@@ -40,6 +52,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(editingSessionId: string): Promise<SchemaTypes.EditingSessionDestroyTargetSchema>;

package/dist/types/generated/resources/Environment.d.ts

@@ -7,60 +7,90 @@ 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, body: SimpleSchemaTypes.EnvironmentForkSchema): Promise<SimpleSchemaTypes.Environment>;
     /**
      * Fork an existing environment
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFork(environmentId: string, body: SchemaTypes.EnvironmentForkSchema): Promise<SchemaTypes.EnvironmentForkJobSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.Environment>;
     /**
      * 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): Promise<SchemaTypes.EnvironmentPromoteTargetSchema>;
     /**
      * List all environments
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(): Promise<SimpleSchemaTypes.EnvironmentInstancesTargetSchema>;
     /**
      * List all environments
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(): Promise<SchemaTypes.EnvironmentInstancesTargetSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.Environment>;
     /**
      * Retrieve a environment
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(environmentId: string): Promise<SchemaTypes.EnvironmentSelfTargetSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.Environment>;
     /**
      * Delete a environment
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawDestroy(environmentId: string): Promise<SchemaTypes.EnvironmentDestroyJobSchema>;
 }

package/dist/types/generated/resources/Field.d.ts

@@ -7,36 +7,54 @@ 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, body: SimpleSchemaTypes.FieldCreateSchema): Promise<SimpleSchemaTypes.Field>;
     /**
      * Create a new field
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawCreate(itemTypeId: string, body: SchemaTypes.FieldCreateSchema): Promise<SchemaTypes.FieldCreateJobSchema>;
     /**
      * 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, body: SimpleSchemaTypes.FieldUpdateSchema): Promise<SimpleSchemaTypes.Field>;
     /**
      * Update a field
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(fieldId: string, body: SchemaTypes.FieldUpdateSchema): Promise<SchemaTypes.FieldUpdateJobSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.FieldInstancesTargetSchema>;
     /**
      * 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>;
     /**
@@ -44,6 +62,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): Promise<SimpleSchemaTypes.FieldReferencingTargetSchema>;
@@ -52,6 +73,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(itemTypeId: string): Promise<SchemaTypes.FieldReferencingTargetSchema>;
@@ -60,6 +84,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): Promise<SimpleSchemaTypes.FieldRelatedTargetSchema>;
@@ -68,6 +95,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(itemTypeId: string): Promise<SchemaTypes.FieldRelatedTargetSchema>;
@@ -75,36 +105,54 @@ 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): Promise<SimpleSchemaTypes.Field>;
     /**
      * 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>;
     /**
      * 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): Promise<SimpleSchemaTypes.Field>;
     /**
      * 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>;
     /**
      * 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): Promise<SimpleSchemaTypes.Field>;
     /**
      * 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>;
 }

package/dist/types/generated/resources/Fieldset.d.ts

@@ -7,60 +7,90 @@ 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, body: SimpleSchemaTypes.FieldsetCreateSchema): Promise<SimpleSchemaTypes.Fieldset>;
     /**
      * Create a new fieldset
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawCreate(itemTypeId: string, body: SchemaTypes.FieldsetCreateSchema): Promise<SchemaTypes.FieldsetCreateTargetSchema>;
     /**
      * 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, body: SimpleSchemaTypes.FieldsetUpdateSchema): Promise<SimpleSchemaTypes.Fieldset>;
     /**
      * Update a fieldset
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(fieldsetId: string, body: SchemaTypes.FieldsetUpdateSchema): Promise<SchemaTypes.FieldsetUpdateTargetSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.FieldsetInstancesTargetSchema>;
     /**
      * List all fieldsets
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(itemTypeId: string): Promise<SchemaTypes.FieldsetInstancesTargetSchema>;
     /**
      * 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): Promise<SimpleSchemaTypes.Fieldset>;
     /**
      * 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>;
     /**
      * 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): Promise<SimpleSchemaTypes.Fieldset>;
     /**
      * Delete a fieldset
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawDestroy(fieldsetId: string): Promise<SchemaTypes.FieldsetDestroyTargetSchema>;
 }