RubyGems - ngrok-api - Versions diffs - 0.9.0 - Mend

ngrok-api 0.9.0

Files changed (100) hide show

checksums.yaml +7 -0
data/.github/workflows/ci.yml +21 -0
data/.gitignore +13 -0
data/.rubocop.yml +28 -0
data/.rubocop_airbnb.yml +2 -0
data/.simplecov +1 -0
data/Gemfile +33 -0
data/Guardfile +16 -0
data/README.md +61 -0
data/Rakefile +7 -0
data/doc/NgrokAPI/Client.html +542 -0
data/doc/NgrokAPI/Error.html +305 -0
data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
data/doc/NgrokAPI/Errors.html +115 -0
data/doc/NgrokAPI/HttpClient.html +1104 -0
data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/doc/NgrokAPI/Models/Listable.html +934 -0
data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/doc/NgrokAPI/Models.html +117 -0
data/doc/NgrokAPI/PagedIterator.html +631 -0
data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/doc/NgrokAPI/Services.html +117 -0
data/doc/NgrokAPI.html +157 -0
data/doc/_index.html +309 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +126 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +126 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1227 -0
data/doc/top-level-namespace.html +110 -0
data/docs/NgrokAPI/Client.html +542 -0
data/docs/NgrokAPI/Error.html +305 -0
data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
data/docs/NgrokAPI/Errors.html +115 -0
data/docs/NgrokAPI/HttpClient.html +1104 -0
data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
data/docs/NgrokAPI/Models/Listable.html +934 -0
data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
data/docs/NgrokAPI/Models.html +117 -0
data/docs/NgrokAPI/PagedIterator.html +631 -0
data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
data/docs/NgrokAPI/Services.html +117 -0
data/docs/NgrokAPI.html +157 -0
data/docs/_index.html +309 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +497 -0
data/docs/file.README.html +126 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +126 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +1227 -0
data/docs/top-level-namespace.html +110 -0
data/lib/ngrokapi/client.rb +49 -0
data/lib/ngrokapi/error.rb +14 -0
data/lib/ngrokapi/errors/not_found_error.rb +16 -0
data/lib/ngrokapi/http_client.rb +132 -0
data/lib/ngrokapi/models/api_key.rb +64 -0
data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
data/lib/ngrokapi/models/listable.rb +42 -0
data/lib/ngrokapi/models/reserved_domain.rb +211 -0
data/lib/ngrokapi/models/tls_certificate.rb +62 -0
data/lib/ngrokapi/paged_iterator.rb +40 -0
data/lib/ngrokapi/services/api_keys_client.rb +144 -0
data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
data/lib/ngrokapi/version.rb +7 -0
data/lib/ngrokapi.rb +13 -0
data/ngrok-api.gemspec +27 -0
data/spec/ngrokapi/client_spec.rb +33 -0
data/spec/ngrokapi/http_client_spec.rb +75 -0
data/spec/ngrokapi/models/api_key_spec.rb +43 -0
data/spec/ngrokapi/models/listable_spec.rb +43 -0
data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
data/spec/spec_helper.rb +80 -0
metadata +144 -0

data/doc/NgrokAPI/Models/EndpointConfiguration.html ADDED Viewed

@@ -0,0 +1,1366 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: NgrokAPI::Models::EndpointConfiguration
+    &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::Models::EndpointConfiguration";
+  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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
+     &raquo;
+    <span class="title">EndpointConfiguration</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::Models::EndpointConfiguration
+</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::Models::EndpointConfiguration</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/models/endpoint_configuration.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>A resource representing data from the endpoint_configuration API</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <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>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</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 created_at.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#description-instance_method" title="#description (instance method)">#<strong>description</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 description.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#id-instance_method" title="#id (instance method)">#<strong>id</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 id.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</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 metadata.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#result-instance_method" title="#result (instance method)">#<strong>result</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 result.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</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 uri.</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="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>  &#x21d2; nil </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Delete this endpoint configuration.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:)  &#x21d2; EndpointConfiguration </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of EndpointConfiguration.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: 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)  &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Update this 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:, result:)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of EndpointConfiguration.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+16
+17
+18
+19
+20
+21
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 16</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='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
+  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
+  <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
+  <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>created_at</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>uri</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</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">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</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>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="created_at-instance_method">
+    #<strong>created_at</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute created_at.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
+  <span class='ivar'>@created_at</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="description-instance_method">
+    #<strong>description</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute description.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
+  <span class='ivar'>@description</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="id-instance_method">
+    #<strong>id</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute id.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
+  <span class='ivar'>@id</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="metadata-instance_method">
+    #<strong>metadata</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute metadata.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
+  <span class='ivar'>@metadata</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="result-instance_method">
+    #<strong>result</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute result.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
+  <span class='ivar'>@result</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="uri-instance_method">
+    #<strong>uri</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute uri.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 8</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
+  <span class='ivar'>@uri</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="==-instance_method">
+    #<strong>==</strong>(other)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 26</span>
+<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
+  <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</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>  &#x21d2; <tt>nil</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Delete this endpoint configuration.</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">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>nil</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>result from delete request</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 40</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
+  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="to_s-instance_method">
+    #<strong>to_s</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 30</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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>(description: nil, metadata: 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)  &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Update this 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'>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>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>circuit breaker module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>compression</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>compression module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>request_headers</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>request headers module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>response_headers</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>response headers module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>ip_policy</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>ip policy module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>mutual_tls</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>mutual TLS module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>tls_termination</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>TLS termination module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>webhook_validation</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>webhook validation module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>oauth</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>oauth module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>logging</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>logging module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>saml</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>saml module configuration</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>oidc</span>
+        <span class='type'>(<tt>string</tt>)</span>
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>oidc module configuration</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>result from update request</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/endpoint_configuration.rb', line 68</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</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'>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='rparen'>)</span>
+  <span class='ivar'>@description</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='ivar'>@metadata</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='ivar'>@circuit_breaker</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='ivar'>@compression</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='ivar'>@request_headers</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='ivar'>@response_headers</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='ivar'>@ip_policy</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='ivar'>@mutual_tls</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='ivar'>@tls_termination</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='ivar'>@webhook_validation</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='ivar'>@oauth</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='ivar'>@logging</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='ivar'>@saml</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='ivar'>@oidc</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='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
+    <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
+    <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
+    <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
+    <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
+    <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
+    <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
+    <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
+    <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
+    <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
+    <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
+    <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
+    <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
+    <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
+    <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
+    <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span>
+  <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri Sep 24 19:20:29 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>