ngrok-api 0.9.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 Fri Sep 24 19:20:29 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

@@ -1,49 +1,229 @@
-# frozen_string_literal: true
-
-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'
-    )
-      @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
-    end
-
-    ##
-    # Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient
-    #
-    # @return [NgrokAPI::Services::ApiKeysClient]
-    def api_keys
-      @_api_keys ||= NgrokAPI::Services::ApiKeysClient.new(client: @client)
-    end
-
-    ##
-    # Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient
-    #
-    # @return [NgrokAPI::Services::EndpointConfigurationsClient]
-    def endpoint_configurations
-      @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(
-        client: @client
-      )
-    end
-
-    ##
-    # Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient
-    #
-    # @return [NgrokAPI::Services::ReservedDomainsClient]
-    def reserved_domains
-      @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
-    end
-
-    ##
-    # Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient
-    #
-    # @return [NgrokAPI::Services::TlsCertificatesClient]
-    def tls_certificates
-      @_tls_certificates ||= NgrokAPI::Services::TlsCertificatesClient.new(client: @client)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'ostruct'
+
+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')
+      @client = NgrokAPI::HttpClient.new(api_key: api_key, base_url: base_url)
+    end
+
+    ##
+    # Abuse Reports allow you to submit take-down requests for URLs hosted by
+    #  ngrok that violate ngrok's terms of service.
+    #
+    # @return [NgrokAPI::Services::AbuseReportsClient]
+    def abuse_reports
+      @_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
+    #  to provision and manage API Keys but you'll need to provision your first API
+    #  key from the [API Keys page](https://dashboard.ngrok.com/api/keys) on your
+    #  ngrok.com dashboard.
+    #
+    # @return [NgrokAPI::Services::APIKeysClient]
+    def api_keys
+      @_api_keys ||= NgrokAPI::Services::APIKeysClient.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
+    #  to verify that the TLS certificate presented by a client has been signed by
+    #  this CA. Certificate Authorities  are used only for mTLS validation only and
+    #  thus a private key is not included in the resource.
+    #
+    # @return [NgrokAPI::Services::CertificateAuthoritiesClient]
+    def certificate_authorities
+      @_certificate_authorities ||= NgrokAPI::Services::CertificateAuthoritiesClient.new(client: @client)
+    end
+
+    ##
+    # 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`
+    #  configuration file with the `authtoken` property.
+    #
+    # @return [NgrokAPI::Services::CredentialsClient]
+    def credentials
+      @_credentials ||= NgrokAPI::Services::CredentialsClient.new(client: @client)
+    end
+
+    ##
+    # Endpoint Configurations are a reusable group of modules that encapsulate how
+    #  traffic to a domain or address is handled. Endpoint configurations are only
+    #  applied to Domains and TCP Addresses they have been attached to.
+    #
+    # @return [NgrokAPI::Services::EndpointConfigurationsClient]
+    def endpoint_configurations
+      @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(client: @client)
+    end
+
+    def event_streams
+      @_event_streams ||= NgrokAPI::Services::EventStreamsClient.new(client: @client)
+    end
+
+    def event_destinations
+      @_event_destinations ||= NgrokAPI::Services::EventDestinationsClient.new(client: @client)
+    end
+
+    def event_subscriptions
+      @_event_subscriptions ||= NgrokAPI::Services::EventSubscriptionsClient.new(client: @client)
+    end
+
+    def event_sources
+      @_event_sources ||= NgrokAPI::Services::EventSourcesClient.new(client: @client)
+    end
+
+    ##
+    # IP Policies are reusable groups of CIDR ranges with an `allow` or `deny`
+    #  action. They can be attached to endpoints via the Endpoint Configuration IP
+    #  Policy module. They can also be used with IP Restrictions to control source
+    #  IP ranges that can start tunnel sessions and connect to the API and dashboard.
+    #
+    # @return [NgrokAPI::Services::IPPoliciesClient]
+    def ip_policies
+      @_ip_policies ||= NgrokAPI::Services::IPPoliciesClient.new(client: @client)
+    end
+
+    ##
+    # IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+    #  make up an IP Policy.
+    #
+    # @return [NgrokAPI::Services::IPPolicyRulesClient]
+    def ip_policy_rules
+      @_ip_policy_rules ||= NgrokAPI::Services::IPPolicyRulesClient.new(client: @client)
+    end
+
+    ##
+    # An IP restriction is a restriction placed on the CIDRs that are allowed to
+    #  initate traffic to a specific aspect of your ngrok account. An IP
+    #  restriction has a type which defines the ingress it applies to. IP
+    #  restrictions can be used to enforce the source IPs that can make API
+    #  requests, log in to the dashboard, start ngrok agents, and connect to your
+    #  public-facing endpoints.
+    #
+    # @return [NgrokAPI::Services::IPRestrictionsClient]
+    def ip_restrictions
+      @_ip_restrictions ||= NgrokAPI::Services::IPRestrictionsClient.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
+    #  chosen.
+    #
+    # @return [NgrokAPI::Services::ReservedAddrsClient]
+    def reserved_addrs
+      @_reserved_addrs ||= NgrokAPI::Services::ReservedAddrsClient.new(client: @client)
+    end
+
+    ##
+    # Reserved Domains are hostnames that you can listen for traffic on. Domains
+    #  can be used to listen for http, https or tls traffic. You may use a domain
+    #  that you own by creating a CNAME record specified in the returned resource.
+    #  This CNAME record points traffic for that domain to ngrok's edge servers.
+    #
+    # @return [NgrokAPI::Services::ReservedDomainsClient]
+    def reserved_domains
+      @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
+    end
+
+    ##
+    # An SSH Certificate Authority is a pair of an SSH Certificate and its private
+    #  key that can be used to sign other SSH host and user certificates.
+    #
+    # @return [NgrokAPI::Services::SSHCertificateAuthoritiesClient]
+    def ssh_certificate_authorities
+      @_ssh_certificate_authorities ||= NgrokAPI::Services::SSHCertificateAuthoritiesClient.new(client: @client)
+    end
+
+    ##
+    # SSH Credentials are SSH public keys that can be used to start SSH tunnels
+    #  via the ngrok SSH tunnel gateway.
+    #
+    # @return [NgrokAPI::Services::SSHCredentialsClient]
+    def ssh_credentials
+      @_ssh_credentials ||= NgrokAPI::Services::SSHCredentialsClient.new(client: @client)
+    end
+
+    ##
+    # SSH Host Certificates along with the corresponding private key allows an SSH
+    #  server to assert its authenticity to connecting SSH clients who trust the
+    #  SSH Certificate Authority that was used to sign the certificate.
+    #
+    # @return [NgrokAPI::Services::SSHHostCertificatesClient]
+    def ssh_host_certificates
+      @_ssh_host_certificates ||= NgrokAPI::Services::SSHHostCertificatesClient.new(client: @client)
+    end
+
+    ##
+    # SSH User Certificates are presented by SSH clients when connecting to an SSH
+    #  server to authenticate their connection. The SSH server must trust the SSH
+    #  Certificate Authority used to sign the certificate.
+    #
+    # @return [NgrokAPI::Services::SSHUserCertificatesClient]
+    def ssh_user_certificates
+      @_ssh_user_certificates ||= NgrokAPI::Services::SSHUserCertificatesClient.new(client: @client)
+    end
+
+    ##
+    # TLS Certificates are pairs of x509 certificates and their matching private
+    #  key that can be used to terminate TLS traffic. TLS certificates are unused
+    #  until they are attached to a Domain. TLS Certificates may also be
+    #  provisioned by ngrok automatically for domains on which you have enabled
+    #  automated certificate provisioning.
+    #
+    # @return [NgrokAPI::Services::TLSCertificatesClient]
+    def tls_certificates
+      @_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.
+    #
+    # @return [NgrokAPI::Services::TunnelsClient]
+    def tunnels
+      @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
+    end
+
+    def pointcfg_module
+      ns = OpenStruct.new
+      ns.logging = NgrokAPI::Services::EndpointLoggingModuleClient.new(client: @client)
+      ns.circuit_breaker = NgrokAPI::Services::EndpointCircuitBreakerModuleClient.new(client: @client)
+      ns.compression = NgrokAPI::Services::EndpointCompressionModuleClient.new(client: @client)
+      ns.tls_termination = NgrokAPI::Services::EndpointTLSTerminationModuleClient.new(client: @client)
+      ns.ip_policy = NgrokAPI::Services::EndpointIPPolicyModuleClient.new(client: @client)
+      ns.mutual_tls = NgrokAPI::Services::EndpointMutualTLSModuleClient.new(client: @client)
+      ns.request_headers = NgrokAPI::Services::EndpointRequestHeadersModuleClient.new(client: @client)
+      ns.response_headers = NgrokAPI::Services::EndpointResponseHeadersModuleClient.new(client: @client)
+      ns.oauth = NgrokAPI::Services::EndpointOAuthModuleClient.new(client: @client)
+      ns.webhook_validation = NgrokAPI::Services::EndpointWebhookValidationModuleClient.new(client: @client)
+      ns.saml = NgrokAPI::Services::EndpointSAMLModuleClient.new(client: @client)
+      ns.oidc = NgrokAPI::Services::EndpointOIDCModuleClient.new(client: @client)
+
+      ns
+    end
+  end
+end

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
@@ -42,21 +39,23 @@ module NgrokAPI
     end
 
     ##
