ngrok-api 0.14.0 → 0.17.0

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,12 +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
-      def replace(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -39,12 +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
-      def replace!(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -58,11 +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
-      def get(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get
+      def get(id: "")
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -75,11 +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
-      def get!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get
+      def get!(id: "")
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -92,11 +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
-      def delete(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete
+      def delete(id: "")
+        path = '/edges/tls/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -107,11 +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
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/mutual_tls'
+      # https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete
+      def delete!(id: "")
+        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,12 +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
-      def replace(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -39,12 +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
-      def replace!(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -58,11 +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
-      def get(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get
+      def get(id: "")
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -75,11 +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
-      def get!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get
+      def get!(id: "")
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -92,11 +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
-      def delete(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete
+      def delete(id: "")
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }
@@ -107,11 +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
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/tls_termination'
+      # https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete
+      def delete!(id: "")
+        path = '/edges/tls/%{id}/tls_termination'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb}

@@ -3,15 +3,15 @@
 module NgrokAPI
   module Services
     ##
-    # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
-    #  with an `endpoints` type instead.
+    # A Tunnel Group Backend balances traffic among all online tunnels that match
+    #  a label selector.
     #
-    # https://ngrok.com/docs/api#api-ip-whitelist
-    class IPWhitelistClient
+    # https://ngrok.com/docs/api#api-tunnel-group-backends
+    class TunnelGroupBackendsClient
       # The API path for the requests
-      PATH = '/ip_whitelist'
+      PATH = '/backends/tunnel_group'
       # The List Property from the resulting API for list calls
-      LIST_PROPERTY = 'whitelist'
+      LIST_PROPERTY = 'backends'
 
       attr_reader :client
 
@@ -20,42 +20,35 @@ module NgrokAPI
       end
 
       ##
-      # Create a new IP whitelist entry that will restrict traffic to all tunnel
-      # endpoints on the account.
-      #
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @param [string] ip_net an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-create
-      def create(
-        description: "",
-        metadata: "",
-        ip_net: ""
-      )
-        path = '/ip_whitelist'
+      # 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[:ip_net] = ip_net if ip_net
+        data[:labels] = labels if labels
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # 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-ip-whitelist-delete
-      def delete(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete(id: "")
+        path = '/backends/tunnel_group/%{id}'
         replacements = {
           id: id,
         }
@@ -63,17 +56,15 @@ module NgrokAPI
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # 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-ip-whitelist-delete
-      def delete!(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete!(id: "")
+        path = '/backends/tunnel_group/%{id}'
         replacements = {
           id: id,
         }
@@ -81,58 +72,51 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an IP whitelist entry by ID.
+      # Get detailed information about a TunnelGroup backend by ID
       #
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-get
-      def get(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # 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::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
       end
 
       ##
-      # Get detailed information about an IP whitelist entry by ID.
+      # Get detailed information about a TunnelGroup backend by ID
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-get
-      def get!(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # 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::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
       end
 
       ##
-      # List all IP whitelist entries on this account
+      # 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-ip-whitelist-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      # 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,
@@ -144,12 +128,12 @@ module NgrokAPI
           client: self,
           result: result,
           list_property: LIST_PROPERTY,
-          klass: NgrokAPI::Models::IPWhitelistEntry
+          klass: NgrokAPI::Models::TunnelGroupBackend
         )
       end
 
       ##
-      # List all IP whitelist entries on this account
+      # List all TunnelGroup backends on this account
       # Throws an exception if API error.
       #
       # @param [string] before_id
@@ -157,12 +141,9 @@ module NgrokAPI
       # @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-ip-whitelist-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      # 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,
@@ -175,60 +156,56 @@ module NgrokAPI
           client: self,
           result: result,
           list_property: LIST_PROPERTY,
-          klass: NgrokAPI::Models::IPWhitelistEntry,
+          klass: NgrokAPI::Models::TunnelGroupBackend,
           danger: true
         )
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update TunnelGroup backend by ID
       #
       # @param [string] id
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
-        path = '/ip_whitelist/%{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::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update TunnelGroup backend by ID
       # Throws an exception if API error.
       #
       # @param [string] id
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
-        path = '/ip_whitelist/%{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::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
       end
     end
   end

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -29,11 +29,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -59,11 +56,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -88,9 +82,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TunnelSession] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/tunnel_sessions/%{id}'
         replacements = {
           id: id,
@@ -108,9 +100,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TunnelSession] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/tunnel_sessions/%{id}'
         replacements = {
           id: id,
@@ -130,9 +120,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-restart
-      def restart(
-        id: ""
-      )
+      def restart(id: "")
         path = '/tunnel_sessions/%{id}/restart'
         replacements = {
           id: id,
@@ -151,9 +139,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-restart
-      def restart!(
-        id: ""
-      )
+      def restart!(id: "")
         path = '/tunnel_sessions/%{id}/restart'
         replacements = {
           id: id,
@@ -169,9 +155,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-stop
-      def stop(
-        id: ""
-      )
+      def stop(id: "")
         path = '/tunnel_sessions/%{id}/stop'
         replacements = {
           id: id,
@@ -188,9 +172,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-stop
-      def stop!(
-        id: ""
-      )
+      def stop!(id: "")
         path = '/tunnel_sessions/%{id}/stop'
         replacements = {
           id: id,
@@ -216,10 +198,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-update
-      def update(
-        id: "",
-        version: ""
-      )
+      def update(id: "", version: "")
         path = '/tunnel_sessions/%{id}/update'
         replacements = {
           id: id,
@@ -246,10 +225,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-sessions-update
-      def update!(
-        id: "",
-        version: ""
-      )
+      def update!(id: "", version: "")
         path = '/tunnel_sessions/%{id}/update'
         replacements = {
           id: id,