@datocms/cma-client/src/generated/resources/Session.ts

JS client for DatoCMS REST Content Management API

import * as Utils from '@datocms/rest-client-utils';
import BaseResource from '../../BaseResource.js';
import type * as ApiTypes from '../ApiTypes.js';
import type * as RawApiTypes from '../RawApiTypes.js';

export default class Session extends BaseResource {
  static readonly TYPE = 'session' as const;

  /**
   * Create a new session
   *
   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
   *
   * @throws {ApiError}
   * @throws {TimeoutError}
   *
   * @deprecated This API call is to be considered private and might change without notice
   */
  create(body: ApiTypes.SessionCreateSchema) {
    return this.rawCreate(
      Utils.serializeRequestBody<RawApiTypes.SessionCreateSchema>(body, {
        type: 'email_credentials',
        attributes: ['email', 'password', 'otp_code'],
        relationships: [],
      }),
    ).then((body) =>
      Utils.deserializeResponseBody<ApiTypes.SessionCreateTargetSchema>(body),
    );
  }

  /**
   * Create a new session
   *
   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
   *
   * @throws {ApiError}
   * @throws {TimeoutError}
   *
   * @deprecated This API call is to be considered private and might change without notice
   */
  rawCreate(
    body: RawApiTypes.SessionCreateSchema,
  ): Promise<RawApiTypes.SessionCreateTargetSchema> {
    return this.client.request<RawApiTypes.SessionCreateTargetSchema>({
      method: 'POST',
      url: '/sessions',
      body,
    });
  }

  /**
   * Destroy the current session
   *
   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/destroy
   *
   * @throws {ApiError}
   * @throws {TimeoutError}
   *
   * @deprecated This API call is to be considered private and might change without notice
   */
  destroy() {
    return this.rawDestroy();
  }

  /**
   * Destroy the current session
   *
   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/destroy
   *
   * @throws {ApiError}
   * @throws {TimeoutError}
   *
   * @deprecated This API call is to be considered private and might change without notice
   */
  rawDestroy(): Promise<void> {
    return this.client.request<void>({
      method: 'DELETE',
      url: '/session',
    });
  }
}