@datocms/cma-client 0.1.0

package/src/generated/resources/AccessToken.ts

@@ -0,0 +1,206 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class AccessToken extends BaseResource {
+  static readonly TYPE: 'access_token' = 'access_token';
+
+  /**
+   * Create a new API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
+   */
+  create(body: SimpleSchemaTypes.AccessTokenCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.AccessTokenCreateSchema>(body, {
+        type: 'access_token',
+        attributes: [
+          'name',
+          'can_access_cda',
+          'can_access_cda_preview',
+          'can_access_cma',
+        ],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
+   */
+  rawCreate(
+    body: SchemaTypes.AccessTokenCreateSchema,
+  ): Promise<SchemaTypes.AccessTokenCreateTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenCreateTargetSchema>({
+      method: 'POST',
+      url: `/access_tokens`,
+      body,
+    });
+  }
+
+  /**
+   * Update an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
+   */
+  update(
+    accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
+    body: SimpleSchemaTypes.AccessTokenUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(accessTokenId),
+      Utils.serializeRequestBody<SchemaTypes.AccessTokenUpdateSchema>(body, {
+        id: Utils.toId(accessTokenId),
+        type: 'access_token',
+        attributes: [
+          'name',
+          'can_access_cda',
+          'can_access_cda_preview',
+          'can_access_cma',
+        ],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
+   */
+  rawUpdate(
+    accessTokenId: string,
+    body: SchemaTypes.AccessTokenUpdateSchema,
+  ): Promise<SchemaTypes.AccessTokenUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/access_tokens/${accessTokenId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all API tokens
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all API tokens
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
+   */
+  rawList(): Promise<SchemaTypes.AccessTokenInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenInstancesTargetSchema>({
+      method: 'GET',
+      url: `/access_tokens`,
+    });
+  }
+
+  /**
+   * Retrieve an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
+   */
+  find(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
+    return this.rawFind(Utils.toId(accessTokenId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
+   */
+  rawFind(
+    accessTokenId: string,
+  ): Promise<SchemaTypes.AccessTokenSelfTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenSelfTargetSchema>({
+      method: 'GET',
+      url: `/access_tokens/${accessTokenId}`,
+    });
+  }
+
+  /**
+   * Rotate API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
+   */
+  regenerateToken(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
+    return this.rawRegenerateToken(Utils.toId(accessTokenId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenRegenerateTokenTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Rotate API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
+   */
+  rawRegenerateToken(
+    accessTokenId: string,
+  ): Promise<SchemaTypes.AccessTokenRegenerateTokenTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenRegenerateTokenTargetSchema>(
+      {
+        method: 'POST',
+        url: `/access_tokens/${accessTokenId}/regenerate_token`,
+      },
+    );
+  }
+
+  /**
+   * Delete an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
+   */
+  destroy(
+    accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
+    queryParams?: SimpleSchemaTypes.AccessTokenDestroyHrefSchema,
+  ) {
+    return this.rawDestroy(Utils.toId(accessTokenId), queryParams).then(
+      (body) =>
+        Utils.deserializeResponseBody<SimpleSchemaTypes.AccessTokenDestroyTargetSchema>(
+          body,
+        ),
+    );
+  }
+
+  /**
+   * Delete an API token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
+   */
+  rawDestroy(
+    accessTokenId: string,
+    queryParams?: SchemaTypes.AccessTokenDestroyHrefSchema,
+  ): Promise<SchemaTypes.AccessTokenDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.AccessTokenDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/access_tokens/${accessTokenId}`,
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/AuditLogEvent.ts

@@ -0,0 +1,42 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class AuditLogEvent extends BaseResource {
+  static readonly TYPE: 'audit_log_event' = 'audit_log_event';
+
+  /**
+   * List Audit Log events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
+   */
+  query(body: SimpleSchemaTypes.AuditLogEventQuerySchema) {
+    return this.rawQuery(
+      Utils.serializeRequestBody<SchemaTypes.AuditLogEventQuerySchema>(body, {
+        type: 'audit_log_query',
+        attributes: ['filter', 'next_token', 'detailed_log'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.AuditLogEventQueryTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List Audit Log events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
+   */
+  rawQuery(
+    body: SchemaTypes.AuditLogEventQuerySchema,
+  ): Promise<SchemaTypes.AuditLogEventQueryTargetSchema> {
+    return this.client.request<SchemaTypes.AuditLogEventQueryTargetSchema>({
+      method: 'POST',
+      url: `/audit-log-events/query`,
+      body,
+    });
+  }
+}

package/src/generated/resources/BuildEvent.ts

@@ -0,0 +1,60 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class BuildEvent extends BaseResource {
+  static readonly TYPE: 'build_event' = 'build_event';
+
+  /**
+   * List all deploy events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildEventInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all deploy events
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   */
+  rawList(): Promise<SchemaTypes.BuildEventInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.BuildEventInstancesTargetSchema>({
+      method: 'GET',
+      url: `/build-events`,
+    });
+  }
+
+  /**
+   * Retrieve a deploy event
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
+   */
+  find(buildEventId: string | SimpleSchemaTypes.BuildEventData) {
+    return this.rawFind(Utils.toId(buildEventId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildEventSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a deploy event
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
+   */
+  rawFind(
+    buildEventId: string,
+  ): Promise<SchemaTypes.BuildEventSelfTargetSchema> {
+    return this.client.request<SchemaTypes.BuildEventSelfTargetSchema>({
+      method: 'GET',
+      url: `/build-events/${buildEventId}`,
+    });
+  }
+}

package/src/generated/resources/BuildTrigger.ts

@@ -0,0 +1,218 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class BuildTrigger extends BaseResource {
+  static readonly TYPE: 'build_trigger' = 'build_trigger';
+
+  /**
+   * List all build triggers for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildTriggerInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all build triggers for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances
+   */
+  rawList(): Promise<SchemaTypes.BuildTriggerInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.BuildTriggerInstancesTargetSchema>({
+      method: 'GET',
+      url: `/build-triggers`,
+    });
+  }
+
+  /**
+   * Retrieve a build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
+   */
+  find(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
+    return this.rawFind(Utils.toId(buildTriggerId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildTriggerSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
+   */
+  rawFind(
+    buildTriggerId: string,
+  ): Promise<SchemaTypes.BuildTriggerSelfTargetSchema> {
+    return this.client.request<SchemaTypes.BuildTriggerSelfTargetSchema>({
+      method: 'GET',
+      url: `/build-triggers/${buildTriggerId}`,
+    });
+  }
+
+  /**
+   * Create build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
+   */
+  create(body: SimpleSchemaTypes.BuildTriggerCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.BuildTriggerCreateSchema>(body, {
+        type: 'build_trigger',
+        attributes: [
+          'name',
+          'webhook_token',
+          'adapter',
+          'indexing_enabled',
+          'frontend_url',
+          'autotrigger_on_scheduled_publications',
+          'adapter_settings',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildTriggerCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
+   */
+  rawCreate(
+    body: SchemaTypes.BuildTriggerCreateSchema,
+  ): Promise<SchemaTypes.BuildTriggerCreateTargetSchema> {
+    return this.client.request<SchemaTypes.BuildTriggerCreateTargetSchema>({
+      method: 'POST',
+      url: `/build-triggers`,
+      body,
+    });
+  }
+
+  /**
+   * Update build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
+   */
+  update(
+    buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData,
+    body: SimpleSchemaTypes.BuildTriggerUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(buildTriggerId),
+      Utils.serializeRequestBody<SchemaTypes.BuildTriggerUpdateSchema>(body, {
+        id: Utils.toId(buildTriggerId),
+        type: 'build_trigger',
+        attributes: [
+          'name',
+          'adapter',
+          'indexing_enabled',
+          'frontend_url',
+          'autotrigger_on_scheduled_publications',
+          'adapter_settings',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildTriggerUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
+   */
+  rawUpdate(
+    buildTriggerId: string,
+    body: SchemaTypes.BuildTriggerUpdateSchema,
+  ): Promise<SchemaTypes.BuildTriggerUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.BuildTriggerUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/build-triggers/${buildTriggerId}`,
+      body,
+    });
+  }
+
+  /**
+   * Trigger a deploy
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
+   */
+  trigger(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
+    return this.rawTrigger(Utils.toId(buildTriggerId));
+  }
+
+  /**
+   * Trigger a deploy
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
+   */
+  rawTrigger(buildTriggerId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'POST',
+      url: `/build-triggers/${buildTriggerId}/trigger`,
+    });
+  }
+
+  /**
+   * Trigger a new Site Search spidering of the website
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
+   */
+  reindex(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
+    return this.rawReindex(Utils.toId(buildTriggerId));
+  }
+
+  /**
+   * Trigger a new Site Search spidering of the website
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
+   */
+  rawReindex(buildTriggerId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'PUT',
+      url: `/build-triggers/${buildTriggerId}/reindex`,
+    });
+  }
+
+  /**
+   * Delete a build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
+   */
+  destroy(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
+    return this.rawDestroy(Utils.toId(buildTriggerId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.BuildTriggerDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a build trigger
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
+   */
+  rawDestroy(
+    buildTriggerId: string,
+  ): Promise<SchemaTypes.BuildTriggerDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.BuildTriggerDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/build-triggers/${buildTriggerId}`,
+    });
+  }
+}

package/src/generated/resources/DailyUsage.ts

@@ -0,0 +1,33 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class DailyUsage extends BaseResource {
+  static readonly TYPE: 'daily_usage' = 'daily_usage';
+
+  /**
+   * Retrieve project's daily usage info
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.DailyUsageInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve project's daily usage info
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
+   */
+  rawList(): Promise<SchemaTypes.DailyUsageInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.DailyUsageInstancesTargetSchema>({
+      method: 'GET',
+      url: `/daily-site-usages`,
+    });
+  }
+}

package/src/generated/resources/EditingSession.ts

@@ -0,0 +1,88 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+
+export default class EditingSession extends BaseResource {
+  static readonly TYPE: 'editing_session' = 'editing_session';
+
+  /**
+   * List all editing sessions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EditingSessionInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all editing sessions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawList(): Promise<SchemaTypes.EditingSessionInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.EditingSessionInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/editing-sessions`,
+      },
+    );
+  }
+
+  /**
+   * Allows all actions on editing sessions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/update
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawUpdate(
+    editingSessionId: string,
+    body: SchemaTypes.EditingSessionUpdateSchema,
+  ): Promise<SchemaTypes.EditingSessionUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.EditingSessionUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/editing-sessions/${editingSessionId}`,
+      body,
+    });
+  }
+
+  /**
+   * Delete an editing session
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  destroy(editingSessionId: string | SimpleSchemaTypes.EditingSessionData) {
+    return this.rawDestroy(Utils.toId(editingSessionId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EditingSessionDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete an editing session
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawDestroy(
+    editingSessionId: string,
+  ): Promise<SchemaTypes.EditingSessionDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.EditingSessionDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/editing-sessions/${editingSessionId}`,
+    });
+  }
+}