ngrok-api 0.19.0 → 0.22.0

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.27
+    &mdash; Documentation by YARD 0.9.36
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Apr 11 19:32:55 2022 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.27 (ruby-2.7.5).
+  Generated on Tue Apr 30 20:26:13 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.36 (ruby-3.3.0).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 require 'ostruct'
 
 module NgrokAPI
@@ -36,6 +38,28 @@ module NgrokAPI
       @_api_keys ||= NgrokAPI::Services::APIKeysClient.new(client: @client)
     end
 
+    def application_sessions
+      @_application_sessions ||= NgrokAPI::Services::ApplicationSessionsClient.new(client: @client)
+    end
+
+    def application_users
+      @_application_users ||= NgrokAPI::Services::ApplicationUsersClient.new(client: @client)
+    end
+
+    ##
+    # Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+    #  sessions that are running and connected to the ngrok service. Each tunnel
+    #  session can include one or more Tunnels.
+    #
+    # @return [NgrokAPI::Services::TunnelSessionsClient]
+    def tunnel_sessions
+      @_tunnel_sessions ||= NgrokAPI::Services::TunnelSessionsClient.new(client: @client)
+    end
+
+    def bot_users
+      @_bot_users ||= NgrokAPI::Services::BotUsersClient.new(client: @client)
+    end
+
     ##
     # Certificate Authorities are x509 certificates that are used to sign other
     #  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -51,7 +75,7 @@ module NgrokAPI
     ##
     # Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
     #  agent to connect the ngrok service as your account. They are installed with
-    #  the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
+    #  the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
     #  configuration file with the `authtoken` property.
     #
     # @return [NgrokAPI::Services::CredentialsClient]
@@ -185,16 +209,6 @@ module NgrokAPI
       @_tls_certificates ||= NgrokAPI::Services::TLSCertificatesClient.new(client: @client)
     end
 
-    ##
-    # Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
-    #  sessions that are running and connected to the ngrok service. Each tunnel
-    #  session can include one or more Tunnels.
-    #
-    # @return [NgrokAPI::Services::TunnelSessionsClient]
-    def tunnel_sessions
-      @_tunnel_sessions ||= NgrokAPI::Services::TunnelSessionsClient.new(client: @client)
-    end
-
     ##
     # Tunnels provide endpoints to access services exposed by a running ngrok
     #  agent tunnel session or an SSH reverse tunnel session.
@@ -208,6 +222,7 @@ module NgrokAPI
       ns = OpenStruct.new
       ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
       ns.http_response = NgrokAPI::Services::HTTPResponseBackendsClient.new(client: @client)
+      ns.static_address = NgrokAPI::Services::StaticBackendsClient.new(client: @client)
       ns.tunnel_group = NgrokAPI::Services::TunnelGroupBackendsClient.new(client: @client)
       ns.weighted = NgrokAPI::Services::WeightedBackendsClient.new(client: @client)
 
@@ -239,6 +254,7 @@ module NgrokAPI
       ns.https_edge_route_saml = NgrokAPI::Services::EdgeRouteSAMLModuleClient.new(client: @client)
       ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
       ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
+      ns.https_edge_route_user_agent_filter = NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient.new(client: @client)
       ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
       ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
       ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)

data/lib/ngrokapi/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   ##
   # Base Error class for all Ngrok Errors

data/lib/ngrokapi/errors/not_found_error.rb

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

data/lib/ngrokapi/http_client.rb

