ngrok-api 0.16.0 → 0.19.0

data/docs/top-level-namespace.html

@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Dec  2 18:48:49 2021 by
+  Generated on Mon Apr 11 19:32:55 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-3.0.1).
+  0.9.27 (ruby-2.7.5).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -60,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
@@ -107,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
@@ -208,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

@@ -69,7 +69,7 @@ module NgrokAPI
     def patch(path, danger: false, data: {})
       uri = get_uri(path)
       req = Net::HTTP::Patch.new(uri, headers_with_json)
-      json_do(uri, req, danger: danger, data: data.to_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
     end
 
     ##
@@ -82,7 +82,20 @@ module NgrokAPI
     def post(path, danger: false, data: {})
       uri = get_uri(path)
       req = Net::HTTP::Post.new(uri, headers_with_json)
-      json_do(uri, req, danger: danger, data: data.to_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
+    end
+
+    ##
+    # Make a PUT request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def put(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Put.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
     end
 
     private
@@ -127,5 +140,11 @@ module NgrokAPI
       path = path.delete_prefix(@base_url)
       "#{@base_url}#{path}"
     end
+
+    def deep_to_h(data)
+      data.to_h.transform_values do |v|
+        (!v.is_a?(Array) && v.methods.include?(:to_h)) ? deep_to_h(v) : v
+      end
+    end
   end
 end

data/lib/ngrokapi/models/abuse_report.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class AbuseReport
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -13,24 +13,28 @@ module NgrokAPI
         :status,
         :hostnames
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @urls = @result['urls']
-        @metadata = @result['metadata']
-        @status = @result['status']
-        @hostnames = @result['hostnames']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @urls = @attrs['urls']
+        @metadata = @attrs['metadata']
+        @status = @attrs['status']
+        @hostnames = @attrs['hostnames']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/abuse_report_hostname.rb

@@ -4,23 +4,27 @@ module NgrokAPI
   module Models
     class AbuseReportHostname
       attr_reader :client,
-        :result,
+        :attrs,
         :hostname,
         :status
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @hostname = @result['hostname']
-        @status = @result['status']
+        @attrs = attrs
+        @hostname = @attrs['hostname']
+        @status = @attrs['status']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/agent_ingress.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class AgentIngress
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :description,
@@ -14,25 +14,29 @@ module NgrokAPI
         :region_domains,
         :created_at
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @domain = @result['domain']
-        @ns_targets = @result['ns_targets']
-        @region_domains = @result['region_domains']
-        @created_at = @result['created_at']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @domain = @attrs['domain']
+        @ns_targets = @attrs['ns_targets']
+        @region_domains = @attrs['region_domains']
+        @created_at = @attrs['created_at']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/api_key.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class APIKey
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :description,
@@ -12,23 +12,27 @@ module NgrokAPI
         :created_at,
         :token
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @created_at = @result['created_at']
-        @token = @result['token']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @created_at = @attrs['created_at']
+        @token = @attrs['token']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/aws_auth.rb

@@ -4,23 +4,27 @@ module NgrokAPI
   module Models
     class AWSAuth
       attr_reader :client,
-        :result,
+        :attrs,
         :role,
         :creds
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @role = @result['role']
-        @creds = @result['creds']
+        @attrs = attrs
+        @role = @attrs['role']
+        @creds = @attrs['creds']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/aws_credentials.rb

@@ -4,23 +4,27 @@ module NgrokAPI
   module Models
     class AWSCredentials
       attr_reader :client,
-        :result,
+        :attrs,
         :aws_access_key_id,
         :aws_secret_access_key
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @aws_access_key_id = @result['aws_access_key_id']
-        @aws_secret_access_key = @result['aws_secret_access_key']
+        @attrs = attrs
+        @aws_access_key_id = @attrs['aws_access_key_id']
+        @aws_secret_access_key = @attrs['aws_secret_access_key']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/aws_role.rb

@@ -4,21 +4,25 @@ module NgrokAPI
   module Models
     class AWSRole
       attr_reader :client,
-        :result,
+        :attrs,
         :role_arn
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @role_arn = @result['role_arn']
+        @attrs = attrs
+        @role_arn = @attrs['role_arn']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/certificate_authority.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class CertificateAuthority
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -17,28 +17,32 @@ module NgrokAPI
         :key_usages,
         :extended_key_usages
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @ca_pem = @result['ca_pem']
-        @subject_common_name = @result['subject_common_name']
-        @not_before = @result['not_before']
-        @not_after = @result['not_after']
-        @key_usages = @result['key_usages']
-        @extended_key_usages = @result['extended_key_usages']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @ca_pem = @attrs['ca_pem']
+        @subject_common_name = @attrs['subject_common_name']
+        @not_before = @attrs['not_before']
+        @not_after = @attrs['not_after']
+        @key_usages = @attrs['key_usages']
+        @extended_key_usages = @attrs['extended_key_usages']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/credential.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class Credential
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -13,24 +13,28 @@ module NgrokAPI
         :token,
         :acl
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @token = @result['token']
-        @acl = @result['acl']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @token = @attrs['token']
+        @acl = @attrs['acl']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/endpoint.rb

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

data/lib/ngrokapi/models/endpoint_backend.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointBackend
+      attr_reader :client,
+        :attrs,
+        :enabled,
+        :backend
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @enabled = @attrs['enabled']
+        @backend = @attrs['backend']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_backend_mutate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointBackendMutate
+      attr_reader :client,
+        :attrs,
+        :enabled,
+        :backend_id
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @enabled = @attrs['enabled']
+        @backend_id = @attrs['backend_id']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end