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

Update generated files

Browse Source
This commit is contained in:
ngrok release bot
2023-08-24 20:57:40 +00:00
parent f5423b58b3
commit 86fb5dea35
581 changed files with 52799 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/NgrokAPI/Services/APIKeysClient.html
+134 -94
View File
@@ -6,7 +6,7 @@
<title>
Class: NgrokAPI::Services::APIKeysClient
&mdash; Documentation by YARD 0.9.27
&mdash; Documentation by YARD 0.9.34
</title>
@@ -207,7 +207,7 @@
<li class="public ">
<span class="summary_signature">
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
@@ -231,7 +231,7 @@
<li class="public ">
<span class="summary_signature">
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
@@ -502,12 +502,12 @@
<pre class="lines">
21
22
23</pre>
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_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>
@@ -550,12 +550,12 @@
<pre class="lines">
19
20
21</pre>
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span>
@@ -575,7 +575,7 @@
<div class="method_details first">
<h3 class="signature first" id="create-instance_method">
#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
@@ -627,6 +627,24 @@
&mdash;
<div class='inline'>
<p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
</div>
</li>
<li>
<span class='name'>owner_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
</div>
</li>
@@ -658,27 +676,29 @@
<pre class="lines">
34
35
36
37
38
39
40
41
42
43</pre>
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>&#39;</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'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
@@ -690,7 +710,7 @@
<div class="method_details ">
<h3 class="signature " id="create!-instance_method">
#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
@@ -742,6 +762,24 @@
&mdash;
<div class='inline'>
<p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
</div>
</li>
<li>
<span class='name'>owner_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
</div>
</li>
@@ -773,27 +811,29 @@
<pre class="lines">
55
56
57
58
59
60
61
62
63
64</pre>
64
65
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 55</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 60</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>&#39;</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'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
@@ -870,16 +910,16 @@
<pre class="lines">
73
74
75
76
77
78
79</pre>
79
80
81
82
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 73</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 79</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'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -961,16 +1001,16 @@
<pre class="lines">
89
90
91
92
93
94
95</pre>
95
96
97
98
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 89</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_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'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1052,18 +1092,18 @@
<pre class="lines">
104
105
106
107
108
109
110
111
112</pre>
112
113
114
115
116
117
118</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 104</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 110</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'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1147,18 +1187,18 @@
<pre class="lines">
122
123
124
125
126
127
128
129
130</pre>
130
131
132
133
134
135
136</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 122</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 128</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'>&quot;</span><span class='tstring_end'>&quot;</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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1268,12 +1308,6 @@
<pre class="lines">
141
142
143
144
145
146
147
148
149
@@ -1282,10 +1316,16 @@
152
153
154
155</pre>
155
156
157
158
159
160
161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 141</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 147</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>
@@ -1401,12 +1441,6 @@
<pre class="lines">
167
168
169
170
171
172
173
174
175
@@ -1417,10 +1451,16 @@
180
181
182
183</pre>
183
184
185
186
187
188
189</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 167</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 173</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>
@@ -1543,20 +1583,20 @@
<pre class="lines">
194
195
196
197
198
199
200
201
202
203
204</pre>
204
205
206
207
208
209
210</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 194</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_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> <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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1673,20 +1713,20 @@
<pre class="lines">
216
217
218
219
220
221
222
223
224
225
226</pre>
226
227
228
229
230
231
232</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 216</span>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 222</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> <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'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1709,9 +1749,9 @@
</div>
<div id="footer">
Generated on Mon Apr 11 19:32:58 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-2.7.5).
Generated on Thu Aug 24 20:57:30 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>