@datocms/cma-client 1.1.2 → 1.1.3

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

@@ -8,24 +8,36 @@ export default class UploadSmartTag extends BaseResource {
      * List all automatically created upload tags
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadSmartTagInstancesTargetSchema>;
     /**
      * List all automatically created upload tags
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema): Promise<SchemaTypes.UploadSmartTagInstancesTargetSchema>;
     /**
      * Async iterator to auto-paginate over elements returned by list()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     listPagedIterator(queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.UploadSmartTag, void, unknown>;
     /**
      * Async iterator to auto-paginate over elements returned by rawList()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawListPagedIterator(queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.UploadSmartTag, void, unknown>;
 }

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

@@ -8,36 +8,54 @@ export default class UploadTag extends BaseResource {
      * List all manually created upload tags
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadTagInstancesTargetSchema>;
     /**
      * List all manually created upload tags
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(queryParams?: SchemaTypes.UploadTagInstancesHrefSchema): Promise<SchemaTypes.UploadTagInstancesTargetSchema>;
     /**
      * Async iterator to auto-paginate over elements returned by list()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     listPagedIterator(queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.UploadTag, void, unknown>;
     /**
      * Async iterator to auto-paginate over elements returned by rawList()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawListPagedIterator(queryParams?: SchemaTypes.UploadTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.UploadTag, void, unknown>;
     /**
      * Create a new upload tag
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     create(body: SimpleSchemaTypes.UploadTagCreateSchema): Promise<SimpleSchemaTypes.UploadTag>;
     /**
      * Create a new upload tag
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawCreate(body: SchemaTypes.UploadTagCreateSchema): Promise<SchemaTypes.UploadTagCreateTargetSchema>;
 }

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

@@ -7,12 +7,18 @@ export default class UsageCounter extends BaseResource {
      * Retrieve a project's usage counter
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     find(usageCounterId: string | SimpleSchemaTypes.UsageCounterData, queryParams?: SimpleSchemaTypes.UsageCounterSelfHrefSchema): Promise<SimpleSchemaTypes.UsageCounter>;
     /**
      * Retrieve a project's usage counter
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(usageCounterId: string, queryParams?: SchemaTypes.UsageCounterSelfHrefSchema): Promise<SchemaTypes.UsageCounterSelfTargetSchema>;
 }

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

@@ -7,60 +7,90 @@ export default class User extends BaseResource {
      * Update a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     update(userId: string | SimpleSchemaTypes.UserData, body: SimpleSchemaTypes.UserUpdateSchema): Promise<SimpleSchemaTypes.User>;
     /**
      * Update a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(userId: string, body: SchemaTypes.UserUpdateSchema): Promise<SchemaTypes.UserUpdateTargetSchema>;
     /**
      * List all collaborators
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(): Promise<SimpleSchemaTypes.UserInstancesTargetSchema>;
     /**
      * List all collaborators
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(): Promise<SchemaTypes.UserInstancesTargetSchema>;
     /**
      * Retrieve a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     find(userId: string | SimpleSchemaTypes.UserData, queryParams?: SimpleSchemaTypes.UserSelfHrefSchema): Promise<SimpleSchemaTypes.User>;
     /**
      * Retrieve a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(userId: string, queryParams?: SchemaTypes.UserSelfHrefSchema): Promise<SchemaTypes.UserSelfTargetSchema>;
     /**
      * Retrieve current signed-in user
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     findMe(queryParams?: SimpleSchemaTypes.UserMeHrefSchema): Promise<SimpleSchemaTypes.User | SimpleSchemaTypes.SsoUser | SimpleSchemaTypes.AccessToken | SimpleSchemaTypes.Account>;
     /**
      * Retrieve current signed-in user
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFindMe(queryParams?: SchemaTypes.UserMeHrefSchema): Promise<SchemaTypes.UserMeTargetSchema>;
     /**
      * Delete a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     destroy(userId: string | SimpleSchemaTypes.UserData, queryParams?: SimpleSchemaTypes.UserDestroyHrefSchema): Promise<SimpleSchemaTypes.User>;
     /**
      * Delete a collaborator
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawDestroy(userId: string, queryParams?: SchemaTypes.UserDestroyHrefSchema): Promise<SchemaTypes.UserDestroyTargetSchema>;
 }

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

@@ -7,60 +7,90 @@ export default class Webhook extends BaseResource {
      * Create a new webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     create(body: SimpleSchemaTypes.WebhookCreateSchema): Promise<SimpleSchemaTypes.Webhook>;
     /**
      * Create a new webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawCreate(body: SchemaTypes.WebhookCreateSchema): Promise<SchemaTypes.WebhookCreateTargetSchema>;
     /**
      * Update a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     update(userId: string | SimpleSchemaTypes.UserData, body: SimpleSchemaTypes.WebhookUpdateSchema): Promise<SimpleSchemaTypes.Webhook>;
     /**
      * Update a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(userId: string, body: SchemaTypes.WebhookUpdateSchema): Promise<SchemaTypes.WebhookUpdateTargetSchema>;
     /**
      * List all webhooks
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(): Promise<SimpleSchemaTypes.WebhookInstancesTargetSchema>;
     /**
      * List all webhooks
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(): Promise<SchemaTypes.WebhookInstancesTargetSchema>;
     /**
      * Retrieve a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     find(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.Webhook>;
     /**
      * Retrieve a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(userId: string): Promise<SchemaTypes.WebhookSelfTargetSchema>;
     /**
      * Delete a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     destroy(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.Webhook>;
     /**
      * Delete a webhook
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawDestroy(userId: string): Promise<SchemaTypes.WebhookDestroyTargetSchema>;
 }

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

@@ -8,36 +8,54 @@ export default class WebhookCall extends BaseResource {
      * List all webhooks calls
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema): Promise<SimpleSchemaTypes.WebhookCallInstancesTargetSchema>;
     /**
      * List all webhooks calls
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema): Promise<SchemaTypes.WebhookCallInstancesTargetSchema>;
     /**
      * Async iterator to auto-paginate over elements returned by list()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     listPagedIterator(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.WebhookCall, void, unknown>;
     /**
      * Async iterator to auto-paginate over elements returned by rawList()
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawListPagedIterator(queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.WebhookCall, void, unknown>;
     /**
      * Re-send the webhook call
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     resendWebhook(userId: string | SimpleSchemaTypes.UserData): Promise<void>;
     /**
      * Re-send the webhook call
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawResendWebhook(userId: string): Promise<void>;
 }

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

@@ -7,24 +7,36 @@ export default class WhiteLabelSettings extends BaseResource {
      * Retrieve white-label settings
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     find(): Promise<SimpleSchemaTypes.WhiteLabelSettings>;
     /**
      * Retrieve white-label settings
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(): Promise<SchemaTypes.WhiteLabelSettingsSelfTargetSchema>;
     /**
      * Update white-label settings
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     update(body: SimpleSchemaTypes.WhiteLabelSettingsUpdateSchema): Promise<SimpleSchemaTypes.WhiteLabelSettings>;
     /**
      * Update white-label settings
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(body: SchemaTypes.WhiteLabelSettingsUpdateSchema): Promise<SchemaTypes.WhiteLabelSettingsUpdateTargetSchema>;
 }

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

@@ -7,60 +7,90 @@ export default class Workflow extends BaseResource {
      * Create a new workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     create(body: SimpleSchemaTypes.WorkflowCreateSchema): Promise<SimpleSchemaTypes.Workflow>;
     /**
      * Create a new workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawCreate(body: SchemaTypes.WorkflowCreateSchema): Promise<SchemaTypes.WorkflowCreateTargetSchema>;
     /**
      * Update a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     update(workflowId: string | SimpleSchemaTypes.WorkflowData, body: SimpleSchemaTypes.WorkflowUpdateSchema): Promise<SimpleSchemaTypes.Workflow>;
     /**
      * Update a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawUpdate(workflowId: string, body: SchemaTypes.WorkflowUpdateSchema): Promise<SchemaTypes.WorkflowUpdateTargetSchema>;
     /**
      * List all workflows
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     list(): Promise<SimpleSchemaTypes.WorkflowInstancesTargetSchema>;
     /**
      * List all workflows
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawList(): Promise<SchemaTypes.WorkflowInstancesTargetSchema>;
     /**
      * Retrieve a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     find(workflowId: string | SimpleSchemaTypes.WorkflowData): Promise<SimpleSchemaTypes.Workflow>;
     /**
      * Retrieve a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawFind(workflowId: string): Promise<SchemaTypes.WorkflowSelfTargetSchema>;
     /**
      * Delete a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     destroy(workflowId: string | SimpleSchemaTypes.WorkflowData): Promise<void>;
     /**
      * Delete a workflow
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
      */
     rawDestroy(workflowId: string): Promise<void>;
 }

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { ApiError, LogLevel } from '@datocms/rest-client-utils';
+export { ApiError, TimeoutError, LogLevel } from '@datocms/rest-client-utils';
 export { Client } from './generated/Client';
 export * as Resources from './generated/resources';
 export type { ClientConfigOptions } from './generated/Client';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,10 +37,10 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^1.1.2"
