@thlmenezes/sdk-js/dist/api/generated/apis/servers-api.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * devopness API
 * Devopness API - Painless essential DevOps to everyone
 *
 * The version of the OpenAPI document: latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { ApiBaseService } from "../../../services/ApiBaseService";
import { ApiResponse } from "../../../common/ApiResponse";
import { Server } from '../../generated/models';
import { ServerCommand } from '../../generated/models';
import { ServerUpdate } from '../../generated/models';
/**
 * ServersApiService - Auto-generated
 */
export declare class ServersApiService extends ApiBaseService {
    /**
     *
     * @summary Connect a server to devopness platform
     * @param {string} activationToken The server activation token.
     * @param {number} serverId The ID of the server.
     */
    connectServer(activationToken: string, serverId: number): Promise<ApiResponse<string>>;
    /**
     *
     * @summary Delete a given server
     * @param {number} serverId The ID of the server.
     * @param {boolean} [destroyServerDisks] Indicates whether disks associated with a cloud server should be deleted after the server is destroyed
     */
    deleteServer(serverId: number, destroyServerDisks?: boolean): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a server by ID
     * @param {number} serverId The ID of the server.
     */
    getServer(serverId: number): Promise<ApiResponse<Server>>;
    /**
     *
     * @summary Get commands to be executed on the given server
     * @param {number} serverId The ID of the server.
     */
    getServerCommands(serverId: number): Promise<ApiResponse<ServerCommand>>;
    /**
     *
     * @summary Get current status of the server on the cloud provider
     * @param {number} serverId The ID of the server.
     */
    getStatusServer(serverId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Restart a current running server
     * @param {number} serverId The ID of the server.
     */
    restartServer(serverId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Start a previously stopped server
     * @param {number} serverId The ID of the server.
     */
    startServer(serverId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Stop a running server
     * @param {number} serverId The ID of the server.
     */
    stopServer(serverId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Update an existing server
     * @param {number} serverId The ID of the server.
     * @param {ServerUpdate} serverUpdate A JSON object containing the resource data
     */
    updateServer(serverId: number, serverUpdate: ServerUpdate): Promise<ApiResponse<void>>;
}