diff --git a/api.md b/api.md index 2f03370136..b1683150ae 100644 --- a/api.md +++ b/api.md @@ -3,13 +3,13 @@ Types: - AuditLog +- CloudflareTunnel - ErrorData - Identifier - LoadBalancerPreview - PaginationInfo - ResponseInfo - Result -- Tunnel # Accounts diff --git a/src/index.ts b/src/index.ts index a7a86f5f56..7228dad9c7 100644 --- a/src/index.ts +++ b/src/index.ts @@ -550,13 +550,13 @@ export namespace Cloudflare { export import CloudforceOne = API.CloudforceOne; export import AuditLog = API.AuditLog; + export import CloudflareTunnel = API.CloudflareTunnel; export import ErrorData = API.ErrorData; export import Identifier = API.Identifier; export import LoadBalancerPreview = API.LoadBalancerPreview; export import PaginationInfo = API.PaginationInfo; export import ResponseInfo = API.ResponseInfo; export import Result = API.Result; - export import Tunnel = API.Tunnel; } export default Cloudflare; diff --git a/src/resources/shared.ts b/src/resources/shared.ts index 69d5f55a4b..5e5ee7452c 100644 --- a/src/resources/shared.ts +++ b/src/resources/shared.ts @@ -100,87 +100,10 @@ export namespace AuditLog { } } -export interface ErrorData { - code?: number; - - message?: string; -} - -export interface Identifier { - /** - * Identifier - */ - id?: string; -} - -export interface LoadBalancerPreview { - /** - * Monitored pool IDs mapped to their respective names. - */ - pools?: Record; - - preview_id?: string; -} - -export interface PaginationInfo { - /** - * Total number of results for the requested service - */ - count?: number; - - /** - * Current page within paginated list of results - */ - page?: number; - - /** - * Number of results per page of results - */ - per_page?: number; - - /** - * Total results available without any search parameters - */ - total_count?: number; -} - -export interface ResponseInfo { - code: number; - - message: string; -} - -export type Result = Result.UnionMember0 | Result.AaaAPIResponseCommon; - -export namespace Result { - export interface UnionMember0 { - errors?: unknown | null; - - messages?: Array; - - result?: Array; - - success?: boolean; - } - - export interface AaaAPIResponseCommon { - errors: Array; - - messages: Array; - - result: unknown | Array | string; - - /** - * Whether the API call was successful - */ - success: true; - } -} - /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export interface Tunnel { +export interface CloudflareTunnel { /** * UUID of the tunnel. */ @@ -194,7 +117,7 @@ export interface Tunnel { /** * The Cloudflare Tunnel connections between your origin and Cloudflare's edge. */ - connections?: Array; + connections?: Array; /** * Timestamp of when the tunnel established at least one connection to Cloudflare's @@ -249,7 +172,7 @@ export interface Tunnel { tun_type?: 'cfd_tunnel' | 'warp_connector' | 'ip_sec' | 'gre' | 'cni'; } -export namespace Tunnel { +export namespace CloudflareTunnel { export interface Connection { /** * UUID of the Cloudflare Tunnel connection. @@ -296,4 +219,81 @@ export namespace Tunnel { } } +export interface ErrorData { + code?: number; + + message?: string; +} + +export interface Identifier { + /** + * Identifier + */ + id?: string; +} + +export interface LoadBalancerPreview { + /** + * Monitored pool IDs mapped to their respective names. + */ + pools?: Record; + + preview_id?: string; +} + +export interface PaginationInfo { + /** + * Total number of results for the requested service + */ + count?: number; + + /** + * Current page within paginated list of results + */ + page?: number; + + /** + * Number of results per page of results + */ + per_page?: number; + + /** + * Total results available without any search parameters + */ + total_count?: number; +} + +export interface ResponseInfo { + code: number; + + message: string; +} + +export type Result = Result.UnionMember0 | Result.AaaAPIResponseCommon; + +export namespace Result { + export interface UnionMember0 { + errors?: unknown | null; + + messages?: Array; + + result?: Array; + + success?: boolean; + } + + export interface AaaAPIResponseCommon { + errors: Array; + + messages: Array; + + result: unknown | Array | string; + + /** + * Whether the API call was successful + */ + success: true; + } +} + export class AuditLogsV4PagePaginationArray extends V4PagePaginationArray {} diff --git a/src/resources/warp-connector.ts b/src/resources/warp-connector.ts index c0814f9638..95cf571645 100644 --- a/src/resources/warp-connector.ts +++ b/src/resources/warp-connector.ts @@ -111,7 +111,7 @@ export class WARPConnectorListResponsesV4PagePaginationArray extends V4PagePagin * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorCreateResponse = - | Shared.Tunnel + | Shared.CloudflareTunnel | WARPConnectorCreateResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorCreateResponse { @@ -232,7 +232,9 @@ export namespace WARPConnectorCreateResponse { /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export type WARPConnectorListResponse = Shared.Tunnel | WARPConnectorListResponse.TunnelWARPConnectorTunnel; +export type WARPConnectorListResponse = + | Shared.CloudflareTunnel + | WARPConnectorListResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorListResponse { /** @@ -353,7 +355,7 @@ export namespace WARPConnectorListResponse { * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ export type WARPConnectorDeleteResponse = - | Shared.Tunnel + | Shared.CloudflareTunnel | WARPConnectorDeleteResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorDeleteResponse { @@ -474,7 +476,9 @@ export namespace WARPConnectorDeleteResponse { /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export type WARPConnectorEditResponse = Shared.Tunnel | WARPConnectorEditResponse.TunnelWARPConnectorTunnel; +export type WARPConnectorEditResponse = + | Shared.CloudflareTunnel + | WARPConnectorEditResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorEditResponse { /** @@ -594,7 +598,9 @@ export namespace WARPConnectorEditResponse { /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export type WARPConnectorGetResponse = Shared.Tunnel | WARPConnectorGetResponse.TunnelWARPConnectorTunnel; +export type WARPConnectorGetResponse = + | Shared.CloudflareTunnel + | WARPConnectorGetResponse.TunnelWARPConnectorTunnel; export namespace WARPConnectorGetResponse { /** diff --git a/src/resources/zero-trust/tunnels/tunnels.ts b/src/resources/zero-trust/tunnels/tunnels.ts index 86eb91bdea..8381c3ec87 100644 --- a/src/resources/zero-trust/tunnels/tunnels.ts +++ b/src/resources/zero-trust/tunnels/tunnels.ts @@ -149,7 +149,7 @@ export interface TunnelCreateResponse { /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export type TunnelListResponse = Shared.Tunnel | TunnelListResponse.TunnelWARPConnectorTunnel; +export type TunnelListResponse = Shared.CloudflareTunnel | TunnelListResponse.TunnelWARPConnectorTunnel; export namespace TunnelListResponse { /** @@ -297,7 +297,7 @@ export interface TunnelDeleteResponse { /** * A Cloudflare Tunnel that connects your origin to Cloudflare's edge. */ -export type TunnelEditResponse = Shared.Tunnel | TunnelEditResponse.TunnelWARPConnectorTunnel; +export type TunnelEditResponse = Shared.CloudflareTunnel | TunnelEditResponse.TunnelWARPConnectorTunnel; export namespace TunnelEditResponse { /**