ngrok-api 0.9.0 → 0.16.0

data/docs/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> &lt; Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::ApiKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">ApiKey</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TlsCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::ApiKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">ApiKeysClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TlsCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">TlsCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li>
+<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> &lt; Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AgentIngress' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceList' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AgentIngressesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AgentIngressesClient.html" title="NgrokAPI::Services::AgentIngressesClient (class)">AgentIngressesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li>
 
       </ul>
     </div>

data/docs/file.README.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -58,7 +58,7 @@
       </div>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
+<h1 id="label-ngrok-api">ngrok-api</h1>
 
 <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
 
@@ -69,56 +69,83 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
 </code></pre>
 
-<h2 id="label-Documentation">Documentation</h2>
-
-<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
-
 <h2 id="label-Quickstart">Quickstart</h2>
 
 <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-
-<span class='comment'># Get an instance of the api_keys client and list all API keys
-</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># Get an instance of the api_keys client and list all API keys
+</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
 <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
 </code></pre>
 
-<h2 id="label-Local+Documentation">Local Documentation</h2>
+<h2 id="label-Automatic+Paging">Automatic Paging</h2>
 
-<p>Documentation can be generated with the command:</p>
+<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># list all api keys, transparently fetching additional
+</span><span class='comment'># pages for you if necessary
+</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
+<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
 
-<p>This will generate documentation which can be viewed within the doc folder.</p>
+<h2 id="label-Instance+Methods">Instance Methods</h2>
+
+<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># update the metadata of a credential
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+
+<span class='comment'># or do it in single call
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+</code></pre>
+
+<h2 id="label-Bang+Methods">Bang Methods</h2>
+
+<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
 
-<h2 id="label-Specs">Specs</h2>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<p>Specs can be run with the command:</p>
+<span class='comment'># no error raised, even though it&#39;s a bad identifier
+</span><span class='comment'># the error is simply returned
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
+<span class='comment'># this raises an NgrokAPI::Error
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 </code></pre>
 
-<p>This will generate a coverage report which can be viewed within the coverage folder.</p>
+<h2 id="label-Error+Handling">Error Handling</h2>
 
-<h2 id="label-Rubocop">Rubocop</h2>
+<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
 
-<p>Rubocop can be run with the command:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
-</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
-
-<span class='comment'># Run rubcop on all files
-</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
+<span class='kw'>begin</span>
+    <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+    <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
 </div></div>
 
       <div id="footer">
-  Generated on Fri Sep 24 19:20:29 2021 by
+  Generated on Thu Dec  2 18:48:49 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-3.0.1).
+  0.9.27 (ruby-3.0.1).
 </div>
 
     </div>

data/docs/frames.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.26</title>
+	<title>Documentation by YARD 0.9.27</title>
 </head>
 <script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);

data/docs/index.html

@@ -6,7 +6,7 @@
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -58,7 +58,7 @@
       </div>
 
       <div id="content"><div id='filecontents'>
-<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
+<h1 id="label-ngrok-api">ngrok-api</h1>
 
 <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
 
@@ -69,56 +69,83 @@
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
 </code></pre>
 
-<h2 id="label-Documentation">Documentation</h2>
-
-<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
-
 <h2 id="label-Quickstart">Quickstart</h2>
 
 <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>&#39;</span></span>
-<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-
-<span class='comment'># Get an instance of the api_keys client and list all API keys
-</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># Get an instance of the api_keys client and list all API keys
+</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
 <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
 </code></pre>
 
-<h2 id="label-Local+Documentation">Local Documentation</h2>
+<h2 id="label-Automatic+Paging">Automatic Paging</h2>
 
-<p>Documentation can be generated with the command:</p>
+<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># list all api keys, transparently fetching additional
+</span><span class='comment'># pages for you if necessary
+</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
+<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
 
-<p>This will generate documentation which can be viewed within the doc folder.</p>
+<h2 id="label-Instance+Methods">Instance Methods</h2>
+
+<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+
+<span class='comment'># update the metadata of a credential
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+
+<span class='comment'># or do it in single call
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
+</code></pre>
+
+<h2 id="label-Bang+Methods">Bang Methods</h2>
+
+<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
 
-<h2 id="label-Specs">Specs</h2>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<p>Specs can be run with the command:</p>
+<span class='comment'># no error raised, even though it&#39;s a bad identifier
+</span><span class='comment'># the error is simply returned
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
+<span class='comment'># this raises an NgrokAPI::Error
+</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 </code></pre>
 
-<p>This will generate a coverage report which can be viewed within the coverage folder.</p>
+<h2 id="label-Error+Handling">Error Handling</h2>
 
-<h2 id="label-Rubocop">Rubocop</h2>
+<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
 
-<p>Rubocop can be run with the command:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_client'>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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
 
-<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
-</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
-
-<span class='comment'># Run rubcop on all files
-</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
+<span class='kw'>begin</span>
+    <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+    <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
 </code></pre>
 </div></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>