ngrok/ngrok-api-ruby
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-ruby.git synced 2026-06-16 16:54:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

cut new release for ngrok-api-ruby

Browse Source
This commit is contained in:
Kyle Wenholz
2021-10-19 08:50:45 -07:00
committed by Kyle Wenholz
parent e02116bc09
commit 89fa79d222
289 changed files with 13485 additions and 4695 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/NgrokAPI/Services/EventSubscriptionsClient.html
+213 -42
View File
@@ -365,6 +365,30 @@
<span class="summary_desc"><div class='inline'>
<p>List this Account&#39;s Event Subscriptions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>List this Account&#39;s Event Subscriptions.</p>
</div></span>
@@ -1186,7 +1210,8 @@
144
145
146
147</pre>
147
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 130</span>
@@ -1202,6 +1227,7 @@
<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::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
<span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
@@ -1212,6 +1238,151 @@
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="list!-instance_method">
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List this Account&#39;s Event Subscriptions. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-list">ngrok.com/docs/api#api-event-subscriptions-list</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>before_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>limit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>url</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>optional and mutually exclusive from before_id and limit</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</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::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
<span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventSubscriptionsClient::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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</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 ">
@@ -1354,28 +1525,28 @@
<pre class="lines">
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178</pre>
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 193</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
@@ -1541,28 +1712,28 @@
<pre class="lines">
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210</pre>
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 192</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 225</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
@@ -1593,7 +1764,7 @@
</div>
<div id="footer">
Generated on Mon Oct 4 23:24:18 2021 by
Generated on Tue Oct 19 15:48:24 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.1).
</div>