@ngrok/ngrok-api 0.3.0 → 0.9.0

package/src/datatypes.ts

@@ -139,6 +139,188 @@ export interface APIKeyList {
   nextPageUri?: string;
 }
 
+export interface FailoverBackend {
+  /** unique identifier for this Failover backend */
+  id: string;
+  /** URI of the FailoverBackend API resource */
+  uri: string;
+  /** timestamp when the backend was created, RFC 3339 format */
+  createdAt: string;
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** the ids of the child backends in order */
+  backends: Array<string>;
+}
+
+export interface FailoverBackendCreate {
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** the ids of the child backends in order */
+  backends: Array<string>;
+}
+
+export interface FailoverBackendUpdate {
+  id: string;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** the ids of the child backends in order */
+  backends: Array<string>;
+}
+
+export interface FailoverBackendList {
+  /** the list of all Failover backends on this account */
+  backends: Array<FailoverBackend>;
+  /** URI of the Failover backends list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
+export interface HTTPResponseBackend {
+  id: string;
+  /** URI of the HTTPResponseBackend API resource */
+  uri: string;
+  /** timestamp when the backend was created, RFC 3339 format */
+  createdAt: string;
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** body to return as fixed content */
+  body: string;
+  /** headers to return */
+  headers: Map<string, string>;
+  /** status code to return */
+  statusCode: number;
+}
+
+export interface HTTPResponseBackendCreate {
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** body to return as fixed content */
+  body: string;
+  /** headers to return */
+  headers: Map<string, string>;
+  /** status code to return */
+  statusCode?: number;
+}
+
+export interface HTTPResponseBackendUpdate {
+  id: string;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** body to return as fixed content */
+  body?: string;
+  /** headers to return */
+  headers?: Map<string, string>;
+  /** status code to return */
+  statusCode?: number;
+}
+
+export interface HTTPResponseBackendList {
+  backends: Array<HTTPResponseBackend>;
+  uri: string;
+  nextPageUri?: string;
+}
+
+export interface TunnelGroupBackend {
+  /** unique identifier for this TunnelGroup backend */
+  id: string;
+  /** URI of the TunnelGroupBackend API resource */
+  uri: string;
+  /** timestamp when the backend was created, RFC 3339 format */
+  createdAt: string;
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** labels to watch for tunnels on, e.g. app->foo, dc->bar */
+  labels: Map<string, string>;
+  /** tunnels matching this backend */
+  tunnels: Array<Ref>;
+}
+
+export interface TunnelGroupBackendCreate {
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** labels to watch for tunnels on, e.g. app->foo, dc->bar */
+  labels: Map<string, string>;
+}
+
+export interface TunnelGroupBackendUpdate {
+  id: string;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** labels to watch for tunnels on, e.g. app->foo, dc->bar */
+  labels: Map<string, string>;
+}
+
+export interface TunnelGroupBackendList {
+  /** the list of all TunnelGroup backends on this account */
+  backends: Array<TunnelGroupBackend>;
+  /** URI of the TunnelGroup backends list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
+export interface WeightedBackend {
+  /** unique identifier for this Weighted backend */
+  id: string;
+  /** URI of the WeightedBackend API resource */
+  uri: string;
+  /** timestamp when the backend was created, RFC 3339 format */
+  createdAt: string;
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** the ids of the child backends to their weights [0-10000] */
+  backends: Map<string, number>;
+}
+
+export interface WeightedBackendCreate {
+  /** human-readable description of this backend. Optional */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata: string;
+  /** the ids of the child backends to their weights [0-10000] */
+  backends: Map<string, number>;
+}
+
+export interface WeightedBackendUpdate {
+  id: string;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** the ids of the child backends to their weights [0-10000] */
+  backends: Map<string, number>;
+}
+
+export interface WeightedBackendList {
+  /** the list of all Weighted backends on this account */
+  backends: Array<WeightedBackend>;
+  /** URI of the Weighted backends list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
 export interface CertificateAuthorityCreate {
   /** human-readable description of this Certificate Authority. optional, max 255 bytes. */
   description: string;
@@ -220,7 +402,7 @@ export interface Credential {
   description: string;
   /** arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes. */
   metadata: string;
-  /** the credential's authtoken that can be used to authenticate an ngrok client. **This value is only available one time, on the API response from credential creation, otherwise it is null.** */
+  /** the credential's authtoken that can be used to authenticate an ngrok agent. **This value is only available one time, on the API response from credential creation, otherwise it is null.** */
   token?: string;
   /** optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the `bind` rule. The `bind` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule `bind:example.ngrok.io`. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of `bind:*.example.com` which will allow `x.example.com`, `y.example.com`, `*.example.com`, etc. A rule of `'*'` is equivalent to no acl at all and will explicitly permit all actions. */
   acl: Array<string>;
@@ -235,124 +417,10 @@ export interface CredentialList {
   nextPageUri?: string;
 }
 
-export interface EndpointConfiguration {
-  /** unique identifier of this endpoint configuration */
-  id: string;
-  /** they type of traffic this endpoint configuration can be applied to. one of: `http`, `https`, `tcp` */
-  type: string;
-  /** human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes */
-  description: string;
-  /** arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes. */
-  metadata: string;
-  /** timestamp when the endpoint configuration was created, RFC 3339 format */
-  createdAt: string;
-  /** URI of the endpoint configuration API resource */
-  uri: string;
-  /** circuit breaker module configuration or `null` */
-  circuitBreaker?: EndpointCircuitBreaker;
-  /** compression module configuration or `null` */
-  compression?: EndpointCompression;
-  /** request headers module configuration or `null` */
-  requestHeaders?: EndpointRequestHeaders;
-  /** response headers module configuration or `null` */
-  responseHeaders?: EndpointResponseHeaders;
-  /** ip policy module configuration or `null` */
-  ipPolicy?: EndpointIPPolicy;
-  /** mutual TLS module configuration or `null` */
-  mutualTls?: EndpointMutualTLS;
-  /** TLS termination module configuration or `null` */
-  tlsTermination?: EndpointTLSTermination;
-  /** webhook validation module configuration or `null` */
-  webhookValidation?: EndpointWebhookValidation;
-  /** oauth module configuration or `null` */
-  oauth?: EndpointOAuth;
-  /** logging module configuration or `null` */
-  logging?: EndpointLogging;
-  /** saml module configuration or `null` */
-  saml?: EndpointSAML;
-  /** oidc module configuration or `null` */
-  oidc?: EndpointOIDC;
-}
-
-export interface EndpointConfigurationList {
-  /** the list of all endpoint configurations on this account */
-  endpointConfigurations: Array<EndpointConfiguration>;
-  /** URI of the endpoint configurations list API resource */
-  uri: string;
-  /** URI of the next page, or null if there is no next page */
-  nextPageUri?: string;
-}
-
-export interface EndpointConfigurationUpdate {
-  /** unique identifier of this endpoint configuration */
-  id: string;
-  /** human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes */
-  description?: string;
-  /** arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes. */
-  metadata?: string;
-  /** circuit breaker module configuration or `null` */
-  circuitBreaker?: EndpointCircuitBreaker;
-  /** compression module configuration or `null` */
-  compression?: EndpointCompression;
-  /** request headers module configuration or `null` */
-  requestHeaders?: EndpointRequestHeaders;
-  /** response headers module configuration or `null` */
-  responseHeaders?: EndpointResponseHeaders;
-  /** ip policy module configuration or `null` */
-  ipPolicy?: EndpointIPPolicyMutate;
-  /** mutual TLS module configuration or `null` */
-  mutualTls?: EndpointMutualTLSMutate;
-  /** TLS termination module configuration or `null` */
-  tlsTermination?: EndpointTLSTermination;
-  /** webhook validation module configuration or `null` */
-  webhookValidation?: EndpointWebhookValidation;
-  /** oauth module configuration or `null` */
-  oauth?: EndpointOAuth;
-  /** logging module configuration or `null` */
-  logging?: EndpointLoggingMutate;
-  /** saml module configuration or `null` */
-  saml?: EndpointSAMLMutate;
-  /** oidc module configuration or `null` */
-  oidc?: EndpointOIDC;
-}
-
-export interface EndpointConfigurationCreate {
-  /** they type of traffic this endpoint configuration can be applied to. one of: `http`, `https`, `tcp` */
-  type: string;
-  /** human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes */
-  description: string;
-  /** arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes. */
-  metadata: string;
-  /** circuit breaker module configuration or `null` */
-  circuitBreaker?: EndpointCircuitBreaker;
-  /** compression module configuration or `null` */
-  compression?: EndpointCompression;
-  /** request headers module configuration or `null` */
-  requestHeaders?: EndpointRequestHeaders;
-  /** response headers module configuration or `null` */
-  responseHeaders?: EndpointResponseHeaders;
-  /** ip policy module configuration or `null` */
-  ipPolicy?: EndpointIPPolicyMutate;
-  /** mutual TLS module configuration or `null` */
-  mutualTls?: EndpointMutualTLSMutate;
-  /** TLS termination module configuration or `null` */
-  tlsTermination?: EndpointTLSTermination;
-  /** webhook validation module configuration or `null` */
-  webhookValidation?: EndpointWebhookValidation;
-  /** oauth module configuration or `null` */
-  oauth?: EndpointOAuth;
-  /** logging module configuration or `null` */
-  logging?: EndpointLoggingMutate;
-  /** saml module configuration or `null` */
-  saml?: EndpointSAMLMutate;
-  /** oidc module configuration or `null` */
-  oidc?: EndpointOIDC;
-}
-
 export interface EndpointWebhookValidation {
   /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
   enabled?: boolean;
-  /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: `SLACK`, `SNS`, `STRIPE`, `GITHUB`, `TWILIO`, `SHOPIFY`, `GITLAB`, `INTERCOM`, `SENDGRID`, `XERO`. */
+  /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: `SLACK`, `SNS`, `STRIPE`, `GITHUB`, `TWILIO`, `SHOPIFY`, `GITLAB`, `INTERCOM`, `SENDGRID`, `XERO`, `PAGERDUTY`. */
   provider: string;
   /** a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret */
   secret: string;
@@ -373,7 +441,7 @@ export interface EndpointMutualTLS {
 export interface EndpointMutualTLSMutate {
   /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
   enabled?: boolean;
-  /** list of certificate authorities that will be used to validate the TLS client certificate presnted by the initiatiator of the TLS connection */
+  /** list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection */
   certificateAuthorityIds: Array<string>;
 }
 
@@ -386,18 +454,11 @@ export interface EndpointTLSTermination {
   minVersion?: string;
 }
 
-export interface EndpointLogging {
-  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
-  enabled?: boolean;
-  /** list of all EventStreams that will be used to configure and export this endpoint's logs */
-  eventStreams: Array<Ref>;
-}
-
-export interface EndpointLoggingMutate {
+export interface EndpointTLSTerminationAtEdge {
   /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
   enabled?: boolean;
-  /** list of all EventStreams that will be used to configure and export this endpoint's logs */
-  eventStreamIds: Array<string>;
+  /** The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if `terminate_at` is set to `upstream`. */
+  minVersion?: string;
 }
 
 export interface EndpointRequestHeaders {
@@ -607,64 +668,439 @@ export interface EndpointOIDC {
   scopes: Array<string>;
 }
 
-export interface EventStreamCreate {
-  /** Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes. */
+export interface EndpointBackend {
+  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
+  enabled?: boolean;
+  /** backend to be used to back this endpoint */
+  backend: Ref;
+}
+
+export interface EndpointBackendMutate {
+  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
+  enabled?: boolean;
+  /** backend to be used to back this endpoint */
+  backendId: string;
+}
+
+export interface EndpointWebsocketTCPConverter {
+  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
+  enabled?: boolean;
+}
+
+export interface EdgeRouteItem {
+  /** unique identifier of this edge */
+  edgeId: string;
+  /** unique identifier of this edge route */
+  id: string;
+}
+
+export interface HTTPSEdgeRouteCreate {
+  /** unique identifier of this edge */
+  edgeId: string;
+  /** Type of match to use for this route. Valid values are "exact_path" and "path_prefix". */
+  matchType: string;
+  /** Route selector: "/blog" or "example.com" or "example.com/blog" */
+  match: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
   metadata: string;
-  /** Human-readable description of the Event Stream. Optional, max 255 bytes. */
+  /** backend module configuration or `null` */
+  backend?: EndpointBackendMutate;
+  /** ip restriction module configuration or `null` */
+  ipRestriction?: EndpointIPPolicyMutate;
+  /** circuit breaker module configuration or `null` */
+  circuitBreaker?: EndpointCircuitBreaker;
+  /** compression module configuration or `null` */
+  compression?: EndpointCompression;
+  /** request headers module configuration or `null` */
+  requestHeaders?: EndpointRequestHeaders;
+  /** response headers module configuration or `null` */
+  responseHeaders?: EndpointResponseHeaders;
+  /** webhook verification module configuration or `null` */
+  webhookVerification?: EndpointWebhookValidation;
+  /** oauth module configuration or `null` */
+  oauth?: EndpointOAuth;
+  /** saml module configuration or `null` */
+  saml?: EndpointSAMLMutate;
+  /** oidc module configuration or `null` */
+  oidc?: EndpointOIDC;
+  /** websocket to tcp adapter configuration or `null` */
+  websocketTcpConverter?: EndpointWebsocketTCPConverter;
+}
+
+export interface HTTPSEdgeRouteUpdate {
+  /** unique identifier of this edge */
+  edgeId: string;
+  /** unique identifier of this edge route */
+  id: string;
+  /** Type of match to use for this route. Valid values are "exact_path" and "path_prefix". */
+  matchType: string;
+  /** Route selector: "/blog" or "example.com" or "example.com/blog" */
+  match: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
   description: string;
-  /** A list of protocol-specific fields you want to collect on each event. */
-  fields: Array<string>;
-  /** The protocol that determines which events will be collected. Supported values are `tcp_connection_closed` and `http_request_complete`. */
-  eventType: string;
-  /** A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination. */
-  destinationIds: Array<string>;
-  /** The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events. */
-  samplingRate: number;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** backend module configuration or `null` */
+  backend?: EndpointBackendMutate;
+  /** ip restriction module configuration or `null` */
+  ipRestriction?: EndpointIPPolicyMutate;
+  /** circuit breaker module configuration or `null` */
+  circuitBreaker?: EndpointCircuitBreaker;
+  /** compression module configuration or `null` */
+  compression?: EndpointCompression;
+  /** request headers module configuration or `null` */
+  requestHeaders?: EndpointRequestHeaders;
+  /** response headers module configuration or `null` */
+  responseHeaders?: EndpointResponseHeaders;
+  /** webhook verification module configuration or `null` */
+  webhookVerification?: EndpointWebhookValidation;
+  /** oauth module configuration or `null` */
+  oauth?: EndpointOAuth;
+  /** saml module configuration or `null` */
+  saml?: EndpointSAMLMutate;
+  /** oidc module configuration or `null` */
+  oidc?: EndpointOIDC;
+  /** websocket to tcp adapter configuration or `null` */
+  websocketTcpConverter?: EndpointWebsocketTCPConverter;
+}
+
+export interface HTTPSEdgeRoute {
+  /** unique identifier of this edge */
+  edgeId: string;
+  /** unique identifier of this edge route */
+  id: string;
+  /** timestamp when the edge configuration was created, RFC 3339 format */
+  createdAt: string;
+  /** Type of match to use for this route. Valid values are "exact_path" and "path_prefix". */
+  matchType: string;
+  /** Route selector: "/blog" or "example.com" or "example.com/blog" */
+  match: string;
+  /** URI of the edge API resource */
+  uri: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** backend module configuration or `null` */
+  backend?: EndpointBackend;
+  /** ip restriction module configuration or `null` */
+  ipRestriction?: EndpointIPPolicy;
+  /** circuit breaker module configuration or `null` */
+  circuitBreaker?: EndpointCircuitBreaker;
+  /** compression module configuration or `null` */
+  compression?: EndpointCompression;
+  /** request headers module configuration or `null` */
+  requestHeaders?: EndpointRequestHeaders;
+  /** response headers module configuration or `null` */
+  responseHeaders?: EndpointResponseHeaders;
+  /** webhook verification module configuration or `null` */
+  webhookVerification?: EndpointWebhookValidation;
+  /** oauth module configuration or `null` */
+  oauth?: EndpointOAuth;
+  /** saml module configuration or `null` */
+  saml?: EndpointSAML;
+  /** oidc module configuration or `null` */
+  oidc?: EndpointOIDC;
+  /** websocket to tcp adapter configuration or `null` */
+  websocketTcpConverter?: EndpointWebsocketTCPConverter;
+}
+
+export interface HTTPSEdgeList {
+  /** the list of all HTTPS Edges on this account */
+  httpsEdges: Array<HTTPSEdge>;
+  /** URI of the HTTPS Edge list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
+export interface HTTPSEdgeCreate {
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes. */
+  metadata: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  mutualTls?: EndpointMutualTLSMutate;
+  tlsTermination?: EndpointTLSTerminationAtEdge;
 }
 
-export interface EventStreamUpdate {
-  /** Unique identifier for this Event Stream. */
+export interface HTTPSEdgeUpdate {
+  /** unique identifier of this edge */
   id: string;
-  /** Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes. */
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes. */
   metadata?: string;
-  /** Human-readable description of the Event Stream. Optional, max 255 bytes. */
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  mutualTls?: EndpointMutualTLSMutate;
+  tlsTermination?: EndpointTLSTerminationAtEdge;
+}
+
+export interface HTTPSEdge {
+  /** unique identifier of this edge */
+  id: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes. */
+  metadata: string;
+  /** timestamp when the edge configuration was created, RFC 3339 format */
+  createdAt: string;
+  /** URI of the edge API resource */
+  uri: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  mutualTls?: EndpointMutualTLS;
+  tlsTermination?: EndpointTLSTermination;
+  /** routes */
+  routes: Array<HTTPSEdgeRoute>;
+}
+
+export interface EdgeBackendReplace {
+  id: string;
+  module: EndpointBackendMutate;
+}
+
+export interface EdgeIPRestrictionReplace {
+  id: string;
+  module: EndpointIPPolicyMutate;
+}
+
+export interface EdgeMutualTLSReplace {
+  id: string;
+  module: EndpointMutualTLSMutate;
+}
+
+export interface EdgeTLSTerminationReplace {
+  id: string;
+  module: EndpointTLSTermination;
+}
+
+export interface EdgeTLSTerminationAtEdgeReplace {
+  id: string;
+  module: EndpointTLSTerminationAtEdge;
+}
+
+export interface EdgeRouteBackendReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointBackendMutate;
+}
+
+export interface EdgeRouteIPRestrictionReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointIPPolicyMutate;
+}
+
+export interface EdgeRouteRequestHeadersReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointRequestHeaders;
+}
+
+export interface EdgeRouteResponseHeadersReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointResponseHeaders;
+}
+
+export interface EdgeRouteCompressionReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointCompression;
+}
+
+export interface EdgeRouteCircuitBreakerReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointCircuitBreaker;
+}
+
+export interface EdgeRouteWebhookVerificationReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointWebhookValidation;
+}
+
+export interface EdgeRouteOAuthReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointOAuth;
+}
+
+export interface EdgeRouteSAMLReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointSAMLMutate;
+}
+
+export interface EdgeRouteOIDCReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointOIDC;
+}
+
+export interface EdgeRouteWebsocketTCPConverterReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointWebsocketTCPConverter;
+}
+
+export interface TCPEdgeList {
+  /** the list of all TCP Edges on this account */
+  tcpEdges: Array<TCPEdge>;
+  /** URI of the TCP Edge list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
+export interface TCPEdgeCreate {
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackendMutate;
+  ipRestriction?: EndpointIPPolicyMutate;
+}
+
+export interface TCPEdgeUpdate {
+  /** unique identifier of this edge */
+  id: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
   description?: string;
-  /** A list of protocol-specific fields you want to collect on each event. */
-  fields?: Array<string>;
-  /** A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination. */
-  destinationIds?: Array<string>;
-  /** The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events. */
-  samplingRate?: number;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata?: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackendMutate;
+  ipRestriction?: EndpointIPPolicyMutate;
 }
 
