ngrok-api 0.14.0 → 0.17.0

data/docs/NgrokAPI/Models/TunnelSession.html

@@ -6,7 +6,7 @@
 <title>
   Class: NgrokAPI::Models::TunnelSession
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -1199,9 +1199,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 19 15:48:19 2021 by
+  Generated on Thu Mar 10 04:54:48 2022 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-2.7.5).
 </div>
 
     </div>

data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html}

@@ -4,9 +4,9 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Class: NgrokAPI::Models::IPWhitelistEntry
+  Class: NgrokAPI::Models::WeightedBackend
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
   
 </title>
 
@@ -15,7 +15,7 @@
   <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
 <script type="text/javascript">
-  pathId = "NgrokAPI::Models::IPWhitelistEntry";
+  pathId = "NgrokAPI::Models::WeightedBackend";
   relpath = '../../';
 </script>
 
@@ -36,10 +36,10 @@
       <div id="header">
         <div id="menu">
   
-    <a href="../../_index.html">Index (I)</a> &raquo;
+    <a href="../../_index.html">Index (W)</a> &raquo;
     <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
      &raquo; 
-    <span class="title">IPWhitelistEntry</span>
+    <span class="title">WeightedBackend</span>
   
 </div>
 
@@ -59,7 +59,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1>Class: NgrokAPI::Models::IPWhitelistEntry
+      <div id="content"><h1>Class: NgrokAPI::Models::WeightedBackend
   
   
   
@@ -74,7 +74,7 @@
         <ul class="fullTree">
           <li>Object</li>
           
-            <li class="next">NgrokAPI::Models::IPWhitelistEntry</li>
+            <li class="next">NgrokAPI::Models::WeightedBackend</li>
           
         </ul>
         <a href="#" class="inheritanceTree">show all</a>
@@ -94,7 +94,7 @@
   
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/ngrokapi/models/ip_whitelist_entry.rb</dd>
+    <dd>lib/ngrokapi/models/weighted_backend.rb</dd>
   </dl>
   
 </div>
@@ -109,7 +109,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong>  &#x21d2; Object </a>
+      <a href="#backends-instance_method" title="#backends (instance method)">#<strong>backends</strong>  &#x21d2; Object </a>
     
 
     
@@ -129,7 +129,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute client.</p>
+<p>Returns the value of attribute backends.</p>
 </div></span>
   
 </li>
@@ -138,7 +138,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong>  &#x21d2; Object </a>
+      <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong>  &#x21d2; Object </a>
     
 
     
@@ -158,7 +158,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute created_at.</p>
+<p>Returns the value of attribute client.</p>
 </div></span>
   
 </li>
@@ -167,7 +167,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong>  &#x21d2; Object </a>
+      <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong>  &#x21d2; Object </a>
     
 
     
@@ -187,7 +187,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute description.</p>
+<p>Returns the value of attribute created_at.</p>
 </div></span>
   
 </li>
@@ -196,7 +196,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong>  &#x21d2; Object </a>
+      <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong>  &#x21d2; Object </a>
     
 
     
@@ -216,7 +216,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute id.</p>
+<p>Returns the value of attribute description.</p>
 </div></span>
   
 </li>
@@ -225,7 +225,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#ip_net-instance_method" title="#ip_net (instance method)">#<strong>ip_net</strong>  &#x21d2; Object </a>
+      <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong>  &#x21d2; Object </a>
     
 
     
@@ -245,7 +245,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute ip_net.</p>
+<p>Returns the value of attribute id.</p>
 </div></span>
   
 </li>
@@ -391,7 +391,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Delete an IP whitelist entry.</p>
+<p>Delete a Weighted backend by ID.</p>
 </div></span>
   
 </li>
@@ -400,7 +400,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:)  &#x21d2; IPWhitelistEntry </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:)  &#x21d2; WeightedBackend </a>
     
 
     
@@ -417,7 +417,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of IPWhitelistEntry.</p>
+<p>A new instance of WeightedBackend.</p>
 </div></span>
   
 </li>
@@ -448,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)  &#x21d2; Object </a>
+      <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil, backends: {})  &#x21d2; Object </a>
     
 
     
@@ -463,7 +463,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Update attributes of an IP whitelist entry by ID.</p>
+<p>Update Weighted backend by ID.</p>
 </div></span>
   
 </li>
@@ -478,7 +478,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>(client:, result:)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></tt> 
+    #<strong>initialize</strong>(client:, result:)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span></tt> 
   
 
   
@@ -487,7 +487,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns a new instance of IPWhitelistEntry.</p>
+<p>Returns a new instance of WeightedBackend.</p>
 
 
   </div>
@@ -513,7 +513,7 @@
 24</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 15</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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>
@@ -523,7 +523,7 @@
   <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'>&#39;</span><span class='tstring_content'>created_at</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
-  <span class='ivar'>@ip_net</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ip_net</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@backends</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>backends</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -538,9 +538,9 @@
       
       <span id=""></span>
       <div class="method_details first">
-  <h3 class="signature first" id="client-instance_method">
+  <h3 class="signature first" id="backends-instance_method">
   
-    #<strong>client</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>backends</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -549,7 +549,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute client.</p>
+<p>Returns the value of attribute backends.</p>
 
 
   </div>
@@ -568,10 +568,10 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
-  <span class='ivar'>@client</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_backends'>backends</span>
+  <span class='ivar'>@backends</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -581,9 +581,9 @@
       
       <span id=""></span>
       <div class="method_details ">
-  <h3 class="signature " id="created_at-instance_method">
+  <h3 class="signature " id="client-instance_method">
   
-    #<strong>created_at</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>client</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -592,7 +592,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute created_at.</p>
+<p>Returns the value of attribute client.</p>
 
 
   </div>
@@ -611,10 +611,10 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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>
+<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
+  <span class='ivar'>@client</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -624,9 +624,9 @@
       
       <span id=""></span>
       <div class="method_details ">
-  <h3 class="signature " id="description-instance_method">
+  <h3 class="signature " id="created_at-instance_method">
   
-    #<strong>description</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>created_at</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -635,7 +635,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute description.</p>
+<p>Returns the value of attribute created_at.</p>
 
 
   </div>
@@ -654,10 +654,10 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
-  <span class='ivar'>@description</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
+  <span class='ivar'>@created_at</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -667,9 +667,9 @@
       
       <span id=""></span>
       <div class="method_details ">
-  <h3 class="signature " id="id-instance_method">
+  <h3 class="signature " id="description-instance_method">
   
-    #<strong>id</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>description</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -678,7 +678,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute id.</p>
+<p>Returns the value of attribute description.</p>
 
 
   </div>
@@ -697,10 +697,10 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
-  <span class='ivar'>@id</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
+  <span class='ivar'>@description</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -710,9 +710,9 @@
       
       <span id=""></span>
       <div class="method_details ">
-  <h3 class="signature " id="ip_net-instance_method">
+  <h3 class="signature " id="id-instance_method">
   
-    #<strong>ip_net</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>id</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -721,7 +721,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute ip_net.</p>
+<p>Returns the value of attribute id.</p>
 
 
   </div>
@@ -740,10 +740,10 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_ip_net'>ip_net</span>
-  <span class='ivar'>@ip_net</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
+  <span class='ivar'>@id</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -783,7 +783,7 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
   <span class='ivar'>@metadata</span>
@@ -826,7 +826,7 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
   <span class='ivar'>@result</span>
@@ -869,7 +869,7 @@
 8</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.rb', line 6</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
   <span class='ivar'>@uri</span>
@@ -906,7 +906,7 @@
 28</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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>
@@ -928,9 +928,9 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Delete an IP whitelist entry.</p>
+<p>Delete a Weighted backend by ID. TODO what if used?</p>
 
-<p><a href="https://ngrok.com/docs/api#api-ip-whitelist-delete">ngrok.com/docs/api#api-ip-whitelist-delete</a></p>
+<p><a href="https://ngrok.com/docs/api#api-weighted-backends-delete">ngrok.com/docs/api#api-weighted-backends-delete</a></p>
 
 
   </div>
@@ -951,7 +951,7 @@
 42</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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>
@@ -983,7 +983,7 @@
 32</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 30</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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>
@@ -996,7 +996,7 @@
       <div class="method_details ">
   <h3 class="signature " id="update-instance_method">
   
-    #<strong>update</strong>(description: nil, metadata: nil)  &#x21d2; <tt>Object</tt> 
+    #<strong>update</strong>(description: nil, metadata: nil, backends: {})  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -1005,9 +1005,9 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Update attributes of an IP whitelist entry by ID</p>
+<p>Update Weighted backend by ID</p>
 
-<p><a href="https://ngrok.com/docs/api#api-ip-whitelist-update">ngrok.com/docs/api#api-ip-whitelist-update</a></p>
+<p><a href="https://ngrok.com/docs/api#api-weighted-backends-update">ngrok.com/docs/api#api-weighted-backends-update</a></p>
 
 
   </div>
@@ -1032,21 +1032,27 @@
 56
 57
 58
-59</pre>
+59
+60
+61
+62</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/ip_whitelist_entry.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/weighted_backend.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='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>backends:</span> <span class='lbrace'>{</span><span class='rbrace'>}</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'>@backends</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</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='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
+    <span class='label'>backends:</span> <span class='id identifier rubyid_backends'>backends</span>
   <span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -1059,9 +1065,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Oct 19 15:48:20 2021 by
+  Generated on Thu Mar 10 04:54:49 2022 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-2.7.5).
 </div>
 
     </div>