// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../../resource'; import * as Core from '../../../../core'; import * as Shared from '../../../shared'; import * as TokenAPI from './token'; import { Token, TokenGetParams, TokenGetResponse } from './token'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../../pagination'; export class WARPConnector extends APIResource { token: TokenAPI.Token = new TokenAPI.Token(this._client); /** * Creates a new Warp Connector Tunnel in an account. */ create( params: WARPConnectorCreateParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/warp_connector`, { body, ...options }) as Core.APIPromise<{ result: WARPConnectorCreateResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Lists and filters Warp Connector Tunnels in an account. */ list( params: WARPConnectorListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id, ...query } = params; return this._client.getAPIList( `/accounts/${account_id}/warp_connector`, WARPConnectorListResponsesV4PagePaginationArray, { query, ...options }, ); } /** * Deletes a Warp Connector Tunnel from an account. */ delete( tunnelId: string, params: WARPConnectorDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.delete(`/accounts/${account_id}/warp_connector/${tunnelId}`, options) as Core.APIPromise<{ result: WARPConnectorDeleteResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Updates an existing Warp Connector Tunnel. */ edit( tunnelId: string, params: WARPConnectorEditParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.patch(`/accounts/${account_id}/warp_connector/${tunnelId}`, { body, ...options, }) as Core.APIPromise<{ result: WARPConnectorEditResponse }> )._thenUnwrap((obj) => obj.result); } /** * Fetches a single Warp Connector Tunnel. */ get( tunnelId: string, params: WARPConnectorGetParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.get(`/accounts/${account_id}/warp_connector/${tunnelId}`, options) as Core.APIPromise<{ result: WARPConnectorGetResponse; }> )._thenUnwrap((obj) => obj.result); } } export class WARPConnectorListResponsesV4PagePaginationArray extends V4PagePaginationArray {} /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorCreateResponse = | Shared.CloudflareTunnel | WARPConnectorCreateResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorCreateResponse { /** * A Warp Connector Tunnel that connects your origin to Cloudflare's edge. */ export interface TunnelWARPConnectorTunnel { /** * UUID of the tunnel. */ id?: string; /** * Cloudflare account ID */ account_tag?: string; /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's * edge. If `null`, the tunnel is inactive. */ conns_active_at?: string; /** * Timestamp of when the tunnel became inactive (no connections to Cloudflare's * edge). If `null`, the tunnel is active. */ conns_inactive_at?: string; /** * Timestamp of when the resource was created. */ created_at?: string; /** * Timestamp of when the resource was deleted. If `null`, the resource has not been * deleted. */ deleted_at?: string; /** * Metadata associated with the tunnel. */ metadata?: unknown; /** * A user-friendly name for a tunnel. */ name?: string; /** * The status of the tunnel. Valid values are `inactive` (tunnel has never been * run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy * state), `healthy` (tunnel is active and able to serve traffic), or `down` * (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * The type of tunnel. */ tun_type?: 'cfd_tunnel' | 'warp_connector' | 'warp' | 'magic' | 'ip_sec' | 'gre' | 'cni'; } export namespace TunnelWARPConnectorTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. */ id?: string; /** * UUID of the Cloudflare Tunnel connector. */ client_id?: string; /** * The cloudflared version used to establish this connection. */ client_version?: string; /** * The Cloudflare data center used for this connection. */ colo_name?: string; /** * Cloudflare continues to track connections for several minutes after they * disconnect. This is an optimization to improve latency and reliability of * reconnecting. If `true`, the connection has disconnected but is still being * tracked. If `false`, the connection is actively serving traffic. */ is_pending_reconnect?: boolean; /** * Timestamp of when the connection was established. */ opened_at?: string; /** * The public IP address of the host running cloudflared. */ origin_ip?: string; /** * UUID of the Cloudflare Tunnel connection. */ uuid?: string; } } } /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorListResponse = | Shared.CloudflareTunnel | WARPConnectorListResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorListResponse { /** * A Warp Connector Tunnel that connects your origin to Cloudflare's edge. */ export interface TunnelWARPConnectorTunnel { /** * UUID of the tunnel. */ id?: string; /** * Cloudflare account ID */ account_tag?: string; /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's * edge. If `null`, the tunnel is inactive. */ conns_active_at?: string; /** * Timestamp of when the tunnel became inactive (no connections to Cloudflare's * edge). If `null`, the tunnel is active. */ conns_inactive_at?: string; /** * Timestamp of when the resource was created. */ created_at?: string; /** * Timestamp of when the resource was deleted. If `null`, the resource has not been * deleted. */ deleted_at?: string; /** * Metadata associated with the tunnel. */ metadata?: unknown; /** * A user-friendly name for a tunnel. */ name?: string; /** * The status of the tunnel. Valid values are `inactive` (tunnel has never been * run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy * state), `healthy` (tunnel is active and able to serve traffic), or `down` * (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * The type of tunnel. */ tun_type?: 'cfd_tunnel' | 'warp_connector' | 'warp' | 'magic' | 'ip_sec' | 'gre' | 'cni'; } export namespace TunnelWARPConnectorTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. */ id?: string; /** * UUID of the Cloudflare Tunnel connector. */ client_id?: string; /** * The cloudflared version used to establish this connection. */ client_version?: string; /** * The Cloudflare data center used for this connection. */ colo_name?: string; /** * Cloudflare continues to track connections for several minutes after they * disconnect. This is an optimization to improve latency and reliability of * reconnecting. If `true`, the connection has disconnected but is still being * tracked. If `false`, the connection is actively serving traffic. */ is_pending_reconnect?: boolean; /** * Timestamp of when the connection was established. */ opened_at?: string; /** * The public IP address of the host running cloudflared. */ origin_ip?: string; /** * UUID of the Cloudflare Tunnel connection. */ uuid?: string; } } } /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorDeleteResponse = | Shared.CloudflareTunnel | WARPConnectorDeleteResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorDeleteResponse { /** * A Warp Connector Tunnel that connects your origin to Cloudflare's edge. */ export interface TunnelWARPConnectorTunnel { /** * UUID of the tunnel. */ id?: string; /** * Cloudflare account ID */ account_tag?: string; /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's * edge. If `null`, the tunnel is inactive. */ conns_active_at?: string; /** * Timestamp of when the tunnel became inactive (no connections to Cloudflare's * edge). If `null`, the tunnel is active. */ conns_inactive_at?: string; /** * Timestamp of when the resource was created. */ created_at?: string; /** * Timestamp of when the resource was deleted. If `null`, the resource has not been * deleted. */ deleted_at?: string; /** * Metadata associated with the tunnel. */ metadata?: unknown; /** * A user-friendly name for a tunnel. */ name?: string; /** * The status of the tunnel. Valid values are `inactive` (tunnel has never been * run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy * state), `healthy` (tunnel is active and able to serve traffic), or `down` * (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * The type of tunnel. */ tun_type?: 'cfd_tunnel' | 'warp_connector' | 'warp' | 'magic' | 'ip_sec' | 'gre' | 'cni'; } export namespace TunnelWARPConnectorTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. */ id?: string; /** * UUID of the Cloudflare Tunnel connector. */ client_id?: string; /** * The cloudflared version used to establish this connection. */ client_version?: string; /** * The Cloudflare data center used for this connection. */ colo_name?: string; /** * Cloudflare continues to track connections for several minutes after they * disconnect. This is an optimization to improve latency and reliability of * reconnecting. If `true`, the connection has disconnected but is still being * tracked. If `false`, the connection is actively serving traffic. */ is_pending_reconnect?: boolean; /** * Timestamp of when the connection was established. */ opened_at?: string; /** * The public IP address of the host running cloudflared. */ origin_ip?: string; /** * UUID of the Cloudflare Tunnel connection. */ uuid?: string; } } } /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorEditResponse = | Shared.CloudflareTunnel | WARPConnectorEditResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorEditResponse { /** * A Warp Connector Tunnel that connects your origin to Cloudflare's edge. */ export interface TunnelWARPConnectorTunnel { /** * UUID of the tunnel. */ id?: string; /** * Cloudflare account ID */ account_tag?: string; /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's * edge. If `null`, the tunnel is inactive. */ conns_active_at?: string; /** * Timestamp of when the tunnel became inactive (no connections to Cloudflare's * edge). If `null`, the tunnel is active. */ conns_inactive_at?: string; /** * Timestamp of when the resource was created. */ created_at?: string; /** * Timestamp of when the resource was deleted. If `null`, the resource has not been * deleted. */ deleted_at?: string; /** * Metadata associated with the tunnel. */ metadata?: unknown; /** * A user-friendly name for a tunnel. */ name?: string; /** * The status of the tunnel. Valid values are `inactive` (tunnel has never been * run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy * state), `healthy` (tunnel is active and able to serve traffic), or `down` * (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * The type of tunnel. */ tun_type?: 'cfd_tunnel' | 'warp_connector' | 'warp' | 'magic' | 'ip_sec' | 'gre' | 'cni'; } export namespace TunnelWARPConnectorTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. */ id?: string; /** * UUID of the Cloudflare Tunnel connector. */ client_id?: string; /** * The cloudflared version used to establish this connection. */ client_version?: string; /** * The Cloudflare data center used for this connection. */ colo_name?: string; /** * Cloudflare continues to track connections for several minutes after they * disconnect. This is an optimization to improve latency and reliability of * reconnecting. If `true`, the connection has disconnected but is still being * tracked. If `false`, the connection is actively serving traffic. */ is_pending_reconnect?: boolean; /** * Timestamp of when the connection was established. */ opened_at?: string; /** * The public IP address of the host running cloudflared. */ origin_ip?: string; /** * UUID of the Cloudflare Tunnel connection. */ uuid?: string; } } } /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorGetResponse = | Shared.CloudflareTunnel | WARPConnectorGetResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorGetResponse { /** * A Warp Connector Tunnel that connects your origin to Cloudflare's edge. */ export interface TunnelWARPConnectorTunnel { /** * UUID of the tunnel. */ id?: string; /** * Cloudflare account ID */ account_tag?: string; /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's * edge. If `null`, the tunnel is inactive. */ conns_active_at?: string; /** * Timestamp of when the tunnel became inactive (no connections to Cloudflare's * edge). If `null`, the tunnel is active. */ conns_inactive_at?: string; /** * Timestamp of when the resource was created. */ created_at?: string; /** * Timestamp of when the resource was deleted. If `null`, the resource has not been * deleted. */ deleted_at?: string; /** * Metadata associated with the tunnel. */ metadata?: unknown; /** * A user-friendly name for a tunnel. */ name?: string; /** * The status of the tunnel. Valid values are `inactive` (tunnel has never been * run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy * state), `healthy` (tunnel is active and able to serve traffic), or `down` * (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * The type of tunnel. */ tun_type?: 'cfd_tunnel' | 'warp_connector' | 'warp' | 'magic' | 'ip_sec' | 'gre' | 'cni'; } export namespace TunnelWARPConnectorTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. */ id?: string; /** * UUID of the Cloudflare Tunnel connector. */ client_id?: string; /** * The cloudflared version used to establish this connection. */ client_version?: string; /** * The Cloudflare data center used for this connection. */ colo_name?: string; /** * Cloudflare continues to track connections for several minutes after they * disconnect. This is an optimization to improve latency and reliability of * reconnecting. If `true`, the connection has disconnected but is still being * tracked. If `false`, the connection is actively serving traffic. */ is_pending_reconnect?: boolean; /** * Timestamp of when the connection was established. */ opened_at?: string; /** * The public IP address of the host running cloudflared. */ origin_ip?: string; /** * UUID of the Cloudflare Tunnel connection. */ uuid?: string; } } } export interface WARPConnectorCreateParams { /** * Path param: Cloudflare account ID */ account_id: string; /** * Body param: A user-friendly name for a tunnel. */ name: string; } export interface WARPConnectorListParams extends V4PagePaginationArrayParams { /** * Path param: Cloudflare account ID */ account_id: string; /** * Query param: */ exclude_prefix?: string; /** * Query param: If provided, include only resources that were created (and not * deleted) before this time. URL encoded. */ existed_at?: string; /** * Query param: */ include_prefix?: string; /** * Query param: If `true`, only include deleted tunnels. If `false`, exclude * deleted tunnels. If empty, all tunnels will be included. */ is_deleted?: boolean; /** * Query param: A user-friendly name for the tunnel. */ name?: string; /** * Query param: The status of the tunnel. Valid values are `inactive` (tunnel has * never been run), `degraded` (tunnel is active and able to serve traffic but in * an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or * `down` (tunnel can not serve traffic as it has no connections to the Cloudflare * Edge). */ status?: 'inactive' | 'degraded' | 'healthy' | 'down'; /** * Query param: UUID of the tunnel. */ uuid?: string; /** * Query param: */ was_active_at?: string; /** * Query param: */ was_inactive_at?: string; } export interface WARPConnectorDeleteParams { /** * Cloudflare account ID */ account_id: string; } export interface WARPConnectorEditParams { /** * Path param: Cloudflare account ID */ account_id: string; /** * Body param: A user-friendly name for a tunnel. */ name?: string; /** * Body param: Sets the password required to run a locally-managed tunnel. Must be * at least 32 bytes and encoded as a base64 string. */ tunnel_secret?: string; } export interface WARPConnectorGetParams { /** * Cloudflare account ID */ account_id: string; } WARPConnector.WARPConnectorListResponsesV4PagePaginationArray = WARPConnectorListResponsesV4PagePaginationArray; WARPConnector.Token = Token; export declare namespace WARPConnector { export { type WARPConnectorCreateResponse as WARPConnectorCreateResponse, type WARPConnectorListResponse as WARPConnectorListResponse, type WARPConnectorDeleteResponse as WARPConnectorDeleteResponse, type WARPConnectorEditResponse as WARPConnectorEditResponse, type WARPConnectorGetResponse as WARPConnectorGetResponse, WARPConnectorListResponsesV4PagePaginationArray as WARPConnectorListResponsesV4PagePaginationArray, type WARPConnectorCreateParams as WARPConnectorCreateParams, type WARPConnectorListParams as WARPConnectorListParams, type WARPConnectorDeleteParams as WARPConnectorDeleteParams, type WARPConnectorEditParams as WARPConnectorEditParams, type WARPConnectorGetParams as WARPConnectorGetParams, }; export { Token as Token, type TokenGetResponse as TokenGetResponse, type TokenGetParams as TokenGetParams }; }