ngrok/ngrok-api-ruby
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-ruby.git synced 2026-05-17 16:50:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0.0.1
ngrok-api-ruby/doc/NgrokAPI/Client.html
T
David Parker dc9571f138 Add ! methods and specs and NotFoundError
2021-09-17 13:27:38 -06:00

542 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: NgrokAPI::Client
&mdash; Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "NgrokAPI::Client";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
&raquo;
<span class="title">Client</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: NgrokAPI::Client
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">NgrokAPI::Client</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi/client.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Low-level api client for communicating with Ngrok&#39;s HTTP API. Use this object to instantiate your clients.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#api_keys-instance_method" title="#api_keys (instance method)">#<strong>api_keys</strong> &#x21d2; NgrokAPI::Services::ApiKeysClient </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#endpoint_configurations-instance_method" title="#endpoint_configurations (instance method)">#<strong>endpoint_configurations</strong> &#x21d2; NgrokAPI::Services::EndpointConfigurationsClient </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;) &#x21d2; Client </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Client.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong> &#x21d2; NgrokAPI::Services::ReservedDomainsClient </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong> &#x21d2; NgrokAPI::Services::TlsCertificatesClient </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(api_key:, base_url: &#39;https://api.ngrok.com&#39;) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Client (class)">Client</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Client.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
<span class='label'>api_key:</span><span class='comma'>,</span>
<span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>&#39;</span></span>
<span class='rparen'>)</span>
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="api_keys-instance_method">
#<strong>api_keys</strong> &#x21d2; <tt><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">NgrokAPI::Services::ApiKeysClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and returns an instance of a NgrokAPI::Services::ApiKeysClient</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">NgrokAPI::Services::ApiKeysClient</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
<span class='ivar'>@_api_keys</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ApiKeysClient.html" title="NgrokAPI::Services::ApiKeysClient (class)">ApiKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ApiKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::ApiKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="endpoint_configurations-instance_method">
#<strong>endpoint_configurations</strong> &#x21d2; <tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and returns an instance of a NgrokAPI::Services::EndpointConfigurationsClient</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
<span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='label'>client:</span> <span class='ivar'>@client</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reserved_domains-instance_method">
#<strong>reserved_domains</strong> &#x21d2; <tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and returns an instance of a NgrokAPI::Services::ReservedDomainsClient</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
<span class='ivar'>@_reserved_domains</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="tls_certificates-instance_method">
#<strong>tls_certificates</strong> &#x21d2; <tt><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">NgrokAPI::Services::TlsCertificatesClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and returns an instance of a NgrokAPI::Services::TlsCertificatesClient</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">NgrokAPI::Services::TlsCertificatesClient</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
<span class='ivar'>@_tls_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TlsCertificatesClient.html" title="NgrokAPI::Services::TlsCertificatesClient (class)">TlsCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TlsCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TlsCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Sep 17 13:27:19 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink