ngrok-api 0.26.0 → 0.28.0

data/docs/NgrokAPI/Services/IPRestrictionsClient.html

@@ -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>
     
 
     
@@ -1289,7 +1289,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> 
   
 
   
@@ -1320,6 +1320,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>
@@ -1333,6 +1338,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>
@@ -1380,7 +1408,6 @@
       <pre class="lines">
 
 
-154
 155
 156
 157
@@ -1398,19 +1425,24 @@
 169
 170
 171
-172</pre>
+172
+173
+174
+175</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 154</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 155</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::IPRestrictionsClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</span>
@@ -1430,7 +1462,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> 
   
 
   
@@ -1461,6 +1493,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>
@@ -1474,6 +1511,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>
@@ -1521,10 +1581,6 @@
       <pre class="lines">
 
 
-184
-185
-186
-187
 188
 189
 190
@@ -1541,19 +1597,27 @@
 201
 202
 203
-204</pre>
+204
+205
+206
+207
+208
+209
+210</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 184</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 188</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::IPRestrictionsClient::PATH (constant)">PATH</a></span></span>
@@ -1707,22 +1771,22 @@
       <pre class="lines">
 
 
-217
-218
-219
-220
-221
-222
 223
 224
 225
 226
 227
 228
-229</pre>
+229
+230
+231
+232
+233
+234
+235</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 217</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_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> <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='comma'>,</span> <span class='label'>enforced:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_policy_ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</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'>/ip_restrictions/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1877,22 +1941,22 @@
       <pre class="lines">
 
 
-243
-244
-245
-246
-247
-248
 249
 250
 251
 252
 253
 254
-255</pre>
+255
+256
+257
+258
+259
+260
+261</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 243</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 249</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='comma'>,</span> <span class='label'>enforced:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_policy_ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</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'>/ip_restrictions/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1917,9 +1981,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 19 22:49:38 2025 by
+  Generated on Fri Jan 23 21:38:06 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/ReservedAddrsClient.html

@@ -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>
     
 
     
@@ -1217,7 +1217,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> 
   
 
   
@@ -1248,6 +1248,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>
@@ -1261,6 +1266,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>
@@ -1308,7 +1336,6 @@
       <pre class="lines">
 
 
-143
 144
 145
 146
@@ -1326,19 +1353,24 @@
 158
 159
 160
-161</pre>
+161
+162
+163
+164</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 143</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 144</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::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</span>
@@ -1358,7 +1390,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> 
   
 
   
@@ -1389,6 +1421,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>
@@ -1402,6 +1439,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>
@@ -1449,10 +1509,6 @@
       <pre class="lines">
 
 
-173
-174
-175
-176
 177
 178
 179
@@ -1469,19 +1525,27 @@
 190
 191
 192
-193</pre>
+193
+194
+195
+196
+197
+198
+199</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 173</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_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'>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::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
@@ -1599,20 +1663,20 @@
       <pre class="lines">
 
 
-204
-205
-206
-207
-208
-209
 210
 211
 212
 213
-214</pre>
+214
+215
+216
+217
+218
+219
+220</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 204</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 210</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='comma'>,</span> <span class='label'>endpoint_configuration_id:</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'>/reserved_addrs/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1729,20 +1793,20 @@
       <pre class="lines">
 
 
-226
-227
-228
-229
-230
-231
 232
 233
 234
 235
-236</pre>
+236
+237
+238
+239
+240
+241
+242</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 226</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 232</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='comma'>,</span> <span class='label'>endpoint_configuration_id:</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'>/reserved_addrs/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1765,9 +1829,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 19 22:49:37 2025 by
+  Generated on Fri Jan 23 21:38:06 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>