ngrok-api 0.9.0 → 0.16.0

data/doc/NgrokAPI/Client.html

@@ -6,7 +6,7 @@
 <title>
   Class: NgrokAPI::Client
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -128,7 +128,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#api_keys-instance_method" title="#api_keys (instance method)">#<strong>api_keys</strong>  &#x21d2; NgrokAPI::Services::ApiKeysClient </a>
+      <a href="#abuse_reports-instance_method" title="#abuse_reports (instance method)">#<strong>abuse_reports</strong>  &#x21d2; NgrokAPI::Services::AbuseReportsClient </a>
     
 
     
@@ -143,7 +143,101 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient.</p>
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok&#39;s terms of service.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#agent_ingresses-instance_method" title="#agent_ingresses (instance method)">#<strong>agent_ingresses</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#api_keys-instance_method" title="#api_keys (instance method)">#<strong>api_keys</strong>  &#x21d2; NgrokAPI::Services::APIKeysClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#certificate_authorities-instance_method" title="#certificate_authorities (instance method)">#<strong>certificate_authorities</strong>  &#x21d2; NgrokAPI::Services::CertificateAuthoritiesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#credentials-instance_method" title="#credentials (instance method)">#<strong>credentials</strong>  &#x21d2; NgrokAPI::Services::CredentialsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Tunnel Credentials are ngrok agent authtokens.</p>
 </div></span>
   
 </li>
@@ -156,107 +250,1307 @@
     
 
     
-  </span>
-  
-  
-  
-  
-  
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#event_destinations-instance_method" title="#event_destinations (instance method)">#<strong>event_destinations</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#event_sources-instance_method" title="#event_sources (instance method)">#<strong>event_sources</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#event_streams-instance_method" title="#event_streams (instance method)">#<strong>event_streams</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#event_subscriptions-instance_method" title="#event_subscriptions (instance method)">#<strong>event_subscriptions</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;)  &#x21d2; Client </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Client.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ip_policies-instance_method" title="#ip_policies (instance method)">#<strong>ip_policies</strong>  &#x21d2; NgrokAPI::Services::IPPoliciesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ip_policy_rules-instance_method" title="#ip_policy_rules (instance method)">#<strong>ip_policy_rules</strong>  &#x21d2; NgrokAPI::Services::IPPolicyRulesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ip_restrictions-instance_method" title="#ip_restrictions (instance method)">#<strong>ip_restrictions</strong>  &#x21d2; NgrokAPI::Services::IPRestrictionsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#pointcfg_module-instance_method" title="#pointcfg_module (instance method)">#<strong>pointcfg_module</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#reserved_addrs-instance_method" title="#reserved_addrs (instance method)">#<strong>reserved_addrs</strong>  &#x21d2; NgrokAPI::Services::ReservedAddrsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong>  &#x21d2; NgrokAPI::Services::ReservedDomainsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Reserved Domains are hostnames that you can listen for traffic on.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ssh_certificate_authorities-instance_method" title="#ssh_certificate_authorities (instance method)">#<strong>ssh_certificate_authorities</strong>  &#x21d2; NgrokAPI::Services::SSHCertificateAuthoritiesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>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.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ssh_credentials-instance_method" title="#ssh_credentials (instance method)">#<strong>ssh_credentials</strong>  &#x21d2; NgrokAPI::Services::SSHCredentialsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ssh_host_certificates-instance_method" title="#ssh_host_certificates (instance method)">#<strong>ssh_host_certificates</strong>  &#x21d2; NgrokAPI::Services::SSHHostCertificatesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>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.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ssh_user_certificates-instance_method" title="#ssh_user_certificates (instance method)">#<strong>ssh_user_certificates</strong>  &#x21d2; NgrokAPI::Services::SSHUserCertificatesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong>  &#x21d2; NgrokAPI::Services::TLSCertificatesClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#tunnel_sessions-instance_method" title="#tunnel_sessions (instance method)">#<strong>tunnel_sessions</strong>  &#x21d2; NgrokAPI::Services::TunnelSessionsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#tunnels-instance_method" title="#tunnels (instance method)">#<strong>tunnels</strong>  &#x21d2; NgrokAPI::Services::TunnelsClient </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Client (class)">Client</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of Client.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>api_key:</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="abuse_reports-instance_method">
+  
+    #<strong>abuse_reports</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by  ngrok that violate ngrok&#39;s terms of service.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_abuse_reports'>abuse_reports</span>
+  <span class='ivar'>@_abuse_reports</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="agent_ingresses-instance_method">
+  
+    #<strong>agent_ingresses</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 23</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_agent_ingresses'>agent_ingresses</span>
+  <span class='ivar'>@_agent_ingresses</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AgentIngressesClient.html" title="NgrokAPI::Services::AgentIngressesClient (class)">AgentIngressesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AgentIngressesClient.html#initialize-instance_method" title="NgrokAPI::Services::AgentIngressesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="api_keys-instance_method">
+  
+    #<strong>api_keys</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself  to provision and manage API Keys but you&#39;ll need to provision your first API  key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your  ngrok.com dashboard.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 35</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
+  <span class='ivar'>@_api_keys</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="certificate_authorities-instance_method">
+  
+    #<strong>certificate_authorities</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 47</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span>
+  <span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="credentials-instance_method">
+  
+    #<strong>credentials</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok  agent to connect the ngrok service as your account. They are installed with  the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code>  configuration file with the <code>authtoken</code> property.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+58
+59
+60</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 58</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
+  <span class='ivar'>@_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="endpoint_configurations-instance_method">
+  
+    #<strong>endpoint_configurations</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+68
+69
+70</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 68</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
+  <span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="event_destinations-instance_method">
+  
+    #<strong>event_destinations</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+76
+77
+78</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 76</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span>
+  <span class='ivar'>@_event_destinations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="event_sources-instance_method">
+  
+    #<strong>event_sources</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+84
+85
+86</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 84</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span>
+  <span class='ivar'>@_event_sources</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="event_streams-instance_method">
+  
+    #<strong>event_streams</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+72
+73
+74</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 72</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_event_streams'>event_streams</span>
+  <span class='ivar'>@_event_streams</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="event_subscriptions-instance_method">
+  
+    #<strong>event_subscriptions</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+80
+81
+82</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 80</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span>
+  <span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ip_policies-instance_method">
+  
+    #<strong>ip_policies</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code>  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.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+95
+96
+97</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 95</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span>
+  <span class='ivar'>@_ip_policies</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ip_policy_rules-instance_method">
+  
+    #<strong>ip_policy_rules</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that  make up an IP Policy.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+104
+105
+106</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 104</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span>
+  <span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ip_restrictions-instance_method">
+  
+    #<strong>ip_restrictions</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+117
+118
+119</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 117</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span>
+  <span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="pointcfg_module-instance_method">
   
