ngrok-api 0.16.0 → 0.17.0

data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-o-auth-module
-    class EndpointOAuthModuleClient
+    # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module
+    class TLSEdgeIPRestrictionModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/oauth'
+      PATH = '/edges/tls/%{id}/ip_restriction'
 
       attr_reader :client
 
@@ -16,75 +16,75 @@ module NgrokAPI
 
       ##
       # @param [string] id
-      # @param [EndpointOAuth] a_module
-      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-replace
       def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
         data = {}
         data[:module] = a_module if a_module
         result = @client.put(path % replacements, data: data)
-        NgrokAPI::Models::EndpointOAuth.new(client: self, result: result)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
       end
 
       ##
       # @param [string] id
-      # @param [EndpointOAuth] a_module
-      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-replace
       def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
         data = {}
         data[:module] = a_module if a_module
         result = @client.put(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointOAuth.new(client: self, result: result)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-get
       def get(id: "")
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointOAuth.new(client: self, result: result)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-get
       def get!(id: "")
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointOAuth.new(client: self, result: result)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
       end
 
       ##
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-delete
       def delete(id: "")
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
@@ -95,9 +95,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-o-auth-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-delete
       def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/oauth'
+        path = '/edges/tls/%{id}/ip_restriction'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module
-    class EndpointMutualTLSModuleClient
+    # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module
+    class TLSEdgeMutualTLSModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/mutual_tls'
+      PATH = '/edges/tls/%{id}/mutual_tls'
 
       attr_reader :client
 
@@ -19,9 +19,9 @@ module NgrokAPI
       # @param [EndpointMutualTLSMutate] a_module
       # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace
       def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -36,9 +36,9 @@ module NgrokAPI
       # @param [EndpointMutualTLSMutate] a_module
       # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace
       def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -52,9 +52,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get
       def get(id: "")
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -67,9 +67,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get
       def get!(id: "")
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -82,9 +82,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete
       def delete(id: "")
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -95,9 +95,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete
       def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-tls-termination-module
-    class EndpointTLSTerminationModuleClient
+    # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module
+    class TLSEdgeTLSTerminationModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/tls_termination'
+      PATH = '/edges/tls/%{id}/tls_termination'
 
       attr_reader :client
 
@@ -19,9 +19,9 @@ module NgrokAPI
       # @param [EndpointTLSTermination] a_module
       # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace
       def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -36,9 +36,9 @@ module NgrokAPI
       # @param [EndpointTLSTermination] a_module
       # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace
       def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -52,9 +52,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get
       def get(id: "")
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -67,9 +67,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get
       def get!(id: "")
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -82,9 +82,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete
       def delete(id: "")
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -95,9 +95,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-tls-termination-module-delete
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete
       def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/tls_termination'
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/tunnel_group_backends_client.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A Tunnel Group Backend balances traffic among all online tunnels that match
+    #  a label selector.
+    #
+    # https://ngrok.com/docs/api#api-tunnel-group-backends
+    class TunnelGroupBackendsClient
+      # The API path for the requests
+      PATH = '/backends/tunnel_group'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'backends'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new TunnelGroup backend
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-create
+      def create(description: "", metadata: "", labels: {})
+        path = '/backends/tunnel_group'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID. TODO what if used?
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID. TODO what if used?
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete!(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a TunnelGroup backend by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-get
+      def get(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about a TunnelGroup backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-get
+      def get!(id: "")
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+      end
+
+      ##
+      # List all TunnelGroup backends on this account
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-list
+      def list(before_id: nil, limit: nil,
+               url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelGroupBackend
+        )
+      end
+
+      ##
+      # List all TunnelGroup backends on this account
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-list
+      def list!(before_id: nil, limit: nil,
+                url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          result: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::TunnelGroupBackend,
+          danger: true
+        )
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update(id: "", description: nil, metadata: nil, labels: {})
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update!(id: "", description: nil, metadata: nil, labels: {})
+        path = '/backends/tunnel_group/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/tunnels_client.rb

@@ -73,6 +73,41 @@ module NgrokAPI
           danger: true
         )
       end
+
+      ##
+      # Get the status of a tunnel by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Tunnel] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-get
+      def get(id: "")
+        path = '/tunnels/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::Tunnel.new(client: self, result: result)
+      end
+
+      ##
+      # Get the status of a tunnel by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Tunnel] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnels-get
+      def get!(id: "")
+        path = '/tunnels/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::Tunnel.new(client: self, result: result)
+      end
     end
   end
 end