cloudflare/resources/zero-trust/networks/virtual-networks.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { SinglePage } from "../../../pagination.js";
export declare class VirtualNetworks extends APIResource {
    /**
     * Adds a new virtual network to an account.
     */
    create(params: VirtualNetworkCreateParams, options?: Core.RequestOptions): Core.APIPromise<VirtualNetwork>;
    /**
     * Lists and filters virtual networks in an account.
     */
    list(params: VirtualNetworkListParams, options?: Core.RequestOptions): Core.PagePromise<VirtualNetworksSinglePage, VirtualNetwork>;
    /**
     * Deletes an existing virtual network.
     */
    delete(virtualNetworkId: string, params: VirtualNetworkDeleteParams, options?: Core.RequestOptions): Core.APIPromise<VirtualNetwork>;
    /**
     * Updates an existing virtual network.
     */
    edit(virtualNetworkId: string, params: VirtualNetworkEditParams, options?: Core.RequestOptions): Core.APIPromise<VirtualNetwork>;
    /**
     * Get a virtual network.
     */
    get(virtualNetworkId: string, params: VirtualNetworkGetParams, options?: Core.RequestOptions): Core.APIPromise<VirtualNetwork>;
}
export declare class VirtualNetworksSinglePage extends SinglePage<VirtualNetwork> {
}
export interface VirtualNetwork {
    /**
     * UUID of the virtual network.
     */
    id: string;
    /**
     * Optional remark describing the virtual network.
     */
    comment: string;
    /**
     * Timestamp of when the resource was created.
     */
    created_at: string;
    /**
     * If `true`, this virtual network is the default for the account.
     */
    is_default_network: boolean;
    /**
     * A user-friendly name for the virtual network.
     */
    name: string;
    /**
     * Timestamp of when the resource was deleted. If `null`, the resource has not been
     * deleted.
     */
    deleted_at?: string;
}
export interface VirtualNetworkCreateParams {
    /**
     * Path param: Cloudflare account ID
     */
    account_id: string;
    /**
     * Body param: A user-friendly name for the virtual network.
     */
    name: string;
    /**
     * Body param: Optional remark describing the virtual network.
     */
    comment?: string;
    /**
     * Body param: If `true`, this virtual network is the default for the account.
     */
    is_default?: boolean;
}
export interface VirtualNetworkListParams {
    /**
     * Path param: Cloudflare account ID
     */
    account_id: string;
    /**
     * Query param: UUID of the virtual network.
     */
    id?: string;
    /**
     * Query param: If `true`, only include the default virtual network. If `false`,
     * exclude the default virtual network. If empty, all virtual networks will be
     * included.
     */
    is_default?: boolean;
    /**
     * Query param: If `true`, only include deleted virtual networks. If `false`,
     * exclude deleted virtual networks. If empty, all virtual networks will be
     * included.
     */
    is_deleted?: boolean;
    /**
     * Query param: A user-friendly name for the virtual network.
     */
    name?: string;
}
export interface VirtualNetworkDeleteParams {
    /**
     * Cloudflare account ID
     */
    account_id: string;
}
export interface VirtualNetworkEditParams {
    /**
     * Path param: Cloudflare account ID
     */
    account_id: string;
    /**
     * Body param: Optional remark describing the virtual network.
     */
    comment?: string;
    /**
     * Body param: If `true`, this virtual network is the default for the account.
     */
    is_default_network?: boolean;
    /**
     * Body param: A user-friendly name for the virtual network.
     */
    name?: string;
}
export interface VirtualNetworkGetParams {
    /**
     * Cloudflare account ID
     */
    account_id: string;
}
export declare namespace VirtualNetworks {
    export { type VirtualNetwork as VirtualNetwork, VirtualNetworksSinglePage as VirtualNetworksSinglePage, type VirtualNetworkCreateParams as VirtualNetworkCreateParams, type VirtualNetworkListParams as VirtualNetworkListParams, type VirtualNetworkDeleteParams as VirtualNetworkDeleteParams, type VirtualNetworkEditParams as VirtualNetworkEditParams, type VirtualNetworkGetParams as VirtualNetworkGetParams, };
}
//# sourceMappingURL=virtual-networks.d.ts.map