+    #<strong>pointcfg_module</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient.</p>
-</div></span>
+
   
-</li>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
 
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;)  &#x21d2; Client </a>
-    
 
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 211</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_pointcfg_module'>pointcfg_module</span>
+  <span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_logging'>logging</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_compression'>compression</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_response_headers'>response_headers</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oauth'>oauth</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_saml'>saml</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oidc'>oidc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+
+  <span class='id identifier rubyid_ns'>ns</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
     
-  </span>
-  
+      <div class="method_details ">
+  <h3 class="signature " id="reserved_addrs-instance_method">
   
-    <span class="note title constructor">constructor</span>
+    #<strong>reserved_addrs</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt> 
   
+
   
+
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
+
+
+  </div>
+</div>
+<div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
   
+</ul>
 
-  
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of Client.</p>
-</div></span>
-  
-</li>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
 
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong>  &#x21d2; NgrokAPI::Services::ReservedDomainsClient </a>
-    
 
+127
+128
+129</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 127</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span>
+  <span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
     
-  </span>
+      <div class="method_details ">
+  <h3 class="signature " id="reserved_domains-instance_method">
   
+    #<strong>reserved_domains</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt> 
   
+
   
+
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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&#39;s edge servers.</p>
+
+
+  </div>
+</div>
+<div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
   
+</ul>
 
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient.</p>
-</div></span>
-  
-</li>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
 
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong>  &#x21d2; NgrokAPI::Services::TlsCertificatesClient </a>
-    
 
+138
+139
+140</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 138</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
+  <span class='ivar'>@_reserved_domains</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
     
-  </span>
-  
-  
-  
+      <div class="method_details ">
+  <h3 class="signature " id="ssh_certificate_authorities-instance_method">
   
+    #<strong>ssh_certificate_authorities</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt> 
   
+
   
+
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
 
+
+  </div>
+</div>
+<div class="tags">
   
-    <span class="summary_desc"><div class='inline'>
-<p>Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient.</p>
-</div></span>
+<p class="tag_title">Returns:</p>
+<ul class="return">
   
