ngrok-api 0.12.0 → 0.14.0

data/doc/NgrokAPI/Services/TLSCertificatesClient.html

@@ -102,13 +102,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>TLS Certificates are pairs of x509 certificates and their matching private</p>
-
-<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused
-until they are attached to a Domain. TLS Certificates may also be
-provisioned by ngrok automatically for domains on which you have enabled
-automated certificate provisioning.
-</code></pre>
+<p>TLS Certificates are pairs of x509 certificates and their matching private  key that can be used to terminate TLS traffic. TLS certificates are unused  until they are attached to a Domain. TLS Certificates may also be  provisioned by ngrok automatically for domains on which you have enabled  automated certificate provisioning.</p>
 
 <p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</a></p>
 
@@ -377,6 +371,30 @@ automated certificate provisioning.
 <p>List all TLS certificates 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 TLS certificates on this account Throws an exception if API error.</p>
+</div></span>
+  
 </li>
 
       
@@ -600,7 +618,7 @@ automated certificate provisioning.
       
         &mdash;
         <div class='inline'>
-<p>chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` &lt;<a href="https://ngrok.com/docs/api#tls-certificates-pem>`_“>ngrok.com/docs/api#tls-certificates-pem>`_</a>.</p>
+<p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles</code> <a href="https://ngrok.com/docs/api#tls-certificates-pem`_">ngrok.com/docs/api#tls-certificates-pem`_</a>.</p>
 </div>
       
     </li>
@@ -616,7 +634,7 @@ automated certificate provisioning.
       
         &mdash;
         <div class='inline'>
-<p>private key for the TLS certificate, PEM-encoded. See `Private Keys` &lt;<a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_“>ngrok.com/docs/ngrok-link#tls-certificates-key>`_</a>.</p>
+<p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys</code> <a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key`_">ngrok.com/docs/ngrok-link#tls-certificates-key`_</a>.</p>
 </div>
       
     </li>
@@ -1190,7 +1208,8 @@ automated certificate provisioning.
 150
 151
 152
-153</pre>
+153
+154</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 136</span>
@@ -1206,6 +1225,7 @@ automated certificate provisioning.
     <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::TLSCertificatesClient::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>
@@ -1216,6 +1236,151 @@ automated certificate provisioning.
     </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 TLS certificates on this account Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-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">
+
+
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 166</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::TLSCertificatesClient::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::TLSCertificatesClient::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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</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 ">
@@ -1317,24 +1482,24 @@ automated certificate provisioning.
       <pre class="lines">
 
 
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173
-174
-175
-176
-177
-178</pre>
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 164</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 197</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>
@@ -1455,24 +1620,24 @@ automated certificate provisioning.
       <pre class="lines">
 
 
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199
-200
-201
-202
-203
-204</pre>
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 190</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 223</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>
@@ -1499,7 +1664,7 @@ automated certificate provisioning.
 </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>