@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
61 lines (60 loc) • 2.22 kB
TypeScript
import BaseResource from '../../BaseResource';
import type * as ApiTypes from '../ApiTypes';
import type * as RawApiTypes from '../RawApiTypes';
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<ApiTypes.MaintenanceMode>;
/**
* Retrieve maintenence mode
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFind(): Promise<RawApiTypes.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?: ApiTypes.MaintenanceModeActivateHrefSchema): Promise<ApiTypes.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?: RawApiTypes.MaintenanceModeActivateHrefSchema): Promise<RawApiTypes.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<ApiTypes.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<RawApiTypes.MaintenanceModeDeactivateTargetSchema>;
}