@ngrok/ngrok-api 0.10.0 → 0.11.0

package/src/datatypes.ts

@@ -416,6 +416,60 @@ export interface HTTPResponseBackendList {
   nextPageUri?: string;
 }
 
+export interface StaticBackend {
+  /** unique identifier for this static backend */
+  id: string;
+  /** URI of the StaticBackend API resource */
+  uri: string;
+  /** timestamp when the backend was created, RFC 3339 format */
+  createdAt: Date;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** the address to forward to */
+  address: string;
+  /** tls configuration to use */
+  tls: StaticBackendTLS;
+}
+
+export interface StaticBackendTLS {
+  /** if TLS is checked */
+  enabled: boolean;
+}
+
+export interface StaticBackendCreate {
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** the address to forward to */
+  address: string;
+  /** tls configuration to use */
+  tls: StaticBackendTLS;
+}
+
+export interface StaticBackendUpdate {
+  id: string;
+  /** human-readable description of this backend. Optional */
+  description?: string;
+  /** arbitrary user-defined machine-readable data of this backend. Optional */
+  metadata?: string;
+  /** the address to forward to */
+  address: string;
+  /** tls configuration to use */
+  tls: StaticBackendTLS;
+}
+
+export interface StaticBackendList {
+  /** the list of all static backends on this account */
+  backends: Array<StaticBackend>;
+  /** URI of the static backends list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
 export interface TunnelGroupBackend {
   /** unique identifier for this TunnelGroup backend */
   id: string;
@@ -504,6 +558,43 @@ export interface WeightedBackendList {
   nextPageUri?: string;
 }
 
+export interface BotUser {
+  /** unique API key resource identifier */
+  id: string;
+  /** URI to the API resource of this bot user */
+  uri: string;
+  /** human-readable name used to identify the bot */
+  name: string;
+  /** whether or not the bot is active */
+  active: boolean;
+  /** timestamp when the api key was created, RFC 3339 format */
+  createdAt: Date;
+}
+
+export interface BotUserCreate {
+  /** human-readable name used to identify the bot */
+  name: string;
+  /** whether or not the bot is active */
+  active?: boolean;
+}
+
+export interface BotUserUpdate {
+  id: string;
+  /** human-readable name used to identify the bot */
+  name?: string;
+  /** whether or not the bot is active */
+  active?: boolean;
+}
+
+export interface BotUserList {
+  /** the list of all bot users on this account */
+  botUsers: Array<BotUser>;
+  /** URI of the bot users 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;
@@ -607,7 +698,7 @@ export interface CredentialList {
 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 defined at https://ngrok.com/docs/cloud-edge/modules/webhook */
+  /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook-verification */
   provider: string;
   /** a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret */
   secret: string;
@@ -915,6 +1006,37 @@ export interface EndpointWebsocketTCPConverter {
   enabled?: boolean;
 }
 
+export interface EndpointUserAgentFilter {
+  enabled?: boolean;
+  allow: Array<string>;
+  deny: Array<string>;
+}
+
+export interface EndpointPolicy {
+  /** `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;
+}
+
 export interface EdgeRouteItem {
   /** unique identifier of this edge */
   edgeId: string;
@@ -955,6 +1077,9 @@ export interface HTTPSEdgeRouteCreate {
   oidc?: EndpointOIDC;
   /** websocket to tcp adapter configuration or `null` */
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
+  userAgentFilter?: EndpointUserAgentFilter;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface HTTPSEdgeRouteUpdate {
@@ -992,6 +1117,9 @@ export interface HTTPSEdgeRouteUpdate {
   oidc?: EndpointOIDC;
   /** websocket to tcp adapter configuration or `null` */
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
+  userAgentFilter?: EndpointUserAgentFilter;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface HTTPSEdgeRoute {
@@ -1033,6 +1161,9 @@ export interface HTTPSEdgeRoute {
   oidc?: EndpointOIDC;
   /** websocket to tcp adapter configuration or `null` */
   websocketTcpConverter?: EndpointWebsocketTCPConverter;
+  userAgentFilter?: EndpointUserAgentFilter;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface HTTPSEdgeList {
@@ -1115,6 +1246,11 @@ export interface EdgeTLSTerminationAtEdgeReplace {
   module: EndpointTLSTerminationAtEdge;
 }
 
+export interface EdgePolicyReplace {
+  id: string;
+  module: EndpointPolicy;
+}
+
 export interface EdgeRouteBackendReplace {
   edgeId: string;
   id: string;
@@ -1181,6 +1317,18 @@ export interface EdgeRouteWebsocketTCPConverterReplace {
   module: EndpointWebsocketTCPConverter;
 }
 
+export interface EdgeRouteUserAgentFilterReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointUserAgentFilter;
+}
+
+export interface EdgeRoutePolicyReplace {
+  edgeId: string;
+  id: string;
+  module: EndpointPolicy;
+}
+
 export interface TCPEdgeList {
   /** the list of all TCP Edges on this account */
   tcpEdges: Array<TCPEdge>;
@@ -1200,6 +1348,8 @@ export interface TCPEdgeCreate {
   /** edge modules */
   backend?: EndpointBackendMutate;
   ipRestriction?: EndpointIPPolicyMutate;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface TCPEdgeUpdate {
@@ -1214,6 +1364,8 @@ export interface TCPEdgeUpdate {
   /** edge modules */
   backend?: EndpointBackendMutate;
   ipRestriction?: EndpointIPPolicyMutate;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface TCPEdge {
@@ -1232,6 +1384,8 @@ export interface TCPEdge {
   /** edge modules */
   backend?: EndpointBackend;
   ipRestriction?: EndpointIPPolicy;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface TLSEdgeList {
@@ -1255,6 +1409,8 @@ export interface TLSEdgeCreate {
   ipRestriction?: EndpointIPPolicyMutate;
   mutualTls?: EndpointMutualTLSMutate;
   tlsTermination?: EndpointTLSTermination;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface TLSEdgeUpdate {
@@ -1271,6 +1427,8 @@ export interface TLSEdgeUpdate {
   ipRestriction?: EndpointIPPolicyMutate;
   mutualTls?: EndpointMutualTLSMutate;
   tlsTermination?: EndpointTLSTermination;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface TLSEdge {
@@ -1291,6 +1449,8 @@ export interface TLSEdge {
   ipRestriction?: EndpointIPPolicy;
   mutualTls?: EndpointMutualTLS;
   tlsTermination?: EndpointTLSTermination;
+  /** the traffic policy associated with this edge or null */
+  policy?: EndpointPolicy;
 }
 
 export interface Endpoint {
@@ -1727,7 +1887,7 @@ export interface ReservedAddrList {
 export interface ReservedDomainCreate {
   /** hostname of the reserved domain */
   domain: string;
-  /** reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
+  /** deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) */
   region: string;
   /** human-readable description of what this reserved domain will be used for */
   description?: string;
@@ -1764,9 +1924,9 @@ export interface ReservedDomain {
   metadata?: string;
   /** hostname of the reserved domain */
   domain: string;
-  /** reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
+  /** deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) */
   region: string;
-  /** DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io */
+  /** DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app) */
   cnameTarget?: string;
   /** 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;

package/src/services.ts

@@ -707,6 +707,113 @@ export class HTTPResponseBackends {
   }
 }
 
+/**
+ * A static backend sends traffic to a TCP address (hostname and port) that
+ is reachable on the public internet.
+ */
+export class StaticBackends {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>staticBackends</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  /**
+   * Create a new static backend
+   */
+  public create(
+    arg: datatypes.StaticBackendCreate
+  ): Promise<datatypes.StaticBackend> {
+    return this.httpClient
+      .url(`/backends/static`)
+      .post(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Delete a static backend by ID.
+   */
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/backends/static/${id}`)
+      .delete(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Get detailed information about a static backend by ID
+   */
+  public get(id): Promise<datatypes.StaticBackend> {
+    return this.httpClient
+      .url(`/backends/static/${id}`)
+      .get(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * List all static backends on this account
+   */
+  public async list(
+    beforeId?: string,
+    limit?: string
+  ): Promise<Array<datatypes.StaticBackend>> {
+    const array: Array<datatypes.StaticBackend> = [];
+    for await (const item of this._asyncList(beforeId, limit)) {
+      array.push(item);
+    }
+    return array;
+  }
+
+  private _pagedList(
+    arg: datatypes.Paging
+  ): Promise<datatypes.StaticBackendList> {
+    return this.httpClient
+      .url(`/backends/static`)
+      .query(arg)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(util.onFulfilled, util.onRejected);
+  }
+
+  private async *_asyncList(beforeId: string, limit = '100') {
+    let nextPage = 'initial loop';
+    let page: datatypes.Paging = { limit: limit };
+
+    if (beforeId) {
+      page.beforeId = beforeId;
+    }
+
+    while (nextPage) {
+      const pagedList = await this._pagedList(page);
+      nextPage = pagedList.nextPageUri;
+      const items: datatypes.StaticBackend[] = pagedList.backends;
+
+      if (nextPage) {
+        page = {
+          beforeId: items[items.length - 1].id,
+          limit: limit,
+        };
+      }
+
+      for (const item of items) {
+        yield item;
+      }
+    }
+  }
+  /**
+   * Update static backend by ID
+   */
+  public update(
+    arg: datatypes.StaticBackendUpdate
+  ): Promise<datatypes.StaticBackend> {
+    return this.httpClient
+      .url(`/backends/static/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 /**
  * A Tunnel Group Backend balances traffic among all online tunnels that match
  a label selector.
@@ -923,6 +1030,103 @@ export class WeightedBackends {
   }
 }
 
+export class BotUsers {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>botUsers</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  /**
+   * Create a new bot user
+   */
+  public create(arg: datatypes.BotUserCreate): Promise<datatypes.BotUser> {
+    return this.httpClient
+      .url(`/bot_users`)
+      .post(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Delete a bot user by ID
+   */
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/bot_users/${id}`)
+      .delete(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Get the details of a Bot User by ID.
+   */
+  public get(id): Promise<datatypes.BotUser> {
+    return this.httpClient
+      .url(`/bot_users/${id}`)
+      .get(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * List all bot users in this account.
+   */
+  public async list(
+    beforeId?: string,
+    limit?: string
+  ): Promise<Array<datatypes.BotUser>> {
+    const array: Array<datatypes.BotUser> = [];
+    for await (const item of this._asyncList(beforeId, limit)) {
+      array.push(item);
+    }
+    return array;
+  }
+
+  private _pagedList(arg: datatypes.Paging): Promise<datatypes.BotUserList> {
+    return this.httpClient
+      .url(`/bot_users`)
+      .query(arg)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(util.onFulfilled, util.onRejected);
+  }
+
+  private async *_asyncList(beforeId: string, limit = '100') {
+    let nextPage = 'initial loop';
+    let page: datatypes.Paging = { limit: limit };
+
+    if (beforeId) {
+      page.beforeId = beforeId;
+    }
+
+    while (nextPage) {
+      const pagedList = await this._pagedList(page);
+      nextPage = pagedList.nextPageUri;
+      const items: datatypes.BotUser[] = pagedList.botUsers;
+
+      if (nextPage) {
+        page = {
+          beforeId: items[items.length - 1].id,
+          limit: limit,
+        };
+      }
+
+      for (const item of items) {
+        yield item;
+      }
+    }
+  }
+  /**
+   * Update attributes of a bot user by ID.
+   */
+  public update(arg: datatypes.BotUserUpdate): Promise<datatypes.BotUser> {
+    return this.httpClient
+      .url(`/bot_users/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 /**
  * Certificate Authorities are x509 certificates that are used to sign other
  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -1727,6 +1931,72 @@ export class EdgeRouteWebsocketTCPConverterModule {
   }
 }
 
+export class EdgeRouteUserAgentFilterModule {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>edgeRouteUserAgentFilterModule</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  public replace(
+    arg: datatypes.EdgeRouteUserAgentFilterReplace
+  ): Promise<datatypes.EndpointUserAgentFilter> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/user_agent_filter`)
+      .put(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public get(
+    arg: datatypes.EdgeRouteItem
+  ): Promise<datatypes.EndpointUserAgentFilter> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/user_agent_filter`)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public delete(arg: datatypes.EdgeRouteItem): Promise<void> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/user_agent_filter`)
+      .delete()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
+export class EdgeRoutePolicyModule {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>edgeRoutePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  public replace(
+    arg: datatypes.EdgeRoutePolicyReplace
+  ): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/policy`)
+      .put(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/policy`)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public delete(arg: datatypes.EdgeRouteItem): Promise<void> {
+    return this.httpClient
+      .url(`/edges/https/${arg.edgeId}/routes/${arg.id}/policy`)
+      .delete()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 export class EdgesTCP {
   private httpClient: Wretcher;
 
@@ -1888,6 +2158,38 @@ export class TCPEdgeIPRestrictionModule {
   }
 }
 
+export class TCPEdgePolicyModule {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>tcpEdgePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  public replace(
+    arg: datatypes.EdgePolicyReplace
+  ): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/tcp/${arg.id}/policy`)
+      .put(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public get(id): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/tcp/${id}/policy`)
+      .get(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/edges/tcp/${id}/policy`)
+      .delete(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 export class EdgesTLS {
   private httpClient: Wretcher;
 
@@ -2113,6 +2415,38 @@ export class TLSEdgeTLSTerminationModule {
   }
 }
 
+export class TLSEdgePolicyModule {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>tlsEdgePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  public replace(
+    arg: datatypes.EdgePolicyReplace
+  ): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/tls/${arg.id}/policy`)
+      .put(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public get(id): Promise<datatypes.EndpointPolicy> {
+    return this.httpClient
+      .url(`/edges/tls/${id}/policy`)
+      .get(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/edges/tls/${id}/policy`)
+      .delete(id)
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 /**
  * Endpoints provides an API for querying the endpoint objects
  which define what tunnel or edge is used to serve a hostport.