ngrok-api 0.14.0 → 0.17.0

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 19 15:48:17 2021 by
+  Generated on Thu Mar 10 04:54:46 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-3.0.1).
+  0.9.27 (ruby-2.7.5).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -7,10 +7,7 @@ module NgrokAPI
   # Low-level api client for communicating with Ngrok's HTTP API.
   # Use this object to instantiate your clients.
   class Client
-    def initialize(
-      api_key:,
-      base_url: 'https://api.ngrok.com'
-    )
+    def initialize(api_key:, base_url: 'https://api.ngrok.com')
       @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
     end
 
@@ -23,6 +20,10 @@ module NgrokAPI
       @_abuse_reports ||= NgrokAPI::Services::AbuseReportsClient.new(client: @client)
     end
 
+    def agent_ingresses
+      @_agent_ingresses ||= NgrokAPI::Services::AgentIngressesClient.new(client: @client)
+    end
+
     ##
     # API Keys are used to authenticate to the [ngrok
     #  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -59,17 +60,13 @@ module NgrokAPI
     end
 
     ##
-    # Endpoint Configurations are a reusable group of modules that encapsulate how
-    #  traffic to a domain or address is handled. Endpoint configurations are only
-    #  applied to Domains and TCP Addresses they have been attached to.
+    # Endpoints provides an API for querying the endpoint objects
+    #  which define what tunnel or edge is used to serve a hostport.
+    #  Only active endpoints associated with a tunnel or backend are returned.
     #
-    # @return [NgrokAPI::Services::EndpointConfigurationsClient]
-    def endpoint_configurations
-      @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(client: @client)
-    end
-
-    def event_streams
-      @_event_streams ||= NgrokAPI::Services::EventStreamsClient.new(client: @client)
+    # @return [NgrokAPI::Services::EndpointsClient]
+    def endpoints
+      @_endpoints ||= NgrokAPI::Services::EndpointsClient.new(client: @client)
     end
 
     def event_destinations
@@ -106,7 +103,7 @@ module NgrokAPI
 
     ##
     # An IP restriction is a restriction placed on the CIDRs that are allowed to
-    #  initate traffic to a specific aspect of your ngrok account. An IP
+    #  initiate traffic to a specific aspect of your ngrok account. An IP
     #  restriction has a type which defines the ingress it applies to. IP
     #  restrictions can be used to enforce the source IPs that can make API
     #  requests, log in to the dashboard, start ngrok agents, and connect to your
@@ -117,15 +114,6 @@ module NgrokAPI
       @_ip_restrictions ||= NgrokAPI::Services::IPRestrictionsClient.new(client: @client)
     end
 
-    ##
-    # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
-    #  with an `endpoints` type instead.
-    #
-    # @return [NgrokAPI::Services::IPWhitelistClient]
-    def ip_whitelist
-      @_ip_whitelist ||= NgrokAPI::Services::IPWhitelistClient.new(client: @client)
-    end
-
     ##
     # Reserved Addresses are TCP addresses that can be used to listen for traffic.
     #  TCP address hostnames and ports are assigned by ngrok, they cannot be
@@ -216,20 +204,47 @@ module NgrokAPI
       @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
     end
 
-    def pointcfg_module
+    def backends
+      ns = OpenStruct.new
+      ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
+      ns.http_response = NgrokAPI::Services::HTTPResponseBackendsClient.new(client: @client)
+      ns.tunnel_group = NgrokAPI::Services::TunnelGroupBackendsClient.new(client: @client)
+      ns.weighted = NgrokAPI::Services::WeightedBackendsClient.new(client: @client)
+
+      ns
+    end
+
+    def edges
+      ns = OpenStruct.new
+      ns.https_routes = NgrokAPI::Services::EdgesHTTPSRoutesClient.new(client: @client)
+      ns.https = NgrokAPI::Services::EdgesHTTPSClient.new(client: @client)
+      ns.tcp = NgrokAPI::Services::EdgesTCPClient.new(client: @client)
+      ns.tls = NgrokAPI::Services::EdgesTLSClient.new(client: @client)
+
+      ns
+    end
+
+    def edge_modules
       ns = OpenStruct.new
