@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
62 lines (61 loc) • 2.37 kB
TypeScript
import BaseResource from '../../BaseResource';
import type * as ApiTypes from '../ApiTypes';
import type * as RawApiTypes from '../RawApiTypes';
export default class EditingSession extends BaseResource {
static readonly TYPE: "editing_session";
/**
* List all editing sessions
*
* 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<ApiTypes.EditingSessionInstancesTargetSchema>;
/**
* List all editing sessions
*
* 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<RawApiTypes.EditingSessionInstancesTargetSchema>;
/**
* Allows all actions on editing sessions
*
* 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: RawApiTypes.EditingSessionUpdateSchema): Promise<RawApiTypes.EditingSessionUpdateTargetSchema>;
/**
* Delete an editing session
*
* 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 | ApiTypes.EditingSessionData): Promise<ApiTypes.EditingSession>;
/**
* Delete an editing session
*
* 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<RawApiTypes.EditingSessionDestroyTargetSchema>;
}