ngrok-api 0.26.0 → 0.28.0

data/doc/NgrokAPI/Services/IPPoliciesClient.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>
     
 
     
@@ -1177,7 +1177,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> 
   
 
   
@@ -1208,6 +1208,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>
@@ -1221,6 +1226,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>
@@ -1268,7 +1296,6 @@
       <pre class="lines">
 
 
-146
 147
 148
 149
@@ -1286,19 +1313,24 @@
 161
 162
 163
-164</pre>
+164
+165
+166
+167</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 146</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 147</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::IPPoliciesClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</span>
@@ -1318,7 +1350,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> 
   
 
   
@@ -1349,6 +1381,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>
@@ -1362,6 +1399,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>
@@ -1409,10 +1469,6 @@
       <pre class="lines">
 
 
-176
-177
-178
-179
 180
 181
 182
@@ -1429,19 +1485,27 @@
 193
 194
 195
-196</pre>
+196
+197
+198
+199
+200
+201
+202</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 176</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 180</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::IPPoliciesClient::PATH (constant)">PATH</a></span></span>
@@ -1559,20 +1623,20 @@
       <pre class="lines">
 
 
-207
-208
-209
-210
-211
-212
 213
 214
 215
 216
-217</pre>
+217
+218
+219
+220
+221
+222
+223</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 207</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 213</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'>/ip_policies/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1689,20 +1753,20 @@
       <pre class="lines">
 
 
-229
-230
-231
-232
-233
-234
 235
 236
 237
 238
-239</pre>
+239
+240
+241
+242
+243
+244
+245</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 229</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 235</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'>/ip_policies/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1725,9 +1789,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 19 22:49:36 2025 by
+  Generated on Fri Jan 23 21:38:05 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/doc/NgrokAPI/Services/IPPolicyRulesClient.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>
     
 
     
@@ -1285,7 +1285,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> 
   
 
   
@@ -1316,6 +1316,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>
@@ -1329,6 +1334,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>
@@ -1376,7 +1404,6 @@
       <pre class="lines">
 
 
-150
 151
 152
 153
@@ -1394,19 +1421,24 @@
 165
 166
 167
-168</pre>
+168
+169
+170
+171</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 150</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 151</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::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span>
   <span class='rparen'>)</span>
@@ -1426,7 +1458,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> 
   
 
   
@@ -1457,6 +1489,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>
@@ -1470,6 +1507,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>
@@ -1517,10 +1577,6 @@
       <pre class="lines">
 
 
-180
-181
-182
-183
 184
 185
 186
@@ -1537,19 +1593,27 @@
 197
 198
 199
-200</pre>
+200
+201
+202
+203
+204
+205
+206</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 180</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 184</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::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span>
@@ -1685,21 +1749,21 @@
       <pre class="lines">
 
 
-212
-213
-214
-215
-216
-217
 218
 219
 220
 221
 222
-223</pre>
+223
+224
+225
+226
+227
+228
+229</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 212</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_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> <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'>cidr:</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'>/ip_policy_rules/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1835,21 +1899,21 @@
       <pre class="lines">
 
 
-236
-237
-238
-239
-240
-241
 242
 243
 244
 245
 246
-247</pre>
+247
+248
+249
+250
+251
+252
+253</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 236</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 242</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'>cidr:</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'>/ip_policy_rules/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1873,9 +1937,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>