-    # Make a GET request
+    # 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(before_id: nil, limit: nil, path: nil, url: nil)
+    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, data: data)
+        get(path, danger: danger, data: data)
       end
     end
 

data/lib/ngrokapi/models/abuse_report.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AbuseReport
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :urls,
+        :metadata,
+        :status,
+        :hostnames
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @urls = @result['urls']
+        @metadata = @result['metadata']
+        @status = @result['status']
+        @hostnames = @result['hostnames']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/abuse_report_hostname.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AbuseReportHostname
+      attr_reader :client,
+        :result,
+        :hostname,
+        :status
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @hostname = @result['hostname']
+        @status = @result['status']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/agent_ingress.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AgentIngress
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :description,
+        :metadata,
+        :domain,
+        :ns_targets,
+        :region_domains,
+        :created_at
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @domain = @result['domain']
+        @ns_targets = @result['ns_targets']
+        @region_domains = @result['region_domains']
+        @created_at = @result['created_at']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an Agent Ingress by ID
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an Agent Ingress by ID.
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/api_key.rb

@@ -1,64 +1,62 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    ##
-    # A resource representing data from the api_keys API
-    class ApiKey
-      attr_reader :id,
-        :client,
-        :created_at,
-        :description,
-        :metadata,
-        :result,
-        :token,
-        :uri
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @created_at = @result['created_at']
-        @id = @result['id']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @token = @result['token']
-        @uri = @result['uri']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete this API key.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete
-        @client.delete(id: @id)
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Update the attributes of this API key.
-      #
-      # @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 update request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-update
-      def update(description: nil, metadata: nil)
-        @description = description if description
-        @metadata = metadata if metadata
-        @client.update(id: @id, description: description, metadata: metadata)
-      end
-      # rubocop:enable LineLength
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class APIKey
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :description,
+        :metadata,
+        :created_at,
+        :token
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @token = @result['token']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an API key by ID
+      #
+      # https://ngrok.com/docs/api#api-api-keys-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an API key by ID.
+      #
+      # https://ngrok.com/docs/api#api-api-keys-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/aws_auth.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AWSAuth
+      attr_reader :client,
+        :result,
+        :role,
+        :creds
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @role = @result['role']
+        @creds = @result['creds']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/aws_credentials.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AWSCredentials
+      attr_reader :client,
+        :result,
+        :aws_access_key_id,
+        :aws_secret_access_key
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @aws_access_key_id = @result['aws_access_key_id']
+        @aws_secret_access_key = @result['aws_secret_access_key']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/aws_role.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class AWSRole
+      attr_reader :client,
+        :result,
+        :role_arn
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @role_arn = @result['role_arn']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end