ngrok-api 0.16.0 → 0.17.0

data/lib/ngrokapi/models/ip_policy_rule.rb

@@ -11,7 +11,8 @@ module NgrokAPI
         :description,
         :metadata,
         :cidr,
-        :ip_policy
+        :ip_policy,
+        :action
 
       def initialize(client:, result:)
         @client = client
@@ -23,6 +24,7 @@ module NgrokAPI
         @metadata = @result['metadata']
         @cidr = @result['cidr']
         @ip_policy = @result['ip_policy']
+        @action = @result['action']
       end
 
       def ==(other)

data/lib/ngrokapi/models/tcp_edge.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TCPEdge
+      attr_reader :client,
+        :result,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :backend,
+        :ip_restriction
+
+      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']
+        @backend = @result['backend']
+        @ip_restriction = @result['ip_restriction']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Updates a TCP 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-tcp-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        backend: nil,
+        ip_restriction: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          backend: backend,
+          ip_restriction: ip_restriction
+        )
+      end
+
+      ##
+      # Delete a TCP Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tls_edge.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TLSEdge
+      attr_reader :client,
+        :result,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :backend,
+        :ip_restriction,
+        :mutual_tls,
+        :tls_termination
+
+      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']
+        @backend = @result['backend']
+        @ip_restriction = @result['ip_restriction']
+        @mutual_tls = @result['mutual_tls']
+        @tls_termination = @result['tls_termination']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Updates a TLS 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-tls-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        backend: nil,
+        ip_restriction: nil,
+        mutual_tls: nil,
+        tls_termination: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
+        @mutual_tls = mutual_tls if mutual_tls
+        @tls_termination = tls_termination if tls_termination
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          backend: backend,
+          ip_restriction: ip_restriction,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination
+        )
+      end
+
+      ##
+      # Delete a TLS Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel.rb

@@ -11,7 +11,11 @@ module NgrokAPI
         :metadata,
         :proto,
         :region,
-        :tunnel_session
+        :tunnel_session,
+        :endpoint,
+        :labels,
+        :backends,
+        :forwards_to
 
       def initialize(client:, result:)
         @client = client
@@ -23,6 +27,10 @@ module NgrokAPI
         @proto = @result['proto']
         @region = @result['region']
         @tunnel_session = @result['tunnel_session']
+        @endpoint = @result['endpoint']
+        @labels = @result['labels']
+        @backends = @result['backends']
+        @forwards_to = @result['forwards_to']
       end
 
       def ==(other)

data/lib/ngrokapi/models/tunnel_group_backend.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TunnelGroupBackend
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :labels,
+        :tunnels
+
+      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']
+        @labels = @result['labels']
+        @tunnels = @result['tunnels']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID. TODO what if used?
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        labels: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @labels = labels if labels
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          labels: labels
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/weighted_backend.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class WeightedBackend
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :backends
+
+      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']
+        @backends = @result['backends']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a Weighted backend by ID. TODO what if used?
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update Weighted backend by ID
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        backends: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @backends = backends if backends
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          backends: backends
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/edge_route_backend_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-backend-module
+    class EdgeRouteBackendModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/backend'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module
-    class EndpointCircuitBreakerModuleClient
+    # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module
+    class EdgeRouteCircuitBreakerModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/circuit_breaker'
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
 
       attr_reader :client
 
@@ -15,14 +15,16 @@ module NgrokAPI
       end
 
       ##
+      # @param [string] edge_id
       # @param [string] id
       # @param [EndpointCircuitBreaker] a_module
       # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
-      def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         data = {}
@@ -32,14 +34,16 @@ module NgrokAPI
       end
 
       ##
+      # @param [string] edge_id
       # @param [string] id
       # @param [EndpointCircuitBreaker] a_module
       # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
-      def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         data = {}
@@ -49,13 +53,15 @@ module NgrokAPI
       end
 
       ##
-      # @param [string] id a resource identifier
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
       # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
-      def get(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         data = {}
@@ -64,13 +70,15 @@ module NgrokAPI
       end
 
       ##
-      # @param [string] id a resource identifier
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
       # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
-      def get!(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         data = {}
@@ -79,26 +87,30 @@ module NgrokAPI
       end
 
       ##
-      # @param [string] id a resource identifier
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
-      def delete(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         @client.delete(path % replacements)
       end
 
       ##
-      # @param [string] id a resource identifier
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
-      def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/circuit_breaker'
+      # https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/circuit_breaker'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         @client.delete(path % replacements, danger: true)