ngrok-api 0.15.0 → 0.16.0

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 19 23:01:32 2021 by
+  Generated on Thu Dec  2 18:48:49 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-3.0.1).
+  0.9.27 (ruby-3.0.1).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -7,10 +7,7 @@ module NgrokAPI
   # Low-level api client for communicating with Ngrok's HTTP API.
   # Use this object to instantiate your clients.
   class Client
-    def initialize(
-      api_key:,
-      base_url: 'https://api.ngrok.com'
-    )
+    def initialize(api_key:, base_url: 'https://api.ngrok.com')
       @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
     end
 
@@ -23,6 +20,10 @@ module NgrokAPI
       @_abuse_reports ||= NgrokAPI::Services::AbuseReportsClient.new(client: @client)
     end
 
+    def agent_ingresses
+      @_agent_ingresses ||= NgrokAPI::Services::AgentIngressesClient.new(client: @client)
+    end
+
     ##
     # API Keys are used to authenticate to the [ngrok
     #  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -117,15 +118,6 @@ module NgrokAPI
       @_ip_restrictions ||= NgrokAPI::Services::IPRestrictionsClient.new(client: @client)
     end
 
-    ##
-    # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
-    #  with an `endpoints` type instead.
-    #
-    # @return [NgrokAPI::Services::IPWhitelistClient]
-    def ip_whitelist
-      @_ip_whitelist ||= NgrokAPI::Services::IPWhitelistClient.new(client: @client)
-    end
-
     ##
     # Reserved Addresses are TCP addresses that can be used to listen for traffic.
     #  TCP address hostnames and ports are assigned by ngrok, they cannot be

data/lib/ngrokapi/http_client.rb

@@ -8,10 +8,7 @@ module NgrokAPI
     attr_reader :api_key,
       :base_url
 
-    def initialize(
-      api_key:,
-      base_url: 'https://api.ngrok.com'
-    )
+    def initialize(api_key:, base_url: 'https://api.ngrok.com')
       @api_key = api_key
       @base_url = base_url
     end

data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb}

@@ -2,25 +2,29 @@
 
 module NgrokAPI
   module Models
-    class IPWhitelistEntry
+    class AgentIngress
       attr_reader :client,
         :result,
         :id,
         :uri,
-        :created_at,
         :description,
         :metadata,
-        :ip_net
+        :domain,
+        :ns_targets,
+        :region_domains,
+        :created_at
 
       def initialize(client:, result:)
         @client = client
         @result = result
         @id = @result['id']
         @uri = @result['uri']
-        @created_at = @result['created_at']
         @description = @result['description']
         @metadata = @result['metadata']
-        @ip_net = @result['ip_net']
+        @domain = @result['domain']
+        @ns_targets = @result['ns_targets']
+        @region_domains = @result['region_domains']
+        @created_at = @result['created_at']
       end
 
       def ==(other)
