mirror of
https://github.com/ngrok/ngrok-api-ruby.git
synced 2026-05-17 16:50:40 +00:00
ngrok release bot
1149 lines
37 KiB
HTML
1149 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
Class: NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient
|
|
|
|
— Documentation by YARD 0.9.36
|
|
|
|
</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::EdgeRouteWebhookVerificationModuleClient";
|
|
relpath = '../../';
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div class="nav_wrap">
|
|
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
<div id="resizer"></div>
|
|
</div>
|
|
|
|
<div id="main" tabindex="-1">
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="../../_index.html">Index (E)</a> »
|
|
<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">EdgeRouteWebhookVerificationModuleClient</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::EdgeRouteWebhookVerificationModuleClient
|
|
|
|
|
|
|
|
</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::EdgeRouteWebhookVerificationModuleClient</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
<dt>Defined in:</dt>
|
|
<dd>lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<h2>Overview</h2><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module">ngrok.com/docs/api#api-edge-route-webhook-verification-module</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete">ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete">ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointWebhookValidation </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get">ngrok.com/docs/api#api-edge-route-webhook-verification-module-get</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointWebhookValidation </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get">ngrok.com/docs/api#api-edge-route-webhook-verification-module-get</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ EdgeRouteWebhookVerificationModuleClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
<span class="note title constructor">constructor</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>A new instance of EdgeRouteWebhookVerificationModuleClient.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#replace-instance_method" title="#replace (instance method)">#<strong>replace</strong>(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointWebhookValidation </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace">ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#replace!-instance_method" title="#replace! (instance method)">#<strong>replace!</strong>(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointWebhookValidation </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace">ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace</a>.</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::EdgeRouteWebhookVerificationModuleClient (class)">EdgeRouteWebhookVerificationModuleClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns a new instance of EdgeRouteWebhookVerificationModuleClient.</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/edge_route_webhook_verification_module_client.rb', line 15</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">
|
|
|
|
|
|
13
|
|
14
|
|
15</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 13</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="delete-instance_method">
|
|
|
|
#<strong>delete</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete">ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<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>unique identifier of this edge route</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">
|
|
|
|
|
|
95
|
|
96
|
|
97
|
|
98
|
|
99
|
|
100
|
|
101
|
|
102</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 95</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete">ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<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>unique identifier of this edge route</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">
|
|
|
|
|
|
110
|
|
111
|
|
112
|
|
113
|
|
114
|
|
115
|
|
116
|
|
117</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 110</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get">ngrok.com/docs/api#api-edge-route-webhook-verification-module-get</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<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>unique identifier of this edge route</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</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</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 61</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#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>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get">ngrok.com/docs/api#api-edge-route-webhook-verification-module-get</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<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>unique identifier of this edge route</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</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">
|
|
|
|
|
|
78
|
|
79
|
|
80
|
|
81
|
|
82
|
|
83
|
|
84
|
|
85
|
|
86
|
|
87</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 78</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#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="replace-instance_method">
|
|
|
|
#<strong>replace</strong>(edge_id: "", id: "", a_module: nil) ⇒ <tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace">ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<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'>a_module</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</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">
|
|
|
|
|
|
26
|
|
27
|
|
28
|
|
29
|
|
30
|
|
31
|
|
32
|
|
33
|
|
34
|
|
35</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 26</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>a_module:</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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='id identifier rubyid_a_module'>a_module</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_put'>put</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#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="replace!-instance_method">
|
|
|
|
#<strong>replace!</strong>(edge_id: "", id: "", a_module: nil) ⇒ <tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace">ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<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'>a_module</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">NgrokAPI::Models::EndpointWebhookValidation</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">
|
|
|
|
|
|
44
|
|
45
|
|
46
|
|
47
|
|
48
|
|
49
|
|
50
|
|
51
|
|
52
|
|
53</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb', line 44</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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'>a_module:</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'>/edges/https/%{edge_id}/routes/%{id}/webhook_verification</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'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</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='id identifier rubyid_a_module'>a_module</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_put'>put</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/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#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 Fri Jan 23 21:38:11 2026 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.36 (ruby-3.3.10).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |