ngrok-api 0.18.0 → 0.21.0

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,10 +1,14 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class WeightedBackend
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -12,27 +16,33 @@ module NgrokAPI
         :metadata,
         :backends
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @backends = @result['backends']
+        @attrs = attrs
+        @id = @attrs['id']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @backends = @attrs['backends']
       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
 
       ##
-      # Delete a Weighted backend by ID. TODO what if used?
+      # Delete a Weighted backend by ID.
       #
       # https://ngrok.com/docs/api#api-weighted-backends-delete
       def delete

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.result[@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
     ##
@@ -35,7 +37,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 +76,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 +94,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

@@ -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,8 +37,34 @@ 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, 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.
+      # @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:, certificate_management_policy: nil)
+        path = '/agent_ingresses'
+        replacements = {
+        }
+        data = {}
+        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
 
       ##
@@ -83,7 +112,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 +130,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 +142,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 +152,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::AgentIngress
         )
@@ -140,8 +168,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 +179,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::AgentIngress,
           danger: true
@@ -165,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,
@@ -176,8 +204,9 @@ 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, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
 
       ##
@@ -187,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,
@@ -198,8 +228,9 @@ 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, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, attrs: result)
       end
     end
   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,18 +30,43 @@ 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, 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
+      # @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: "", 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
 
       ##
@@ -87,7 +114,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 +132,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 +144,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 +154,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::APIKey
         )
@@ -144,8 +170,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 +181,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 +206,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 +228,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

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