@devopness/sdk-js/dist/api/generated/apis/virtual-hosts-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 { VirtualHost } from '../../generated/models';
import { VirtualHostEnvironmentCreate } from '../../generated/models';
import { VirtualHostGetStatus } from '../../generated/models';
import { VirtualHostRelation } from '../../generated/models';
import { VirtualHostUpdate } from '../../generated/models';
/**
 * VirtualHostsApiService - Auto-generated
 */
export declare class VirtualHostsApiService extends ApiBaseService {
    /**
     *
     * @summary Create a new virtual host
     * @param {number} environmentId The ID of the environment.
     * @param {VirtualHostEnvironmentCreate} virtualHostEnvironmentCreate A JSON object containing the resource data
     */
    addEnvironmentVirtualHost(environmentId: number, virtualHostEnvironmentCreate: VirtualHostEnvironmentCreate): Promise<ApiResponse<VirtualHost>>;
    /**
     *
     * @summary Delete a given virtual host
     * @param {number} virtualHostId The ID of the virtual host.
     */
    deleteVirtualHost(virtualHostId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get current status of a virtual host
     * @param {number} virtualHostId The ID of the virtual host.
     * @param {VirtualHostGetStatus} virtualHostGetStatus A JSON object containing the resource data
     */
    getStatusVirtualHost(virtualHostId: number, virtualHostGetStatus: VirtualHostGetStatus): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a virtual host by ID
     * @param {number} virtualHostId The ID of the virtual host.
     */
    getVirtualHost(virtualHostId: number): Promise<ApiResponse<VirtualHost>>;
    /**
     *
     * @summary Return a list of all Virtual Hosts belonging to an environment
     * @param {number} environmentId The ID of the environment.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listEnvironmentVirtualHosts(environmentId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<VirtualHostRelation>>>;
    /**
     *
     * @summary Update an existing virtual host
     * @param {number} virtualHostId The ID of the virtual host.
     * @param {VirtualHostUpdate} virtualHostUpdate A JSON object containing the resource data
     */
    updateVirtualHost(virtualHostId: number, virtualHostUpdate: VirtualHostUpdate): Promise<ApiResponse<void>>;
}