ngrok-api 0.12.0 → 0.14.0

data/doc/NgrokAPI/Services/ReservedDomainsClient.html

@@ -102,12 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p>
-
-<pre class="code ruby"><code class="ruby">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&#39;s edge servers.
-</code></pre>
+<p>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&#39;s edge servers.</p>
 
 <p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p>
 
@@ -564,6 +559,30 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
   
 
   
+    <span class="summary_desc"><div class='inline'>
+<p>List all reserved domains on 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 reserved domains on this account.</p>
 </div></span>
@@ -863,7 +882,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
+<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
 </div>
       
     </li>
@@ -881,7 +900,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
+<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
 </div>
       
     </li>
@@ -1230,18 +1249,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-283
-284
-285
-286
-287
-288
-289
-290
-291</pre>
+316
+317
+318
+319
+320
+321
+322
+323
+324</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 283</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 316</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</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>
@@ -1325,18 +1344,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-301
-302
-303
-304
-305
-306
-307
-308
-309</pre>
+334
+335
+336
+337
+338
+339
+340
+341
+342</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 301</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 334</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</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>
@@ -1420,18 +1439,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-248
-249
-250
-251
-252
-253
-254
-255
-256</pre>
+281
+282
+283
+284
+285
+286
+287
+288
+289</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 248</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 281</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</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>
@@ -1515,18 +1534,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-266
-267
-268
-269
-270
-271
-272
-273
-274</pre>
+299
+300
+301
+302
+303
+304
+305
+306
+307</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 266</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 299</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</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>
@@ -1610,18 +1629,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-318
-319
-320
-321
-322
-323
-324
-325
-326</pre>
+351
+352
+353
+354
+355
+356
+357
+358
+359</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 318</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 351</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</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>
@@ -1705,18 +1724,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-336
-337
-338
-339
-340
-341
-342
-343
-344</pre>
+369
+370
+371
+372
+373
+374
+375
+376
+377</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 336</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 369</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</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>
@@ -1800,18 +1819,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-353
-354
-355
-356
-357
-358
-359
-360
-361</pre>
+386
+387
+388
+389
+390
+391
+392
+393
+394</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 353</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 386</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</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>
@@ -1895,18 +1914,18 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-371
-372
-373
-374
-375
-376
-377
-378
-379</pre>
+404
+405
+406
+407
+408
+409
+410
+411
+412</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 371</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 404</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</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>
@@ -2231,7 +2250,8 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
 161
 162
 163
-164</pre>
+164
+165</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 147</span>
@@ -2247,6 +2267,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
     <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::ReservedDomainsClient::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>
@@ -2257,6 +2278,151 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
     </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 reserved domains on this account. Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-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">
+
+
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192
+193
+194
+195
+196
+197</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 177</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::ReservedDomainsClient::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::ReservedDomainsClient::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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</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 ">
@@ -2380,7 +2546,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
+<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
 </div>
       
     </li>
@@ -2398,7 +2564,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
+<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
 </div>
       
     </li>
@@ -2430,32 +2596,32 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-179
-180
-181
-182
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199
-200
-201</pre>
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 179</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 212</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>
@@ -2606,7 +2772,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
+<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
 </div>
       
     </li>
@@ -2624,7 +2790,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       
         &mdash;
         <div class='inline'>
-<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
+<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
 </div>
       
     </li>
@@ -2656,32 +2822,32 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
       <pre class="lines">
 
 
-217
-218
-219
-220
-221
-222
-223
-224
-225
-226
-227
-228
-229
-230
-231
-232
-233
-234
-235
-236
-237
-238
-239</pre>
+250
+251
+252
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 217</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 250</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>
@@ -2716,7 +2882,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:24 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>