-      ns.logging = NgrokAPI::Services::EndpointLoggingModuleClient.new(client: @client)
-      ns.circuit_breaker = NgrokAPI::Services::EndpointCircuitBreakerModuleClient.new(client: @client)
-      ns.compression = NgrokAPI::Services::EndpointCompressionModuleClient.new(client: @client)
-      ns.tls_termination = NgrokAPI::Services::EndpointTLSTerminationModuleClient.new(client: @client)
-      ns.ip_policy = NgrokAPI::Services::EndpointIPPolicyModuleClient.new(client: @client)
-      ns.mutual_tls = NgrokAPI::Services::EndpointMutualTLSModuleClient.new(client: @client)
-      ns.request_headers = NgrokAPI::Services::EndpointRequestHeadersModuleClient.new(client: @client)
-      ns.response_headers = NgrokAPI::Services::EndpointResponseHeadersModuleClient.new(client: @client)
-      ns.oauth = NgrokAPI::Services::EndpointOAuthModuleClient.new(client: @client)
-      ns.webhook_validation = NgrokAPI::Services::EndpointWebhookValidationModuleClient.new(client: @client)
-      ns.saml = NgrokAPI::Services::EndpointSAMLModuleClient.new(client: @client)
-      ns.oidc = NgrokAPI::Services::EndpointOIDCModuleClient.new(client: @client)
+      ns.https_edge_mutual_tls = NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient.new(client: @client)
+      ns.https_edge_tls_termination = NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient.new(client: @client)
+      ns.https_edge_route_backend = NgrokAPI::Services::EdgeRouteBackendModuleClient.new(client: @client)
+      ns.https_edge_route_ip_restriction = NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient.new(client: @client)
+      ns.https_edge_route_request_headers = NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient.new(client: @client)
+      ns.https_edge_route_response_headers = NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient.new(client: @client)
+      ns.https_edge_route_compression = NgrokAPI::Services::EdgeRouteCompressionModuleClient.new(client: @client)
+      ns.https_edge_route_circuit_breaker = NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient.new(client: @client)
+      ns.https_edge_route_webhook_verification = NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient.new(client: @client)
+      ns.https_edge_route_oauth = NgrokAPI::Services::EdgeRouteOAuthModuleClient.new(client: @client)
+      ns.https_edge_route_saml = NgrokAPI::Services::EdgeRouteSAMLModuleClient.new(client: @client)
+      ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
+      ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
+      ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
+      ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
+      ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)
+      ns.tls_edge_ip_restriction = NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient.new(client: @client)
+      ns.tls_edge_mutual_tls = NgrokAPI::Services::TLSEdgeMutualTLSModuleClient.new(client: @client)
+      ns.tls_edge_tls_termination = NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient.new(client: @client)
 
       ns
     end

data/lib/ngrokapi/http_client.rb

@@ -8,10 +8,7 @@ module NgrokAPI
     attr_reader :api_key,
       :base_url
 
-    def initialize(
-      api_key:,
-      base_url: 'https://api.ngrok.com'
-    )
+    def initialize(api_key:, base_url: 'https://api.ngrok.com')
       @api_key = api_key
       @base_url = base_url
     end

data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb}

@@ -2,25 +2,29 @@
 
 module NgrokAPI
   module Models
-    class IPWhitelistEntry
+    class AgentIngress
       attr_reader :client,
         :result,
         :id,
         :uri,
-        :created_at,
         :description,
         :metadata,
-        :ip_net
+        :domain,
+        :ns_targets,
+        :region_domains,
+        :created_at
 
       def initialize(client:, result:)
         @client = client
         @result = result
         @id = @result['id']
         @uri = @result['uri']
-        @created_at = @result['created_at']
         @description = @result['description']
         @metadata = @result['metadata']
-        @ip_net = @result['ip_net']
+        @domain = @result['domain']
+        @ns_targets = @result['ns_targets']
+        @region_domains = @result['region_domains']
+        @created_at = @result['created_at']
       end
 
       def ==(other)
@@ -32,9 +36,9 @@ module NgrokAPI
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # Delete an Agent Ingress by ID
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-delete
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
       def delete
         @client.delete(
           id: @id
@@ -42,9 +46,9 @@ module NgrokAPI
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update attributes of an Agent Ingress by ID.
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
+      # https://ngrok.com/docs/api#api-agent-ingresses-update
       def update(
         description: nil,
         metadata: nil

data/lib/ngrokapi/models/endpoint.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class Endpoint
+      attr_reader :client,
+        :result,
+        :id,
+        :region,
+        :created_at,
+        :updated_at,
+        :public_url,
+        :proto,
+        :hostport,
+        :type,
+        :metadata,
+        :domain,
+        :tcp_addr,
+        :tunnel,
+        :edge
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @region = @result['region']
+        @created_at = @result['created_at']
+        @updated_at = @result['updated_at']
+        @public_url = @result['public_url']
+        @proto = @result['proto']
+        @hostport = @result['hostport']
+        @type = @result['type']
+        @metadata = @result['metadata']
+        @domain = @result['domain']
+        @tcp_addr = @result['tcp_addr']
+        @tunnel = @result['tunnel']
+        @edge = @result['edge']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb}

@@ -2,17 +2,17 @@
 
 module NgrokAPI
   module Models
-    class EndpointLogging
+    class EndpointBackend
       attr_reader :client,
         :result,
         :enabled,
-        :event_streams
+        :backend
 
       def initialize(client:, result:)
         @client = client
         @result = result
         @enabled = @result['enabled']
-        @event_streams = @result['event_streams']
+        @backend = @result['backend']
       end
 
       def ==(other)

data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb}

