docs/NgrokAPI/Services/EndpointConfigurationsClient.html in ngrok-api-0.12.0 vs docs/NgrokAPI/Services/EndpointConfigurationsClient.html in ngrok-api-0.14.0
- old
+ new
@@ -100,16 +100,12 @@
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p>
+<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p>
-<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only
-applied to Domains and TCP Addresses they have been attached to.
-</code></pre>
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p>
</div>
</div>
@@ -379,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>Returns a list of all endpoint configurations 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, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) ⇒ NgrokAPI::Models::EndpointConfiguration </a>
</span>
@@ -562,11 +582,11 @@
<em class="default">(defaults to: <tt>""</tt>)</em>
—
<div class='inline'>
-<p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p>
+<p>they type of traffic this endpoint configuration can be applied to. one of: <code>http</code>, <code>https</code>, <code>tcp</code></p>
</div>
</li>
<li>
@@ -616,11 +636,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>circuit breaker module configuration or “null“</p>
+<p>circuit breaker module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -634,11 +654,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>compression module configuration or “null“</p>
+<p>compression module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -652,11 +672,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>request headers module configuration or “null“</p>
+<p>request headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -670,11 +690,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>response headers module configuration or “null“</p>
+<p>response headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -688,11 +708,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>ip policy module configuration or “null“</p>
+<p>ip policy module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -706,11 +726,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>mutual TLS module configuration or “null“</p>
+<p>mutual TLS module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -724,11 +744,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>TLS termination module configuration or “null“</p>
+<p>TLS termination module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -742,11 +762,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>webhook validation module configuration or “null“</p>
+<p>webhook validation module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -760,11 +780,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oauth module configuration or “null“</p>
+<p>oauth module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -778,11 +798,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>logging module configuration or “null“</p>
+<p>logging module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -796,11 +816,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>saml module configuration or “null“</p>
+<p>saml module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -814,11 +834,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oidc module configuration or “null“</p>
+<p>oidc module configuration or <code>null</code></p>
</div>
</li>
</ul>
@@ -1436,11 +1456,12 @@
183
184
185
186
187
-188</pre>
+188
+189</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 171</span>
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
@@ -1452,10 +1473,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::EndpointConfigurationsClient::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::EndpointConfigurationsClient::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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span>
@@ -1465,10 +1487,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>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-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">
+
+
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219
+220
+221</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 201</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::EndpointConfigurationsClient::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::EndpointConfigurationsClient::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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</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, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) ⇒ <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
@@ -1554,11 +1721,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>circuit breaker module configuration or “null“</p>
+<p>circuit breaker module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1572,11 +1739,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>compression module configuration or “null“</p>
+<p>compression module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1590,11 +1757,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>request headers module configuration or “null“</p>
+<p>request headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1608,11 +1775,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>response headers module configuration or “null“</p>
+<p>response headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1626,11 +1793,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>ip policy module configuration or “null“</p>
+<p>ip policy module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1644,11 +1811,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>mutual TLS module configuration or “null“</p>
+<p>mutual TLS module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1662,11 +1829,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>TLS termination module configuration or “null“</p>
+<p>TLS termination module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1680,11 +1847,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>webhook validation module configuration or “null“</p>
+<p>webhook validation module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1698,11 +1865,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oauth module configuration or “null“</p>
+<p>oauth module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1716,11 +1883,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>logging module configuration or “null“</p>
+<p>logging module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1734,11 +1901,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>saml module configuration or “null“</p>
+<p>saml module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1752,11 +1919,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oidc module configuration or “null“</p>
+<p>oidc module configuration or <code>null</code></p>
</div>
</li>
</ul>
@@ -1784,54 +1951,54 @@
<tr>
<td>
<pre class="lines">
-214
-215
-216
-217
-218
-219
-220
-221
-222
-223
-224
-225
-226
-227
-228
-229
-230
-231
-232
-233
-234
-235
-236
-237
-238
-239
-240
-241
-242
-243
-244
-245
-246
247
248
249
250
251
252
253
-254</pre>
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 214</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 247</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><span class='comma'>,</span>
@@ -1965,11 +2132,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>circuit breaker module configuration or “null“</p>
+<p>circuit breaker module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -1983,11 +2150,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>compression module configuration or “null“</p>
+<p>compression module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2001,11 +2168,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>request headers module configuration or “null“</p>
+<p>request headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2019,11 +2186,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>response headers module configuration or “null“</p>
+<p>response headers module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2037,11 +2204,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>ip policy module configuration or “null“</p>
+<p>ip policy module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2055,11 +2222,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>mutual TLS module configuration or “null“</p>
+<p>mutual TLS module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2073,11 +2240,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>TLS termination module configuration or “null“</p>
+<p>TLS termination module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2091,11 +2258,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>webhook validation module configuration or “null“</p>
+<p>webhook validation module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2109,11 +2276,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oauth module configuration or “null“</p>
+<p>oauth module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2127,11 +2294,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>logging module configuration or “null“</p>
+<p>logging module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2145,11 +2312,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>saml module configuration or “null“</p>
+<p>saml module configuration or <code>null</code></p>
</div>
</li>
<li>
@@ -2163,11 +2330,11 @@
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
-<p>oidc module configuration or “null“</p>
+<p>oidc module configuration or <code>null</code></p>
</div>
</li>
</ul>
@@ -2195,54 +2362,54 @@
<tr>
<td>
<pre class="lines">
-281
-282
-283
-284
-285
-286
-287
-288
-289
-290
-291
-292
-293
-294
-295
-296
-297
-298
-299
-300
-301
-302
-303
-304
-305
-306
-307
-308
-309
-310
-311
-312
-313
314
315
316
317
318
319
320
-321</pre>
+321
+322
+323
+324
+325
+326
+327
+328
+329
+330
+331
+332
+333
+334
+335
+336
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 281</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 314</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><span class='comma'>,</span>
@@ -2291,10 +2458,10 @@
</div>
</div>
<div id="footer">
- Generated on Mon Oct 4 23:24:18 2021 by
+ Generated on Tue Oct 19 15:48:26 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