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
9adcf161dfa2c40a80132c72586608c754ab1a63
ngrok-api-ruby/doc/NgrokAPI/Services/ReservedDomainsClient.html
T
ngrok-release-bot 9adcf161df cut new release for ngrok-api-ruby
2021-09-24 19:20:30 +00:00

2541 lines
76 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::ReservedDomainsClient
&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::ReservedDomainsClient";
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 (R)</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">ReservedDomainsClient</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::ReservedDomainsClient
</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::ReservedDomainsClient</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi/services/reserved_domains_client.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A client for interacting with the reserved_domains API</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</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="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'>reserved_domains</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="PATH-constant" class="">PATH =
<div class="docstring">
<div class="discussion">
<p>The API path for reserved domains</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'>/reserved_domains</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>(name: &#39;&#39;, region: &#39;&#39;, description: &#39;&#39;, metadata: &#39;&#39;, http_endpoint_configuration_id: &#39;&#39;, https_endpoint_configuration_id: &#39;&#39;, certificate_id: nil, certificate_management_policy: nil) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create a new reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delete a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delete a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the certificate attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the certificate attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the certificate management policy attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the certificate management policy attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id: nil) &#x21d2; nil </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: nil) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the details of a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: nil) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the details of a reserved domain.</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; ReservedDomainsClient </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ReservedDomainsClient.</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 reserved domains 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: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Update the attributes of a reserved domain.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Update the attributes of a reserved domain.</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::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ReservedDomainsClient.</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/reserved_domains_client.rb', line 17</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">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 15</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>(name: &#39;&#39;, region: &#39;&#39;, description: &#39;&#39;, metadata: &#39;&#39;, http_endpoint_configuration_id: &#39;&#39;, https_endpoint_configuration_id: &#39;&#39;, certificate_id: nil, certificate_management_policy: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-create">ngrok.com/docs/api#api-reserved-domains-create</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a &#39;.&#39; it will reserve that subdomain on ngrok.io.</p>
</div>
</li>
<li>
<span class='name'>region</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>human-readable description of what this reserved domain will be used for</p>
</div>
</li>
<li>
<span class='name'>metadata</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>http_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>https_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>certificate_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
</div>
</li>
<li>
<span class='name'>certificate_management_policy</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from create request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>region:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>http_endpoint_configuration_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
<span class='label'>region:</span> <span class='id identifier rubyid_region'>region</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'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span><span class='comma'>,</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_post'>post</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-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>nil</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>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">
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 69</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='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></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: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-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>nil</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>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">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 80</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='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</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="delete_certificate-instance_method">
#<strong>delete_certificate</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the certificate attached from a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</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>nil</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>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">
205
206
207</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 205</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_certificate!-instance_method">
#<strong>delete_certificate!</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the certificate attached from a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</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>nil</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>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">
216
217
218</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 216</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate</span><span class='tstring_end'>&quot;</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="delete_certificate_management_policy-instance_method">
#<strong>delete_certificate_management_policy</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the certificate management policy attached from a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</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>nil</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>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">
227
228
229</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 227</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate_management_policy</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_certificate_management_policy!-instance_method">
#<strong>delete_certificate_management_policy!</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the certificate management policy attached from a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</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>nil</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>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">
238
239
240</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 238</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/certificate_management_policy</span><span class='tstring_end'>&quot;</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="delete_http_endpoint_config-instance_method">
#<strong>delete_http_endpoint_config</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the http endpoint configuration attached from a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</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>nil</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>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">
249
250
251</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 249</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/http_endpoint_configuration</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_http_endpoint_config!-instance_method">
#<strong>delete_http_endpoint_config!</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the http endpoint configuration attached from a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</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>nil</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>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">
260
261
262</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 260</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/http_endpoint_configuration</span><span class='tstring_end'>&quot;</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="delete_https_endpoint_config-instance_method">
#<strong>delete_https_endpoint_config</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the https endpoint configuration attached from a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</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>nil</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>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">
271
272
273</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 271</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/https_endpoint_configuration</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_https_endpoint_config!-instance_method">
#<strong>delete_https_endpoint_config!</strong>(id: nil) &#x21d2; <tt>nil</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the https endpoint configuration attached from a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</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>nil</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>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">
282
283
284</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 282</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/https_endpoint_configuration</span><span class='tstring_end'>&quot;</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="get-instance_method">
#<strong>get</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the details of a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-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>nil</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from get request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
91
92
93
94</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 91</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='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_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the details of a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-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>nil</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from get request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105
106</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 103</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='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_get!'>get!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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 reserved domains on this account.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-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>integer</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 list request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120
121
122
123
124
125</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 117</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::ReservedDomainsClient::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::ReservedDomainsClient::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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</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: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Update the attributes of a reserved domain.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-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>nil</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 what this reserved domain will be used for</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 reserved domain. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>http_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>https_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>certificate_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
</div>
</li>
<li>
<span class='name'>certificate_management_policy</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</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">
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 142</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='kw'>nil</span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>metadata:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</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'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</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_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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: nil, certificate_id: nil, certificate_management_policy: nil, description: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Update the attributes of a reserved domain. Throw an exception if 404.</p>
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-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>nil</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 what this reserved domain will be used for</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 reserved domain. Optional, max 4096 bytes.</p>
</div>
</li>
<li>
<span class='name'>http_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>https_endpoint_configuration_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
</div>
</li>
<li>
<span class='name'>certificate_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
</div>
</li>
<li>
<span class='name'>certificate_management_policy</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</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">
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 176</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='kw'>nil</span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>metadata:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</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'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</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_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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 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>
Reference in New Issue View Git Blame Copy Permalink