@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
62 lines (61 loc) • 2.41 kB
TypeScript
import BaseResource from '../../BaseResource';
import type * as SchemaTypes from '../SchemaTypes';
import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
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<SimpleSchemaTypes.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<SchemaTypes.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: SchemaTypes.EditingSessionUpdateSchema): Promise<SchemaTypes.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 | SimpleSchemaTypes.EditingSessionData): Promise<SimpleSchemaTypes.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<SchemaTypes.EditingSessionDestroyTargetSchema>;
}