-export interface EventStreamList {
-  /** The list of all Event Streams on this account. */
-  eventStreams: Array<EventStream>;
-  /** URI of the Event Stream list API resource. */
+export interface TCPEdge {
+  /** unique identifier of this edge */
+  id: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** timestamp when the edge was created, RFC 3339 format */
+  createdAt: string;
+  /** URI of the edge API resource */
   uri: string;
-  /** URI of the next page, or null if there is no next page. */
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackend;
+  ipRestriction?: EndpointIPPolicy;
+}
+
+export interface TLSEdgeList {
+  /** the list of all TLS Edges on this account */
+  tlsEdges: Array<TLSEdge>;
+  /** URI of the TLS Edge list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
   nextPageUri?: string;
 }
 
-export interface EventStream {
-  /** Unique identifier for this Event Stream. */
+export interface TLSEdgeCreate {
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackendMutate;
+  ipRestriction?: EndpointIPPolicyMutate;
+  mutualTls?: EndpointMutualTLSMutate;
+  tlsTermination?: EndpointTLSTermination;
+}
+
+export interface TLSEdgeUpdate {
+  /** unique identifier of this edge */
   id: string;
-  /** URI of the Event Stream API resource. */
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata?: string;
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackendMutate;
+  ipRestriction?: EndpointIPPolicyMutate;
+  mutualTls?: EndpointMutualTLSMutate;
+  tlsTermination?: EndpointTLSTermination;
+}
+
+export interface TLSEdge {
+  /** unique identifier of this edge */
+  id: string;
+  /** human-readable description of what this edge will be used for; optional, max 255 bytes. */
+  description: string;
+  /** arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. */
+  metadata: string;
+  /** timestamp when the edge configuration was created, RFC 3339 format */
+  createdAt: string;
+  /** URI of the edge API resource */
   uri: string;
-  /** Timestamp when the Event Stream was created, RFC 3339 format. */
+  /** hostports served by this edge */
+  hostports?: Array<string>;
+  /** edge modules */
+  backend?: EndpointBackend;
+  ipRestriction?: EndpointIPPolicy;
+  mutualTls?: EndpointMutualTLS;
+  tlsTermination?: EndpointTLSTermination;
+}
+
+export interface Endpoint {
+  /** unique endpoint resource identifier */
+  id: string;
+  /** identifier of the region this endpoint belongs to */
+  region: string;
+  /** timestamp when the endpoint was created in RFC 3339 format */
   createdAt: string;
-  /** Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes. */
+  /** timestamp when the endpoint was updated in RFC 3339 format */
+  updatedAt: string;
+  /** URL of the hostport served by this endpoint */
+  publicUrl: string;
+  /** protocol served by this endpoint. one of `http`, `https`, `tcp`, or `tls` */
+  proto: string;
+  /** hostport served by this endpoint (hostname:port) */
+  hostport: string;
+  /** whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) */
+  type: string;
+  /** user-supplied metadata of the associated tunnel or edge object */
   metadata: string;
-  /** Human-readable description of the Event Stream. Optional, max 255 bytes. */
-  description: string;
-  /** A list of protocol-specific fields you want to collect on each event. */
-  fields: Array<string>;
-  /** The protocol that determines which events will be collected. Supported values are `tcp_connection_closed` and `http_request_complete`. */
-  eventType: string;
-  /** A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination. */
-  destinationIds: Array<string>;
-  /** The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events. */
-  samplingRate: number;
+  /** the domain reserved for this endpoint */
+  domain?: Ref;
+  /** the address reserved for this endpoint */
+  tcpAddr?: Ref;
+  /** the tunnel serving requests to this endpoint, if this is an ephemeral endpoint */
+  tunnel?: Ref;
+  /** the edge serving requests to this endpoint, if this is an edge endpoint */
+  edge?: Ref;
+}
+
+export interface EndpointList {
+  /** the list of all active endpoints on this account */
+  endpoints: Array<Endpoint>;
+  /** URI of the endpoints list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
 }
 
 export interface EventDestinationCreate {
@@ -773,7 +1209,7 @@ export interface EventSubscriptionCreate {
   description: string;
   /** Sources containing the types for which this event subscription will trigger */
   sources: Array<EventSourceReplace>;
-  /** A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination. */
+  /** A list of Event Destination IDs which should be used for this Event Subscription. */
   destinationIds: Array<string>;
 }
 
@@ -786,7 +1222,7 @@ export interface EventSubscriptionUpdate {
   description?: string;
   /** Sources containing the types for which this event subscription will trigger */
   sources?: Array<EventSourceReplace>;
-  /** A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination. */
+  /** A list of Event Destination IDs which should be used for this Event Subscription. */
   destinationIds?: Array<string>;
 }
 
@@ -868,8 +1304,6 @@ export interface IPPolicyCreate {
   description: string;
   /** arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. */
   metadata: string;
-  /** the IP policy action. Supported values are `allow` or `deny` */
-  action: string;
 }
 
 export interface IPPolicyUpdate {
@@ -891,8 +1325,6 @@ export interface IPPolicy {
   description: string;
   /** arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes. */
   metadata: string;
-  /** the IP policy action. Supported values are `allow` or `deny` */
-  action: string;
 }
 
 export interface IPPolicyList {
@@ -913,6 +1345,8 @@ export interface IPPolicyRuleCreate {
   cidr: string;
   /** ID of the IP policy this IP policy rule will be attached to */
   ipPolicyId: string;
+  /** the action to apply to the policy rule, either `allow` or `deny` */
+  action?: string;
 }
 
 export interface IPPolicyRuleUpdate {
@@ -940,6 +1374,8 @@ export interface IPPolicyRule {
   cidr: string;
   /** object describing the IP policy this IP Policy Rule belongs to */
   ipPolicy: Ref;
+  /** the action to apply to the policy rule, either `allow` or `deny` */
+  action: string;
 }
 
 export interface IPPolicyRuleList {
@@ -998,72 +1434,12 @@ export interface IPRestriction {
 export interface IPRestrictionList {
   /** the list of all IP restrictions on this account */
   ipRestrictions: Array<IPRestriction>;
-  /** URI of the IP resrtrictions list API resource */
+  /** URI of the IP restrictions list API resource */
   uri: string;
   /** URI of the next page, or null if there is no next page */
   nextPageUri?: string;
 }
 
-export interface EndpointLoggingReplace {
-  id: string;
-  module: EndpointLoggingMutate;
-}
-
-export interface EndpointCircuitBreakerReplace {
-  id: string;
-  module: EndpointCircuitBreaker;
-}
-
-export interface EndpointCompressionReplace {
-  id: string;
-  module: EndpointCompression;
-}
-
-export interface EndpointTLSTerminationReplace {
-  id: string;
-  module: EndpointTLSTermination;
-}
-
-export interface EndpointIPPolicyReplace {
-  id: string;
-  module: EndpointIPPolicyMutate;
-}
-
-export interface EndpointMutualTLSReplace {
-  id: string;
-  module: EndpointMutualTLSMutate;
-}
-
-export interface EndpointRequestHeadersReplace {
-  id: string;
-  module: EndpointRequestHeaders;
-}
-
-export interface EndpointResponseHeadersReplace {
-  id: string;
-  module: EndpointResponseHeaders;
-}
-
-export interface EndpointOAuthReplace {
-  id: string;
-  module: EndpointOAuth;
-}
-
-export interface EndpointWebhookValidationReplace {
-  id: string;
-  module: EndpointWebhookValidation;
-}
-
-export interface EndpointSAMLReplace {
-  id: string;
-  module: EndpointSAMLMutate;
-}
-
-export interface EndpointOIDCReplace {
-  id: string;
-  module: EndpointOIDC;
-}
-
 export interface ReservedAddrCreate {
   /** human-readable description of what this reserved address will be used for */
   description: string;
@@ -1071,8 +1447,6 @@ export interface ReservedAddrCreate {
   metadata: string;
   /** reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
   region: string;
-  /** ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address */
-  endpointConfigurationId?: string;
 }
 
 export interface ReservedAddrUpdate {
@@ -1081,8 +1455,6 @@ export interface ReservedAddrUpdate {
   description?: string;
   /** arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes. */
   metadata?: string;
-  /** ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address */
-  endpointConfigurationId?: string;
 }
 
 export interface ReservedAddr {
@@ -1100,8 +1472,6 @@ export interface ReservedAddr {
   addr: string;
   /** reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
   region: string;
-  /** object reference to the endpoint configuration that will be applied to traffic to this address */
-  endpointConfiguration?: Ref;
 }
 
 export interface ReservedAddrList {
@@ -1122,10 +1492,6 @@ export interface ReservedDomainCreate {
   description: string;
   /** arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. */
   metadata: string;
-  /** ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain */
-  httpEndpointConfigurationId?: string;
-  /** ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain */
-  httpsEndpointConfigurationId?: string;
   /** ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`. */
   certificateId?: string;
   /** configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with `certificate_id`. */
@@ -1138,10 +1504,6 @@ export interface ReservedDomainUpdate {
   description?: string;
   /** arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes. */
   metadata?: string;
-  /** ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain */
-  httpEndpointConfigurationId?: string;
-  /** ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain */
-  httpsEndpointConfigurationId?: string;
   /** ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with `certificate_management_policy`. */
   certificateId?: string;
   /** configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with `certificate_id`. */
@@ -1165,10 +1527,6 @@ export interface ReservedDomain {
   region: string;
   /** DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io */
   cnameTarget?: string;
-  /** object referencing the endpoint configuration applied to http traffic on this domain */
-  httpEndpointConfiguration?: Ref;
-  /** object referencing the endpoint configuration applied to https traffic on this domain */
-  httpsEndpointConfiguration?: Ref;
   /** object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise. */
   certificate?: Ref;
   /** configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled */
@@ -1373,7 +1731,7 @@ export interface SSHUserCertificateCreate {
   sshCertificateAuthorityId: string;
   /** a public key in OpenSSH Authorized Keys format that this certificate signs */
   publicKey: string;
-  /** the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. */
+  /** the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. */
   principals: Array<string>;
   /** A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: `force-command` and `source-address`. See [the OpenSSH certificate protocol spec](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys) for additional details. */
   criticalOptions: Map<string, string>;
@@ -1414,7 +1772,7 @@ export interface SSHUserCertificate {
   keyType: string;
   /** the ssh certificate authority that is used to sign this ssh user certificate */
   sshCertificateAuthorityId: string;
-  /** the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. */
+  /** the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user. */
   principals: Array<string>;
   /** A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: `force-command` and `source-address`. See [the OpenSSH certificate protocol spec](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys) for additional details. */
   criticalOptions: Map<string, string>;
@@ -1556,18 +1914,26 @@ export interface TunnelSessionsUpdate {
 export interface Tunnel {
   /** unique tunnel resource identifier */
   id: string;
-  /** URL of the tunnel's public endpoint */
+  /** URL of the ephemeral tunnel's public endpoint */
   publicUrl: string;
   /** timestamp when the tunnel was initiated in RFC 3339 format */
   startedAt: string;
   /** user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel [metadata configuration option](https://ngrok.com/docs#tunnel-definitions-metadata) In API version 0, this value was instead pulled from the top-level [metadata configuration option](https://ngrok.com/docs#config_metadata). */
   metadata: string;
-  /** tunnel protocol. one of `http`, `https`, `tcp` or `tls` */
+  /** tunnel protocol for ephemeral tunnels. one of `http`, `https`, `tcp` or `tls` */
   proto: string;
   /** identifier of tune region where the tunnel is running */
   region: string;
   /** reference object pointing to the tunnel session on which this tunnel was started */
   tunnelSession: Ref;
+  /** the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel */
+  endpoint?: Ref;
+  /** the labels the tunnel group backends will match against, if this is a backend tunnel */
+  labels: Map<string, string>;
+  /** tunnel group backends served by this backend tunnel */
+  backends?: Array<Ref>;
+  /** upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address. */
+  forwardsTo: string;
 }
 
 export interface TunnelList {