ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/services/ssh_user_certificates_client.rb

@@ -35,17 +35,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-create
-      def create(
-        ssh_certificate_authority_id:,
-        public_key:,
-        principals: [],
-        critical_options: {},
-        extensions: {},
-        valid_after: "",
-        valid_until: "",
-        description: "",
-        metadata: ""
-      )
+      def create(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "")
         path = '/ssh_user_certificates'
         replacements = {
         }
@@ -70,9 +60,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,
@@ -88,9 +76,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,
@@ -105,9 +91,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,
@@ -125,9 +109,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,
@@ -146,11 +128,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-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,
@@ -176,11 +155,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-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,
@@ -207,11 +183,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,
@@ -233,11 +205,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/ssh_user_certificates/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-logging-module
-    class EndpointLoggingModuleClient
+    # https://ngrok.com/docs/api#api-tcp-edge-backend-module
+    class TCPEdgeBackendModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/logging'
+      PATH = '/edges/tcp/%{id}/backend'
 
       attr_reader :client
 
@@ -16,87 +16,75 @@ module NgrokAPI
 
       ##
       # @param [string] id
-      # @param [EndpointLoggingMutate] a_module
-      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] 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'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/edges/tcp/%{id}/backend'
         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)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
       end
 
       ##
       # @param [string] id
-      # @param [EndpointLoggingMutate] a_module
-      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] 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'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/edges/tcp/%{id}/backend'
         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)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-logging-module-get
-      def get(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/logging'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-get
+      def get(id: "")
+        path = '/edges/tcp/%{id}/backend'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointLogging.new(client: self, result: result)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointLogging] result from the API request
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-logging-module-get
-      def get!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/logging'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-get
+      def get!(id: "")
+        path = '/edges/tcp/%{id}/backend'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointLogging.new(client: self, result: result)
+        NgrokAPI::Models::EndpointBackend.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'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete
+      def delete(id: "")
+        path = '/edges/tcp/%{id}/backend'
         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-logging-module-delete
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/logging'
+      # https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete
+      def delete!(id: "")
+        path = '/edges/tcp/%{id}/backend'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-ip-policy-module
-    class EndpointIPPolicyModuleClient
+    # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module
+    class TCPEdgeIPRestrictionModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/ip_policy'
+      PATH = '/edges/tcp/%{id}/ip_restriction'
 
       attr_reader :client
 
@@ -19,12 +19,9 @@ module NgrokAPI
       # @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'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/edges/tcp/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
@@ -39,12 +36,9 @@ module NgrokAPI
       # @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'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/edges/tcp/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
@@ -58,11 +52,9 @@ module NgrokAPI
       # @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'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get
+      def get(id: "")
+        path = '/edges/tcp/%{id}/ip_restriction'
         replacements = {
           id: id,
         }
@@ -75,11 +67,9 @@ module NgrokAPI
       # @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'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get
+      def get!(id: "")
+        path = '/edges/tcp/%{id}/ip_restriction'
         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-ip-policy-module-delete
-      def delete(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/ip_policy'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete
+      def delete(id: "")
+        path = '/edges/tcp/%{id}/ip_restriction'
         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-ip-policy-module-delete
-      def delete!(
-        id: ""
-      )
-        path = '/endpoint_configurations/%{id}/ip_policy'
+      # https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete
+      def delete!(id: "")
+        path = '/edges/tcp/%{id}/ip_restriction'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -32,12 +32,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-create
-      def create(
-        description: "",
-        metadata: "",
-        certificate_pem:,
-        private_key_pem:
-      )
+      def create(description: "", metadata: "", certificate_pem:, private_key_pem:)
         path = '/tls_certificates'
         replacements = {
         }
@@ -57,9 +52,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -75,9 +68,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -92,9 +83,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -112,9 +101,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -133,11 +120,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-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,
@@ -163,11 +147,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-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,
@@ -194,11 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,
@@ -220,11 +197,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::TLSCertificate] result from the API request
       #
       # https://ngrok.com/docs/api#api-tls-certificates-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/tls_certificates/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/tls_edge_backend_module_client.rb

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

data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module
+    class TLSEdgeIPRestrictionModuleClient
+      # The API path for the requests
+      PATH = '/edges/tls/%{id}/ip_restriction'
+
+      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-tls-edge-ip-restriction-module-replace
+      def replace(id: "", a_module: nil)
+        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::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-tls-edge-ip-restriction-module-replace
+      def replace!(id: "", a_module: nil)
+        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::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-tls-edge-ip-restriction-module-get
+      def get(id: "")
+        path = '/edges/tls/%{id}/ip_restriction'
+        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-tls-edge-ip-restriction-module-get
+      def get!(id: "")
+        path = '/edges/tls/%{id}/ip_restriction'
+        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-tls-edge-ip-restriction-module-delete
+      def delete(id: "")
+        path = '/edges/tls/%{id}/ip_restriction'
+        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-tls-edge-ip-restriction-module-delete
+      def delete!(id: "")
+        path = '/edges/tls/%{id}/ip_restriction'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end