ngrok-api 0.16.0 → 0.17.0

data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-compression-module
-    class EndpointCompressionModuleClient
+    # https://ngrok.com/docs/api#api-edge-route-compression-module
+    class EdgeRouteCompressionModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/compression'
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/compression'
 
       attr_reader :client
 
@@ -15,14 +15,16 @@ module NgrokAPI
       end
 
       ##
+      # @param [string] edge_id
       # @param [string] id
       # @param [EndpointCompression] a_module
       # @return [NgrokAPI::Models::EndpointCompression] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
-      def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         data = {}
@@ -32,14 +34,16 @@ module NgrokAPI
       end
 
       ##
+      # @param [string] edge_id
       # @param [string] id
       # @param [EndpointCompression] a_module
       # @return [NgrokAPI::Models::EndpointCompression] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
-      def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         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::EndpointCompression] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
-      def get(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         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::EndpointCompression] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
-      def get!(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         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-compression-module-delete
-      def delete(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         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-compression-module-delete
-      def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/compression'
+      # https://ngrok.com/docs/api#api-edge-route-compression-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/compression'
         replacements = {
+          edge_id: edge_id,
           id: id,
         }
         @client.delete(path % replacements, danger: true)

data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-ip-restriction-module
+    class EdgeRouteIPRestrictionModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        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::EndpointIPPolicy.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::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointIPPolicy.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::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointIPPolicy.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-ip-restriction-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        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-ip-restriction-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/ip_restriction'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-o-auth-module
+    class EdgeRouteOAuthModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointOAuth] a_module
+      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        replacements = {
+          edge_id: edge_id,
+          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)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointOAuth] a_module
+      # @return [NgrokAPI::Models::EndpointOAuth] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        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::EndpointOAuth.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::EndpointOAuth] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-o-auth-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointOAuth.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::EndpointOAuth] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-o-auth-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointOAuth.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-o-auth-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        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-o-auth-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/edge_route_oidc_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-oidc-module
+    class EdgeRouteOIDCModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointOIDC] a_module
+      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-oidc-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointOIDC] a_module
+      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-oidc-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        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::EndpointOIDC.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::EndpointOIDC] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-oidc-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointOIDC.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::EndpointOIDC] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-oidc-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointOIDC.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-oidc-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        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-oidc-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/oidc'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-request-headers-module
+    class EdgeRouteRequestHeadersModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointRequestHeaders] a_module
+      # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-request-headers-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointRequestHeaders] a_module
+      # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-request-headers-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        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::EndpointRequestHeaders.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::EndpointRequestHeaders] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-request-headers-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointRequestHeaders.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::EndpointRequestHeaders] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-request-headers-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointRequestHeaders.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-request-headers-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        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-request-headers-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end