cloudflare
Version:
The official TypeScript library for the Cloudflare API
208 lines • 7.04 kB
TypeScript
import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { PagePromise, SinglePage } from "../../../core/pagination.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseNetworks extends APIResource {
static readonly _key: readonly ['zeroTrust', 'devices', 'networks'];
/**
* Creates a new device managed network.
*
* @example
* ```ts
* const deviceNetwork =
* await client.zeroTrust.devices.networks.create({
* account_id: '699d98642c564d2e855e9661899b7252',
* config: { tls_sockaddr: 'foo.bar:1234' },
* name: 'managed-network-1',
* type: 'tls',
* });
* ```
*/
create(params: NetworkCreateParams, options?: RequestOptions): APIPromise<DeviceNetwork | null>;
/**
* Updates a configured device managed network.
*
* @example
* ```ts
* const deviceNetwork =
* await client.zeroTrust.devices.networks.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
update(networkID: string, params: NetworkUpdateParams, options?: RequestOptions): APIPromise<DeviceNetwork | null>;
/**
* Fetches a list of managed networks for an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const deviceNetwork of client.zeroTrust.devices.networks.list(
* { account_id: '699d98642c564d2e855e9661899b7252' },
* )) {
* // ...
* }
* ```
*/
list(params: NetworkListParams, options?: RequestOptions): PagePromise<DeviceNetworksSinglePage, DeviceNetwork>;
/**
* Deletes a device managed network and fetches a list of the remaining device
* managed networks for an account.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const deviceNetwork of client.zeroTrust.devices.networks.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* )) {
* // ...
* }
* ```
*/
delete(networkID: string, params: NetworkDeleteParams, options?: RequestOptions): PagePromise<DeviceNetworksSinglePage, DeviceNetwork>;
/**
* Fetches details for a single managed network.
*
* @example
* ```ts
* const deviceNetwork =
* await client.zeroTrust.devices.networks.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '699d98642c564d2e855e9661899b7252' },
* );
* ```
*/
get(networkID: string, params: NetworkGetParams, options?: RequestOptions): APIPromise<DeviceNetwork | null>;
}
export declare class Networks extends BaseNetworks {
}
export type DeviceNetworksSinglePage = SinglePage<DeviceNetwork>;
export interface DeviceNetwork {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
config?: DeviceNetwork.Config;
/**
* The name of the device managed network. This name must be unique.
*/
name?: string;
/**
* API UUID.
*/
network_id?: string;
/**
* The type of device managed network.
*/
type?: 'tls';
}
export declare namespace DeviceNetwork {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
interface Config {
/**
* A network address of the form "host:port" that the WARP client will use to
* detect the presence of a TLS host.
*/
tls_sockaddr: string;
/**
* The SHA-256 hash of the TLS certificate presented by the host found at
* tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
* timestamp, etc) will be used to validate the certificate.
*/
sha256?: string;
}
}
export interface NetworkCreateParams {
/**
* Path param
*/
account_id: string;
/**
* Body param: The configuration object containing information for the WARP client
* to detect the managed network.
*/
config: NetworkCreateParams.Config;
/**
* Body param: The name of the device managed network. This name must be unique.
*/
name: string;
/**
* Body param: The type of device managed network.
*/
type: 'tls';
}
export declare namespace NetworkCreateParams {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
interface Config {
/**
* A network address of the form "host:port" that the WARP client will use to
* detect the presence of a TLS host.
*/
tls_sockaddr: string;
/**
* The SHA-256 hash of the TLS certificate presented by the host found at
* tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
* timestamp, etc) will be used to validate the certificate.
*/
sha256?: string;
}
}
export interface NetworkUpdateParams {
/**
* Path param
*/
account_id: string;
/**
* Body param: The configuration object containing information for the WARP client
* to detect the managed network.
*/
config?: NetworkUpdateParams.Config;
/**
* Body param: The name of the device managed network. This name must be unique.
*/
name?: string;
/**
* Body param: The type of device managed network.
*/
type?: 'tls';
}
export declare namespace NetworkUpdateParams {
/**
* The configuration object containing information for the WARP client to detect
* the managed network.
*/
interface Config {
/**
* A network address of the form "host:port" that the WARP client will use to
* detect the presence of a TLS host.
*/
tls_sockaddr: string;
/**
* The SHA-256 hash of the TLS certificate presented by the host found at
* tls_sockaddr. If absent, regular certificate verification (trusted roots, valid
* timestamp, etc) will be used to validate the certificate.
*/
sha256?: string;
}
}
export interface NetworkListParams {
account_id: string;
}
export interface NetworkDeleteParams {
account_id: string;
}
export interface NetworkGetParams {
account_id: string;
}
export declare namespace Networks {
export { type DeviceNetwork as DeviceNetwork, type DeviceNetworksSinglePage as DeviceNetworksSinglePage, type NetworkCreateParams as NetworkCreateParams, type NetworkUpdateParams as NetworkUpdateParams, type NetworkListParams as NetworkListParams, type NetworkDeleteParams as NetworkDeleteParams, type NetworkGetParams as NetworkGetParams, };
}
//# sourceMappingURL=networks.d.ts.map