@@ -1,150 +1,153 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  ##
-  # Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have
-  # to use this class directly, but use the individual clients to make your API calls.
-  class HttpClient
-    attr_reader :api_key,
-      :base_url
-
-    def initialize(api_key:, base_url: 'https://api.ngrok.com')
-      @api_key = api_key
-      @base_url = base_url
-    end
-
-    ##
-    # Make a DELETE request to a given URI
-    #
-    # @param [string] path URL resource path.
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @return [nil]
-    def delete(path, danger: false)
-      uri = get_uri(path)
-      req = Net::HTTP::Delete.new(uri, headers)
-      json_do(uri, req, danger: danger)
-    end
-
-    ##
-    # Make a GET request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def get(path, danger: false, data: {})
-      uri = get_uri(path, data: data)
-      req = Net::HTTP::Get.new(uri, headers)
-      json_do(uri, req, danger: danger)
-    end
-
-    ##
-    # Make a GET request to list resources
-    #
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @param [string] before_id URL resource path
-    # @param [integer] limit URL resource path
-    # @param [string] path resource path, mutually exclusive with url
-    # @param [string] url Full URL of the resource, mutually exclusive with path
-    # @param [string] url Full URL of the resource, mutually exclusive with path
-    # @return [json] response body
-    def list(danger: false, before_id: nil, limit: nil, path: nil, url: nil)
-      if url
-        get(url)
-      else
-        data = {}
-        data[:before_id] = before_id if before_id
-        data[:limit] = limit if limit
-        get(path, danger: danger, data: data)
-      end
-    end
-
-    ##
-    # Make a PATCH request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def patch(path, danger: false, data: {})
-      uri = get_uri(path)
-      req = Net::HTTP::Patch.new(uri, headers_with_json)
-      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
-    end
-
-    ##
-    # Make a POST request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def post(path, danger: false, data: {})
-      uri = get_uri(path)
-      req = Net::HTTP::Post.new(uri, headers_with_json)
-      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
-    end
-
-    ##
-    # Make a PUT request to a given URI with optional data
-    #
-    # @param [string] path URL resource path
-    # @param [boolean] danger determine if we should throw an exception on 404 or not
-    # @param [hash] data hash which will be converted to query parameters or form data
-    # @return [json] response body
-    def put(path, danger: false, data: {})
-      uri = get_uri(path)
-      req = Net::HTTP::Put.new(uri, headers_with_json)
-      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
-    end
-
-    private
-
-    def headers
-      {
-        'Authorization': "Bearer #{@api_key}",
-        'Ngrok-Version': '2',
-      }
-    end
-
-    def headers_with_json
-      headers.merge({ 'Content-Type': 'application/json' })
-    end
-
-    def json_do(uri, req, danger: false, data: nil)
-      resp = Net::HTTP.start(uri.hostname, uri.port, req_options(uri)) do |http|
-        http.request(req, data)
-      end
-      if danger
-        if resp.code.to_i == 404
-          raise NgrokAPI::Errors::NotFoundError.new(response: resp)
-        elsif resp.code.to_i >= 400
-          raise NgrokAPI::Error.new(response: resp)
-        end
-      end
-      if resp.body && resp.body != ''
-        JSON.parse(resp.body)
-      end
-    end
-
-    def req_options(uri)
-      { use_ssl: uri.scheme == 'https' }
-    end
-
-    def get_uri(path, data: nil)
-      data = (!data.nil? && data != {}) ? "?#{URI.encode_www_form(data)}" : ""
-      URI("#{url(path)}#{data}")
-    end
-
-    def url(path)
-      path = path.delete_prefix(@base_url)
-      "#{@base_url}#{path}"
-    end
-
-    def deep_to_h(data)
-      data.to_h.transform_values do |v|
-        (!v.is_a?(Array) && v.methods.include?(:to_h)) ? deep_to_h(v) : v
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  ##
+  # Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have
+  # to use this class directly, but use the individual clients to make your API calls.
+  class HttpClient
+    attr_reader :api_key,
+      :base_url
+
+    def initialize(api_key:, base_url: 'https://api.ngrok.com')
+      @api_key = api_key
+      @base_url = base_url
+    end
+
+    ##
+    # Make a DELETE request to a given URI
+    #
+    # @param [string] path URL resource path.
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @return [nil]
+    def delete(path, danger: false)
+      uri = get_uri(path)
+      req = Net::HTTP::Delete.new(uri, headers)
+      json_do(uri, req, danger: danger)
+    end
+
+    ##
+    # Make a GET request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def get(path, danger: false, data: {})
+      uri = get_uri(path, data: data)
+      req = Net::HTTP::Get.new(uri, headers)
+      json_do(uri, req, danger: danger)
+    end
+
+    ##
+    # Make a GET request to list resources
+    #
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [string] before_id URL resource path
+    # @param [integer] limit URL resource path
+    # @param [string] path resource path, mutually exclusive with url
+    # @param [string] url Full URL of the resource, mutually exclusive with path
+    # @param [string] url Full URL of the resource, mutually exclusive with path
+    # @return [json] response body
+    def list(danger: false, before_id: nil, limit: nil, path: nil, url: nil)
+      if url
+        get(url)
+      else
+        data = {}
+        data[:before_id] = before_id if before_id
+        data[:limit] = limit if limit
+        get(path, danger: danger, data: data)
+      end
+    end
+
+    ##
+    # Make a PATCH request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def patch(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Patch.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
+    end
+
+    ##
+    # Make a POST request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def post(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Post.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
+    end
+
+    ##
+    # Make a PUT request to a given URI with optional data
+    #
+    # @param [string] path URL resource path
+    # @param [boolean] danger determine if we should throw an exception on 404 or not
+    # @param [hash] data hash which will be converted to query parameters or form data
+    # @return [json] response body
+    def put(path, danger: false, data: {})
+      uri = get_uri(path)
+      req = Net::HTTP::Put.new(uri, headers_with_json)
+      json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
+    end
+
+    private
+
+    def headers
+      {
+        'Authorization': "Bearer #{@api_key}",
+        'Ngrok-Version': '2',
+        'User-Agent': "ngrok-api-ruby/#{@VERSION}/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
+      }
+    end
+
+    def headers_with_json
+      headers.merge({ 'Content-Type': 'application/json' })
+    end
+
+    def json_do(uri, req, danger: false, data: nil)
+      resp = Net::HTTP.start(uri.hostname, uri.port, req_options(uri)) do |http|
+        http.request(req, data)
+      end
+      if danger
+        if resp.code.to_i == 404
+          raise NgrokAPI::Errors::NotFoundError.new(response: resp)
+        elsif resp.code.to_i >= 400
+          raise NgrokAPI::Error.new(response: resp)
+        end
+      end
+      if resp.body && resp.body != ''
+        JSON.parse(resp.body)
+      end
+    end
+
+    def req_options(uri)
+      { use_ssl: uri.scheme == 'https' }
+    end
+
+    def get_uri(path, data: nil)
+      data = (!data.nil? && data != {}) ? "?#{URI.encode_www_form(data)}" : ""
+      URI("#{url(path)}#{data}")
+    end
+
+    def url(path)
+      path = path.delete_prefix(@base_url)
+      "#{@base_url}#{path}"
+    end
+
+    def deep_to_h(data)
+      data.to_h.transform_values do |v|
+        (!v.is_a?(Array) && v.methods.include?(:to_h)) ? deep_to_h(v) : v
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/abuse_report.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class AbuseReport
@@ -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']
         @urls = @attrs['urls']
         @metadata = @attrs['metadata']

