@ngrok/ngrok-api 0.11.0 → 0.13.0

package/src/datatypes.ts

@@ -1012,29 +1012,11 @@ export interface EndpointUserAgentFilter {
   deny: Array<string>;
 }
 
-export interface EndpointPolicy {
+export interface EndpointTrafficPolicy {
   /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
   enabled?: boolean;
-  /** the inbound rules of the traffic policy. */
-  inbound: Array<EndpointRule>;
-  /** the outbound rules on the traffic policy. */
-  outbound: Array<EndpointRule>;
-}
-
-export interface EndpointRule {
-  /** cel expressions that filter traffic the policy rule applies to. */
-  expressions: Array<string>;
-  /** the set of actions on a policy rule. */
-  actions: Array<EndpointAction>;
-  /** the name of the rule that is part of the traffic policy. */
-  name: string;
-}
-
-export interface EndpointAction {
-  /** the type of action on the policy rule. */
-  type: string;
-  /** the configuration for the action on the policy rule. */
-  config: Record<string, unknown> | undefined;
+  /** the traffic policy that should be applied to the traffic on your endpoint. */
+  value: string;
 }
 
 export interface EdgeRouteItem {
@@ -1079,7 +1061,7 @@ export interface HTTPSEdgeRouteCreate {
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
   userAgentFilter?: EndpointUserAgentFilter;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface HTTPSEdgeRouteUpdate {
@@ -1119,7 +1101,7 @@ export interface HTTPSEdgeRouteUpdate {
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
   userAgentFilter?: EndpointUserAgentFilter;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface HTTPSEdgeRoute {
@@ -1163,7 +1145,7 @@ export interface HTTPSEdgeRoute {
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
   userAgentFilter?: EndpointUserAgentFilter;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface HTTPSEdgeList {
@@ -1246,9 +1228,9 @@ export interface EdgeTLSTerminationAtEdgeReplace {
   module: EndpointTLSTerminationAtEdge;
 }
 
-export interface EdgePolicyReplace {
+export interface EdgeTrafficPolicyReplace {
   id: string;
-  module: EndpointPolicy;
+  module: EndpointTrafficPolicy;
 }
 
 export interface EdgeRouteBackendReplace {
@@ -1323,10 +1305,10 @@ export interface EdgeRouteUserAgentFilterReplace {
   module: EndpointUserAgentFilter;
 }
 
-export interface EdgeRoutePolicyReplace {
+export interface EdgeRouteTrafficPolicyReplace {
   edgeId: string;
   id: string;
-  module: EndpointPolicy;
+  module: EndpointTrafficPolicy;
 }
 
 export interface TCPEdgeList {
@@ -1349,7 +1331,7 @@ export interface TCPEdgeCreate {
   backend?: EndpointBackendMutate;
   ipRestriction?: EndpointIPPolicyMutate;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface TCPEdgeUpdate {
@@ -1365,7 +1347,7 @@ export interface TCPEdgeUpdate {
   backend?: EndpointBackendMutate;
   ipRestriction?: EndpointIPPolicyMutate;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface TCPEdge {
@@ -1385,7 +1367,7 @@ export interface TCPEdge {
   backend?: EndpointBackend;
   ipRestriction?: EndpointIPPolicy;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface TLSEdgeList {
@@ -1410,7 +1392,7 @@ export interface TLSEdgeCreate {
   mutualTls?: EndpointMutualTLSMutate;
   tlsTermination?: EndpointTLSTermination;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface TLSEdgeUpdate {
@@ -1428,7 +1410,7 @@ export interface TLSEdgeUpdate {
   mutualTls?: EndpointMutualTLSMutate;
   tlsTermination?: EndpointTLSTermination;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface TLSEdge {
@@ -1450,7 +1432,7 @@ export interface TLSEdge {
   mutualTls?: EndpointMutualTLS;
   tlsTermination?: EndpointTLSTermination;
   /** the traffic policy associated with this edge or null */
-  policy?: EndpointPolicy;
+  trafficPolicy?: EndpointTrafficPolicy;
 }
 
 export interface Endpoint {
@@ -1466,12 +1448,17 @@ export interface Endpoint {
   publicUrl: string;
   /** protocol served by this endpoint. one of `http`, `https`, `tcp`, or `tls` */
   proto: string;
-  /** hostport served by this endpoint (hostname:port) */
+  scheme?: string;
+  /** hostport served by this endpoint (hostname:port) -> soon to be deprecated */
   hostport: string;
-  /** whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) */
+  host?: string;
+  port?: number;
+  /** whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) or `cloud (represents a cloud endpoint)` */
   type: string;
   /** user-supplied metadata of the associated tunnel or edge object */
   metadata?: string;
+  /** user-supplied description of the associated tunnel */
+  description?: string;
   /** the domain reserved for this endpoint */
   domain?: Ref;
   /** the address reserved for this endpoint */
@@ -1480,6 +1467,26 @@ export interface Endpoint {
   tunnel?: Ref;
   /** the edge serving requests to this endpoint, if this is an edge endpoint */
   edge?: Ref;
+  /** the local address the tunnel forwards to */
+  upstreamUrl?: string;
+  /** the protocol the agent uses to forward with */
+  upstreamProto?: string;
+  /** the url of the endpoint */
+  url?: string;
+  /** The ID of the owner (bot or user) that owns this endpoint */
+  principal?: Ref;
+  /** TODO: deprecate me! */
+  principalId?: Ref;
+  /** The traffic policy attached to this endpoint */
+  trafficPolicy?: string;
+  /** the bindings associated with this endpoint */
+  bindings?: Array<string>;
+  /** The tunnel session of the agent for this endpoint */
+  tunnelSession?: Ref;
+  /** URI of the clep API resource */
+  uri?: string;
+  /** user supplied name for the endpoint */
+  name?: string;
 }
 
 export interface EndpointList {
@@ -1491,6 +1498,36 @@ export interface EndpointList {
   nextPageUri?: string;
 }
 
+export interface EndpointCreate {
+  /** the url of the endpoint */
+  url: string;
+  /** whether the endpoint is `ephemeral` (served directly by an agent-initiated tunnel) or `edge` (served by an edge) or `cloud (represents a cloud endpoint)` */
+  type: string;
+  /** The traffic policy attached to this endpoint */
+  trafficPolicy: string;
+  /** user-supplied description of the associated tunnel */
+  description?: string;
+  /** user-supplied metadata of the associated tunnel or edge object */
+  metadata?: string;
+  /** the bindings associated with this endpoint */
+  bindings?: Array<string>;
+}
+
+export interface EndpointUpdate {
+  /** unique endpoint resource identifier */
+  id: string;
+  /** the url of the endpoint */
+  url?: string;
+  /** The traffic policy attached to this endpoint */
+  trafficPolicy?: string;
+  /** user-supplied description of the associated tunnel */
+  description?: string;
+  /** user-supplied metadata of the associated tunnel or edge object */
+  metadata?: string;
+  /** the bindings associated with this endpoint */
+  bindings?: Array<string>;
+}
+
 export interface EventDestinationCreate {
   /** Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes. */
   metadata?: string;
@@ -1550,6 +1587,7 @@ export interface EventTarget {
   cloudwatchLogs?: EventTargetCloudwatchLogs;
   /** Configuration used to send events to Datadog. */
   datadog?: EventTargetDatadog;
+  azureLogsIngestion?: EventTargetAzureLogsIngestion;
 }
 
 export interface EventTargetFirehose {
@@ -1584,6 +1622,21 @@ export interface EventTargetDatadog {
   ddsite?: string;
 }
 
+export interface EventTargetAzureLogsIngestion {
+  /** Tenant ID for the Azure account */
+  tenantId: string;
+  /** Client ID for the application client */
+  clientId: string;
+  /** Client Secret for the application client */
+  clientSecret: string;
+  /** Data collection endpoint logs ingestion URI */
+  logsIngestionUri: string;
+  /** Data collection rule immutable ID */
+  dataCollectionRuleId: string;
+  /** Data collection stream name to use as destination, located inside the DCR */
+  dataCollectionStreamName: string;
+}
+
 export interface AWSAuth {
   /** A role for ngrok to assume on your behalf to deposit events into your AWS account. */
   role?: AWSRole;
@@ -1950,7 +2003,7 @@ export interface ReservedDomainList {
 export interface ReservedDomainCertPolicy {
   /** certificate authority to request certificates from. The only supported value is letsencrypt. */
   authority: string;
-  /** type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa. */
+  /** type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa. */
   privateKeyType: string;
 }