-</li>
-
+    <li>
       
-    </ul>
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
   
+</ul>
 
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-  
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+147
+148
+149</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 147</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span>
+  <span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ssh_credentials-instance_method">
   
-    #<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Client (class)">Client</a></span></tt> 
+    #<strong>ssh_credentials</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt> 
   
 
   
@@ -265,13 +1559,26 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns a new instance of Client.</p>
+<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels  via the ngrok SSH tunnel gateway.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -279,38 +1586,79 @@
       <pre class="lines">
 
 
-8
-9
-10
-11
-12
-13</pre>
+156
+157
+158</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 156</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
-  <span class='label'>api_key:</span><span class='comma'>,</span>
-  <span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>&#39;</span></span>
-<span class='rparen'>)</span>
-  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span>
+  <span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ssh_host_certificates-instance_method">
+  
+    #<strong>ssh_host_certificates</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt> 
+  
+
+  
+
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>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.</p>
+
+
+  </div>
 </div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
 
 
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
+166
+167
+168</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 166</span>
 
+<span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span>
+  <span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
     
-      <div class="method_details first">
-  <h3 class="signature first" id="api_keys-instance_method">
+      <div class="method_details ">
+  <h3 class="signature " id="ssh_user_certificates-instance_method">
   
-    #<strong>api_keys</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">NgrokAPI::Services::ApiKeysClient</a></span></tt> 
+    #<strong>ssh_user_certificates</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt> 
   
 
   
@@ -319,7 +1667,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient</p>
+<p>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.</p>
 
 
   </div>
@@ -332,7 +1680,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">NgrokAPI::Services::ApiKeysClient</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt>)</span>
       
       
       
@@ -346,15 +1694,15 @@
       <pre class="lines">
 
 
-19
-20
-21</pre>
+176
+177
+178</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 19</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 176</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
-  <span class='ivar'>@_api_keys</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">ApiKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ApiKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::ApiKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span>
+  <span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -362,9 +1710,9 @@
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="endpoint_configurations-instance_method">
+  <h3 class="signature " id="tls_certificates-instance_method">
   
-    #<strong>endpoint_configurations</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt> 
+    #<strong>tls_certificates</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt> 
   
 
   
@@ -373,7 +1721,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient</p>
+<p>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.</p>
 
 
   </div>
@@ -386,7 +1734,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt>)</span>
       
       
       
@@ -400,19 +1748,15 @@
       <pre class="lines">
 
 
-27
-28
-29
-30
-31</pre>
+188
+189
+190</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 188</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
-  <span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span>
-    <span class='label'>client:</span> <span class='ivar'>@client</span>
-  <span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
+  <span class='ivar'>@_tls_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -420,9 +1764,9 @@
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="reserved_domains-instance_method">
+  <h3 class="signature " id="tunnel_sessions-instance_method">
   
-    #<strong>reserved_domains</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt> 
+    #<strong>tunnel_sessions</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt> 
   
 
   
@@ -431,7 +1775,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient</p>
+<p>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.</p>
 
 
   </div>
@@ -444,7 +1788,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt>)</span>
       
       
       
@@ -458,15 +1802,15 @@
       <pre class="lines">
 
 
-37
-38
-39</pre>
+198
+199
+200</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 198</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
-  <span class='ivar'>@_reserved_domains</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_tunnel_sessions'>tunnel_sessions</span>
+  <span class='ivar'>@_tunnel_sessions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -474,9 +1818,9 @@
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="tls_certificates-instance_method">
+  <h3 class="signature " id="tunnels-instance_method">
   
-    #<strong>tls_certificates</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">NgrokAPI::Services::TlsCertificatesClient</a></span></tt> 
+    #<strong>tunnels</strong>  &#x21d2; <tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt> 
   
 
   
@@ -485,7 +1829,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient</p>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok  agent tunnel session or an SSH reverse tunnel session.</p>
 
 
   </div>
@@ -498,7 +1842,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">NgrokAPI::Services::TlsCertificatesClient</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt>)</span>
       
       
       
@@ -512,15 +1856,15 @@
       <pre class="lines">
 
 
-45
-46
-47</pre>
+207
+208
+209</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 207</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
-  <span class='ivar'>@_tls_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">TlsCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TlsCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TlsCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
+  <span class='ivar'>@_tunnels</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -532,9 +1876,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>