@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
61 lines (60 loc) • 2.27 kB
TypeScript
import BaseResource from '../../BaseResource';
import type * as SchemaTypes from '../SchemaTypes';
import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
export default class MaintenanceMode extends BaseResource {
static readonly TYPE: "maintenance_mode";
/**
* Retrieve maintenence mode
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
find(): Promise<SimpleSchemaTypes.MaintenanceMode>;
/**
* Retrieve maintenence mode
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFind(): Promise<SchemaTypes.MaintenanceModeSelfTargetSchema>;
/**
* Activate maintenance mode: this means that the primary environment will be read-only
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
activate(queryParams?: SimpleSchemaTypes.MaintenanceModeActivateHrefSchema): Promise<SimpleSchemaTypes.MaintenanceMode>;
/**
* Activate maintenance mode: this means that the primary environment will be read-only
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawActivate(queryParams?: SchemaTypes.MaintenanceModeActivateHrefSchema): Promise<SchemaTypes.MaintenanceModeActivateTargetSchema>;
/**
* De-activate maintenance mode
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
deactivate(): Promise<SimpleSchemaTypes.MaintenanceMode>;
/**
* De-activate maintenance mode
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawDeactivate(): Promise<SchemaTypes.MaintenanceModeDeactivateTargetSchema>;
}