data/lib/ngrokapi/models/abuse_report_hostname.rb

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

data/lib/ngrokapi/models/agent_ingress.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class AgentIngress
@@ -12,19 +16,25 @@ module NgrokAPI
         :domain,
         :ns_targets,
         :region_domains,
-        :created_at
+        :created_at,
+        :certificate_management_policy,
+        :certificate_management_status
 
       def initialize(client: nil, attrs: {})
         @client = client
         @attrs = attrs
         @id = @attrs['id']
-        @uri = @attrs['uri']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
         @description = @attrs['description']
         @metadata = @attrs['metadata']
         @domain = @attrs['domain']
         @ns_targets = @attrs['ns_targets']
         @region_domains = @attrs['region_domains']
         @created_at = @attrs['created_at']
+        @certificate_management_policy = @attrs['certificate_management_policy']
+        @certificate_management_status = @attrs['certificate_management_status']
       end
 
       def ==(other)
@@ -55,14 +65,17 @@ module NgrokAPI
       # https://ngrok.com/docs/api#api-agent-ingresses-update
       def update(
         description: nil,
-        metadata: nil
+        metadata: nil,
+        certificate_management_policy: nil
       )
         @description = description if description
         @metadata = metadata if metadata
+        @certificate_management_policy = certificate_management_policy if certificate_management_policy
         @client.update(
           id: @id,
           description: description,
-          metadata: metadata
+          metadata: metadata,
+          certificate_management_policy: certificate_management_policy
         )
       end
     end

data/lib/ngrokapi/models/agent_ingress_cert_job.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class AgentIngressCertJob
+      attr_reader :client,
+        :attrs,
+        :error_code,
+        :msg,
+        :started_at,
+        :retries_at
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @error_code = @attrs['error_code']
+        @msg = @attrs['msg']
+        @started_at = @attrs['started_at']
+        @retries_at = @attrs['retries_at']
+      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/agent_ingress_cert_policy.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class AgentIngressCertPolicy
+      attr_reader :client,
+        :attrs,
+        :authority,
+        :private_key_type
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @authority = @attrs['authority']
+        @private_key_type = @attrs['private_key_type']
+      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/agent_ingress_cert_status.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class AgentIngressCertStatus
+      attr_reader :client,
+        :attrs,
+        :renews_at,
+        :provisioning_job
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @renews_at = @attrs['renews_at']
+        @provisioning_job = @attrs['provisioning_job']
+      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/api_key.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
 module NgrokAPI
   module Models
     class APIKey
@@ -10,17 +14,21 @@ module NgrokAPI
         :description,
         :metadata,
         :created_at,
-        :token
+        :token,
+        :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
         @description = @attrs['description']
         @metadata = @attrs['metadata']
         @created_at = @attrs['created_at']
         @token = @attrs['token']
+        @owner_id = @attrs['owner_id']
       end
 
       def ==(other)