ngrok-api 0.12.0 → 0.14.0

data/doc/NgrokAPI/Services/APIKeysClient.html

@@ -102,13 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p>
-
-<pre class="code ruby"><code class="ruby">API. You may use the API itself
-to provision and manage API Keys but you&#39;ll need to provision your first API
-key from the  (https://dashboard.ngrok.com/api/keys)API Keys page on your
-ngrok.com dashboard.
-</code></pre>
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself  to provision and manage API Keys but you&#39;ll need to provision your first API  key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your  ngrok.com dashboard.</p>
 
 <p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p>
 
@@ -377,6 +371,30 @@ ngrok.com dashboard.
 <p>List all API keys owned by this account.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil)  &#x21d2; NgrokAPI::Models::Listable </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>List all API keys owned by this account Throws an exception if API error.</p>
+</div></span>
+  
 </li>
 
       
@@ -460,12 +478,12 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+21
 22
-23
-24</pre>
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 22</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</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='rparen'>)</span>
   <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
@@ -508,12 +526,12 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+19
 20
-21
-22</pre>
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
   <span class='ivar'>@client</span>
@@ -616,6 +634,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+34
 35
 36
 37
@@ -627,11 +646,10 @@ ngrok.com dashboard.
 43
 44
 45
-46
-47</pre>
+46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 35</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
   <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
@@ -719,6 +737,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+55
 56
 57
 58
@@ -726,11 +745,10 @@ ngrok.com dashboard.
 60
 61
 62
-63
-64</pre>
+63</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 55</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
   <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -814,6 +832,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+73
 74
 75
 76
@@ -821,11 +840,10 @@ ngrok.com dashboard.
 78
 79
 80
-81
-82</pre>
+81</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 74</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 73</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
   <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -909,6 +927,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+90
 91
 92
 93
@@ -918,11 +937,10 @@ ngrok.com dashboard.
 97
 98
 99
-100
-101</pre>
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 91</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 90</span>
 
 <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -1008,6 +1026,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+110
 111
 112
 113
@@ -1017,11 +1036,10 @@ ngrok.com dashboard.
 117
 118
 119
-120
-121</pre>
+120</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 111</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 110</span>
 
 <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -1133,6 +1151,7 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
+131
 132
 133
 134
@@ -1153,7 +1172,7 @@ ngrok.com dashboard.
 149</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 132</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 131</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
   <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
@@ -1166,6 +1185,7 @@ ngrok.com dashboard.
     <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
     <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
     <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
     <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
@@ -1176,6 +1196,151 @@ ngrok.com dashboard.
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="list!-instance_method">
+  
+    #<strong>list!</strong>(before_id: nil, limit: nil, url: nil)  &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>List all API keys owned by this account Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>before_id</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>limit</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>url</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>optional and mutually exclusive from before_id and limit</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>result from the API request</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 161</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
+  <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+  <span class='label'>url:</span> <span class='kw'>nil</span>
+<span class='rparen'>)</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
+    <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
+    <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
+    <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
+    <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span>
+  <span class='rparen'>)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+    <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
+    <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
+    <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
+    <span class='label'>klass:</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span>
+  <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1277,24 +1442,24 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
-160
-161
-162
-163
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173
-174</pre>
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 160</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 192</span>
 
 <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
@@ -1415,24 +1580,24 @@ ngrok.com dashboard.
       <pre class="lines">
 
 
-186
-187
-188
-189
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199
-200</pre>
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 186</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 218</span>
 
 <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
@@ -1459,7 +1624,7 @@ ngrok.com dashboard.
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:16 2021 by
+  Generated on Tue Oct 19 15:48:20 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>

data/doc/NgrokAPI/Services/AbuseReportsClient.html

@@ -102,10 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p>
-
-<pre class="code ruby"><code class="ruby">ngrok that violate ngrok&#39;s terms of service.
-</code></pre>
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by  ngrok that violate ngrok&#39;s terms of service.</p>
 
 <p><a href="https://ngrok.com/docs/api#api-abuse-reports">ngrok.com/docs/api#api-abuse-reports</a></p>
 
@@ -713,7 +710,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:17 2021 by
+  Generated on Tue Oct 19 15:48:21 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>