@@ -32,9 +36,9 @@ module NgrokAPI
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # Delete an Agent Ingress by ID
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-delete
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
       def delete
         @client.delete(
           id: @id
@@ -42,9 +46,9 @@ module NgrokAPI
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update attributes of an Agent Ingress by ID.
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
+      # https://ngrok.com/docs/api#api-agent-ingresses-update
       def update(
         description: nil,
         metadata: nil

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -27,10 +27,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-create
-      def create(
-        urls:,
-        metadata: ""
-      )
+      def create(urls:, metadata: "")
         path = '/abuse_reports'
         replacements = {
         }
@@ -48,9 +45,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/abuse_reports/%{id}'
         replacements = {
           id: id,
@@ -68,9 +63,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/abuse_reports/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/{ip_whitelist_client.rb → agent_ingresses_client.rb}

@@ -3,15 +3,12 @@
 module NgrokAPI
   module Services
     ##
-    # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
-    #  with an `endpoints` type instead.
-    #
-    # https://ngrok.com/docs/api#api-ip-whitelist
-    class IPWhitelistClient
+    # https://ngrok.com/docs/api#api-agent-ingresses
+    class AgentIngressesClient
       # The API path for the requests
-      PATH = '/ip_whitelist'
+      PATH = '/agent_ingresses'
       # The List Property from the resulting API for list calls
-      LIST_PROPERTY = 'whitelist'
+      LIST_PROPERTY = 'ingresses'
 
       attr_reader :client
 
@@ -20,42 +17,36 @@ module NgrokAPI
       end
 
       ##
-      # Create a new IP whitelist entry that will restrict traffic to all tunnel
-      # endpoints on the account.
-      #
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @param [string] ip_net an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-create
-      def create(
-        description: "",
-        metadata: "",
-        ip_net: ""
-      )
-        path = '/ip_whitelist'
+      # 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.
+      #
+      # @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[:ip_net] = ip_net if ip_net
+        data[:domain] = domain if domain
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # Delete an Agent Ingress by ID
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-delete
-      def delete(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
+      def delete(id: "")
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
@@ -63,17 +54,15 @@ module NgrokAPI
       end
 
       ##
-      # Delete an IP whitelist entry.
+      # Delete an Agent Ingress 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-ip-whitelist-delete
-      def delete!(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
+      def delete!(id: "")
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
@@ -81,58 +70,51 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an IP whitelist entry by ID.
+      # Get the details of an Agent Ingress by ID.
       #
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-get
-      def get(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-agent-ingresses-get
+      def get(id: "")
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
       end
 
       ##
-      # Get detailed information about an IP whitelist entry by ID.
+      # Get the details of an Agent Ingress by ID.
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
       #
-      # https://ngrok.com/docs/api#api-ip-whitelist-get
-      def get!(
-        id: ""
-      )
-        path = '/ip_whitelist/%{id}'
+      # https://ngrok.com/docs/api#api-agent-ingresses-get
+      def get!(id: "")
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
       end
 
       ##
-      # List all IP whitelist entries on this account
+      # List all Agent Ingresses owned by 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-ip-whitelist-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      # https://ngrok.com/docs/api#api-agent-ingresses-list
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -144,12 +126,12 @@ module NgrokAPI
           client: self,
           result: result,
           list_property: LIST_PROPERTY,
-          klass: NgrokAPI::Models::IPWhitelistEntry
+          klass: NgrokAPI::Models::AgentIngress
         )
       end
 
       ##
-      # List all IP whitelist entries on this account
+      # List all Agent Ingresses owned by this account
       # Throws an exception if API error.
       #
       # @param [string] before_id
@@ -157,12 +139,9 @@ module NgrokAPI
       # @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-ip-whitelist-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      # https://ngrok.com/docs/api#api-agent-ingresses-list
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -175,26 +154,22 @@ module NgrokAPI
           client: self,
           result: result,
           list_property: LIST_PROPERTY,
-          klass: NgrokAPI::Models::IPWhitelistEntry,
+          klass: NgrokAPI::Models::AgentIngress,
           danger: true
         )
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update attributes of an Agent Ingress by ID.
       #
       # @param [string] id
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
-        path = '/ip_whitelist/%{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
+      # @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)
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
@@ -202,25 +177,21 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
       end
 
       ##
-      # Update attributes of an IP whitelist entry by ID
+      # Update attributes of an Agent Ingress by ID.
       # Throws an exception if API error.
       #
       # @param [string] id
-      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
-      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-ip-whitelist-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
-        path = '/ip_whitelist/%{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
+      # @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)
+        path = '/agent_ingresses/%{id}'
         replacements = {
           id: id,
         }
@@ -228,7 +199,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
       end
     end
   end

data/lib/ngrokapi/services/api_keys_client.rb

@@ -31,10 +31,7 @@ module NgrokAPI
       # @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: "")
         path = '/api_keys'
         replacements = {
         }
@@ -52,9 +49,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -70,9 +65,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -87,9 +80,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -107,9 +98,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -128,11 +117,8 @@ 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,
@@ -158,11 +144,8 @@ 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,
@@ -189,11 +172,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -215,11 +194,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/api_keys/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/certificate_authorities_client.rb

@@ -31,11 +31,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-create
-      def create(
-        description: "",
-        metadata: "",
-        ca_pem:
-      )
+      def create(description: "", metadata: "", ca_pem:)
         path = '/certificate_authorities'
         replacements = {
         }
@@ -54,9 +50,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -72,9 +66,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -89,9 +81,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -109,9 +99,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -130,11 +118,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-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,
@@ -160,11 +145,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-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,
@@ -191,11 +173,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -217,11 +195,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,