ngrok-api 0.19.0 → 0.21.0

data/lib/ngrokapi/models/ssh_credential.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class SSHCredential
@@ -11,18 +15,22 @@ module NgrokAPI
         :description,
         :metadata,
         :public_key,
-        :acl
+        :acl,
+        :owner_id
 
       def initialize(client: nil, attrs: {})
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']
         @public_key = @attrs['public_key']
         @acl = @attrs['acl']
+        @owner_id = @attrs['owner_id']
       end
 
       def ==(other)

data/lib/ngrokapi/models/ssh_host_certificate.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class SSHHostCertificate
@@ -22,7 +26,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/models/ssh_user_certificate.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class SSHUserCertificate
@@ -24,7 +28,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/models/tcp_edge.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class TCPEdge
@@ -21,7 +25,9 @@ module NgrokAPI
         @description = @attrs['description']
         @metadata = @attrs['metadata']
         @created_at = @attrs['created_at']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @hostports = @attrs['hostports']
         @backend = @attrs['backend']
         @ip_restriction = @attrs['ip_restriction']

data/lib/ngrokapi/models/tls_certificate.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class TLSCertificate
@@ -31,7 +35,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/models/tls_certificate_sa_ns.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Models
     class TLSCertificateSANs

data/lib/ngrokapi/models/tls_edge.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class TLSEdge
@@ -23,7 +27,9 @@ module NgrokAPI
         @description = @attrs['description']
         @metadata = @attrs['metadata']
         @created_at = @attrs['created_at']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @hostports = @attrs['hostports']
         @backend = @attrs['backend']
         @ip_restriction = @attrs['ip_restriction']

data/lib/ngrokapi/models/tunnel.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class Tunnel
@@ -21,7 +25,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @public_url = @attrs['public_url']
+        unless @attrs['public_url'].nil?
+          @public_url = URI(@attrs['public_url'])
+        end
         @started_at = @attrs['started_at']
         @metadata = @attrs['metadata']
         @proto = @attrs['proto']

data/lib/ngrokapi/models/tunnel_group_backend.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class TunnelGroupBackend
@@ -17,7 +21,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/models/tunnel_session.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class TunnelSession
@@ -28,7 +32,9 @@ module NgrokAPI
         @region = @attrs['region']
         @started_at = @attrs['started_at']
         @transport = @attrs['transport']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
       end
 
       def ==(other)

data/lib/ngrokapi/models/user_agent.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class UserAgent
+      attr_reader :client,
+        :attrs,
+        :raw,
+        :browser_name,
+        :browser_version,
+        :device_type,
+        :os_name,
+        :os_version
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @raw = @attrs['raw']
+        @browser_name = @attrs['browser_name']
+        @browser_version = @attrs['browser_version']
+        @device_type = @attrs['device_type']
+        @os_name = @attrs['os_name']
+        @os_version = @attrs['os_version']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/weighted_backend.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class WeightedBackend
@@ -16,7 +20,9 @@ module NgrokAPI
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/paged_iterator.rb

@@ -1,42 +1,44 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  ##
-  # Low level class which allows the user to iterate through the results of a list API call
-  class PagedIterator
-    attr_accessor :page, :n
-    attr_reader :client, :list_property
-
-    def initialize(
-      client:,
-      page:,
-      list_property:,
-      danger: false
-    )
-      @n = 0
-      @client = client
-      @list_property = list_property
-      @page = page
-      @danger = danger
-    end
-
-    ##
-    # Iterate through the result set, returning the next instance if we already have one, or make
-    # a new API call to next_page_uri to get more results and return the next one from that call.
-    #
-    # @return [object] Returns an instance of a class.
-    def get_next
-      item = @page.attrs[@list_property][@n]
-      raise "None" if item.nil?
-      self.n += 1
-      item
-    rescue
-      if @page.next_page_uri
-        res = @client.list(danger: @danger, url: @page.next_page_uri)
-        self.n = 0
-        self.page = res
-        get_next
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  ##
+  # Low level class which allows the user to iterate through the results of a list API call
+  class PagedIterator
+    attr_accessor :page, :n
+    attr_reader :client, :list_property
+
+    def initialize(
+      client:,
+      page:,
+      list_property:,
+      danger: false
+    )
+      @n = 0
+      @client = client
+      @list_property = list_property
+      @page = page
+      @danger = danger
+    end
+
+    ##
+    # Iterate through the result set, returning the next instance if we already have one, or make
+    # a new API call to next_page_uri to get more results and return the next one from that call.
+    #
+    # @return [object] Returns an instance of a class.
+    def get_next
+      item = @page.attrs[@list_property][@n]
+      raise "None" if item.nil?
+      self.n += 1
+      item
+    rescue
+      if @page.next_page_uri
+        res = @client.list(danger: @danger, url: @page.next_page_uri)
+        self.n = 0
+        self.page = res
+        get_next
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##

