ngrok-api 0.12.0 → 0.14.0

data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:25 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>

data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:25 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>

data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:19 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:19 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:18 2021 by
+  Generated on Tue Oct 19 15:48:25 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>

data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:19 2021 by
+  Generated on Tue Oct 19 15:48:26 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>

data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html

@@ -1061,7 +1061,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct  4 23:24:19 2021 by
+  Generated on Tue Oct 19 15:48:27 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>

data/doc/NgrokAPI/Services/EventDestinationsClient.html

@@ -365,6 +365,30 @@
   
 
   
+    <span class="summary_desc"><div class='inline'>
+<p>List all Event Destinations on this account.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil)  &#x21d2; NgrokAPI::Models::Listable </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
     <span class="summary_desc"><div class='inline'>
 <p>List all Event Destinations on this account.</p>
 </div></span>
@@ -594,7 +618,7 @@
       
         &mdash;
         <div class='inline'>
-<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
+<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p>
 </div>
       
     </li>
@@ -612,7 +636,7 @@
       
         &mdash;
         <div class='inline'>
-<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p>
+<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p>
 </div>
       
     </li>
@@ -1188,7 +1212,8 @@
 151
 152
 153
-154</pre>
+154
+155</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 137</span>
@@ -1204,6 +1229,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::EventDestinationsClient::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>
@@ -1214,6 +1240,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 all Event Destinations on this account. Throws an exception if API error.</p>
+
+<p><a href="https://ngrok.com/docs/api#api-event-destinations-list">ngrok.com/docs/api#api-event-destinations-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">
+
+
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176
+177
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</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::EventDestinationsClient::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::EventDestinationsClient::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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</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 ">
@@ -1306,7 +1477,7 @@
       
         &mdash;
         <div class='inline'>
-<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
+<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p>
 </div>
       
     </li>
@@ -1324,7 +1495,7 @@
       
         &mdash;
         <div class='inline'>
-<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p>
+<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p>
 </div>
       
     </li>
@@ -1356,29 +1527,29 @@
       <pre class="lines">
 
 
-167
-168
-169
-170
-171
-172
-173
-174
-175
-176
-177
-178
-179
-180
-181
-182
-183
-184
-185
-186</pre>
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+216
+217
+218
+219</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</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>
@@ -1495,7 +1666,7 @@
       
         &mdash;
         <div class='inline'>
-<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
+<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p>
 </div>
       
     </li>
@@ -1513,7 +1684,7 @@
       
         &mdash;
         <div class='inline'>
-<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p>
+<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p>
 </div>
       
     </li>
@@ -1545,29 +1716,29 @@
       <pre class="lines">
 
 
-200
-201
-202
-203
-204
-205
-206
-207
-208
-209
-210
-211
-212
-213
-214
-215
-216
-217
-218
-219</pre>
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244
+245
+246
+247
+248
+249
+250
+251
+252</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span>
+      <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 233</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>
@@ -1599,7 +1770,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>