RubyGems - ngrok-api - Versions diffs - 0.16.0 → 0.17.0 - Mend

ngrok-api 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (373) hide show

data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html ADDED Viewed

@@ -0,0 +1,1644 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: NgrokAPI::Services::TunnelGroupBackendsClient
+    &mdash; Documentation by YARD 0.9.27
+</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::TunnelGroupBackendsClient";
+  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 (T)</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">TunnelGroupBackendsClient</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::TunnelGroupBackendsClient
+</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::TunnelGroupBackendsClient</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/ngrokapi/services/tunnel_group_backends_client.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>A Tunnel Group Backend balances traffic among all online tunnels that match  a label selector.</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends">ngrok.com/docs/api#api-tunnel-group-backends</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'>/backends/tunnel_group</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'>backends</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>(description: &quot;&quot;, metadata: &quot;&quot;, labels: {})  &#x21d2; NgrokAPI::Models::TunnelGroupBackend </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Create a new TunnelGroup backend.</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 a TunnelGroup backend by ID.</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 a TunnelGroup backend by ID.</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::TunnelGroupBackend </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get detailed information about a TunnelGroup backend by ID.</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::TunnelGroupBackend </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get detailed information about a TunnelGroup backend by ID 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; TunnelGroupBackendsClient </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of TunnelGroupBackendsClient.</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>List all TunnelGroup backends on this account.</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>List all TunnelGroup backends on this account Throws an exception if API error.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, labels: {})  &#x21d2; NgrokAPI::Models::TunnelGroupBackend </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Update TunnelGroup backend by ID.</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, labels: {})  &#x21d2; NgrokAPI::Models::TunnelGroupBackend </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Update TunnelGroup backend by ID Throws an exception if API error.</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::TunnelGroupBackendsClient (class)">TunnelGroupBackendsClient</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of TunnelGroupBackendsClient.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 18</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">
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 16</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>(description: &quot;&quot;, metadata: &quot;&quot;, labels: {})  &#x21d2; <tt><span class='object_link'><a href="../Models/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Create a new TunnelGroup backend</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-create">ngrok.com/docs/api#api-tunnel-group-backends-create</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>&quot;&quot;</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>human-readable description of this backend. Optional</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 backend. Optional</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>labels</span>
+        <span class='type'>(<tt>Map&lt;string, string&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>labels to watch for tunnels on, e.g. app-&gt;foo, dc-&gt;bar</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</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">
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 31</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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'>labels:</span> <span class='lbrace'>{</span><span class='rbrace'>}</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'>/backends/tunnel_group</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'>: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'>:labels</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_labels'>labels</span> <span class='kw'>if</span> <span class='id identifier rubyid_labels'>labels</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelGroupBackend.html#initialize-instance_method" title="NgrokAPI::Models::TunnelGroupBackend#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 a TunnelGroup backend by ID. TODO what if used?</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-delete">ngrok.com/docs/api#api-tunnel-group-backends-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">
+50
+51
+52
+53
+54
+55
+56</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 50</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'>/backends/tunnel_group/%{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 a TunnelGroup backend by ID. TODO what if used? Throws an exception if API error.</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-delete">ngrok.com/docs/api#api-tunnel-group-backends-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">
+66
+67
+68
+69
+70
+71
+72</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 66</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'>/backends/tunnel_group/%{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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get detailed information about a TunnelGroup backend by ID</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-get">ngrok.com/docs/api#api-tunnel-group-backends-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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</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">
+81
+82
+83
+84
+85
+86
+87
+88
+89</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 81</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'>/backends/tunnel_group/%{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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelGroupBackend.html#initialize-instance_method" title="NgrokAPI::Models::TunnelGroupBackend#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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Get detailed information about a TunnelGroup backend by ID Throws an exception if API error.</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-get">ngrok.com/docs/api#api-tunnel-group-backends-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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</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">
+99
+100
+101
+102
+103
+104
+105
+106
+107</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 99</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'>/backends/tunnel_group/%{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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelGroupBackend.html#initialize-instance_method" title="NgrokAPI::Models::TunnelGroupBackend#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>List all TunnelGroup backends on this account</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-list">ngrok.com/docs/api#api-tunnel-group-backends-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">
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 118</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::TunnelGroupBackendsClient::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::TunnelGroupBackendsClient::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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</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="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>List all TunnelGroup backends on this account Throws an exception if API error.</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-list">ngrok.com/docs/api#api-tunnel-group-backends-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">
+145
+146
+147
+148
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 145</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+          <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
+    <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
+    <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
+    <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
+    <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelGroupBackendsClient::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::TunnelGroupBackendsClient::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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='comma'>,</span>
+    <span class='label'>danger:</span> <span class='kw'>true</span>
+  <span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="update-instance_method">
+    #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, labels: {})  &#x21d2; <tt><span class='object_link'><a href="../Models/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Update TunnelGroup backend by ID</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-update">ngrok.com/docs/api#api-tunnel-group-backends-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>
+    </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 this backend. Optional</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 backend. Optional</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>labels</span>
+        <span class='type'>(<tt>Map&lt;string, string&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>labels to watch for tunnels on, e.g. app-&gt;foo, dc-&gt;bar</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</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">
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 174</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'>labels:</span> <span class='lbrace'>{</span><span class='rbrace'>}</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'>/backends/tunnel_group/%{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'>:labels</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_labels'>labels</span> <span class='kw'>if</span> <span class='id identifier rubyid_labels'>labels</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelGroupBackend.html#initialize-instance_method" title="NgrokAPI::Models::TunnelGroupBackend#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, labels: {})  &#x21d2; <tt><span class='object_link'><a href="../Models/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</a></span></tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Update TunnelGroup backend by ID Throws an exception if API error.</p>
+<p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-update">ngrok.com/docs/api#api-tunnel-group-backends-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>
+    </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 this backend. Optional</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 backend. Optional</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>labels</span>
+        <span class='type'>(<tt>Map&lt;string, string&gt;</tt>)</span>
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+        &mdash;
+        <div class='inline'>
+<p>labels to watch for tunnels on, e.g. app-&gt;foo, dc-&gt;bar</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">NgrokAPI::Models::TunnelGroupBackend</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">
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_group_backends_client.rb', line 198</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'>labels:</span> <span class='lbrace'>{</span><span class='rbrace'>}</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'>/backends/tunnel_group/%{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'>:labels</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_labels'>labels</span> <span class='kw'>if</span> <span class='id identifier rubyid_labels'>labels</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/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelGroupBackend.html#initialize-instance_method" title="NgrokAPI::Models::TunnelGroupBackend#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 Thu Mar 10 04:54:55 2022 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.27 (ruby-2.7.5).
+</div>
+    </div>
+  </body>
+</html>