data/lib/ngrokapi/services/agent_ingresses_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -23,10 +25,11 @@ module NgrokAPI
       # @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.
+      # @param [AgentIngressCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.
       # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-create
-      def create(description: "", metadata: "", domain:)
+      def create(description: "", metadata: "", domain:, certificate_management_policy: nil)
         path = '/agent_ingresses'
         replacements = {
         }
@@ -34,6 +37,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         data[:domain] = domain if domain
+        data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.post(path % replacements, data: data)
         NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
@@ -46,10 +50,11 @@ module NgrokAPI
       # @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.
+      # @param [AgentIngressCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.
       # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-create
-      def create!(description: "", metadata: "", domain:)
+      def create!(description: "", metadata: "", domain:, certificate_management_policy: nil)
         path = '/agent_ingresses'
         replacements = {
         }
@@ -57,6 +62,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         data[:domain] = domain if domain
+        data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.post(path % replacements, data: data, danger: true)
         NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
@@ -186,10 +192,11 @@ module NgrokAPI
       # @param [string] id
       # @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 [AgentIngressCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.
       # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-update
-      def update(id: "", description: nil, metadata: nil)
+      def update(id: "", description: nil, metadata: nil, certificate_management_policy: nil)
         path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
@@ -197,6 +204,7 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
+        data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.patch(path % replacements, data: data)
         NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
@@ -208,10 +216,11 @@ module NgrokAPI
       # @param [string] id
       # @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 [AgentIngressCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.
       # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
       # https://ngrok.com/docs/api#api-agent-ingresses-update
-      def update!(id: "", description: nil, metadata: nil)
+      def update!(id: "", description: nil, metadata: nil, certificate_management_policy: nil)
         path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
@@ -219,6 +228,7 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
+        data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
         result = @client.patch(path % replacements, data: data, danger: true)
         NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end

data/lib/ngrokapi/services/api_keys_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -28,16 +30,18 @@ module NgrokAPI
       #
       # @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
+      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-create
-      def create(description: "", metadata: "")
+      def create(description: "", metadata: "", owner_id: nil, owner_email: "")
         path = '/api_keys'
         replacements = {
         }
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
+        data[:owner_id] = owner_id if owner_id
         result = @client.post(path % replacements, data: data)
         NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end
@@ -49,16 +53,18 @@ module NgrokAPI
       #
       # @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
+      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-create
-      def create!(description: "", metadata: "")
+      def create!(description: "", metadata: "", owner_id: nil, owner_email: "")
         path = '/api_keys'
         replacements = {
         }
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
+        data[:owner_id] = owner_id if owner_id
         result = @client.post(path % replacements, data: data, danger: true)
         NgrokAPI::Models::APIKey.new(client: self, attrs: result)
       end

data/lib/ngrokapi/services/application_sessions_client.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-application-sessions
+    class ApplicationSessionsClient
+      # The API path for the requests
+      PATH = '/app/sessions/%{id}'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'application_sessions'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Get an application session by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ApplicationSession] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-get
+      def get(id: "")
+        path = '/app/sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::ApplicationSession.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get an application session by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ApplicationSession] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-get
+      def get!(id: "")
+        path = '/app/sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::ApplicationSession.new(client: self, attrs: result)
+      end
+
+      ##
+      # Delete an application session by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-delete
+      def delete(id: "")
+        path = '/app/sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an application session by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-delete
+      def delete!(id: "")
+        path = '/app/sessions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # List all application sessions for this account.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-list
+      def list(before_id: nil, limit: nil, url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::ApplicationSession
+        )
+      end
+
+      ##
+      # List all application sessions for this account.
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-application-sessions-list
+      def list!(before_id: nil, limit: nil, url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::ApplicationSession,
+          danger: true
+        )
+      end
+    end
+  end
+end