ngrok-api 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ci.yml +21 -0
  3. data/.gitignore +13 -0
  4. data/.rubocop.yml +28 -0
  5. data/.rubocop_airbnb.yml +2 -0
  6. data/.simplecov +1 -0
  7. data/Gemfile +33 -0
  8. data/Guardfile +16 -0
  9. data/README.md +61 -0
  10. data/Rakefile +7 -0
  11. data/doc/NgrokAPI/Client.html +542 -0
  12. data/doc/NgrokAPI/Error.html +305 -0
  13. data/doc/NgrokAPI/Errors/NotFoundError.html +309 -0
  14. data/doc/NgrokAPI/Errors.html +115 -0
  15. data/doc/NgrokAPI/HttpClient.html +1104 -0
  16. data/doc/NgrokAPI/Models/ApiKey.html +1138 -0
  17. data/doc/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
  18. data/doc/NgrokAPI/Models/Listable.html +934 -0
  19. data/doc/NgrokAPI/Models/ReservedDomain.html +2498 -0
  20. data/doc/NgrokAPI/Models/TlsCertificate.html +1064 -0
  21. data/doc/NgrokAPI/Models.html +117 -0
  22. data/doc/NgrokAPI/PagedIterator.html +631 -0
  23. data/doc/NgrokAPI/Services/ApiKeysClient.html +1333 -0
  24. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
  25. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
  26. data/doc/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
  27. data/doc/NgrokAPI/Services.html +117 -0
  28. data/doc/NgrokAPI.html +157 -0
  29. data/doc/_index.html +309 -0
  30. data/doc/class_list.html +51 -0
  31. data/doc/css/common.css +1 -0
  32. data/doc/css/full_list.css +58 -0
  33. data/doc/css/style.css +497 -0
  34. data/doc/file.README.html +126 -0
  35. data/doc/file_list.html +56 -0
  36. data/doc/frames.html +17 -0
  37. data/doc/index.html +126 -0
  38. data/doc/js/app.js +314 -0
  39. data/doc/js/full_list.js +216 -0
  40. data/doc/js/jquery.js +4 -0
  41. data/doc/method_list.html +1227 -0
  42. data/doc/top-level-namespace.html +110 -0
  43. data/docs/NgrokAPI/Client.html +542 -0
  44. data/docs/NgrokAPI/Error.html +305 -0
  45. data/docs/NgrokAPI/Errors/NotFoundError.html +309 -0
  46. data/docs/NgrokAPI/Errors.html +115 -0
  47. data/docs/NgrokAPI/HttpClient.html +1104 -0
  48. data/docs/NgrokAPI/Models/ApiKey.html +1138 -0
  49. data/docs/NgrokAPI/Models/EndpointConfiguration.html +1366 -0
  50. data/docs/NgrokAPI/Models/Listable.html +934 -0
  51. data/docs/NgrokAPI/Models/ReservedDomain.html +2498 -0
  52. data/docs/NgrokAPI/Models/TlsCertificate.html +1064 -0
  53. data/docs/NgrokAPI/Models.html +117 -0
  54. data/docs/NgrokAPI/PagedIterator.html +631 -0
  55. data/docs/NgrokAPI/Services/ApiKeysClient.html +1333 -0
  56. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +2201 -0
  57. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2541 -0
  58. data/docs/NgrokAPI/Services/TlsCertificatesClient.html +1417 -0
  59. data/docs/NgrokAPI/Services.html +117 -0
  60. data/docs/NgrokAPI.html +157 -0
  61. data/docs/_index.html +309 -0
  62. data/docs/class_list.html +51 -0
  63. data/docs/css/common.css +1 -0
  64. data/docs/css/full_list.css +58 -0
  65. data/docs/css/style.css +497 -0
  66. data/docs/file.README.html +126 -0
  67. data/docs/file_list.html +56 -0
  68. data/docs/frames.html +17 -0
  69. data/docs/index.html +126 -0
  70. data/docs/js/app.js +314 -0
  71. data/docs/js/full_list.js +216 -0
  72. data/docs/js/jquery.js +4 -0
  73. data/docs/method_list.html +1227 -0
  74. data/docs/top-level-namespace.html +110 -0
  75. data/lib/ngrokapi/client.rb +49 -0
  76. data/lib/ngrokapi/error.rb +14 -0
  77. data/lib/ngrokapi/errors/not_found_error.rb +16 -0
  78. data/lib/ngrokapi/http_client.rb +132 -0
  79. data/lib/ngrokapi/models/api_key.rb +64 -0
  80. data/lib/ngrokapi/models/endpoint_configuration.rb +119 -0
  81. data/lib/ngrokapi/models/listable.rb +42 -0
  82. data/lib/ngrokapi/models/reserved_domain.rb +211 -0
  83. data/lib/ngrokapi/models/tls_certificate.rb +62 -0
  84. data/lib/ngrokapi/paged_iterator.rb +40 -0
  85. data/lib/ngrokapi/services/api_keys_client.rb +144 -0
  86. data/lib/ngrokapi/services/endpoint_configurations_client.rb +313 -0
  87. data/lib/ngrokapi/services/reserved_domains_client.rb +313 -0
  88. data/lib/ngrokapi/services/tls_certificates_client.rb +161 -0
  89. data/lib/ngrokapi/version.rb +7 -0
  90. data/lib/ngrokapi.rb +13 -0
  91. data/ngrok-api.gemspec +27 -0
  92. data/spec/ngrokapi/client_spec.rb +33 -0
  93. data/spec/ngrokapi/http_client_spec.rb +75 -0
  94. data/spec/ngrokapi/models/api_key_spec.rb +43 -0
  95. data/spec/ngrokapi/models/listable_spec.rb +43 -0
  96. data/spec/ngrokapi/models/reserved_domain_spec.rb +100 -0
  97. data/spec/ngrokapi/paged_iterator_spec.rb +84 -0
  98. data/spec/ngrokapi/services/api_keys_client_spec.rb +127 -0
  99. data/spec/spec_helper.rb +80 -0
  100. metadata +144 -0
