diff --git a/.rubocop.yml b/.rubocop.yml
index 048693c..5e18862 100644
--- a/.rubocop.yml
+++ b/.rubocop.yml
@@ -5,7 +5,7 @@ AllCops:
TargetRubyVersion: 3.0
Metrics/LineLength:
- Max: 120
+ Enabled: false
# Ignore Rails-y Airbnb recommendation
Airbnb/ClassOrModuleDeclaredInWrongFile:
diff --git a/doc/.gitkeep b/doc/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/doc/NgrokAPI.html b/doc/NgrokAPI.html
index d228cce..d1b1a63 100644
--- a/doc/NgrokAPI.html
+++ b/doc/NgrokAPI.html
@@ -79,7 +79,7 @@
Defined in:
lib/ngrokapi.rb,
+ lib/ngrokapi/error.rb,
@@ -131,7 +131,7 @@
- " 0.1.0 " . freeze " 0.9.0 " . freeze
- #api_keys ⇒ NgrokAPI::Services::ApiKeysClient
+ #abuse_reports ⇒ NgrokAPI::Services::AbuseReportsClient
@@ -143,7 +143,79 @@
-
Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient.
+
Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.
+
+
+
+
+
+
+ #api_keys ⇒ NgrokAPI::Services::APIKeysClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #certificate_authorities ⇒ NgrokAPI::Services::CertificateAuthoritiesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other x509 certificates.
+
+
+
+
+
+
+ #credentials ⇒ NgrokAPI::Services::CredentialsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel Credentials are ngrok agent authtokens.
@@ -167,9 +239,97 @@
-
Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient.
+
Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.
+
+
+ #event_destinations ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #event_sources ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #event_streams ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #event_subscriptions ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -196,6 +356,126 @@
A new instance of Client.
+
+
+
+
+
+
+ #ip_policies ⇒ NgrokAPI::Services::IPPoliciesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or deny action.
+
+
+
+
+
+
+ #ip_policy_rules ⇒ NgrokAPI::Services::IPPolicyRulesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
+
+
+
+
+
+
+ #ip_restrictions ⇒ NgrokAPI::Services::IPRestrictionsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.
+
+
+
+
+
+
+ #ip_whitelist ⇒ NgrokAPI::Services::IPWhitelistClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The IP Whitelist is deprecated and will be removed.
+
+
+
+
+
+
+ #reserved_addrs ⇒ NgrokAPI::Services::ReservedAddrsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
@@ -217,7 +497,7 @@
-
Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient.
+
Reserved Domains are hostnames that you can listen for traffic on.
- #tls_certificates ⇒ NgrokAPI::Services::TlsCertificatesClient
+ #ssh_certificate_authorities ⇒ NgrokAPI::Services::SSHCertificateAuthoritiesClient
@@ -241,7 +521,151 @@
-
Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient.
+
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
+
+
+
+
+
+
+ #ssh_credentials ⇒ NgrokAPI::Services::SSHCredentialsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
+
+
+
+
+
+
+ #ssh_host_certificates ⇒ NgrokAPI::Services::SSHHostCertificatesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
+
+
+ #ssh_user_certificates ⇒ NgrokAPI::Services::SSHUserCertificatesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.
+
+
+
+
+
+
+ #tls_certificates ⇒ NgrokAPI::Services::TLSCertificatesClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.
+
+
+
+
+
+
+ #tunnel_sessions ⇒ NgrokAPI::Services::TunnelSessionsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.
+
+
+
+
+
+
+ #tunnels ⇒ NgrokAPI::Services::TunnelsClient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
@@ -289,11 +713,11 @@
# File 'lib/ngrokapi/client.rb', line 8
-def initialize (
- api_key: ,
- base_url: ' https://api.ngrok.com ' )
- @client = NgrokAPI :: HttpClient . new ( api_key: api_key , base_url: base_url )
+def initialize (
+ api_key: ,
+ base_url: ' https://api.ngrok.com ' )
+ @client = NgrokAPI :: HttpClient . new ( api_key: api_key , base_url: base_url )
end
@@ -308,9 +732,9 @@
-
+
+
+
+
+
+
+
API Keys are used to authenticate to the (ngrok.com/docs/api#authentication)ngrok
+
+
API. You may use the API itself
+to provision and manage API Keys but you'll need to provision your first API
+key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your
+ngrok.com dashboard.
+
+
+
+
+
+
+
+
+
+
+
+33
+34
+35
+
+
+ # File 'lib/ngrokapi/client.rb', line 33
+
+def api_keys
+ @_api_keys ||= NgrokAPI :: Services :: APIKeysClient . new ( client: @client )
+end
+
+
+
+
+
+
+
Certificate Authorities are x509 certificates that are used to sign other
+
+
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
+to verify that the TLS certificate presented by a client has been signed by
+this CA. Certificate Authorities are used only for mTLS validation only and
+thus a private key is not included in the resource.
+
+
+
+
+
+
+
+
+
+
+
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+
+
agent to connect the ngrok service as your account. They are installed with
+the ngrok authtoken command or by specifying it in the ngrok.yml
+configuration file with the authtoken property.
+
+
+
+
+
+
+
+
+
+
+
+56
+57
+58
+
+
+ # File 'lib/ngrokapi/client.rb', line 56
+
+def credentials
+ @_credentials ||= NgrokAPI :: Services :: CredentialsClient . new ( client: @client )
end
@@ -373,7 +979,11 @@
-
Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient
+
Endpoint Configurations are a reusable group of modules that encapsulate how
+
+
traffic to a domain or address is handled. Endpoint configurations are only
+applied to Domains and TCP Addresses they have been attached to.
+
@@ -400,19 +1010,427 @@
-27
-28
-29
-30
-31
+66
+67
+68
- # File 'lib/ngrokapi/client.rb', line 27
+ # File 'lib/ngrokapi/client.rb', line 66
-def endpoint_configurations
- @_endpoint_configurations ||= NgrokAPI :: Services :: EndpointConfigurationsClient . new (
- client: @client
- )
+def endpoint_configurations
+ @_endpoint_configurations ||= NgrokAPI :: Services :: EndpointConfigurationsClient . new ( client: @client )
+end
+
+
+
+
+
+ #event_destinations ⇒ Object
+
+
+
+
+
+
+
+
+
+ #event_sources ⇒ Object
+
+
+
+
+
+
+
+
+
+ #event_streams ⇒ Object
+
+
+
+
+
+
+
+
+
+ #event_subscriptions ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
IP Policies are reusable groups of CIDR ranges with an allow or deny
+
+
action. They can be attached to endpoints via the Endpoint Configuration IP
+Policy module. They can also be used with IP Restrictions to control source
+IP ranges that can start tunnel sessions and connect to the API and dashboard.
+
+
+
+
+
+
+
+
+
+
+
+93
+94
+95
+
+
+ # File 'lib/ngrokapi/client.rb', line 93
+
+def ip_policies
+ @_ip_policies ||= NgrokAPI :: Services :: IPPoliciesClient . new ( client: @client )
+end
+
+
+
+
+
+
+
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+
+
make up an IP Policy.
+
+
+
+
+
+
+
+
+
+
+
+102
+103
+104
+
+
+ # File 'lib/ngrokapi/client.rb', line 102
+
+def ip_policy_rules
+ @_ip_policy_rules ||= NgrokAPI :: Services :: IPPolicyRulesClient . new ( client: @client )
+end
+
+
+
+
+
+
+
An IP restriction is a restriction placed on the CIDRs that are allowed to
+
+
initate traffic to a specific aspect of your ngrok account. An IP
+restriction has a type which defines the ingress it applies to. IP
+restrictions can be used to enforce the source IPs that can make API
+requests, log in to the dashboard, start ngrok agents, and connect to your
+public-facing endpoints.
+
+
+
+
+
+
+
+
+
+
+
The IP Whitelist is deprecated and will be removed. Use an IP Restriction
+
+
with an endpoints type instead.
+
+
+
+
+
+
+
+
+
+
+
+124
+125
+126
+
+
+ # File 'lib/ngrokapi/client.rb', line 124
+
+def ip_whitelist
+ @_ip_whitelist ||= NgrokAPI :: Services :: IPWhitelistClient . new ( client: @client )
+end
+
+
+
+
+
+
+
Reserved Addresses are TCP addresses that can be used to listen for traffic.
+
+
TCP address hostnames and ports are assigned by ngrok, they cannot be
+chosen.
+
+
+
+
+
+
+
+
+
+
+
+134
+135
+136
+
+
+ # File 'lib/ngrokapi/client.rb', line 134
+
+def reserved_addrs
+ @_reserved_addrs ||= NgrokAPI :: Services :: ReservedAddrsClient . new ( client: @client )
end
@@ -431,7 +1449,12 @@
-
Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient
+
Reserved Domains are hostnames that you can listen for traffic on. Domains
+
+
can be used to listen for http, https or tls traffic. You may use a domain
+that you own by creating a CNAME record specified in the returned resource.
+This CNAME record points traffic for that domain to ngrok's edge servers.
+
@@ -458,15 +1481,15 @@
-37
-38
-39
+145
+146
+147
- # File 'lib/ngrokapi/client.rb', line 37
+ # File 'lib/ngrokapi/client.rb', line 145
-def reserved_domains
- @_reserved_domains ||= NgrokAPI :: Services :: ReservedDomainsClient . new ( client: @client )
+def reserved_domains
+ @_reserved_domains ||= NgrokAPI :: Services :: ReservedDomainsClient . new ( client: @client )
end
@@ -474,9 +1497,9 @@
+
+
+
+
+
SSH Credentials are SSH public keys that can be used to start SSH tunnels
+
+
via the ngrok SSH tunnel gateway.
+
+
+
+
+
+
+
+
+
+
+
SSH Host Certificates along with the corresponding private key allows an SSH
+
+
server to assert its authenticity to connecting SSH clients who trust the
+SSH Certificate Authority that was used to sign the certificate.
+
+
+
+
+
+
+
+
+
+
+
SSH User Certificates are presented by SSH clients when connecting to an SSH
+
+
server to authenticate their connection. The SSH server must trust the SSH
+Certificate Authority used to sign the certificate.
+
+
+
+
+
+
+
+
+
+
+
TLS Certificates are pairs of x509 certificates and their matching private
+
+
key that can be used to terminate TLS traffic. TLS certificates are unused
+until they are attached to a Domain. TLS Certificates may also be
+provisioned by ngrok automatically for domains on which you have enabled
+automated certificate provisioning.
+
+
+
+
+
+
+
+
+
+
+
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
+
+
sessions that are running and connected to the ngrok service. Each tunnel
+session can include one or more Tunnels.
+
+
+
+
+
+
+
+
+
+
+
Tunnels provide endpoints to access services exposed by a running ngrok
+
+
agent tunnel session or an SSH reverse tunnel session.
+
+
+
+
+
+
+
+
+
+
+
+214
+215
+216
+
+
+ # File 'lib/ngrokapi/client.rb', line 214
+
+def tunnels
+ @_tunnels ||= NgrokAPI :: Services :: TunnelsClient . new ( client: @client )
end
@@ -532,7 +1906,7 @@
diff --git a/doc/NgrokAPI/Error.html b/doc/NgrokAPI/Error.html
index e16e045..4a054f2 100644
--- a/doc/NgrokAPI/Error.html
+++ b/doc/NgrokAPI/Error.html
@@ -295,7 +295,7 @@
diff --git a/doc/NgrokAPI/Errors.html b/doc/NgrokAPI/Errors.html
index 90902d8..da40ae2 100644
--- a/doc/NgrokAPI/Errors.html
+++ b/doc/NgrokAPI/Errors.html
@@ -105,7 +105,7 @@
diff --git a/doc/NgrokAPI/Errors/NotFoundError.html b/doc/NgrokAPI/Errors/NotFoundError.html
index 6fa84ef..9ae67da 100644
--- a/doc/NgrokAPI/Errors/NotFoundError.html
+++ b/doc/NgrokAPI/Errors/NotFoundError.html
@@ -299,7 +299,7 @@
diff --git a/doc/NgrokAPI/HttpClient.html b/doc/NgrokAPI/HttpClient.html
index a221500..ebdf903 100644
--- a/doc/NgrokAPI/HttpClient.html
+++ b/doc/NgrokAPI/HttpClient.html
@@ -1094,7 +1094,7 @@
diff --git a/doc/NgrokAPI/Models.html b/doc/NgrokAPI/Models.html
index 1521ef1..0547e73 100644
--- a/doc/NgrokAPI/Models.html
+++ b/doc/NgrokAPI/Models.html
@@ -78,8 +78,8 @@
Defined in:
- lib/ngrokapi/models/api_key.rb,
+ lib/ngrokapi/models/ref.rb,
@@ -91,7 +91,7 @@
- Classes: ApiKey EndpointConfiguration Listable ReservedDomain TlsCertificate Classes: APIKey AWSAuth AWSCredentials AWSRole AbuseReport AbuseReportHostname CertificateAuthority Credential EndpointCircuitBreaker EndpointCompression EndpointConfiguration EndpointIPPolicy EndpointIPPolicyMutate EndpointLogging EndpointLoggingMutate EndpointMutualTLS EndpointMutualTLSMutate EndpointOAuth EndpointOAuthFacebook EndpointOAuthGitHub EndpointOAuthGoogle EndpointOAuthMicrosoft EndpointOAuthProvider EndpointOIDC EndpointRequestHeaders EndpointResponseHeaders EndpointSAML EndpointSAMLMutate EndpointTLSTermination EndpointWebhookValidation EventDestination EventSource EventSourceReplace EventStream EventSubscription EventTarget EventTargetCloudwatchLogs EventTargetFirehose EventTargetKinesis IPPolicy IPPolicyRule IPRestriction IPWhitelistEntry Listable Ref ReservedAddr ReservedDomain ReservedDomainCertJob ReservedDomainCertNSTarget ReservedDomainCertPolicy ReservedDomainCertStatus SSHCertificateAuthority SSHCredential SSHHostCertificate SSHUserCertificate TLSCertificate TLSCertificateSANs Tunnel TunnelSession
- Class: NgrokAPI::Models::ApiKey
+ Class: NgrokAPI::Models::APIKey
— Documentation by YARD 0.9.26
@@ -15,7 +15,7 @@
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
- pathId = "NgrokAPI::Models::ApiKey";
+ pathId = "NgrokAPI::Models::APIKey";
relpath = '../../';
</script>
@@ -39,7 +39,7 @@
<a href="../../_index.html">Index (A)</a> »
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
»
- <span class="title">ApiKey</span>
+ <span class="title">APIKey</span>
</div>
@@ -59,7 +59,7 @@
<div class="clear"></div>
</div>
- <div id="content"><h1>Class: NgrokAPI::Models::ApiKey
+ <div id="content"><h1>Class: NgrokAPI::Models::APIKey
@@ -74,7 +74,7 @@
<ul class="fullTree">
<li>Object</li>
- <li class="next">NgrokAPI::Models::ApiKey</li>
+ <li class="next">NgrokAPI::Models::APIKey</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
@@ -99,19 +99,8 @@
</div>
-<h2>Overview</h2><div class="docstring">
- <div class="discussion">
-
-<p>A resource representing data from the api_keys API</p>
- </div>
-</div>
-<div class="tags">
-
-
-</div>
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
@@ -387,7 +376,7 @@
<li class="public ">
<span class="summary_signature">
- <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> ⇒ nil </a>
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> ⇒ Object </a>
@@ -402,7 +391,7 @@
<span class="summary_desc"><div class='inline'>
-<p>Delete this API key.</p>
+<p>Delete an API key by ID.</p>
</div></span>
</li>
@@ -411,7 +400,7 @@
<li class="public ">
<span class="summary_signature">
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ ApiKey </a>
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ APIKey </a>
@@ -428,7 +417,7 @@
<span class="summary_desc"><div class='inline'>
-<p>A new instance of ApiKey.</p>
+<p>A new instance of APIKey.</p>
</div></span>
</li>
@@ -459,7 +448,7 @@
<li class="public ">
<span class="summary_signature">
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil) ⇒ NgrokAPI::Models::ApiKey </a>
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil) ⇒ Object </a>
@@ -474,7 +463,7 @@
<span class="summary_desc"><div class='inline'>
-<p>Update the attributes of this API key.</p>
+<p>Update attributes of an API key by ID.</p>
</div></span>
</li>
@@ -489,7 +478,7 @@
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ApiKey (class)">ApiKey</a></span></tt>
+ #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></tt>
@@ -498,7 +487,7 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns a new instance of ApiKey.</p>
+<p>Returns a new instance of APIKey.</p>
</div>
@@ -512,6 +501,8 @@
<pre class="lines">
+15
+16
17
18
19
@@ -519,22 +510,20 @@
21
22
23
-24
-25
-26</pre>
+24</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 17</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 15</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
- <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
- <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>created_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
- <span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
- <span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
- <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>metadata</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
- <span class='ivar'>@token</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>token</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
- <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
+ <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+ <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>metadata</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+ <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>created_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
+ <span class='ivar'>@token</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>token</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -574,12 +563,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span>
@@ -617,12 +606,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
<span class='ivar'>@created_at</span>
@@ -660,12 +649,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='ivar'>@description</span>
@@ -703,12 +692,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
@@ -746,12 +735,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
<span class='ivar'>@metadata</span>
@@ -789,12 +778,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
<span class='ivar'>@result</span>
@@ -832,12 +821,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
<span class='ivar'>@token</span>
@@ -875,12 +864,12 @@
<pre class="lines">
-8
-9
-10</pre>
+6
+7
+8</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
<span class='ivar'>@uri</span>
@@ -912,15 +901,15 @@
<pre class="lines">
-28
-29
-30</pre>
+26
+27
+28</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 28</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 26</span>
-<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
- <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
+<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
+ <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -930,7 +919,7 @@
<div class="method_details ">
<h3 class="signature " id="delete-instance_method">
- #<strong>delete</strong> ⇒ <tt>nil</tt>
+ #<strong>delete</strong> ⇒ <tt>Object</tt>
@@ -939,7 +928,7 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Delete this API key.</p>
+<p>Delete an API key by ID</p>
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
@@ -948,24 +937,6 @@
</div>
<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>nil</tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>result from delete request</p>
-</div>
-
- </li>
-
-</ul>
</div><table class="source_code">
<tr>
@@ -973,15 +944,19 @@
<pre class="lines">
-42
-43
-44</pre>
+38
+39
+40
+41
+42</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 42</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 38</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
+ <span class='label'>id:</span> <span class='ivar'>@id</span>
+ <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -1003,15 +978,15 @@
<pre class="lines">
-32
-33
-34</pre>
+30
+31
+32</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 32</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 30</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
- <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -1021,7 +996,7 @@
<div class="method_details ">
<h3 class="signature " id="update-instance_method">
- #<strong>update</strong>(description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
+ #<strong>update</strong>(description: nil, metadata: nil) ⇒ <tt>Object</tt>
@@ -1030,7 +1005,7 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Update the attributes of this API key.</p>
+<p>Update attributes of an API key by ID.</p>
<p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
@@ -1038,65 +1013,7 @@
</div>
</div>
<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
- <li>
-
- <span class='name'>description</span>
-
-
- <span class='type'>(<tt>string</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'>
-<p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
-</div>
-
- </li>
-
- <li>
-
- <span class='name'>metadata</span>
-
-
- <span class='type'>(<tt>string</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>nil</tt>)</em>
-
-
- —
- <div class='inline'>
-<p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
-</div>
-
- </li>
-
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
-
-
-
- —
- <div class='inline'>
-<p>result from update request</p>
-</div>
-
- </li>
-
-</ul>
</div><table class="source_code">
<tr>
@@ -1104,19 +1021,33 @@
<pre class="lines">
+48
+49
+50
+51
+52
+53
+54
+55
56
57
58
-59
-60</pre>
+59</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 56</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 48</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
- <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
- <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+ <span class='label'>metadata:</span> <span class='kw'>nil</span>
+<span class='rparen'>)</span>
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
+ <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span>
+ <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
@@ -1128,7 +1059,7 @@
</div>
<div id="footer">
- Generated on Fri Sep 24 19:20:29 2021 by
+ Generated on Mon Oct 4 23:24:15 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>
diff --git a/doc/NgrokAPI/Models/AWSAuth.html b/doc/NgrokAPI/Models/AWSAuth.html
new file mode 100644
index 0000000..1c60506
--- /dev/null
+++ b/doc/NgrokAPI/Models/AWSAuth.html
@@ -0,0 +1,617 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+ Class: NgrokAPI::Models::AWSAuth
+
+ — Documentation by YARD 0.9.26
+
+
+
+
+
+
+
Class: NgrokAPI::Models::AWSAuth
+
+
+
+
+
+
+
+ Inherits:
+
+ Object
+
+
+ Object
+
+ NgrokAPI::Models::AWSAuth
+
+
+ show all
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Defined in:
+ lib/ngrokapi/models/aws_auth.rb
+
+
+
+
+
+
+
+
+
Instance Attribute Summary collapse
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+ #creds ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute creds.
+
+
+
+
+
+
+ #result ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute result.
+
+
+
+
+
+
+ #role ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute role.
+
+
+
+
+
+
+
+
+
+
+ Instance Method Summary
+ collapse
+
+
+
+
+
+
Constructor Details
+
+
+
+
+ #initialize (client:, result:) ⇒ AWSAuth
+
+
+
Returns a new instance of AWSAuth.
+
+
+
+
+
+
+
+
+
+
+
+
+
+11
+12
+13
+14
+15
+16
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 11
+
+def initialize ( client: , result: )
+ @client = client
+ @result = result
+ @role = @result [ ' role ' ]
+ @creds = @result [ ' creds ' ]
+end
+
+
+
+
+
+
+
+
Instance Attribute Details
+
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+
+
+
+
+
+
+
+6
+7
+8
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 6
+
+def client
+ @client
+end
+
+
+
+
+
+
+
+
+
+ #creds ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute creds.
+
+
+
+
+
+
+
+
+
+
+
+
+
+6
+7
+8
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 6
+
+def creds
+ @creds
+end
+
+
+
+
+
+
+
+
+
+ #result ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute result.
+
+
+
+
+
+
+
+
+
+
+
+
+
+6
+7
+8
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 6
+
+def result
+ @result
+end
+
+
+
+
+
+
+
+
+
+ #role ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute role.
+
+
+
+
+
+
+
+
+
+
+
+
+
+6
+7
+8
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 6
+
+def role
+ @role
+end
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #== (other) ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+18
+19
+20
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 18
+
+def == ( other )
+ @result == other . result
+end
+
+
+
+
+
+
+
+ #to_s ⇒ Object
+
+
+
+
+
+
+
+
+
+
+
+22
+23
+24
+
+
+ # File 'lib/ngrokapi/models/aws_auth.rb', line 22
+
+def to_s
+ @result . to_s
+end
+
+
+
+
+
+
+
+
+
+
+