doc/NgrokAPI/Services/IPWhitelistClient.html in ngrok-api-0.12.0 vs doc/NgrokAPI/Services/IPWhitelistClient.html in ngrok-api-0.14.0
- old
+ new
@@ -100,15 +100,12 @@
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p>
+<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p>
-<pre class="code ruby"><code class="ruby">with an endpoints type instead.
-</code></pre>
-
<p><a href="https://ngrok.com/docs/api#api-ip-whitelist">ngrok.com/docs/api#api-ip-whitelist</a></p>
</div>
</div>
@@ -378,10 +375,34 @@
<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) ⇒ NgrokAPI::Models::Listable </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'>
+<p>List all IP whitelist entries on this account Throws an exception if API error.</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPWhitelistEntry </a>
</span>
@@ -1167,11 +1188,12 @@
143
144
145
146
147
-148</pre>
+148
+149</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 131</span>
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
@@ -1183,10 +1205,11 @@
<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'>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::IPWhitelistClient::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::IPWhitelistClient::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/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span>
@@ -1196,10 +1219,155 @@
</tr>
</table>
</div>
<div class="method_details ">
+ <h3 class="signature " id="list!-instance_method">
+
+ #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <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 IP whitelist entries on this account Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-ip-whitelist-list">ngrok.com/docs/api#api-ip-whitelist-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>
+
+
+ —
+ <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>
+
+
+
+ —
+ <div class='inline'>
+<p>result from the API request</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 161</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::IPWhitelistClient::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::IPWhitelistClient::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/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</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 ">
<h3 class="signature " id="update-instance_method">
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
@@ -1294,28 +1462,28 @@
<tr>
<td>
<pre class="lines">
-159
-160
-161
-162
-163
-164
-165
-166
-167
-168
-169
-170
-171
-172
-173</pre>
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 159</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 192</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'>"</span><span class='tstring_end'>"</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>
@@ -1432,28 +1600,28 @@
<tr>
<td>
<pre class="lines">
-185
-186
-187
-188
-189
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199</pre>
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 185</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_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'>"</span><span class='tstring_end'>"</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>
@@ -1476,10 +1644,10 @@
</div>
</div>
<div id="footer">
- Generated on Mon Oct 4 23:24:17 2021 by
+ Generated on Tue Oct 19 15:48:21 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>
</div>
\ No newline at end of file