ngrok/ngrok-api-ruby
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-ruby.git synced 2026-05-17 16:50:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b67224454befd994a6b525314a724afa5ccca511
ngrok-api-ruby/doc/NgrokAPI/Services/EndpointConfigurationsClient.html
T
ngrok-release-bot b67224454b cut new release for ngrok-api-ruby
2021-10-04 23:24:19 +00:00

2303 lines
79 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: NgrokAPI::Services::EndpointConfigurationsClient
&mdash; Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "NgrokAPI::Services::EndpointConfigurationsClient";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
&raquo;
<span class="title">EndpointConfigurationsClient</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: NgrokAPI::Services::EndpointConfigurationsClient
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">NgrokAPI::Services::EndpointConfigurationsClient</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi/services/endpoint_configurations_client.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Endpoint Configurations are a reusable group of modules that encapsulate how</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>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="PATH-constant" class="">PATH =
<div class="docstring">
<div class="discussion">
<p>The API path for the requests</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
<div class="docstring">
<div class="discussion">
<p>The List Property from the resulting API for list calls</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute client.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(type: &quot;&quot;, description: &quot;&quot;, metadata: &quot;&quot;, 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) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create a new endpoint configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delete an endpoint configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delete an endpoint configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns detailed information about an endpoint configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; EndpointConfigurationsClient </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of EndpointConfigurationsClient.</p>
</div></span>
</li>
<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>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a list of all endpoint configurations on this account.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, 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) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Updates an endpoint configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, 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) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Updates an endpoint configuration.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of EndpointConfigurationsClient.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="client-instance_method">
#<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute client.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create-instance_method">
#<strong>create</strong>(type: &quot;&quot;, description: &quot;&quot;, metadata: &quot;&quot;, 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) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new endpoint configuration</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-create">ngrok.com/docs/api#api-endpoint-configurations-create</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
</div>
</li>
<li>
<span class='name'>metadata</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>circuit_breaker</span>
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>circuit breaker module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>compression</span>
<span class='type'>(<tt>EndpointCompression</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>compression module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>request_headers</span>
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>request headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>response_headers</span>
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>response headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>ip_policy</span>
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ip policy module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>mutual_tls</span>
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>mutual TLS module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>tls_termination</span>
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>TLS termination module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>webhook_validation</span>
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>webhook validation module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oauth</span>
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oauth module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>logging</span>
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>logging module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>saml</span>
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>saml module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oidc</span>
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oidc module configuration or “null“</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
<span class='label'>type:</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>backend:</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'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</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_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete-instance_method">
#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96
97
98
99
100
101
102</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</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='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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete!-instance_method">
#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
113
114
115
116
117
118
119
120
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 113</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</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='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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</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="get-instance_method">
#<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns detailed information about an endpoint configuration</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
130
131
132
133
134
135
136
137
138
139
140</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 130</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</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='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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get!-instance_method">
#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
150
151
152
153
154
155
156
157
158
159
160</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 150</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</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='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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<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>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a list of all endpoint configurations on this account</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>
&mdash;
<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>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188</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>
<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'>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='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: &quot;&quot;, 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) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>unique identifier of this endpoint configuration</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
</div>
</li>
<li>
<span class='name'>metadata</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>circuit_breaker</span>
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>circuit breaker module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>compression</span>
<span class='type'>(<tt>EndpointCompression</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>compression module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>request_headers</span>
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>request headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>response_headers</span>
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>response headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>ip_policy</span>
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ip policy module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>mutual_tls</span>
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>mutual TLS module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>tls_termination</span>
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>TLS termination module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>webhook_validation</span>
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>webhook validation module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oauth</span>
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oauth module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>logging</span>
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>logging module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>saml</span>
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>saml module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oidc</span>
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oidc module configuration or “null“</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<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>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 214</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'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>backend:</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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</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_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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='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: &quot;&quot;, 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) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>unique identifier of this endpoint configuration</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
</div>
</li>
<li>
<span class='name'>metadata</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>circuit_breaker</span>
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>circuit breaker module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>compression</span>
<span class='type'>(<tt>EndpointCompression</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>compression module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>request_headers</span>
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>request headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>response_headers</span>
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>response headers module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>ip_policy</span>
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ip policy module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>mutual_tls</span>
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>mutual TLS module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>tls_termination</span>
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>TLS termination module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>webhook_validation</span>
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>webhook validation module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oauth</span>
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oauth module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>logging</span>
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>logging module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>saml</span>
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>saml module configuration or “null“</p>
</div>
</li>
<li>
<span class='name'>oidc</span>
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>oidc module configuration or “null“</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<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>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 281</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'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>backend:</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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</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_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 4 23:24:18 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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink