ngrok-api 0.9.0 → 0.16.0

data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-ip-policy-module
+    class EndpointIPPolicyModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/ip_policy'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          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] id
+      # @param [EndpointIPPolicyMutate] a_module
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          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] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get
+      def get(id: "")
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointIPPolicy.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointIPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get
+      def get!(id: "")
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        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-ip-policy-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-ip-policy-module-delete
+      def delete!(id: "")
+        path = '/endpoint_configurations/%{id}/ip_policy'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_logging_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-logging-module
+    class EndpointLoggingModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/logging'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointLoggingMutate] a_module
+      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-logging-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointLogging.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointLoggingMutate] a_module
+      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-logging-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointLogging.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-logging-module-get
+      def get(id: "")
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointLogging.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-logging-module-get
+      def get!(id: "")
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointLogging.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-logging-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-logging-module-delete
+      def delete!(id: "")
+        path = '/endpoint_configurations/%{id}/logging'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-mutual-tls-module
+    class EndpointMutualTLSModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/mutual_tls'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
+      end
+
+      ##
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
+      end
+
+      ##
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointMutualTLS.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-mutual-tls-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/mutual_tls'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @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'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb

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

data/lib/ngrokapi/services/endpoint_oidc_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-oidc-module
+    class EndpointOIDCModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/oidc'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @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'
+        replacements = {
+          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] 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'
+        replacements = {
+          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] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointOIDC.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-oidc-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/oidc'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-request-headers-module
+    class EndpointRequestHeadersModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/request_headers'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @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'
+        replacements = {
+          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] 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'
+        replacements = {
+          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] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointRequestHeaders.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-request-headers-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/request_headers'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @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'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end