RubyGems - ngrok-api - Versions diffs - 0.26.0 → 0.28.0 - Mend

ngrok-api 0.26.0 → 0.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (373) hide show

data/docs/NgrokAPI/Services/StaticBackendsClient.html CHANGED Viewed

@@ -1885,9 +1885,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:38 2025 by
+  Generated on Fri Jan 23 21:38:07 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:41 2025 by
+  Generated on Fri Jan 23 21:38:09 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:42 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:42 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSCertificatesClient.html CHANGED Viewed

@@ -377,7 +377,7 @@
         <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>
+      <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil)  &#x21d2; NgrokAPI::Models::Listable </a>
@@ -401,7 +401,7 @@
         <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>
+      <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil)  &#x21d2; NgrokAPI::Models::Listable </a>
@@ -1249,7 +1249,7 @@
       <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>
+    #<strong>list</strong>(before_id: nil, limit: nil, filter: 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>
@@ -1280,6 +1280,11 @@
         <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
+</div>
     </li>
     <li>
@@ -1293,6 +1298,29 @@
         <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>filter</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
+</div>
     </li>
     <li>
@@ -1340,7 +1368,6 @@
       <pre class="lines">
-149
 150
 151
 152
@@ -1358,19 +1385,24 @@
 164
 165
 166
-167</pre>
+167
+168
+169
+170</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 149</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 150</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'>filter:</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'>filter:</span> <span class='id identifier rubyid_filter'>filter</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>
@@ -1390,7 +1422,7 @@
       <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>
+    #<strong>list!</strong>(before_id: nil, limit: nil, filter: 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>
@@ -1421,6 +1453,11 @@
         <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
+</div>
     </li>
     <li>
@@ -1434,6 +1471,29 @@
         <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>filter</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
+</div>
     </li>
     <li>
@@ -1481,10 +1541,6 @@
       <pre class="lines">
-179
-180
-181
-182
 183
 184
 185
@@ -1501,19 +1557,27 @@
 196
 197
 198
-199</pre>
+199
+200
+201
+202
+203
+204
+205</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 179</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 183</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'>filter:</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'>filter:</span> <span class='id identifier rubyid_filter'>filter</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>
@@ -1631,20 +1695,20 @@
       <pre class="lines">
-210
-211
-212
-213
-214
-215
 216
 217
 218
 219
-220</pre>
+220
+221
+222
+223
+224
+225
+226</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 210</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 216</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> <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='rparen'>)</span>
   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1761,20 +1825,20 @@
       <pre class="lines">
-232
-233
-234
-235
-236
-237
 238
 239
 240
 241
-242</pre>
+242
+243
+244
+245
+246
+247
+248</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 232</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 238</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> <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='rparen'>)</span>
   <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1797,9 +1861,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:39 2025 by
+  Generated on Fri Jan 23 21:38:07 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:41 2025 by
+  Generated on Fri Jan 23 21:38:09 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:42 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:41 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:42 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html CHANGED Viewed

@@ -1029,9 +1029,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:42 2025 by
+  Generated on Fri Jan 23 21:38:10 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>

data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html CHANGED Viewed

@@ -1805,9 +1805,9 @@
 </div>
       <div id="footer">
-  Generated on Tue Aug 19 22:49:40 2025 by
+  Generated on Fri Jan 23 21:38:09 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
     </div>