ngrok-api 0.16.0 → 0.19.0

data/lib/ngrokapi/models/tls_edge.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TLSEdge
+      attr_reader :client,
+        :attrs,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :backend,
+        :ip_restriction,
+        :mutual_tls,
+        :tls_termination
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @id = @attrs['id']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @created_at = @attrs['created_at']
+        @uri = @attrs['uri']
+        @hostports = @attrs['hostports']
+        @backend = @attrs['backend']
+        @ip_restriction = @attrs['ip_restriction']
+        @mutual_tls = @attrs['mutual_tls']
+        @tls_termination = @attrs['tls_termination']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+
+      ##
+      # Updates a TLS Edge by ID. If a module is not specified in the update, it will
+      # not be modified. However, each module configuration that is specified will
+      # completely replace the existing value. There is no way to delete an existing
+      # module via this API, instead use the delete module API.
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        backend: nil,
+        ip_restriction: nil,
+        mutual_tls: nil,
+        tls_termination: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
+        @mutual_tls = mutual_tls if mutual_tls
+        @tls_termination = tls_termination if tls_termination
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          backend: backend,
+          ip_restriction: ip_restriction,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination
+        )
+      end
+
+      ##
+      # Delete a TLS Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel.rb

@@ -4,33 +4,45 @@ module NgrokAPI
   module Models
     class Tunnel
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :public_url,
         :started_at,
         :metadata,
         :proto,
         :region,
-        :tunnel_session
+        :tunnel_session,
+        :endpoint,
+        :labels,
+        :backends,
+        :forwards_to
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @public_url = @result['public_url']
-        @started_at = @result['started_at']
-        @metadata = @result['metadata']
-        @proto = @result['proto']
-        @region = @result['region']
-        @tunnel_session = @result['tunnel_session']
+        @attrs = attrs
+        @id = @attrs['id']
+        @public_url = @attrs['public_url']
+        @started_at = @attrs['started_at']
+        @metadata = @attrs['metadata']
+        @proto = @attrs['proto']
+        @region = @attrs['region']
+        @tunnel_session = @attrs['tunnel_session']
+        @endpoint = @attrs['endpoint']
+        @labels = @attrs['labels']
+        @backends = @attrs['backends']
+        @forwards_to = @attrs['forwards_to']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/tunnel_group_backend.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TunnelGroupBackend
+      attr_reader :client,
+        :attrs,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :labels,
+        :tunnels
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @labels = @attrs['labels']
+        @tunnels = @attrs['tunnels']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID.
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        labels: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @labels = labels if labels
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          labels: labels
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel_session.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TunnelSession
       attr_reader :client,
-        :result,
+        :attrs,
         :agent_version,
         :credential,
         :id,
@@ -16,27 +16,31 @@ module NgrokAPI
         :transport,
         :uri
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @agent_version = @result['agent_version']
-        @credential = @result['credential']
-        @id = @result['id']
-        @ip = @result['ip']
-        @metadata = @result['metadata']
-        @os = @result['os']
-        @region = @result['region']
-        @started_at = @result['started_at']
-        @transport = @result['transport']
-        @uri = @result['uri']
+        @attrs = attrs
+        @agent_version = @attrs['agent_version']
+        @credential = @attrs['credential']
+        @id = @attrs['id']
+        @ip = @attrs['ip']
+        @metadata = @attrs['metadata']
+        @os = @attrs['os']
+        @region = @attrs['region']
+        @started_at = @attrs['started_at']
+        @transport = @attrs['transport']
+        @uri = @attrs['uri']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/weighted_backend.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class WeightedBackend
+      attr_reader :client,
+        :attrs,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :backends
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @backends = @attrs['backends']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+
+      ##
+      # Delete a Weighted backend by ID.
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update Weighted backend by ID
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        backends: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @backends = backends if backends
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          backends: backends
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/paged_iterator.rb

@@ -26,7 +26,7 @@ module NgrokAPI
     #
     # @return [object] Returns an instance of a class.
     def get_next
-      item = @page.result[@list_property][@n]
+      item = @page.attrs[@list_property][@n]
       raise "None" if item.nil?
       self.n += 1
       item

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -35,7 +35,29 @@ module NgrokAPI
         data[:urls] = urls if urls
         data[:metadata] = metadata if metadata
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
+      end
+
+      ##
+      # Creates a new abuse report which will be reviewed by our system and abuse
+      # response team. This API is only available to authorized accounts. Contact
+      # abuse@ngrok.com to request access
+      # Throws an exception if API error.
+      #
+      # @param [List<uri (string)>] urls a list of URLs containing suspected abusive content
+      # @param [string] metadata arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::AbuseReport] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-abuse-reports-create
+      def create!(urls:, metadata: "")
+        path = '/abuse_reports'
+        replacements = {
+        }
+        data = {}
+        data[:urls] = urls if urls
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
 
       ##
@@ -52,7 +74,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
 
       ##
@@ -70,7 +92,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/agent_ingresses_client.rb

@@ -35,7 +35,30 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:domain] = domain if domain
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new Agent Ingress. The ngrok agent can be configured to connect to
+      # ngrok via the new set of addresses on the returned Agent Ingress.
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
+      # @param [string] domain the domain that you own to be used as the base domain name to generate regional agent ingress domains.
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-create
+      def create!(description: "", metadata: "", domain:)
+        path = '/agent_ingresses'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:domain] = domain if domain
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
 
       ##
@@ -83,7 +106,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
 
       ##
@@ -101,7 +124,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
 
       ##
@@ -113,8 +136,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-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,
@@ -124,7 +146,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::AgentIngress
         )
@@ -140,8 +162,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-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,
@@ -152,7 +173,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::AgentIngress,
           danger: true
@@ -177,7 +198,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
 
       ##
@@ -199,7 +220,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/api_keys_client.rb

@@ -39,7 +39,28 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::APIKey.new(client: self, result: result)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new API key. The generated API key can be used to authenticate to the
+      # ngrok API.
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::APIKey] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-create
+      def create!(description: "", metadata: "")
+        path = '/api_keys'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
 
       ##
@@ -87,7 +108,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::APIKey.new(client: self, result: result)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
 
       ##
@@ -105,7 +126,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::APIKey.new(client: self, result: result)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
 
       ##
@@ -117,8 +138,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-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,
@@ -128,7 +148,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::APIKey
         )
@@ -144,8 +164,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-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,
@@ -156,7 +175,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::APIKey,
           danger: true
@@ -181,7 +200,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::APIKey.new(client: self, result: result)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
 
       ##
@@ -203,7 +222,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::APIKey.new(client: self, result: result)
+        NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
     end
   end