@devopness/sdk-js/dist/api/generated/apis/networks-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 { Network } from '../../generated/models';
import { NetworkEnvironmentCreate } from '../../generated/models';
import { NetworkRelation } from '../../generated/models';
import { NetworkUpdate } from '../../generated/models';
/**
 * NetworksApiService - Auto-generated
 */
export declare class NetworksApiService extends ApiBaseService {
    /**
     *
     * @summary Create a new network for the given environment
     * @param {number} environmentId The ID of the environment.
     * @param {NetworkEnvironmentCreate} networkEnvironmentCreate A JSON object containing the resource data
     */
    addEnvironmentNetwork(environmentId: number, networkEnvironmentCreate: NetworkEnvironmentCreate): Promise<ApiResponse<Network>>;
    /**
     *
     * @summary Delete a given network
     * @param {number} networkId The ID of the network.
     */
    deleteNetwork(networkId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a network by ID
     * @param {number} networkId The ID of the network.
     */
    getNetwork(networkId: number): Promise<ApiResponse<Network>>;
    /**
     *
     * @summary Get current status of a network
     * @param {number} networkId The ID of the network.
     */
    getStatusNetwork(networkId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Return a list of all networks 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
     * @param {boolean} [includeDefaultNetwork] If true, include a \&#39;default\&#39; network in the list.
     * @param {string} [providerName] Filter by network\&#39;s cloud provider.
     * @param {string} [region] Filter by network\&#39;s region.
     */
    listEnvironmentNetworks(environmentId: number, page?: number, perPage?: number, includeDefaultNetwork?: boolean, providerName?: string, region?: string): Promise<ApiResponse<Array<NetworkRelation>>>;
    /**
     *
     * @summary Update an existing Network
     * @param {number} networkId The ID of the network.
     * @param {NetworkUpdate} networkUpdate A JSON object containing the resource data
     */
    updateNetwork(networkId: number, networkUpdate: NetworkUpdate): Promise<ApiResponse<void>>;
}