cut new release for ngrok-api-ruby

2026-06-16 16:54:38 +00:00 · 2021-09-24 19:04:10 +00:00
parent 702c4332ba
commit f1dcc0fb43
48 changed files with 445 additions and 106 deletions
@@ -532,7 +532,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -0,0 +1,305 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: NgrokAPI::Error
+  
+    &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::Error";
+  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 (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
+     &raquo; 
+    <span class="title">Error</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>Exception: NgrokAPI::Error
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">StandardError</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next">NgrokAPI::Error</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/error.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Base Error class for all Ngrok Errors</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NgrokAPI::Errors::NotFoundError</a></span></p>
+</div>
+
+
+
+
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute response.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(msg: &quot;An error occurred with the NgrokAPI&quot;, response: nil)  &#x21d2; Error </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Error.</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>(msg: &quot;An error occurred with the NgrokAPI&quot;, response: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Error (class)">Error</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of Error.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line 9</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>An error occurred with the NgrokAPI</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="response-instance_method">
+  
+    #<strong>response</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute response.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line 7</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
+  <span class='ivar'>@response</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+      <div id="footer">
+  Generated on Fri Sep 24 19:04:09 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>
+
+    </div>
+  </body>
+</html>
@@ -105,7 +105,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -69,13 +69,15 @@
  <dl>
    <dt>Inherits:</dt>
    <dd>
-      <span class="inheritName">StandardError</span>
+      <span class="inheritName"><span class='object_link'><a href="../Error.html" title="NgrokAPI::Error (class)">NgrokAPI::Error</a></span></span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">StandardError</li>
          
+            <li class="next"><span class='object_link'><a href="../Error.html" title="NgrokAPI::Error (class)">NgrokAPI::Error</a></span></li>
+          
            <li class="next">NgrokAPI::Errors::NotFoundError</li>
          
        </ul>
@@ -191,6 +193,12 @@
  


+  
+  
+  
+  
+  
+  
  <div id="constructor_details" class="method_details_list">
  <h2>Constructor Details</h2>
  
@@ -230,7 +238,7 @@

 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Resource not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
-  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
+  <span class='kw'>super</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='id identifier rubyid_msg'>msg</span><span class='comma'>,</span> <span class='label'>response:</span> <span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
    </td>
  </tr>
@@ -291,7 +299,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1094,7 +1094,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -107,7 +107,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1128,7 +1128,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1356,7 +1356,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -924,7 +924,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -2488,7 +2488,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1054,7 +1054,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -621,7 +621,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -107,7 +107,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:34 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1323,7 +1323,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -2191,7 +2191,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -2531,7 +2531,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>
@@ -1407,7 +1407,7 @@
 </div>

      <div id="footer">
-  Generated on Mon Sep 20 22:08:35 2021 by
+  Generated on Fri Sep 24 19:04:09 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>