ngrok-api 0.12.0 → 0.14.0

data/doc/NgrokAPI/Services/TunnelsClient.html

@@ -102,10 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Tunnels provide endpoints to access services exposed by a running ngrok</p>
-
-<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session.
-</code></pre>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok  agent tunnel session or an SSH reverse tunnel session.</p>
 
 <p><a href="https://ngrok.com/docs/api#api-tunnels">ngrok.com/docs/api#api-tunnels</a></p>
 
@@ -250,6 +247,30 @@
   
 
   
+    <span class="summary_desc"><div class='inline'>
+<p>List all online tunnels currently running on the account.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil)  &#x21d2; NgrokAPI::Models::Listable </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'>
 <p>List all online tunnels currently running on the account.</p>
 </div></span>
@@ -470,7 +491,8 @@
 45
 46
 47
-48</pre>
+48
+49</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 31</span>
@@ -486,6 +508,7 @@
     <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
     <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
     <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
     <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
@@ -496,6 +519,151 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="list!-instance_method">
+  
+    #<strong>list!</strong>(before_id: nil, limit: nil, url: nil)  &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>List all online tunnels currently running on the account. Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-tunnels-list">ngrok.com/docs/api#api-tunnels-list</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>before_id</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>limit</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>url</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>optional and mutually exclusive from before_id and limit</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>result from the API request</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 61</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
+  <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>url:</span> <span class='kw'>nil</span>
+<span class='rparen'>)</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
+    <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
+    <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
+    <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
+    <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span>
+  <span class='rparen'>)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+    <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
+    <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
+    <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
+    <span class='label'>klass:</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span></span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span>
+  <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -503,7 +671,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:16 2021 by
+  Generated on Tue Oct 19 15:48:19 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doc/NgrokAPI/Services.html

@@ -107,7 +107,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:15 2021 by
+  Generated on Tue Oct 19 15:48:17 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doc/NgrokAPI.html

@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/ngrokapi.rb<span class="defines">,<br />
-  lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_ns_target.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span>
+  lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span>
 </dd>
   </dl>
   
@@ -147,7 +147,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:15 2021 by
+  Generated on Tue Oct 19 15:48:17 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>

data/doc/README

@@ -0,0 +1,94 @@
+# ngrok-api
+
+This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
+easier to consume in Ruby.
+
+## Installation
+
+This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
+
+```ruby
+gem install ngrok-api
+```
+
+## Quickstart
+
+Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+# Get an instance of the api_keys client and list all API keys
+keys_client = client.api_keys
+keys_client.list
+```
+
+## Automatic Paging
+
+The ngrok API pages all list resources but this library abstracts that away
+from you. All response objects from any ``list`` or ``list!`` methods return an object that
+implements an ``each`` method which will automatically fetch additional
+pages for you.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+# list all api keys, transparently fetching additional
+# pages for you if necessary
+keys_client = client.api_keys
+keys_client.list.each do |key|
+  puts(key)
+end
+```
+
+## Instance Methods
+
+Instance methods like ``update`` and ``delete`` can be invoked on an instance of an
+API object itself as well as directly without needing to first fetch the object.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+# update the metadata of a credential
+cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz')
+cred.update(metadata: {server_name: 'giraffe-1'}.to_json)
+
+# or do it in single call
+cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json)
+```
+
+## Bang Methods
+Most methods that interact with the API have a `!` counterpart. It raises an error when
+one is returned by the API.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+# no error raised, even though it's a bad identifier
+# the error is simply returned
+cred = client.credentials.get(id: 'invalid')
+
+# this raises an NgrokAPI::Error
+cred = client.credentials.get!(id: 'invalid')
+```
+
+## Error Handling
+
+The ngrok API returns detailed information when an API call fails. Consult the
+section on errors for additional details.
+
+```ruby
+require 'ngrokapi'
+client = NgrokAPI::Client.new(api_key: '<API KEY>')
+
+begin
+    client.ip_policies.get!(id: 'invalid')
+rescue NgrokAPI::Error => e
+    puts(e)
+    puts(e.response.to_s)
+end
+```

data/doc/_index.html

@@ -467,6 +467,13 @@
                 
               </li>
             
+              <li>
+                <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span>
+                
+                  <small>(NgrokAPI::Models)</small>
+                
+              </li>
+            
               <li>
                 <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span>
                 
@@ -727,13 +734,6 @@
                 
               </li>
             
-              <li>
-                <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span>
-                
-                  <small>(NgrokAPI::Models)</small>
-                
-              </li>
-            
               <li>
                 <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span>
                 
@@ -895,7 +895,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:15 2021 by
+  Generated on Tue Oct 19 15:48:17 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-3.0.1).
 </div>