+    "@datocms/rest-client-utils": "^1.1.3"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^1.1.2"
+    "@datocms/dashboard-client": "^1.1.3"
   },
-  "gitHead": "60159cb125e4a493dbbeefb4ac3764d25c2abae8"
+  "gitHead": "e370345a81ed2ae180fa51990d25333d3d34f430"
 }

package/src/generated/Client.ts

@@ -11,12 +11,21 @@ export type RequestOptions = {
 };
 
 export type ClientConfigOptions = {
+  /** The API token to use to perform requests */
   apiToken: string | null;
+  /** The base URL of the server. Defaults to https://site-api.datocms.com */
   baseUrl?: string;
+  /** The environment in which to perform every API request */
   environment?: string;
+  /** Configure request timeout (in ms). When timeout is reached and `autoRetry` is active, a new request will be performed. Otherwise, a `TimeoutError` will be raised. Defaults to `30000` */
+  requestTimeout?: number;
+  /** Any extra header to add to every API request */
   extraHeaders?: Record<string, string>;
+  /** Level of logging */
   logLevel?: LogLevel;
+  /** Function to use to log. Defaults to `console.log` */
   logFn?: (message: string) => void;
+  /** Whether to automatically retry failed requests (ie. timeout, rate-limiting, etc.), with a linear incremental backoff. Defaults to `true` */
   autoRetry?: boolean;
 };