ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-oidc-module
-    class EndpointOIDCModuleClient
+    # https://ngrok.com/docs/api#api-edge-route-oidc-module
+    class EdgeRouteOIDCModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/oidc'
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/oidc'
 
       attr_reader :client
 
@@ -15,17 +15,16 @@ module NgrokAPI
       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-endpoint-oidc-module-replace
-      def replace(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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 = {}
@@ -35,17 +34,16 @@ module NgrokAPI
       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-endpoint-oidc-module-replace
-      def replace!(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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 = {}
@@ -55,15 +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::EndpointOIDC] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-get
-      def get(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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 = {}
@@ -72,15 +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::EndpointOIDC] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-get
-      def get!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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 = {}
@@ -89,30 +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-oidc-module-delete
-      def delete(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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] 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-oidc-module-delete
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/oidc'
+      # 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)

data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-request-headers-module
-    class EndpointRequestHeadersModuleClient
+    # https://ngrok.com/docs/api#api-edge-route-request-headers-module
+    class EdgeRouteRequestHeadersModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/request_headers'
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/request_headers'
 
       attr_reader :client
 
@@ -15,17 +15,16 @@ module NgrokAPI
       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-endpoint-request-headers-module-replace
-      def replace(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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 = {}
@@ -35,17 +34,16 @@ module NgrokAPI
       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-endpoint-request-headers-module-replace
-      def replace!(
-        id: "",
-        a_module: nil
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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 = {}
@@ -55,15 +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::EndpointRequestHeaders] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-request-headers-module-get
-      def get(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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 = {}
@@ -72,15 +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::EndpointRequestHeaders] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-request-headers-module-get
-      def get!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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 = {}
@@ -89,30 +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-request-headers-module-delete
-      def delete(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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] 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-request-headers-module-delete
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/request_headers'
+      # 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)

data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb}

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

data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb}

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