@@ -2,17 +2,17 @@
 
 module NgrokAPI
   module Models
-    class EndpointLoggingMutate
+    class EndpointBackendMutate
       attr_reader :client,
         :result,
         :enabled,
-        :event_stream_ids
+        :backend_id
 
       def initialize(client:, result:)
         @client = client
         @result = result
         @enabled = @result['enabled']
-        @event_stream_ids = @result['event_stream_ids']
+        @backend_id = @result['backend_id']
       end
 
       def ==(other)

data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointTLSTerminationAtEdge
+      attr_reader :client,
+        :result,
+        :enabled,
+        :min_version
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @min_version = @result['min_version']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointWebsocketTCPConverter
+      attr_reader :client,
+        :result,
+        :enabled
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_destination.rb

@@ -35,8 +35,7 @@ module NgrokAPI
 
       ##
       # Delete an Event Destination. If the Event Destination is still referenced by an
-      # Event Stream, this will throw an error until that Event Stream has removed that
-      # reference.
+      # Event Subscription.
       #
       # https://ngrok.com/docs/api#api-event-destinations-delete
       def delete

data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb}

@@ -2,18 +2,15 @@
 
 module NgrokAPI
   module Models
-    class EventStream
+    class FailoverBackend
       attr_reader :client,
         :result,
         :id,
         :uri,
         :created_at,
-        :metadata,
         :description,
-        :fields,
-        :event_type,
-        :destination_ids,
-        :sampling_rate
+        :metadata,
+        :backends
 
       def initialize(client:, result:)
         @client = client
@@ -21,12 +18,9 @@ module NgrokAPI
         @id = @result['id']
         @uri = @result['uri']
         @created_at = @result['created_at']
-        @metadata = @result['metadata']
         @description = @result['description']
-        @fields = @result['fields']
-        @event_type = @result['event_type']
-        @destination_ids = @result['destination_ids']
-        @sampling_rate = @result['sampling_rate']
+        @metadata = @result['metadata']
+        @backends = @result['backends']
       end
 
       def ==(other)
@@ -38,9 +32,9 @@ module NgrokAPI
       end
 
       ##
-      # Delete an Event Stream. Associated Event Destinations will be preserved.
+      # Delete a Failover backend by ID. TODO what if used?
       #
-      # https://ngrok.com/docs/api#api-event-streams-delete
+      # https://ngrok.com/docs/api#api-failover-backends-delete
       def delete
         @client.delete(
           id: @id
@@ -48,28 +42,22 @@ module NgrokAPI
       end
 
       ##
-      # Update attributes of an Event Stream by ID.
+      # Update Failover backend by ID
       #
-      # https://ngrok.com/docs/api#api-event-streams-update
+      # https://ngrok.com/docs/api#api-failover-backends-update
       def update(
-        metadata: nil,
         description: nil,
-        fields: nil,
-        destination_ids: nil,
-        sampling_rate: nil
+        metadata: nil,
+        backends: []
       )
-        @metadata = metadata if metadata
         @description = description if description
-        @fields = fields if fields
-        @destination_ids = destination_ids if destination_ids
-        @sampling_rate = sampling_rate if sampling_rate
+        @metadata = metadata if metadata
+        @backends = backends if backends
         @client.update(
           id: @id,
-          metadata: metadata,
           description: description,
-          fields: fields,
-          destination_ids: destination_ids,
-          sampling_rate: sampling_rate
+          metadata: metadata,
+          backends: backends
         )
       end
     end

data/lib/ngrokapi/models/http_response_backend.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class HTTPResponseBackend
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :body,
+        :headers,
+        :status_code
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @body = @result['body']
+        @headers = @result['headers']
+        @status_code = @result['status_code']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # https://ngrok.com/docs/api#api-http-response-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # https://ngrok.com/docs/api#api-http-response-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        body: nil,
+        headers: nil,
+        status_code: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @body = body if body
+        @headers = headers if headers
+        @status_code = status_code if status_code
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          body: body,
+          headers: headers,
+          status_code: status_code
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/https_edge.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class HTTPSEdge
+      attr_reader :client,
+        :result,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :mutual_tls,
+        :tls_termination,
+        :routes
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @uri = @result['uri']
+        @hostports = @result['hostports']
+        @mutual_tls = @result['mutual_tls']
+        @tls_termination = @result['tls_termination']
+        @routes = @result['routes']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Updates an HTTPS Edge by ID. If a module is not specified in the update, it will
+      # not be modified. However, each module configuration that is specified will
+      # completely replace the existing value. There is no way to delete an existing
+      # module via this API, instead use the delete module API.
+      #
+      # https://ngrok.com/docs/api#api-edges-https-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        mutual_tls: nil,
+        tls_termination: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @mutual_tls = mutual_tls if mutual_tls
+        @tls_termination = tls_termination if tls_termination
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination
+        )
+      end
+
+      ##
+      # Delete an HTTPS Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-https-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end