<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: NgrokAPI::Services::TLSCertificatesClient — Documentation by YARD 0.9.34 </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::TLSCertificatesClient"; 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> » <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span> » <span class="title">TLSCertificatesClient</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::TLSCertificatesClient </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::TLSCertificatesClient</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/ngrokapi/services/tls_certificates_client.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</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'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>tls_certificates</span><span class='tstring_end'>'</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> ⇒ 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: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Upload a new TLS certificate.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Upload a new TLS certificate Throws an exception if API error.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a> </span> <span class="summary_desc"><div class='inline'> <p>Delete a TLS certificate.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a> </span> <span class="summary_desc"><div class='inline'> <p>Delete a TLS certificate Throws an exception if API error.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Get detailed information about a TLS certificate.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Get detailed information about a TLS certificate 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:) ⇒ TLSCertificatesClient </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'> <p>A new instance of TLSCertificatesClient.</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) ⇒ NgrokAPI::Models::Listable </a> </span> <span class="summary_desc"><div class='inline'> <p>List all TLS certificates 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) ⇒ NgrokAPI::Models::Listable </a> </span> <span class="summary_desc"><div class='inline'> <p>List all TLS certificates on this account Throws an exception if API error.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Update attributes of a TLS Certificate 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: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a> </span> <span class="summary_desc"><div class='inline'> <p>Update attributes of a TLS Certificate 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:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of TLSCertificatesClient.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 23 24 25</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 23</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> ⇒ <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"> 21 22 23</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 21</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: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Upload a new TLS certificate</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-create">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <div class='inline'> <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p> </div> </li> <li> <span class='name'>metadata</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'> <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p> </div> </li> <li> <span class='name'>certificate_pem</span> <span class='type'>(<tt>string</tt>)</span> — <div class='inline'> <p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains></code><a href="_">_</a>.</p> </div> </li> <li> <span class='name'>private_key_pem</span> <span class='type'>(<tt>string</tt>)</span> — <div class='inline'> <p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys></code><a href="_">_</a>.</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 37 38 39 40 41 42 43 44 45 46 47 48</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_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'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>certificate_pem:</span><span class='comma'>,</span> <span class='label'>private_key_pem:</span><span class='rparen'>)</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</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'>:certificate_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:private_key_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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="create!-instance_method"> #<strong>create!</strong>(description: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Upload a new TLS certificate Throws an exception if API error.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-create">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <div class='inline'> <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p> </div> </li> <li> <span class='name'>metadata</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>""</tt>)</em> — <div class='inline'> <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p> </div> </li> <li> <span class='name'>certificate_pem</span> <span class='type'>(<tt>string</tt>)</span> — <div class='inline'> <p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains></code><a href="_">_</a>.</p> </div> </li> <li> <span class='name'>private_key_pem</span> <span class='type'>(<tt>string</tt>)</span> — <div class='inline'> <p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys></code><a href="_">_</a>.</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 61 62 63 64 65 66 67 68 69 70 71 72</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 61</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>certificate_pem:</span><span class='comma'>,</span> <span class='label'>private_key_pem:</span><span class='rparen'>)</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</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'>:certificate_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:private_key_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</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='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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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: "") ⇒ <tt>NgrokAPI::Models::Empty</tt> </h3><div class="docstring"> <div class="discussion"> <p>Delete a TLS certificate</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <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> — <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</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 81</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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: "") ⇒ <tt>NgrokAPI::Models::Empty</tt> </h3><div class="docstring"> <div class="discussion"> <p>Delete a TLS certificate Throws an exception if API error.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <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> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 97 98 99 100 101 102 103</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 97</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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: "") ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Get detailed information about a TLS certificate</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 112 113 114 115 116 117 118 119 120</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 112</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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: "") ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Get detailed information about a TLS certificate Throws an exception if API error.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-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>""</tt>)</em> — <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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 130 131 132 133 134 135 136 137 138</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 130</span> <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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) ⇒ <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 TLS certificates on this account</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>before_id</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> </li> <li> <span class='name'>limit</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> </li> <li> <span class='name'>url</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'> <p>optional and mutually exclusive from before_id and limit</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 149</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::TLSCertificatesClient::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'>attrs:</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::TLSCertificatesClient::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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</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) ⇒ <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 TLS certificates on this account Throws an exception if API error.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>before_id</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> </li> <li> <span class='name'>limit</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> </li> <li> <span class='name'>url</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'> <p>optional and mutually exclusive from before_id and limit</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 175</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::TLSCertificatesClient::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'>attrs:</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::TLSCertificatesClient::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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span> <span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update-instance_method"> #<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Update attributes of a TLS Certificate by ID</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-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>""</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> — <div class='inline'> <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p> </div> </li> <li> <span class='name'>metadata</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'> <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 202 203 204 205 206 207 208 209 210 211 212</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 202</span> <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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_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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Update attributes of a TLS Certificate by ID Throws an exception if API error.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-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>""</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> — <div class='inline'> <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p> </div> </li> <li> <span class='name'>metadata</span> <span class='type'>(<tt>string</tt>)</span> <em class="default">(defaults to: <tt>nil</tt>)</em> — <div class='inline'> <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span> — <div class='inline'> <p>result from the API request</p> </div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 224 225 226 227 228 229 230 231 232 233 234</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 224</span> <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</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_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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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'>attrs:</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 Aug 24 20:57:35 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.0.6). </div> </div> </body> </html>