data/docs/NgrokAPI/Services/ApiKeysClient.html ADDED
@@ -0,0 +1,1333 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: NgrokAPI::Services::ApiKeysClient
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NgrokAPI::Services::ApiKeysClient";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
+ &raquo;
42
+ <span class="title">ApiKeysClient</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: NgrokAPI::Services::ApiKeysClient
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NgrokAPI::Services::ApiKeysClient</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/ngrokapi/services/api_keys_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A client for interacting with the api_keys API</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+ <h2>
118
+ Constant Summary
119
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <dl class="constants">
123
+
124
+ <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
125
+ <div class="docstring">
126
+ <div class="discussion">
127
+
128
+ <p>The List Property from the resulting API for list calls</p>
129
+
130
+
131
+ </div>
132
+ </div>
133
+ <div class="tags">
134
+
135
+
136
+ </div>
137
+ </dt>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>keys</span><span class='tstring_end'>&#39;</span></span></pre></dd>
139
+
140
+ <dt id="PATH-constant" class="">PATH =
141
+ <div class="docstring">
142
+ <div class="discussion">
143
+
144
+ <p>The API path for API keys</p>
145
+
146
+
147
+ </div>
148
+ </div>
149
+ <div class="tags">
150
+
151
+
152
+ </div>
153
+ </dt>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
+
156
+ </dl>
157
+
158
+
159
+
160
+
161
+
162
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
163
+ <ul class="summary">
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+ <span class="note title readonly">readonly</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Returns the value of attribute client.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+ <h2>
201
+ Instance Method Summary
202
+ <small><a href="#" class="summary_toggle">collapse</a></small>
203
+ </h2>
204
+
205
+ <ul class="summary">
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::ApiKey </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Create a new API key.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: nil) &#x21d2; nil </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Delete an API key by ID.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: nil) &#x21d2; nil </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>Delete an API key by ID.</p>
274
+ </div></span>
275
+
276
+ </li>
277
+
278
+
279
+ <li class="public ">
280
+ <span class="summary_signature">
281
+
282
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: nil) &#x21d2; NgrokAPI::Models::ApiKey </a>
283
+
284
+
285
+
286
+ </span>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+ <span class="summary_desc"><div class='inline'>
297
+ <p>Get the details of an API key by ID.</p>
298
+ </div></span>
299
+
300
+ </li>
301
+
302
+
303
+ <li class="public ">
304
+ <span class="summary_signature">
305
+
306
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: nil) &#x21d2; NgrokAPI::Models::ApiKey </a>
307
+
308
+
309
+
310
+ </span>
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+ <span class="summary_desc"><div class='inline'>
321
+ <p>Get the details of an API key by ID.</p>
322
+ </div></span>
323
+
324
+ </li>
325
+
326
+
327
+ <li class="public ">
328
+ <span class="summary_signature">
329
+
330
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; ApiKeysClient </a>
331
+
332
+
333
+
334
+ </span>
335
+
336
+
337
+ <span class="note title constructor">constructor</span>
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+ <span class="summary_desc"><div class='inline'>
347
+ <p>A new instance of ApiKeysClient.</p>
348
+ </div></span>
349
+
350
+ </li>
351
+
352
+
353
+ <li class="public ">
354
+ <span class="summary_signature">
355
+
356
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
357
+
358
+
359
+
360
+ </span>
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ <span class="summary_desc"><div class='inline'>
371
+ <p>List all API keys owned by this account.</p>
372
+ </div></span>
373
+
374
+ </li>
375
+
376
+
377
+ <li class="public ">
378
+ <span class="summary_signature">
379
+
380
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: nil, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::ApiKey </a>
381
+
382
+
383
+
384
+ </span>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+ <span class="summary_desc"><div class='inline'>
395
+ <p>Update attributes of an API key by ID.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ <li class="public ">
402
+ <span class="summary_signature">
403
+
404
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: nil, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::ApiKey </a>
405
+
406
+
407
+
408
+ </span>
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <span class="summary_desc"><div class='inline'>
419
+ <p>Update attributes of an API key by ID.</p>
420
+ </div></span>
421
+
422
+ </li>
423
+
424
+
425
+ </ul>
426
+
427
+
428
+ <div id="constructor_details" class="method_details_list">
429
+ <h2>Constructor Details</h2>
430
+
431
+ <div class="method_details first">
432
+ <h3 class="signature first" id="initialize-instance_method">
433
+
434
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::ApiKeysClient (class)">ApiKeysClient</a></span></tt>
435
+
436
+
437
+
438
+
439
+
440
+ </h3><div class="docstring">
441
+ <div class="discussion">
442
+
443
+ <p>Returns a new instance of ApiKeysClient.</p>
444
+
445
+
446
+ </div>
447
+ </div>
448
+ <div class="tags">
449
+
450
+
451
+ </div><table class="source_code">
452
+ <tr>
453
+ <td>
454
+ <pre class="lines">
455
+
456
+
457
+ 17
458
+ 18
459
+ 19</pre>
460
+ </td>
461
+ <td>
462
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 17</span>
463
+
464
+ <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>
465
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
466
+ <span class='kw'>end</span></pre>
467
+ </td>
468
+ </tr>
469
+ </table>
470
+ </div>
471
+
472
+ </div>
473
+
474
+ <div id="instance_attr_details" class="attr_details">
475
+ <h2>Instance Attribute Details</h2>
476
+
477
+
478
+ <span id=""></span>
479
+ <div class="method_details first">
480
+ <h3 class="signature first" id="client-instance_method">
481
+
482
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
483
+
484
+
485
+
486
+
487
+
488
+ </h3><div class="docstring">
489
+ <div class="discussion">
490
+
491
+ <p>Returns the value of attribute client.</p>
492
+
493
+
494
+ </div>
495
+ </div>
496
+ <div class="tags">
497
+
498
+
499
+ </div><table class="source_code">
500
+ <tr>
501
+ <td>
502
+ <pre class="lines">
503
+
504
+
505
+ 15
506
+ 16
507
+ 17</pre>
508
+ </td>
509
+ <td>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 15</span>
511
+
512
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
513
+ <span class='ivar'>@client</span>
514
+ <span class='kw'>end</span></pre>
515
+ </td>
516
+ </tr>
517
+ </table>
518
+ </div>
519
+
520
+ </div>
521
+
522
+
523
+ <div id="instance_method_details" class="method_details_list">
524
+ <h2>Instance Method Details</h2>
525
+
526
+
527
+ <div class="method_details first">
528
+ <h3 class="signature first" id="create-instance_method">
529
+
530
+ #<strong>create</strong>(description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
531
+
532
+
533
+
534
+
535
+
536
+ </h3><div class="docstring">
537
+ <div class="discussion">
538
+
539
+ <p>Create a new API key. The generated API key can be used to authenticate to the ngrok API.</p>
540
+
541
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-create">ngrok.com/docs/api#api-api-keys-create</a></p>
542
+
543
+
544
+ </div>
545
+ </div>
546
+ <div class="tags">
547
+ <p class="tag_title">Parameters:</p>
548
+ <ul class="param">
549
+
550
+ <li>
551
+
552
+ <span class='name'>description</span>
553
+
554
+
555
+ <span class='type'>(<tt>string</tt>)</span>
556
+
557
+
558
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
559
+
560
+
561
+ &mdash;
562
+ <div class='inline'>
563
+ <p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
564
+ </div>
565
+
566
+ </li>
567
+
568
+ <li>
569
+
570
+ <span class='name'>metadata</span>
571
+
572
+
573
+ <span class='type'>(<tt>string</tt>)</span>
574
+
575
+
576
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
577
+
578
+
579
+ &mdash;
580
+ <div class='inline'>
581
+ <p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
582
+ </div>
583
+
584
+ </li>
585
+
586
+ </ul>
587
+
588
+ <p class="tag_title">Returns:</p>
589
+ <ul class="return">
590
+
591
+ <li>
592
+
593
+
594
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
595
+
596
+
597
+
598
+ &mdash;
599
+ <div class='inline'>
600
+ <p>result from create request</p>
601
+ </div>
602
+
603
+ </li>
604
+
605
+ </ul>
606
+
607
+ </div><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 31
614
+ 32
615
+ 33
616
+ 34</pre>
617
+ </td>
618
+ <td>
619
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 31</span>
620
+
621
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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>
622
+ <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='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span><span class='rparen'>)</span>
623
+ <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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
624
+ <span class='kw'>end</span></pre>
625
+ </td>
626
+ </tr>
627
+ </table>
628
+ </div>
629
+
630
+ <div class="method_details ">
631
+ <h3 class="signature " id="delete-instance_method">
632
+
633
+ #<strong>delete</strong>(id: nil) &#x21d2; <tt>nil</tt>
634
+
635
+
636
+
637
+
638
+
639
+ </h3><div class="docstring">
640
+ <div class="discussion">
641
+
642
+ <p>Delete an API key by ID.</p>
643
+
644
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
645
+
646
+
647
+ </div>
648
+ </div>
649
+ <div class="tags">
650
+ <p class="tag_title">Parameters:</p>
651
+ <ul class="param">
652
+
653
+ <li>
654
+
655
+ <span class='name'>id</span>
656
+
657
+
658
+ <span class='type'>(<tt>string</tt>)</span>
659
+
660
+
661
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
662
+
663
+
664
+ &mdash;
665
+ <div class='inline'>
666
+ <p>a resource identifier</p>
667
+ </div>
668
+
669
+ </li>
670
+
671
+ </ul>
672
+
673
+ <p class="tag_title">Returns:</p>
674
+ <ul class="return">
675
+
676
+ <li>
677
+
678
+
679
+ <span class='type'>(<tt>nil</tt>)</span>
680
+
681
+
682
+
683
+ &mdash;
684
+ <div class='inline'>
685
+ <p>result from delete request</p>
686
+ </div>
687
+
688
+ </li>
689
+
690
+ </ul>
691
+
692
+ </div><table class="source_code">
693
+ <tr>
694
+ <td>
695
+ <pre class="lines">
696
+
697
+
698
+ 44
699
+ 45
700
+ 46</pre>
701
+ </td>
702
+ <td>
703
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 44</span>
704
+
705
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
706
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
707
+ <span class='kw'>end</span></pre>
708
+ </td>
709
+ </tr>
710
+ </table>
711
+ </div>
712
+
713
+ <div class="method_details ">
714
+ <h3 class="signature " id="delete!-instance_method">
715
+
716
+ #<strong>delete!</strong>(id: nil) &#x21d2; <tt>nil</tt>
717
+
718
+
719
+
720
+
721
+
722
+ </h3><div class="docstring">
723
+ <div class="discussion">
724
+
725
+ <p>Delete an API key by ID. Throw an exception if 404.</p>
726
+
727
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
728
+
729
+
730
+ </div>
731
+ </div>
732
+ <div class="tags">
733
+ <p class="tag_title">Parameters:</p>
734
+ <ul class="param">
735
+
736
+ <li>
737
+
738
+ <span class='name'>id</span>
739
+
740
+
741
+ <span class='type'>(<tt>string</tt>)</span>
742
+
743
+
744
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
745
+
746
+
747
+ &mdash;
748
+ <div class='inline'>
749
+ <p>a resource identifier</p>
750
+ </div>
751
+
752
+ </li>
753
+
754
+ </ul>
755
+
756
+ <p class="tag_title">Returns:</p>
757
+ <ul class="return">
758
+
759
+ <li>
760
+
761
+
762
+ <span class='type'>(<tt>nil</tt>)</span>
763
+
764
+
765
+
766
+ &mdash;
767
+ <div class='inline'>
768
+ <p>result from delete request</p>
769
+ </div>
770
+
771
+ </li>
772
+
773
+ </ul>
774
+
775
+ </div><table class="source_code">
776
+ <tr>
777
+ <td>
778
+ <pre class="lines">
779
+
780
+
781
+ 55
782
+ 56
783
+ 57</pre>
784
+ </td>
785
+ <td>
786
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 55</span>
787
+
788
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
789
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
790
+ <span class='kw'>end</span></pre>
791
+ </td>
792
+ </tr>
793
+ </table>
794
+ </div>
795
+
796
+ <div class="method_details ">
797
+ <h3 class="signature " id="get-instance_method">
798
+
799
+ #<strong>get</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
800
+
801
+
802
+
803
+
804
+
805
+ </h3><div class="docstring">
806
+ <div class="discussion">
807
+
808
+ <p>Get the details of an API key by ID.</p>
809
+
810
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-get">ngrok.com/docs/api#api-api-keys-get</a></p>
811
+
812
+
813
+ </div>
814
+ </div>
815
+ <div class="tags">
816
+ <p class="tag_title">Parameters:</p>
817
+ <ul class="param">
818
+
819
+ <li>
820
+
821
+ <span class='name'>id</span>
822
+
823
+
824
+ <span class='type'>(<tt>string</tt>)</span>
825
+
826
+
827
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
828
+
829
+
830
+ &mdash;
831
+ <div class='inline'>
832
+ <p>a resource identifier</p>
833
+ </div>
834
+
835
+ </li>
836
+
837
+ </ul>
838
+
839
+ <p class="tag_title">Returns:</p>
840
+ <ul class="return">
841
+
842
+ <li>
843
+
844
+
845
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
846
+
847
+
848
+
849
+ &mdash;
850
+ <div class='inline'>
851
+ <p>result from get request</p>
852
+ </div>
853
+
854
+ </li>
855
+
856
+ </ul>
857
+
858
+ </div><table class="source_code">
859
+ <tr>
860
+ <td>
861
+ <pre class="lines">
862
+
863
+
864
+ 66
865
+ 67
866
+ 68
867
+ 69</pre>
868
+ </td>
869
+ <td>
870
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 66</span>
871
+
872
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
873
+ <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='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
874
+ <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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
875
+ <span class='kw'>end</span></pre>
876
+ </td>
877
+ </tr>
878
+ </table>
879
+ </div>
880
+
881
+ <div class="method_details ">
882
+ <h3 class="signature " id="get!-instance_method">
883
+
884
+ #<strong>get!</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
885
+
886
+
887
+
888
+
889
+
890
+ </h3><div class="docstring">
891
+ <div class="discussion">
892
+
893
+ <p>Get the details of an API key by ID. Throw an exception if 404.</p>
894
+
895
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-get">ngrok.com/docs/api#api-api-keys-get</a></p>
896
+
897
+
898
+ </div>
899
+ </div>
900
+ <div class="tags">
901
+ <p class="tag_title">Parameters:</p>
902
+ <ul class="param">
903
+
904
+ <li>
905
+
906
+ <span class='name'>id</span>
907
+
908
+
909
+ <span class='type'>(<tt>string</tt>)</span>
910
+
911
+
912
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
913
+
914
+
915
+ &mdash;
916
+ <div class='inline'>
917
+ <p>a resource identifier</p>
918
+ </div>
919
+
920
+ </li>
921
+
922
+ </ul>
923
+
924
+ <p class="tag_title">Returns:</p>
925
+ <ul class="return">
926
+
927
+ <li>
928
+
929
+
930
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
931
+
932
+
933
+
934
+ &mdash;
935
+ <div class='inline'>
936
+ <p>result from get request</p>
937
+ </div>
938
+
939
+ </li>
940
+
941
+ </ul>
942
+
943
+ </div><table class="source_code">
944
+ <tr>
945
+ <td>
946
+ <pre class="lines">
947
+
948
+
949
+ 78
950
+ 79
951
+ 80
952
+ 81</pre>
953
+ </td>
954
+ <td>
955
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 78</span>
956
+
957
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
958
+ <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='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
959
+ <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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
960
+ <span class='kw'>end</span></pre>
961
+ </td>
962
+ </tr>
963
+ </table>
964
+ </div>
965
+
966
+ <div class="method_details ">
967
+ <h3 class="signature " id="list-instance_method">
968
+
969
+ #<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>
970
+
971
+
972
+
973
+
974
+
975
+ </h3><div class="docstring">
976
+ <div class="discussion">
977
+
978
+ <p>List all API keys owned by this account.</p>
979
+
980
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p>
981
+
982
+
983
+ </div>
984
+ </div>
985
+ <div class="tags">
986
+ <p class="tag_title">Parameters:</p>
987
+ <ul class="param">
988
+
989
+ <li>
990
+
991
+ <span class='name'>before_id</span>
992
+
993
+
994
+ <span class='type'>(<tt>string</tt>)</span>
995
+
996
+
997
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
998
+
999
+
1000
+ </li>
1001
+
1002
+ <li>
1003
+
1004
+ <span class='name'>limit</span>
1005
+
1006
+
1007
+ <span class='type'>(<tt>integer</tt>)</span>
1008
+
1009
+
1010
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1011
+
1012
+
1013
+ </li>
1014
+
1015
+ <li>
1016
+
1017
+ <span class='name'>url</span>
1018
+
1019
+
1020
+ <span class='type'>(<tt>string</tt>)</span>
1021
+
1022
+
1023
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1024
+
1025
+
1026
+ &mdash;
1027
+ <div class='inline'>
1028
+ <p>optional and mutually exclusive from before_id and limit</p>
1029
+ </div>
1030
+
1031
+ </li>
1032
+
1033
+ </ul>
1034
+
1035
+ <p class="tag_title">Returns:</p>
1036
+ <ul class="return">
1037
+
1038
+ <li>
1039
+
1040
+
1041
+ <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>
1042
+
1043
+
1044
+
1045
+ &mdash;
1046
+ <div class='inline'>
1047
+ <p>the result listable</p>
1048
+ </div>
1049
+
1050
+ </li>
1051
+
1052
+ </ul>
1053
+
1054
+ </div><table class="source_code">
1055
+ <tr>
1056
+ <td>
1057
+ <pre class="lines">
1058
+
1059
+
1060
+ 92
1061
+ 93
1062
+ 94
1063
+ 95
1064
+ 96
1065
+ 97
1066
+ 98
1067
+ 99
1068
+ 100</pre>
1069
+ </td>
1070
+ <td>
1071
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 92</span>
1072
+
1073
+ <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>
1074
+ <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::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='rparen'>)</span>
1075
+ <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>
1076
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1077
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1078
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ApiKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1079
+ <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/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">ApiKey</a></span></span>
1080
+ <span class='rparen'>)</span>
1081
+ <span class='kw'>end</span></pre>
1082
+ </td>
1083
+ </tr>
1084
+ </table>
1085
+ </div>
1086
+
1087
+ <div class="method_details ">
1088
+ <h3 class="signature " id="update-instance_method">
1089
+
1090
+ #<strong>update</strong>(id: nil, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+ </h3><div class="docstring">
1097
+ <div class="discussion">
1098
+
1099
+ <p>Update attributes of an API key by ID.</p>
1100
+
1101
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
1102
+
1103
+
1104
+ </div>
1105
+ </div>
1106
+ <div class="tags">
1107
+ <p class="tag_title">Parameters:</p>
1108
+ <ul class="param">
1109
+
1110
+ <li>
1111
+
1112
+ <span class='name'>id</span>
1113
+
1114
+
1115
+ <span class='type'>(<tt>string</tt>)</span>
1116
+
1117
+
1118
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1119
+
1120
+
1121
+ </li>
1122
+
1123
+ <li>
1124
+
1125
+ <span class='name'>description</span>
1126
+
1127
+
1128
+ <span class='type'>(<tt>string</tt>)</span>
1129
+
1130
+
1131
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1132
+
1133
+
1134
+ &mdash;
1135
+ <div class='inline'>
1136
+ <p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
1137
+ </div>
1138
+
1139
+ </li>
1140
+
1141
+ <li>
1142
+
1143
+ <span class='name'>metadata</span>
1144
+
1145
+
1146
+ <span class='type'>(<tt>string</tt>)</span>
1147
+
1148
+
1149
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1150
+
1151
+
1152
+ &mdash;
1153
+ <div class='inline'>
1154
+ <p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
1155
+ </div>
1156
+
1157
+ </li>
1158
+
1159
+ </ul>
1160
+
1161
+ <p class="tag_title">Returns:</p>
1162
+ <ul class="return">
1163
+
1164
+ <li>
1165
+
1166
+
1167
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
1168
+
1169
+
1170
+
1171
+ &mdash;
1172
+ <div class='inline'>
1173
+ <p>result from update request</p>
1174
+ </div>
1175
+
1176
+ </li>
1177
+
1178
+ </ul>
1179
+
1180
+ </div><table class="source_code">
1181
+ <tr>
1182
+ <td>
1183
+ <pre class="lines">
1184
+
1185
+
1186
+ 113
1187
+ 114
1188
+ 115
1189
+ 116</pre>
1190
+ </td>
1191
+ <td>
1192
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 113</span>
1193
+
1194
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</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>
1195
+ <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='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span><span class='rparen'>)</span>
1196
+ <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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1197
+ <span class='kw'>end</span></pre>
1198
+ </td>
1199
+ </tr>
1200
+ </table>
1201
+ </div>
1202
+
1203
+ <div class="method_details ">
1204
+ <h3 class="signature " id="update!-instance_method">
1205
+
1206
+ #<strong>update!</strong>(id: nil, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+ </h3><div class="docstring">
1213
+ <div class="discussion">
1214
+
1215
+ <p>Update attributes of an API key by ID.</p>
1216
+
1217
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
1218
+
1219
+
1220
+ </div>
1221
+ </div>
1222
+ <div class="tags">
1223
+ <p class="tag_title">Parameters:</p>
1224
+ <ul class="param">
1225
+
1226
+ <li>
1227
+
1228
+ <span class='name'>id</span>
1229
+
1230
+
1231
+ <span class='type'>(<tt>string</tt>)</span>
1232
+
1233
+
1234
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1235
+
1236
+
1237
+ </li>
1238
+
1239
+ <li>
1240
+
1241
+ <span class='name'>description</span>
1242
+
1243
+
1244
+ <span class='type'>(<tt>string</tt>)</span>
1245
+
1246
+
1247
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1248
+
1249
+
1250
+ &mdash;
1251
+ <div class='inline'>
1252
+ <p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
1253
+ </div>
1254
+
1255
+ </li>
1256
+
1257
+ <li>
1258
+
1259
+ <span class='name'>metadata</span>
1260
+
1261
+
1262
+ <span class='type'>(<tt>string</tt>)</span>
1263
+
1264
+
1265
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1266
+
1267
+
1268
+ &mdash;
1269
+ <div class='inline'>
1270
+ <p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
1271
+ </div>
1272
+
1273
+ </li>
1274
+
1275
+ </ul>
1276
+
1277
+ <p class="tag_title">Returns:</p>
1278
+ <ul class="return">
1279
+
1280
+ <li>
1281
+
1282
+
1283
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ApiKey.html" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
1284
+
1285
+
1286
+
1287
+ &mdash;
1288
+ <div class='inline'>
1289
+ <p>result from update request</p>
1290
+ </div>
1291
+
1292
+ </li>
1293
+
1294
+ </ul>
1295
+
1296
+ </div><table class="source_code">
1297
+ <tr>
1298
+ <td>
1299
+ <pre class="lines">
1300
+
1301
+
1302
+ 127
1303
+ 128
1304
+ 129
1305
+ 130
1306
+ 131</pre>
1307
+ </td>
1308
+ <td>
1309
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 127</span>
1310
+
1311
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</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>
1312
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span>
1313
+ <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='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ApiKeysClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1314
+ <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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1315
+ <span class='kw'>end</span></pre>
1316
+ </td>
1317
+ </tr>
1318
+ </table>
1319
+ </div>
1320
+
1321
+ </div>
1322
+
1323
+ </div>
1324
+
1325
+ <div id="footer">
1326
+ Generated on Fri Sep 24 19:20:29 2021 by
1327
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1328
+ 0.9.26 (ruby-3.0.1).
1329
+ </div>
1330
+
1331
+ </div>
1332
+ </body>
1333
+ </html>