@ngrok/ngrok-api 0.12.0 → 0.13.0

package/src/client.ts

@@ -185,12 +185,15 @@ export class Ngrok {
     edgeRouteOidcModule: services.EdgeRouteOIDCModule;
     edgeRouteWebsocketTcpConverterModule: services.EdgeRouteWebsocketTCPConverterModule;
     edgeRouteUserAgentFilterModule: services.EdgeRouteUserAgentFilterModule;
+    edgeRouteTrafficPolicyModule: services.EdgeRouteTrafficPolicyModule;
     tcpEdgeBackendModule: services.TCPEdgeBackendModule;
     tcpEdgeIpRestrictionModule: services.TCPEdgeIPRestrictionModule;
+    tcpEdgeTrafficPolicyModule: services.TCPEdgeTrafficPolicyModule;
     tlsEdgeBackendModule: services.TLSEdgeBackendModule;
     tlsEdgeIpRestrictionModule: services.TLSEdgeIPRestrictionModule;
     tlsEdgeMutualTlsModule: services.TLSEdgeMutualTLSModule;
     tlsEdgeTlsTerminationModule: services.TLSEdgeTLSTerminationModule;
+    tlsEdgeTrafficPolicyModule: services.TLSEdgeTrafficPolicyModule;
   };
 
   /**
@@ -213,7 +216,7 @@ export class Ngrok {
     this.httpClient = wretch()
       .url(baseUrl)
       .headers({
-        'User-Agent': 'ngrok-api-typescript/0.11.0/' + process.version,
+        'User-Agent': 'ngrok-api-typescript/0.12.0/' + process.version,
         'Ngrok-Version': '2',
       })
       .content('application/json')
@@ -298,10 +301,16 @@ export class Ngrok {
         new services.EdgeRouteWebsocketTCPConverterModule(this.httpClient),
       edgeRouteUserAgentFilterModule:
         new services.EdgeRouteUserAgentFilterModule(this.httpClient),
+      edgeRouteTrafficPolicyModule: new services.EdgeRouteTrafficPolicyModule(
+        this.httpClient
+      ),
       tcpEdgeBackendModule: new services.TCPEdgeBackendModule(this.httpClient),
       tcpEdgeIpRestrictionModule: new services.TCPEdgeIPRestrictionModule(
         this.httpClient
       ),
+      tcpEdgeTrafficPolicyModule: new services.TCPEdgeTrafficPolicyModule(
+        this.httpClient
+      ),
       tlsEdgeBackendModule: new services.TLSEdgeBackendModule(this.httpClient),
       tlsEdgeIpRestrictionModule: new services.TLSEdgeIPRestrictionModule(
         this.httpClient
@@ -312,6 +321,9 @@ export class Ngrok {
       tlsEdgeTlsTerminationModule: new services.TLSEdgeTLSTerminationModule(
         this.httpClient
       ),
+      tlsEdgeTrafficPolicyModule: new services.TLSEdgeTrafficPolicyModule(
+        this.httpClient
+      ),
     };
   }
 }

package/src/datatypes.ts

@@ -1448,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 */
@@ -1462,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 {
@@ -1473,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;
@@ -1578,7 +1633,7 @@ export interface EventTargetAzureLogsIngestion {
   logsIngestionUri: string;
   /** Data collection rule immutable ID */
   dataCollectionRuleId: string;
-  /** Data collection stream name to use as destination, located instide the DCR */
+  /** Data collection stream name to use as destination, located inside the DCR */
   dataCollectionStreamName: string;
 }
 
@@ -1948,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;
 }
 

package/src/services.ts

@@ -2461,6 +2461,16 @@ export class Endpoints {
   public constructor(httpClient: Wretcher) {
     this.httpClient = httpClient;
   }
+  /**
+   * Create an endpoint, currently available only for cloud endpoints
+   */
+  public create(arg: datatypes.EndpointCreate): Promise<datatypes.Endpoint> {
+    return this.httpClient
+      .url(`/endpoints`)
+      .post(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
   /**
    * List all active endpoints on the account
    */
@@ -2519,6 +2529,26 @@ export class Endpoints {
       .json(payload => util.deserializeResult(payload))
       .then(f => f, util.onRejected);
   }
+  /**
+   * Update an Endpoint by ID, currently available only for cloud endpoints
+   */
+  public update(arg: datatypes.EndpointUpdate): Promise<datatypes.Endpoint> {
+    return this.httpClient
+      .url(`/endpoints/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Delete an Endpoint by ID, currently available only for cloud endpoints
+   */
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/endpoints/${id}`)
+      .delete()
+      .res()
+      .then(f => f, util.onRejected);
+  }
 }
 
 export class EventDestinations {