ngrok-api 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
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/doc/NgrokAPI/Services/TlsCertificatesClient.html ADDED
@@ -0,0 +1,1417 @@
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::TlsCertificatesClient
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::TlsCertificatesClient";
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 (T)</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">TlsCertificatesClient</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::TlsCertificatesClient
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::TlsCertificatesClient</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/tls_certificates_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 tls_certificates API</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</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'>tls_certificates</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 tls certificates</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'>/tls_certificates</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>(certificate_pem: &#39;&#39;, description: &#39;&#39;, metadata: &#39;&#39;, private_key_pem: &#39;&#39;) &#x21d2; NgrokAPI::Models::TlsCertificate </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>Upload a new TLS certificate.</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 a TLS certificate 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 a TLS certificate 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::TlsCertificate </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 detailed information about a TLS certificate 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::TlsCertificate </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 detailed information about a TLS certificate 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; TlsCertificatesClient </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 TlsCertificatesClient.</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 TLS certificates on 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::TlsCertificate </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 a TLS Certificate 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::TlsCertificate </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 a TLS Certificate 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::TlsCertificatesClient (class)">TlsCertificatesClient</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 TlsCertificatesClient.</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/tls_certificates_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/tls_certificates_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>(certificate_pem: &#39;&#39;, description: &#39;&#39;, metadata: &#39;&#39;, private_key_pem: &#39;&#39;) &#x21d2; <tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>
531
+
532
+
533
+
534
+
535
+
536
+ </h3><div class="docstring">
537
+ <div class="discussion">
538
+
539
+ <p>Upload a new TLS certificate.</p>
540
+
541
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-create">ngrok.com/docs/api#api-tls-certificates-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>&#39;&#39;</tt>)</em>
559
+
560
+
561
+ &mdash;
562
+ <div class='inline'>
563
+ <p>human-readable description of this TLS certificate. 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>&#39;&#39;</tt>)</em>
577
+
578
+
579
+ &mdash;
580
+ <div class='inline'>
581
+ <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p>
582
+ </div>
583
+
584
+ </li>
585
+
586
+ <li>
587
+
588
+ <span class='name'>certificate_pem</span>
589
+
590
+
591
+ <span class='type'>(<tt>string</tt>)</span>
592
+
593
+
594
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
595
+
596
+
597
+ &mdash;
598
+ <div class='inline'>
599
+ <p>chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` &lt;<a href="https://ngrok.com/docs/api#tls-certificates-pem>`_“>ngrok.com/docs/api#tls-certificates-pem>`_</a>.</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ <li>
605
+
606
+ <span class='name'>private_key_pem</span>
607
+
608
+
609
+ <span class='type'>(<tt>string</tt>)</span>
610
+
611
+
612
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>private key for the TLS certificate, PEM-encoded. See `Private Keys` &lt;<a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_“>ngrok.com/docs/ngrok-link#tls-certificates-key>`_</a>.</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+ <p class="tag_title">Returns:</p>
625
+ <ul class="return">
626
+
627
+ <li>
628
+
629
+
630
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>)</span>
631
+
632
+
633
+
634
+ &mdash;
635
+ <div class='inline'>
636
+ <p>result from create request</p>
637
+ </div>
638
+
639
+ </li>
640
+
641
+ </ul>
642
+
643
+ </div><table class="source_code">
644
+ <tr>
645
+ <td>
646
+ <pre class="lines">
647
+
648
+
649
+ 33
650
+ 34
651
+ 35
652
+ 36
653
+ 37
654
+ 38
655
+ 39
656
+ 40
657
+ 41
658
+ 42
659
+ 43
660
+ 44
661
+ 45
662
+ 46
663
+ 47</pre>
664
+ </td>
665
+ <td>
666
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 33</span>
667
+
668
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
669
+ <span class='label'>certificate_pem:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
670
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
671
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
672
+ <span class='label'>private_key_pem:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
673
+ <span class='rparen'>)</span>
674
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
675
+ <span class='label'>certificate_pem:</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span><span class='comma'>,</span>
676
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
677
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
678
+ <span class='label'>private_key_pem:</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</span><span class='comma'>,</span>
679
+ <span class='rbrace'>}</span>
680
+ <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::TlsCertificatesClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
681
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TlsCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TlsCertificate#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>
682
+ <span class='kw'>end</span></pre>
683
+ </td>
684
+ </tr>
685
+ </table>
686
+ </div>
687
+
688
+ <div class="method_details ">
689
+ <h3 class="signature " id="delete-instance_method">
690
+
691
+ #<strong>delete</strong>(id: nil) &#x21d2; <tt>nil</tt>
692
+
693
+
694
+
695
+
696
+
697
+ </h3><div class="docstring">
698
+ <div class="discussion">
699
+
700
+ <p>Delete a TLS certificate by ID.</p>
701
+
702
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
703
+
704
+
705
+ </div>
706
+ </div>
707
+ <div class="tags">
708
+ <p class="tag_title">Parameters:</p>
709
+ <ul class="param">
710
+
711
+ <li>
712
+
713
+ <span class='name'>id</span>
714
+
715
+
716
+ <span class='type'>(<tt>string</tt>)</span>
717
+
718
+
719
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
720
+
721
+
722
+ &mdash;
723
+ <div class='inline'>
724
+ <p>a resource identifier</p>
725
+ </div>
726
+
727
+ </li>
728
+
729
+ </ul>
730
+
731
+ <p class="tag_title">Returns:</p>
732
+ <ul class="return">
733
+
734
+ <li>
735
+
736
+
737
+ <span class='type'>(<tt>nil</tt>)</span>
738
+
739
+
740
+
741
+ &mdash;
742
+ <div class='inline'>
743
+ <p>result from delete request</p>
744
+ </div>
745
+
746
+ </li>
747
+
748
+ </ul>
749
+
750
+ </div><table class="source_code">
751
+ <tr>
752
+ <td>
753
+ <pre class="lines">
754
+
755
+
756
+ 57
757
+ 58
758
+ 59</pre>
759
+ </td>
760
+ <td>
761
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 57</span>
762
+
763
+ <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>
764
+ <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::TlsCertificatesClient::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>
765
+ <span class='kw'>end</span></pre>
766
+ </td>
767
+ </tr>
768
+ </table>
769
+ </div>
770
+
771
+ <div class="method_details ">
772
+ <h3 class="signature " id="delete!-instance_method">
773
+
774
+ #<strong>delete!</strong>(id: nil) &#x21d2; <tt>nil</tt>
775
+
776
+
777
+
778
+
779
+
780
+ </h3><div class="docstring">
781
+ <div class="discussion">
782
+
783
+ <p>Delete a TLS certificate by ID. Throw an exception if 404.</p>
784
+
785
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
786
+
787
+
788
+ </div>
789
+ </div>
790
+ <div class="tags">
791
+ <p class="tag_title">Parameters:</p>
792
+ <ul class="param">
793
+
794
+ <li>
795
+
796
+ <span class='name'>id</span>
797
+
798
+
799
+ <span class='type'>(<tt>string</tt>)</span>
800
+
801
+
802
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
803
+
804
+
805
+ &mdash;
806
+ <div class='inline'>
807
+ <p>a resource identifier</p>
808
+ </div>
809
+
810
+ </li>
811
+
812
+ </ul>
813
+
814
+ <p class="tag_title">Returns:</p>
815
+ <ul class="return">
816
+
817
+ <li>
818
+
819
+
820
+ <span class='type'>(<tt>nil</tt>)</span>
821
+
822
+
823
+
824
+ &mdash;
825
+ <div class='inline'>
826
+ <p>result from delete request</p>
827
+ </div>
828
+
829
+ </li>
830
+
831
+ </ul>
832
+
833
+ </div><table class="source_code">
834
+ <tr>
835
+ <td>
836
+ <pre class="lines">
837
+
838
+
839
+ 68
840
+ 69
841
+ 70</pre>
842
+ </td>
843
+ <td>
844
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 68</span>
845
+
846
+ <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>
847
+ <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::TlsCertificatesClient::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>
848
+ <span class='kw'>end</span></pre>
849
+ </td>
850
+ </tr>
851
+ </table>
852
+ </div>
853
+
854
+ <div class="method_details ">
855
+ <h3 class="signature " id="get-instance_method">
856
+
857
+ #<strong>get</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>
858
+
859
+
860
+
861
+
862
+
863
+ </h3><div class="docstring">
864
+ <div class="discussion">
865
+
866
+ <p>Get detailed information about a TLS certificate by ID.</p>
867
+
868
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-get</a></p>
869
+
870
+
871
+ </div>
872
+ </div>
873
+ <div class="tags">
874
+ <p class="tag_title">Parameters:</p>
875
+ <ul class="param">
876
+
877
+ <li>
878
+
879
+ <span class='name'>id</span>
880
+
881
+
882
+ <span class='type'>(<tt>string</tt>)</span>
883
+
884
+
885
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
886
+
887
+
888
+ &mdash;
889
+ <div class='inline'>
890
+ <p>a resource identifier</p>
891
+ </div>
892
+
893
+ </li>
894
+
895
+ </ul>
896
+
897
+ <p class="tag_title">Returns:</p>
898
+ <ul class="return">
899
+
900
+ <li>
901
+
902
+
903
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>)</span>
904
+
905
+
906
+
907
+ &mdash;
908
+ <div class='inline'>
909
+ <p>result from get request</p>
910
+ </div>
911
+
912
+ </li>
913
+
914
+ </ul>
915
+
916
+ </div><table class="source_code">
917
+ <tr>
918
+ <td>
919
+ <pre class="lines">
920
+
921
+
922
+ 79
923
+ 80
924
+ 81
925
+ 82</pre>
926
+ </td>
927
+ <td>
928
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 79</span>
929
+
930
+ <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>
931
+ <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::TlsCertificatesClient::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>
932
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TlsCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TlsCertificate#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>
933
+ <span class='kw'>end</span></pre>
934
+ </td>
935
+ </tr>
936
+ </table>
937
+ </div>
938
+
939
+ <div class="method_details ">
940
+ <h3 class="signature " id="get!-instance_method">
941
+
942
+ #<strong>get!</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>
943
+
944
+
945
+
946
+
947
+
948
+ </h3><div class="docstring">
949
+ <div class="discussion">
950
+
951
+ <p>Get detailed information about a TLS certificate by ID. Throw an exception if 404.</p>
952
+
953
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-get</a></p>
954
+
955
+
956
+ </div>
957
+ </div>
958
+ <div class="tags">
959
+ <p class="tag_title">Parameters:</p>
960
+ <ul class="param">
961
+
962
+ <li>
963
+
964
+ <span class='name'>id</span>
965
+
966
+
967
+ <span class='type'>(<tt>string</tt>)</span>
968
+
969
+
970
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
971
+
972
+
973
+ &mdash;
974
+ <div class='inline'>
975
+ <p>a resource identifier</p>
976
+ </div>
977
+
978
+ </li>
979
+
980
+ </ul>
981
+
982
+ <p class="tag_title">Returns:</p>
983
+ <ul class="return">
984
+
985
+ <li>
986
+
987
+
988
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>)</span>
989
+
990
+
991
+
992
+ &mdash;
993
+ <div class='inline'>
994
+ <p>result from get request</p>
995
+ </div>
996
+
997
+ </li>
998
+
999
+ </ul>
1000
+
1001
+ </div><table class="source_code">
1002
+ <tr>
1003
+ <td>
1004
+ <pre class="lines">
1005
+
1006
+
1007
+ 91
1008
+ 92
1009
+ 93
1010
+ 94</pre>
1011
+ </td>
1012
+ <td>
1013
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 91</span>
1014
+
1015
+ <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>
1016
+ <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::TlsCertificatesClient::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>
1017
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TlsCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TlsCertificate#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>
1018
+ <span class='kw'>end</span></pre>
1019
+ </td>
1020
+ </tr>
1021
+ </table>
1022
+ </div>
1023
+
1024
+ <div class="method_details ">
1025
+ <h3 class="signature " id="list-instance_method">
1026
+
1027
+ #<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>
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+ </h3><div class="docstring">
1034
+ <div class="discussion">
1035
+
1036
+ <p>List all TLS certificates on this account.</p>
1037
+
1038
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p>
1039
+
1040
+
1041
+ </div>
1042
+ </div>
1043
+ <div class="tags">
1044
+ <p class="tag_title">Parameters:</p>
1045
+ <ul class="param">
1046
+
1047
+ <li>
1048
+
1049
+ <span class='name'>before_id</span>
1050
+
1051
+
1052
+ <span class='type'>(<tt>string</tt>)</span>
1053
+
1054
+
1055
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1056
+
1057
+
1058
+ </li>
1059
+
1060
+ <li>
1061
+
1062
+ <span class='name'>limit</span>
1063
+
1064
+
1065
+ <span class='type'>(<tt>integer</tt>)</span>
1066
+
1067
+
1068
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1069
+
1070
+
1071
+ </li>
1072
+
1073
+ <li>
1074
+
1075
+ <span class='name'>url</span>
1076
+
1077
+
1078
+ <span class='type'>(<tt>string</tt>)</span>
1079
+
1080
+
1081
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1082
+
1083
+
1084
+ &mdash;
1085
+ <div class='inline'>
1086
+ <p>optional and mutually exclusive from before_id and limit</p>
1087
+ </div>
1088
+
1089
+ </li>
1090
+
1091
+ </ul>
1092
+
1093
+ <p class="tag_title">Returns:</p>
1094
+ <ul class="return">
1095
+
1096
+ <li>
1097
+
1098
+
1099
+ <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>
1100
+
1101
+
1102
+
1103
+ &mdash;
1104
+ <div class='inline'>
1105
+ <p>the result listable</p>
1106
+ </div>
1107
+
1108
+ </li>
1109
+
1110
+ </ul>
1111
+
1112
+ </div><table class="source_code">
1113
+ <tr>
1114
+ <td>
1115
+ <pre class="lines">
1116
+
1117
+
1118
+ 105
1119
+ 106
1120
+ 107
1121
+ 108
1122
+ 109
1123
+ 110
1124
+ 111
1125
+ 112
1126
+ 113</pre>
1127
+ </td>
1128
+ <td>
1129
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 105</span>
1130
+
1131
+ <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>
1132
+ <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::TlsCertificatesClient::PATH (constant)">PATH</a></span></span><span class='rparen'>)</span>
1133
+ <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>
1134
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1135
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1136
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TlsCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1137
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span>
1138
+ <span class='rparen'>)</span>
1139
+ <span class='kw'>end</span></pre>
1140
+ </td>
1141
+ </tr>
1142
+ </table>
1143
+ </div>
1144
+
1145
+ <div class="method_details ">
1146
+ <h3 class="signature " id="update-instance_method">
1147
+
1148
+ #<strong>update</strong>(id: nil, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+ </h3><div class="docstring">
1155
+ <div class="discussion">
1156
+
1157
+ <p>Update attributes of a TLS Certificate by ID.</p>
1158
+
1159
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
1160
+
1161
+
1162
+ </div>
1163
+ </div>
1164
+ <div class="tags">
1165
+ <p class="tag_title">Parameters:</p>
1166
+ <ul class="param">
1167
+
1168
+ <li>
1169
+
1170
+ <span class='name'>id</span>
1171
+
1172
+
1173
+ <span class='type'>(<tt>string</tt>)</span>
1174
+
1175
+
1176
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1177
+
1178
+
1179
+ </li>
1180
+
1181
+ <li>
1182
+
1183
+ <span class='name'>description</span>
1184
+
1185
+
1186
+ <span class='type'>(<tt>string</tt>)</span>
1187
+
1188
+
1189
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1190
+
1191
+
1192
+ &mdash;
1193
+ <div class='inline'>
1194
+ <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p>
1195
+ </div>
1196
+
1197
+ </li>
1198
+
1199
+ <li>
1200
+
1201
+ <span class='name'>metadata</span>
1202
+
1203
+
1204
+ <span class='type'>(<tt>string</tt>)</span>
1205
+
1206
+
1207
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1208
+
1209
+
1210
+ &mdash;
1211
+ <div class='inline'>
1212
+ <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p>
1213
+ </div>
1214
+
1215
+ </li>
1216
+
1217
+ </ul>
1218
+
1219
+ <p class="tag_title">Returns:</p>
1220
+ <ul class="return">
1221
+
1222
+ <li>
1223
+
1224
+
1225
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>)</span>
1226
+
1227
+
1228
+
1229
+ &mdash;
1230
+ <div class='inline'>
1231
+ <p>result from update request</p>
1232
+ </div>
1233
+
1234
+ </li>
1235
+
1236
+ </ul>
1237
+
1238
+ </div><table class="source_code">
1239
+ <tr>
1240
+ <td>
1241
+ <pre class="lines">
1242
+
1243
+
1244
+ 126
1245
+ 127
1246
+ 128
1247
+ 129
1248
+ 130
1249
+ 131
1250
+ 132
1251
+ 133
1252
+ 134
1253
+ 135
1254
+ 136</pre>
1255
+ </td>
1256
+ <td>
1257
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 126</span>
1258
+
1259
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1260
+ <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1261
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1262
+ <span class='label'>metadata:</span> <span class='kw'>nil</span>
1263
+ <span class='rparen'>)</span>
1264
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1265
+ <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>
1266
+ <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>
1267
+ <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::TlsCertificatesClient::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_data'>data</span><span class='rparen'>)</span>
1268
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TlsCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TlsCertificate#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>
1269
+ <span class='kw'>end</span></pre>
1270
+ </td>
1271
+ </tr>
1272
+ </table>
1273
+ </div>
1274
+
1275
+ <div class="method_details ">
1276
+ <h3 class="signature " id="update!-instance_method">
1277
+
1278
+ #<strong>update!</strong>(id: nil, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+ </h3><div class="docstring">
1285
+ <div class="discussion">
1286
+
1287
+ <p>Update attributes of a TLS Certificate by ID. Throw an exception if 404.</p>
1288
+
1289
+ <p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
1290
+
1291
+
1292
+ </div>
1293
+ </div>
1294
+ <div class="tags">
1295
+ <p class="tag_title">Parameters:</p>
1296
+ <ul class="param">
1297
+
1298
+ <li>
1299
+
1300
+ <span class='name'>id</span>
1301
+
1302
+
1303
+ <span class='type'>(<tt>string</tt>)</span>
1304
+
1305
+
1306
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1307
+
1308
+
1309
+ </li>
1310
+
1311
+ <li>
1312
+
1313
+ <span class='name'>description</span>
1314
+
1315
+
1316
+ <span class='type'>(<tt>string</tt>)</span>
1317
+
1318
+
1319
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1320
+
1321
+
1322
+ &mdash;
1323
+ <div class='inline'>
1324
+ <p>human-readable description of this TLS certificate. optional, max 255 bytes.</p>
1325
+ </div>
1326
+
1327
+ </li>
1328
+
1329
+ <li>
1330
+
1331
+ <span class='name'>metadata</span>
1332
+
1333
+
1334
+ <span class='type'>(<tt>string</tt>)</span>
1335
+
1336
+
1337
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1338
+
1339
+
1340
+ &mdash;
1341
+ <div class='inline'>
1342
+ <p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p>
1343
+ </div>
1344
+
1345
+ </li>
1346
+
1347
+ </ul>
1348
+
1349
+ <p class="tag_title">Returns:</p>
1350
+ <ul class="return">
1351
+
1352
+ <li>
1353
+
1354
+
1355
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">NgrokAPI::Models::TlsCertificate</a></span></tt>)</span>
1356
+
1357
+
1358
+
1359
+ &mdash;
1360
+ <div class='inline'>
1361
+ <p>result from update request</p>
1362
+ </div>
1363
+
1364
+ </li>
1365
+
1366
+ </ul>
1367
+
1368
+ </div><table class="source_code">
1369
+ <tr>
1370
+ <td>
1371
+ <pre class="lines">
1372
+
1373
+
1374
+ 147
1375
+ 148
1376
+ 149
1377
+ 150
1378
+ 151
1379
+ 152
1380
+ 153
1381
+ 154
1382
+ 155
1383
+ 156
1384
+ 157</pre>
1385
+ </td>
1386
+ <td>
1387
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 147</span>
1388
+
1389
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
1390
+ <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1391
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1392
+ <span class='label'>metadata:</span> <span class='kw'>nil</span>
1393
+ <span class='rparen'>)</span>
1394
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1395
+ <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>
1396
+ <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>
1397
+ <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::TlsCertificatesClient::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>
1398
+ <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/TlsCertificate.html" title="NgrokAPI::Models::TlsCertificate (class)">TlsCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TlsCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TlsCertificate#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>
1399
+ <span class='kw'>end</span></pre>
1400
+ </td>
1401
+ </tr>
1402
+ </table>
1403
+ </div>
1404
+
1405
+ </div>
1406
+
1407
+ </div>
1408
+
1409
+ <div id="footer">
1410
+ Generated on Fri Sep 24 19:20:29 2021 by
1411
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1412
+ 0.9.26 (ruby-3.0.1).
1413
+ </div>
1414
+
1415
+ </div>
1416
+ </body>
1417
+ </html>