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
@@ -0,0 +1,2498 @@
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::Models::ReservedDomain
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::Models::ReservedDomain";
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 (R)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
41
+ &raquo;
42
+ <span class="title">ReservedDomain</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::Models::ReservedDomain
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::Models::ReservedDomain</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/models/reserved_domain.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A resource representing data from the reserved_domains API</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#certificate-instance_method" title="#certificate (instance method)">#<strong>certificate</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute certificate.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#certificate_management_policy-instance_method" title="#certificate_management_policy (instance method)">#<strong>certificate_management_policy</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns the value of attribute certificate_management_policy.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#certificate_management_status-instance_method" title="#certificate_management_status (instance method)">#<strong>certificate_management_status</strong> &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Returns the value of attribute certificate_management_status.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+ <span class="note title readonly">readonly</span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>Returns the value of attribute client.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#cname_target-instance_method" title="#cname_target (instance method)">#<strong>cname_target</strong> &#x21d2; Object </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+
247
+
248
+ <span class="note title readonly">readonly</span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>Returns the value of attribute cname_target.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+
277
+ <span class="note title readonly">readonly</span>
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+ <span class="summary_desc"><div class='inline'>
288
+ <p>Returns the value of attribute created_at.</p>
289
+ </div></span>
290
+
291
+ </li>
292
+
293
+
294
+ <li class="public ">
295
+ <span class="summary_signature">
296
+
297
+ <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> &#x21d2; Object </a>
298
+
299
+
300
+
301
+ </span>
302
+
303
+
304
+
305
+
306
+ <span class="note title readonly">readonly</span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Returns the value of attribute description.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ <li class="public ">
324
+ <span class="summary_signature">
325
+
326
+ <a href="#domain-instance_method" title="#domain (instance method)">#<strong>domain</strong> &#x21d2; Object </a>
327
+
328
+
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+ <span class="note title readonly">readonly</span>
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ <span class="summary_desc"><div class='inline'>
346
+ <p>Returns the value of attribute domain.</p>
347
+ </div></span>
348
+
349
+ </li>
350
+
351
+
352
+ <li class="public ">
353
+ <span class="summary_signature">
354
+
355
+ <a href="#http_endpoint_configuration-instance_method" title="#http_endpoint_configuration (instance method)">#<strong>http_endpoint_configuration</strong> &#x21d2; Object </a>
356
+
357
+
358
+
359
+ </span>
360
+
361
+
362
+
363
+
364
+ <span class="note title readonly">readonly</span>
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+ <span class="summary_desc"><div class='inline'>
375
+ <p>Returns the value of attribute http_endpoint_configuration.</p>
376
+ </div></span>
377
+
378
+ </li>
379
+
380
+
381
+ <li class="public ">
382
+ <span class="summary_signature">
383
+
384
+ <a href="#https_endpoint_configuration-instance_method" title="#https_endpoint_configuration (instance method)">#<strong>https_endpoint_configuration</strong> &#x21d2; Object </a>
385
+
386
+
387
+
388
+ </span>
389
+
390
+
391
+
392
+
393
+ <span class="note title readonly">readonly</span>
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+ <span class="summary_desc"><div class='inline'>
404
+ <p>Returns the value of attribute https_endpoint_configuration.</p>
405
+ </div></span>
406
+
407
+ </li>
408
+
409
+
410
+ <li class="public ">
411
+ <span class="summary_signature">
412
+
413
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
414
+
415
+
416
+
417
+ </span>
418
+
419
+
420
+
421
+
422
+ <span class="note title readonly">readonly</span>
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+ <span class="summary_desc"><div class='inline'>
433
+ <p>Returns the value of attribute id.</p>
434
+ </div></span>
435
+
436
+ </li>
437
+
438
+
439
+ <li class="public ">
440
+ <span class="summary_signature">
441
+
442
+ <a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong> &#x21d2; Object </a>
443
+
444
+
445
+
446
+ </span>
447
+
448
+
449
+
450
+
451
+ <span class="note title readonly">readonly</span>
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+ <span class="summary_desc"><div class='inline'>
462
+ <p>Returns the value of attribute metadata.</p>
463
+ </div></span>
464
+
465
+ </li>
466
+
467
+
468
+ <li class="public ">
469
+ <span class="summary_signature">
470
+
471
+ <a href="#region-instance_method" title="#region (instance method)">#<strong>region</strong> &#x21d2; Object </a>
472
+
473
+
474
+
475
+ </span>
476
+
477
+
478
+
479
+
480
+ <span class="note title readonly">readonly</span>
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+ <span class="summary_desc"><div class='inline'>
491
+ <p>Returns the value of attribute region.</p>
492
+ </div></span>
493
+
494
+ </li>
495
+
496
+
497
+ <li class="public ">
498
+ <span class="summary_signature">
499
+
500
+ <a href="#result-instance_method" title="#result (instance method)">#<strong>result</strong> &#x21d2; Object </a>
501
+
502
+
503
+
504
+ </span>
505
+
506
+
507
+
508
+
509
+ <span class="note title readonly">readonly</span>
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+ <span class="summary_desc"><div class='inline'>
520
+ <p>Returns the value of attribute result.</p>
521
+ </div></span>
522
+
523
+ </li>
524
+
525
+
526
+ <li class="public ">
527
+ <span class="summary_signature">
528
+
529
+ <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</strong> &#x21d2; Object </a>
530
+
531
+
532
+
533
+ </span>
534
+
535
+
536
+
537
+
538
+ <span class="note title readonly">readonly</span>
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+ <span class="summary_desc"><div class='inline'>
549
+ <p>Returns the value of attribute uri.</p>
550
+ </div></span>
551
+
552
+ </li>
553
+
554
+
555
+ </ul>
556
+
557
+
558
+
559
+
560
+
561
+ <h2>
562
+ Instance Method Summary
563
+ <small><a href="#" class="summary_toggle">collapse</a></small>
564
+ </h2>
565
+
566
+ <ul class="summary">
567
+
568
+ <li class="public ">
569
+ <span class="summary_signature">
570
+
571
+ <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Object </a>
572
+
573
+
574
+
575
+ </span>
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+ <span class="summary_desc"><div class='inline'></div></span>
586
+
587
+ </li>
588
+
589
+
590
+ <li class="public ">
591
+ <span class="summary_signature">
592
+
593
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> &#x21d2; nil </a>
594
+
595
+
596
+
597
+ </span>
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+ <span class="summary_desc"><div class='inline'>
608
+ <p>Delete this reserved domain.</p>
609
+ </div></span>
610
+
611
+ </li>
612
+
613
+
614
+ <li class="public ">
615
+ <span class="summary_signature">
616
+
617
+ <a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong> &#x21d2; nil </a>
618
+
619
+
620
+
621
+ </span>
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+ <span class="summary_desc"><div class='inline'>
632
+ <p>Detach the certificate attached from this reserved domain.</p>
633
+ </div></span>
634
+
635
+ </li>
636
+
637
+
638
+ <li class="public ">
639
+ <span class="summary_signature">
640
+
641
+ <a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong> &#x21d2; nil </a>
642
+
643
+
644
+
645
+ </span>
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+ <span class="summary_desc"><div class='inline'>
656
+ <p>Detach the certificate management policy attached from this reserved domain.</p>
657
+ </div></span>
658
+
659
+ </li>
660
+
661
+
662
+ <li class="public ">
663
+ <span class="summary_signature">
664
+
665
+ <a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong> &#x21d2; nil </a>
666
+
667
+
668
+
669
+ </span>
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+ <span class="summary_desc"><div class='inline'>
680
+ <p>Detach the http endpoint configuration attached from this reserved domain.</p>
681
+ </div></span>
682
+
683
+ </li>
684
+
685
+
686
+ <li class="public ">
687
+ <span class="summary_signature">
688
+
689
+ <a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong> &#x21d2; nil </a>
690
+
691
+
692
+
693
+ </span>
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+ <span class="summary_desc"><div class='inline'>
704
+ <p>Detach the https endpoint configuration attached from this reserved domain.</p>
705
+ </div></span>
706
+
707
+ </li>
708
+
709
+
710
+ <li class="public ">
711
+ <span class="summary_signature">
712
+
713
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) &#x21d2; ReservedDomain </a>
714
+
715
+
716
+
717
+ </span>
718
+
719
+
720
+ <span class="note title constructor">constructor</span>
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+ <span class="summary_desc"><div class='inline'>
730
+ <p>A new instance of ReservedDomain.</p>
731
+ </div></span>
732
+
733
+ </li>
734
+
735
+
736
+ <li class="public ">
737
+ <span class="summary_signature">
738
+
739
+ <a href="#restore_certificate-instance_method" title="#restore_certificate (instance method)">#<strong>restore_certificate</strong> &#x21d2; NgrokAPI::Models::ReservedDomain </a>
740
+
741
+
742
+
743
+ </span>
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+ <span class="summary_desc"><div class='inline'>
754
+ <p>Restore the certificate attached to this reserved domain.</p>
755
+ </div></span>
756
+
757
+ </li>
758
+
759
+
760
+ <li class="public ">
761
+ <span class="summary_signature">
762
+
763
+ <a href="#restore_certificate_management_policy-instance_method" title="#restore_certificate_management_policy (instance method)">#<strong>restore_certificate_management_policy</strong> &#x21d2; NgrokAPI::Models::ReservedDomain </a>
764
+
765
+
766
+
767
+ </span>
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+ <span class="summary_desc"><div class='inline'>
778
+ <p>Restore the certificate management policy attached to this reserved domain.</p>
779
+ </div></span>
780
+
781
+ </li>
782
+
783
+
784
+ <li class="public ">
785
+ <span class="summary_signature">
786
+
787
+ <a href="#restore_http_endpoint_config-instance_method" title="#restore_http_endpoint_config (instance method)">#<strong>restore_http_endpoint_config</strong> &#x21d2; NgrokAPI::Models::ReservedDomain </a>
788
+
789
+
790
+
791
+ </span>
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+ <span class="summary_desc"><div class='inline'>
802
+ <p>Restore the http endpoint configuration attached to this reserved domain.</p>
803
+ </div></span>
804
+
805
+ </li>
806
+
807
+
808
+ <li class="public ">
809
+ <span class="summary_signature">
810
+
811
+ <a href="#restore_https_endpoint_config-instance_method" title="#restore_https_endpoint_config (instance method)">#<strong>restore_https_endpoint_config</strong> &#x21d2; NgrokAPI::Models::ReservedDomain </a>
812
+
813
+
814
+
815
+ </span>
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+ <span class="summary_desc"><div class='inline'>
826
+ <p>Restore the https endpoint configuration attached to this reserved domain.</p>
827
+ </div></span>
828
+
829
+ </li>
830
+
831
+
832
+ <li class="public ">
833
+ <span class="summary_signature">
834
+
835
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
836
+
837
+
838
+
839
+ </span>
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <span class="summary_desc"><div class='inline'></div></span>
850
+
851
+ </li>
852
+
853
+
854
+ <li class="public ">
855
+ <span class="summary_signature">
856
+
857
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(certificate_id: nil, certificate_management_policy: nil, description: &#39;&#39;, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: &#39;&#39;) &#x21d2; NgrokAPI::Models::ReservedDomain </a>
858
+
859
+
860
+
861
+ </span>
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+ <span class="summary_desc"><div class='inline'>
872
+ <p>Update the attributes of this reserved domain.</p>
873
+ </div></span>
874
+
875
+ </li>
876
+
877
+
878
+ </ul>
879
+
880
+
881
+ <div id="constructor_details" class="method_details_list">
882
+ <h2>Constructor Details</h2>
883
+
884
+ <div class="method_details first">
885
+ <h3 class="signature first" id="initialize-instance_method">
886
+
887
+ #<strong>initialize</strong>(client:, result:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></tt>
888
+
889
+
890
+
891
+
892
+
893
+ </h3><div class="docstring">
894
+ <div class="discussion">
895
+
896
+ <p>Returns a new instance of ReservedDomain.</p>
897
+
898
+
899
+ </div>
900
+ </div>
901
+ <div class="tags">
902
+
903
+
904
+ </div><table class="source_code">
905
+ <tr>
906
+ <td>
907
+ <pre class="lines">
908
+
909
+
910
+ 24
911
+ 25
912
+ 26
913
+ 27
914
+ 28
915
+ 29
916
+ 30
917
+ 31
918
+ 32
919
+ 33
920
+ 34
921
+ 35
922
+ 36
923
+ 37
924
+ 38
925
+ 39
926
+ 40</pre>
927
+ </td>
928
+ <td>
929
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 24</span>
930
+
931
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
932
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
933
+ <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
934
+ <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>created_at</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
935
+ <span class='ivar'>@certificate</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
936
+ <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate_management_policy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
937
+ <span class='ivar'>@certificate_management_status</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate_management_status</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
938
+ <span class='ivar'>@cname_target</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cname_target</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
939
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
940
+ <span class='ivar'>@domain</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>domain</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
941
+ <span class='ivar'>@http_endpoint_configuration</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
942
+ <span class='ivar'>@https_endpoint_configuration</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
943
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
944
+ <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
945
+ <span class='ivar'>@region</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>region</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
946
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>uri</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
947
+ <span class='kw'>end</span></pre>
948
+ </td>
949
+ </tr>
950
+ </table>
951
+ </div>
952
+
953
+ </div>
954
+
955
+ <div id="instance_attr_details" class="attr_details">
956
+ <h2>Instance Attribute Details</h2>
957
+
958
+
959
+ <span id=""></span>
960
+ <div class="method_details first">
961
+ <h3 class="signature first" id="certificate-instance_method">
962
+
963
+ #<strong>certificate</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
964
+
965
+
966
+
967
+
968
+
969
+ </h3><div class="docstring">
970
+ <div class="discussion">
971
+
972
+ <p>Returns the value of attribute certificate.</p>
973
+
974
+
975
+ </div>
976
+ </div>
977
+ <div class="tags">
978
+
979
+
980
+ </div><table class="source_code">
981
+ <tr>
982
+ <td>
983
+ <pre class="lines">
984
+
985
+
986
+ 8
987
+ 9
988
+ 10</pre>
989
+ </td>
990
+ <td>
991
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
992
+
993
+ <span class='kw'>def</span> <span class='id identifier rubyid_certificate'>certificate</span>
994
+ <span class='ivar'>@certificate</span>
995
+ <span class='kw'>end</span></pre>
996
+ </td>
997
+ </tr>
998
+ </table>
999
+ </div>
1000
+
1001
+
1002
+ <span id=""></span>
1003
+ <div class="method_details ">
1004
+ <h3 class="signature " id="certificate_management_policy-instance_method">
1005
+
1006
+ #<strong>certificate_management_policy</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+ </h3><div class="docstring">
1013
+ <div class="discussion">
1014
+
1015
+ <p>Returns the value of attribute certificate_management_policy.</p>
1016
+
1017
+
1018
+ </div>
1019
+ </div>
1020
+ <div class="tags">
1021
+
1022
+
1023
+ </div><table class="source_code">
1024
+ <tr>
1025
+ <td>
1026
+ <pre class="lines">
1027
+
1028
+
1029
+ 8
1030
+ 9
1031
+ 10</pre>
1032
+ </td>
1033
+ <td>
1034
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1035
+
1036
+ <span class='kw'>def</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
1037
+ <span class='ivar'>@certificate_management_policy</span>
1038
+ <span class='kw'>end</span></pre>
1039
+ </td>
1040
+ </tr>
1041
+ </table>
1042
+ </div>
1043
+
1044
+
1045
+ <span id=""></span>
1046
+ <div class="method_details ">
1047
+ <h3 class="signature " id="certificate_management_status-instance_method">
1048
+
1049
+ #<strong>certificate_management_status</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+ </h3><div class="docstring">
1056
+ <div class="discussion">
1057
+
1058
+ <p>Returns the value of attribute certificate_management_status.</p>
1059
+
1060
+
1061
+ </div>
1062
+ </div>
1063
+ <div class="tags">
1064
+
1065
+
1066
+ </div><table class="source_code">
1067
+ <tr>
1068
+ <td>
1069
+ <pre class="lines">
1070
+
1071
+
1072
+ 8
1073
+ 9
1074
+ 10</pre>
1075
+ </td>
1076
+ <td>
1077
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1078
+
1079
+ <span class='kw'>def</span> <span class='id identifier rubyid_certificate_management_status'>certificate_management_status</span>
1080
+ <span class='ivar'>@certificate_management_status</span>
1081
+ <span class='kw'>end</span></pre>
1082
+ </td>
1083
+ </tr>
1084
+ </table>
1085
+ </div>
1086
+
1087
+
1088
+ <span id=""></span>
1089
+ <div class="method_details ">
1090
+ <h3 class="signature " id="client-instance_method">
1091
+
1092
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+ </h3><div class="docstring">
1099
+ <div class="discussion">
1100
+
1101
+ <p>Returns the value of attribute client.</p>
1102
+
1103
+
1104
+ </div>
1105
+ </div>
1106
+ <div class="tags">
1107
+
1108
+
1109
+ </div><table class="source_code">
1110
+ <tr>
1111
+ <td>
1112
+ <pre class="lines">
1113
+
1114
+
1115
+ 8
1116
+ 9
1117
+ 10</pre>
1118
+ </td>
1119
+ <td>
1120
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1121
+
1122
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
1123
+ <span class='ivar'>@client</span>
1124
+ <span class='kw'>end</span></pre>
1125
+ </td>
1126
+ </tr>
1127
+ </table>
1128
+ </div>
1129
+
1130
+
1131
+ <span id=""></span>
1132
+ <div class="method_details ">
1133
+ <h3 class="signature " id="cname_target-instance_method">
1134
+
1135
+ #<strong>cname_target</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+ </h3><div class="docstring">
1142
+ <div class="discussion">
1143
+
1144
+ <p>Returns the value of attribute cname_target.</p>
1145
+
1146
+
1147
+ </div>
1148
+ </div>
1149
+ <div class="tags">
1150
+
1151
+
1152
+ </div><table class="source_code">
1153
+ <tr>
1154
+ <td>
1155
+ <pre class="lines">
1156
+
1157
+
1158
+ 8
1159
+ 9
1160
+ 10</pre>
1161
+ </td>
1162
+ <td>
1163
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1164
+
1165
+ <span class='kw'>def</span> <span class='id identifier rubyid_cname_target'>cname_target</span>
1166
+ <span class='ivar'>@cname_target</span>
1167
+ <span class='kw'>end</span></pre>
1168
+ </td>
1169
+ </tr>
1170
+ </table>
1171
+ </div>
1172
+
1173
+
1174
+ <span id=""></span>
1175
+ <div class="method_details ">
1176
+ <h3 class="signature " id="created_at-instance_method">
1177
+
1178
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+ </h3><div class="docstring">
1185
+ <div class="discussion">
1186
+
1187
+ <p>Returns the value of attribute created_at.</p>
1188
+
1189
+
1190
+ </div>
1191
+ </div>
1192
+ <div class="tags">
1193
+
1194
+
1195
+ </div><table class="source_code">
1196
+ <tr>
1197
+ <td>
1198
+ <pre class="lines">
1199
+
1200
+
1201
+ 8
1202
+ 9
1203
+ 10</pre>
1204
+ </td>
1205
+ <td>
1206
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1207
+
1208
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
1209
+ <span class='ivar'>@created_at</span>
1210
+ <span class='kw'>end</span></pre>
1211
+ </td>
1212
+ </tr>
1213
+ </table>
1214
+ </div>
1215
+
1216
+
1217
+ <span id=""></span>
1218
+ <div class="method_details ">
1219
+ <h3 class="signature " id="description-instance_method">
1220
+
1221
+ #<strong>description</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+ </h3><div class="docstring">
1228
+ <div class="discussion">
1229
+
1230
+ <p>Returns the value of attribute description.</p>
1231
+
1232
+
1233
+ </div>
1234
+ </div>
1235
+ <div class="tags">
1236
+
1237
+
1238
+ </div><table class="source_code">
1239
+ <tr>
1240
+ <td>
1241
+ <pre class="lines">
1242
+
1243
+
1244
+ 8
1245
+ 9
1246
+ 10</pre>
1247
+ </td>
1248
+ <td>
1249
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1250
+
1251
+ <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
1252
+ <span class='ivar'>@description</span>
1253
+ <span class='kw'>end</span></pre>
1254
+ </td>
1255
+ </tr>
1256
+ </table>
1257
+ </div>
1258
+
1259
+
1260
+ <span id=""></span>
1261
+ <div class="method_details ">
1262
+ <h3 class="signature " id="domain-instance_method">
1263
+
1264
+ #<strong>domain</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+ </h3><div class="docstring">
1271
+ <div class="discussion">
1272
+
1273
+ <p>Returns the value of attribute domain.</p>
1274
+
1275
+
1276
+ </div>
1277
+ </div>
1278
+ <div class="tags">
1279
+
1280
+
1281
+ </div><table class="source_code">
1282
+ <tr>
1283
+ <td>
1284
+ <pre class="lines">
1285
+
1286
+
1287
+ 8
1288
+ 9
1289
+ 10</pre>
1290
+ </td>
1291
+ <td>
1292
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1293
+
1294
+ <span class='kw'>def</span> <span class='id identifier rubyid_domain'>domain</span>
1295
+ <span class='ivar'>@domain</span>
1296
+ <span class='kw'>end</span></pre>
1297
+ </td>
1298
+ </tr>
1299
+ </table>
1300
+ </div>
1301
+
1302
+
1303
+ <span id=""></span>
1304
+ <div class="method_details ">
1305
+ <h3 class="signature " id="http_endpoint_configuration-instance_method">
1306
+
1307
+ #<strong>http_endpoint_configuration</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+ </h3><div class="docstring">
1314
+ <div class="discussion">
1315
+
1316
+ <p>Returns the value of attribute http_endpoint_configuration.</p>
1317
+
1318
+
1319
+ </div>
1320
+ </div>
1321
+ <div class="tags">
1322
+
1323
+
1324
+ </div><table class="source_code">
1325
+ <tr>
1326
+ <td>
1327
+ <pre class="lines">
1328
+
1329
+
1330
+ 8
1331
+ 9
1332
+ 10</pre>
1333
+ </td>
1334
+ <td>
1335
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1336
+
1337
+ <span class='kw'>def</span> <span class='id identifier rubyid_http_endpoint_configuration'>http_endpoint_configuration</span>
1338
+ <span class='ivar'>@http_endpoint_configuration</span>
1339
+ <span class='kw'>end</span></pre>
1340
+ </td>
1341
+ </tr>
1342
+ </table>
1343
+ </div>
1344
+
1345
+
1346
+ <span id=""></span>
1347
+ <div class="method_details ">
1348
+ <h3 class="signature " id="https_endpoint_configuration-instance_method">
1349
+
1350
+ #<strong>https_endpoint_configuration</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+ </h3><div class="docstring">
1357
+ <div class="discussion">
1358
+
1359
+ <p>Returns the value of attribute https_endpoint_configuration.</p>
1360
+
1361
+
1362
+ </div>
1363
+ </div>
1364
+ <div class="tags">
1365
+
1366
+
1367
+ </div><table class="source_code">
1368
+ <tr>
1369
+ <td>
1370
+ <pre class="lines">
1371
+
1372
+
1373
+ 8
1374
+ 9
1375
+ 10</pre>
1376
+ </td>
1377
+ <td>
1378
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1379
+
1380
+ <span class='kw'>def</span> <span class='id identifier rubyid_https_endpoint_configuration'>https_endpoint_configuration</span>
1381
+ <span class='ivar'>@https_endpoint_configuration</span>
1382
+ <span class='kw'>end</span></pre>
1383
+ </td>
1384
+ </tr>
1385
+ </table>
1386
+ </div>
1387
+
1388
+
1389
+ <span id=""></span>
1390
+ <div class="method_details ">
1391
+ <h3 class="signature " id="id-instance_method">
1392
+
1393
+ #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+ </h3><div class="docstring">
1400
+ <div class="discussion">
1401
+
1402
+ <p>Returns the value of attribute id.</p>
1403
+
1404
+
1405
+ </div>
1406
+ </div>
1407
+ <div class="tags">
1408
+
1409
+
1410
+ </div><table class="source_code">
1411
+ <tr>
1412
+ <td>
1413
+ <pre class="lines">
1414
+
1415
+
1416
+ 8
1417
+ 9
1418
+ 10</pre>
1419
+ </td>
1420
+ <td>
1421
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1422
+
1423
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
1424
+ <span class='ivar'>@id</span>
1425
+ <span class='kw'>end</span></pre>
1426
+ </td>
1427
+ </tr>
1428
+ </table>
1429
+ </div>
1430
+
1431
+
1432
+ <span id=""></span>
1433
+ <div class="method_details ">
1434
+ <h3 class="signature " id="metadata-instance_method">
1435
+
1436
+ #<strong>metadata</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+ </h3><div class="docstring">
1443
+ <div class="discussion">
1444
+
1445
+ <p>Returns the value of attribute metadata.</p>
1446
+
1447
+
1448
+ </div>
1449
+ </div>
1450
+ <div class="tags">
1451
+
1452
+
1453
+ </div><table class="source_code">
1454
+ <tr>
1455
+ <td>
1456
+ <pre class="lines">
1457
+
1458
+
1459
+ 8
1460
+ 9
1461
+ 10</pre>
1462
+ </td>
1463
+ <td>
1464
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1465
+
1466
+ <span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
1467
+ <span class='ivar'>@metadata</span>
1468
+ <span class='kw'>end</span></pre>
1469
+ </td>
1470
+ </tr>
1471
+ </table>
1472
+ </div>
1473
+
1474
+
1475
+ <span id=""></span>
1476
+ <div class="method_details ">
1477
+ <h3 class="signature " id="region-instance_method">
1478
+
1479
+ #<strong>region</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+ </h3><div class="docstring">
1486
+ <div class="discussion">
1487
+
1488
+ <p>Returns the value of attribute region.</p>
1489
+
1490
+
1491
+ </div>
1492
+ </div>
1493
+ <div class="tags">
1494
+
1495
+
1496
+ </div><table class="source_code">
1497
+ <tr>
1498
+ <td>
1499
+ <pre class="lines">
1500
+
1501
+
1502
+ 8
1503
+ 9
1504
+ 10</pre>
1505
+ </td>
1506
+ <td>
1507
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1508
+
1509
+ <span class='kw'>def</span> <span class='id identifier rubyid_region'>region</span>
1510
+ <span class='ivar'>@region</span>
1511
+ <span class='kw'>end</span></pre>
1512
+ </td>
1513
+ </tr>
1514
+ </table>
1515
+ </div>
1516
+
1517
+
1518
+ <span id=""></span>
1519
+ <div class="method_details ">
1520
+ <h3 class="signature " id="result-instance_method">
1521
+
1522
+ #<strong>result</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+ </h3><div class="docstring">
1529
+ <div class="discussion">
1530
+
1531
+ <p>Returns the value of attribute result.</p>
1532
+
1533
+
1534
+ </div>
1535
+ </div>
1536
+ <div class="tags">
1537
+
1538
+
1539
+ </div><table class="source_code">
1540
+ <tr>
1541
+ <td>
1542
+ <pre class="lines">
1543
+
1544
+
1545
+ 8
1546
+ 9
1547
+ 10</pre>
1548
+ </td>
1549
+ <td>
1550
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1551
+
1552
+ <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
1553
+ <span class='ivar'>@result</span>
1554
+ <span class='kw'>end</span></pre>
1555
+ </td>
1556
+ </tr>
1557
+ </table>
1558
+ </div>
1559
+
1560
+
1561
+ <span id=""></span>
1562
+ <div class="method_details ">
1563
+ <h3 class="signature " id="uri-instance_method">
1564
+
1565
+ #<strong>uri</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1566
+
1567
+
1568
+
1569
+
1570
+
1571
+ </h3><div class="docstring">
1572
+ <div class="discussion">
1573
+
1574
+ <p>Returns the value of attribute uri.</p>
1575
+
1576
+
1577
+ </div>
1578
+ </div>
1579
+ <div class="tags">
1580
+
1581
+
1582
+ </div><table class="source_code">
1583
+ <tr>
1584
+ <td>
1585
+ <pre class="lines">
1586
+
1587
+
1588
+ 8
1589
+ 9
1590
+ 10</pre>
1591
+ </td>
1592
+ <td>
1593
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 8</span>
1594
+
1595
+ <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
1596
+ <span class='ivar'>@uri</span>
1597
+ <span class='kw'>end</span></pre>
1598
+ </td>
1599
+ </tr>
1600
+ </table>
1601
+ </div>
1602
+
1603
+ </div>
1604
+
1605
+
1606
+ <div id="instance_method_details" class="method_details_list">
1607
+ <h2>Instance Method Details</h2>
1608
+
1609
+
1610
+ <div class="method_details first">
1611
+ <h3 class="signature first" id="==-instance_method">
1612
+
1613
+ #<strong>==</strong>(other) &#x21d2; <tt>Object</tt>
1614
+
1615
+
1616
+
1617
+
1618
+
1619
+ </h3><table class="source_code">
1620
+ <tr>
1621
+ <td>
1622
+ <pre class="lines">
1623
+
1624
+
1625
+ 42
1626
+ 43
1627
+ 44</pre>
1628
+ </td>
1629
+ <td>
1630
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 42</span>
1631
+
1632
+ <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
1633
+ <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
1634
+ <span class='kw'>end</span></pre>
1635
+ </td>
1636
+ </tr>
1637
+ </table>
1638
+ </div>
1639
+
1640
+ <div class="method_details ">
1641
+ <h3 class="signature " id="delete-instance_method">
1642
+
1643
+ #<strong>delete</strong> &#x21d2; <tt>nil</tt>
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+ </h3><div class="docstring">
1650
+ <div class="discussion">
1651
+
1652
+ <p>Delete this reserved domain.</p>
1653
+
1654
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
1655
+
1656
+
1657
+ </div>
1658
+ </div>
1659
+ <div class="tags">
1660
+
1661
+ <p class="tag_title">Returns:</p>
1662
+ <ul class="return">
1663
+
1664
+ <li>
1665
+
1666
+
1667
+ <span class='type'>(<tt>nil</tt>)</span>
1668
+
1669
+
1670
+
1671
+ &mdash;
1672
+ <div class='inline'>
1673
+ <p>result from delete request</p>
1674
+ </div>
1675
+
1676
+ </li>
1677
+
1678
+ </ul>
1679
+
1680
+ </div><table class="source_code">
1681
+ <tr>
1682
+ <td>
1683
+ <pre class="lines">
1684
+
1685
+
1686
+ 56
1687
+ 57
1688
+ 58</pre>
1689
+ </td>
1690
+ <td>
1691
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 56</span>
1692
+
1693
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
1694
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
1695
+ <span class='kw'>end</span></pre>
1696
+ </td>
1697
+ </tr>
1698
+ </table>
1699
+ </div>
1700
+
1701
+ <div class="method_details ">
1702
+ <h3 class="signature " id="delete_certificate-instance_method">
1703
+
1704
+ #<strong>delete_certificate</strong> &#x21d2; <tt>nil</tt>
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+ </h3><div class="docstring">
1711
+ <div class="discussion">
1712
+
1713
+ <p>Detach the certificate attached from this reserved domain.</p>
1714
+
1715
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
1716
+
1717
+
1718
+ </div>
1719
+ </div>
1720
+ <div class="tags">
1721
+
1722
+ <p class="tag_title">Returns:</p>
1723
+ <ul class="return">
1724
+
1725
+ <li>
1726
+
1727
+
1728
+ <span class='type'>(<tt>nil</tt>)</span>
1729
+
1730
+
1731
+
1732
+ &mdash;
1733
+ <div class='inline'>
1734
+ <p>result from delete request</p>
1735
+ </div>
1736
+
1737
+ </li>
1738
+
1739
+ </ul>
1740
+
1741
+ </div><table class="source_code">
1742
+ <tr>
1743
+ <td>
1744
+ <pre class="lines">
1745
+
1746
+
1747
+ 113
1748
+ 114
1749
+ 115
1750
+ 116</pre>
1751
+ </td>
1752
+ <td>
1753
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 113</span>
1754
+
1755
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span>
1756
+ <span class='ivar'>@certificate</span> <span class='op'>=</span> <span class='kw'>nil</span>
1757
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
1758
+ <span class='kw'>end</span></pre>
1759
+ </td>
1760
+ </tr>
1761
+ </table>
1762
+ </div>
1763
+
1764
+ <div class="method_details ">
1765
+ <h3 class="signature " id="delete_certificate_management_policy-instance_method">
1766
+
1767
+ #<strong>delete_certificate_management_policy</strong> &#x21d2; <tt>nil</tt>
1768
+
1769
+
1770
+
1771
+
1772
+
1773
+ </h3><div class="docstring">
1774
+ <div class="discussion">
1775
+
1776
+ <p>Detach the certificate management policy attached from this reserved domain.</p>
1777
+
1778
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
1779
+
1780
+
1781
+ </div>
1782
+ </div>
1783
+ <div class="tags">
1784
+
1785
+ <p class="tag_title">Returns:</p>
1786
+ <ul class="return">
1787
+
1788
+ <li>
1789
+
1790
+
1791
+ <span class='type'>(<tt>nil</tt>)</span>
1792
+
1793
+
1794
+
1795
+ &mdash;
1796
+ <div class='inline'>
1797
+ <p>result from delete request</p>
1798
+ </div>
1799
+
1800
+ </li>
1801
+
1802
+ </ul>
1803
+
1804
+ </div><table class="source_code">
1805
+ <tr>
1806
+ <td>
1807
+ <pre class="lines">
1808
+
1809
+
1810
+ 124
1811
+ 125
1812
+ 126
1813
+ 127
1814
+ 128</pre>
1815
+ </td>
1816
+ <td>
1817
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 124</span>
1818
+
1819
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span>
1820
+ <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='kw'>nil</span>
1821
+ <span class='ivar'>@certificate_management_status</span> <span class='op'>=</span> <span class='kw'>nil</span>
1822
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
1823
+ <span class='kw'>end</span></pre>
1824
+ </td>
1825
+ </tr>
1826
+ </table>
1827
+ </div>
1828
+
1829
+ <div class="method_details ">
1830
+ <h3 class="signature " id="delete_http_endpoint_config-instance_method">
1831
+
1832
+ #<strong>delete_http_endpoint_config</strong> &#x21d2; <tt>nil</tt>
1833
+
1834
+
1835
+
1836
+
1837
+
1838
+ </h3><div class="docstring">
1839
+ <div class="discussion">
1840
+
1841
+ <p>Detach the http endpoint configuration attached from this reserved domain.</p>
1842
+
1843
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
1844
+
1845
+
1846
+ </div>
1847
+ </div>
1848
+ <div class="tags">
1849
+
1850
+ <p class="tag_title">Returns:</p>
1851
+ <ul class="return">
1852
+
1853
+ <li>
1854
+
1855
+
1856
+ <span class='type'>(<tt>nil</tt>)</span>
1857
+
1858
+
1859
+
1860
+ &mdash;
1861
+ <div class='inline'>
1862
+ <p>result from delete request</p>
1863
+ </div>
1864
+
1865
+ </li>
1866
+
1867
+ </ul>
1868
+
1869
+ </div><table class="source_code">
1870
+ <tr>
1871
+ <td>
1872
+ <pre class="lines">
1873
+
1874
+
1875
+ 136
1876
+ 137
1877
+ 138
1878
+ 139</pre>
1879
+ </td>
1880
+ <td>
1881
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 136</span>
1882
+
1883
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span>
1884
+ <span class='ivar'>@http_endpoint_configuration</span> <span class='op'>=</span> <span class='kw'>nil</span>
1885
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
1886
+ <span class='kw'>end</span></pre>
1887
+ </td>
1888
+ </tr>
1889
+ </table>
1890
+ </div>
1891
+
1892
+ <div class="method_details ">
1893
+ <h3 class="signature " id="delete_https_endpoint_config-instance_method">
1894
+
1895
+ #<strong>delete_https_endpoint_config</strong> &#x21d2; <tt>nil</tt>
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+ </h3><div class="docstring">
1902
+ <div class="discussion">
1903
+
1904
+ <p>Detach the https endpoint configuration attached from this reserved domain.</p>
1905
+
1906
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
1907
+
1908
+
1909
+ </div>
1910
+ </div>
1911
+ <div class="tags">
1912
+
1913
+ <p class="tag_title">Returns:</p>
1914
+ <ul class="return">
1915
+
1916
+ <li>
1917
+
1918
+
1919
+ <span class='type'>(<tt>nil</tt>)</span>
1920
+
1921
+
1922
+
1923
+ &mdash;
1924
+ <div class='inline'>
1925
+ <p>result from delete request</p>
1926
+ </div>
1927
+
1928
+ </li>
1929
+
1930
+ </ul>
1931
+
1932
+ </div><table class="source_code">
1933
+ <tr>
1934
+ <td>
1935
+ <pre class="lines">
1936
+
1937
+
1938
+ 147
1939
+ 148
1940
+ 149
1941
+ 150</pre>
1942
+ </td>
1943
+ <td>
1944
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 147</span>
1945
+
1946
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span>
1947
+ <span class='ivar'>@https_endpoint_configuration</span> <span class='op'>=</span> <span class='kw'>nil</span>
1948
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='rparen'>)</span>
1949
+ <span class='kw'>end</span></pre>
1950
+ </td>
1951
+ </tr>
1952
+ </table>
1953
+ </div>
1954
+
1955
+ <div class="method_details ">
1956
+ <h3 class="signature " id="restore_certificate-instance_method">
1957
+
1958
+ #<strong>restore_certificate</strong> &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+ </h3><div class="docstring">
1965
+ <div class="discussion">
1966
+
1967
+ <p>Restore the certificate attached to this reserved domain. Only works if the @result is still present from a previous action</p>
1968
+
1969
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
1970
+
1971
+
1972
+ </div>
1973
+ </div>
1974
+ <div class="tags">
1975
+
1976
+ <p class="tag_title">Returns:</p>
1977
+ <ul class="return">
1978
+
1979
+ <li>
1980
+
1981
+
1982
+ <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
1983
+
1984
+
1985
+
1986
+ &mdash;
1987
+ <div class='inline'>
1988
+ <p>result from update request</p>
1989
+ </div>
1990
+
1991
+ </li>
1992
+
1993
+ </ul>
1994
+
1995
+ </div><table class="source_code">
1996
+ <tr>
1997
+ <td>
1998
+ <pre class="lines">
1999
+
2000
+
2001
+ 159
2002
+ 160
2003
+ 161
2004
+ 162</pre>
2005
+ </td>
2006
+ <td>
2007
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 159</span>
2008
+
2009
+ <span class='kw'>def</span> <span class='id identifier rubyid_restore_certificate'>restore_certificate</span>
2010
+ <span class='ivar'>@certificate</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2011
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
2012
+ <span class='kw'>end</span></pre>
2013
+ </td>
2014
+ </tr>
2015
+ </table>
2016
+ </div>
2017
+
2018
+ <div class="method_details ">
2019
+ <h3 class="signature " id="restore_certificate_management_policy-instance_method">
2020
+
2021
+ #<strong>restore_certificate_management_policy</strong> &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
2022
+
2023
+
2024
+
2025
+
2026
+
2027
+ </h3><div class="docstring">
2028
+ <div class="discussion">
2029
+
2030
+ <p>Restore the certificate management policy attached to this reserved domain. Only works if the @result is still present from a previous action</p>
2031
+
2032
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
2033
+
2034
+
2035
+ </div>
2036
+ </div>
2037
+ <div class="tags">
2038
+
2039
+ <p class="tag_title">Returns:</p>
2040
+ <ul class="return">
2041
+
2042
+ <li>
2043
+
2044
+
2045
+ <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
2046
+
2047
+
2048
+
2049
+ &mdash;
2050
+ <div class='inline'>
2051
+ <p>result from update request</p>
2052
+ </div>
2053
+
2054
+ </li>
2055
+
2056
+ </ul>
2057
+
2058
+ </div><table class="source_code">
2059
+ <tr>
2060
+ <td>
2061
+ <pre class="lines">
2062
+
2063
+
2064
+ 171
2065
+ 172
2066
+ 173
2067
+ 174
2068
+ 175
2069
+ 176
2070
+ 177
2071
+ 178</pre>
2072
+ </td>
2073
+ <td>
2074
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 171</span>
2075
+
2076
+ <span class='kw'>def</span> <span class='id identifier rubyid_restore_certificate_management_policy'>restore_certificate_management_policy</span>
2077
+ <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate_management_policy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2078
+ <span class='ivar'>@certificate_management_status</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate_management_status</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2079
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2080
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
2081
+ <span class='label'>certificate_management_policy:</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>certificate_management_policy</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2082
+ <span class='rparen'>)</span>
2083
+ <span class='kw'>end</span></pre>
2084
+ </td>
2085
+ </tr>
2086
+ </table>
2087
+ </div>
2088
+
2089
+ <div class="method_details ">
2090
+ <h3 class="signature " id="restore_http_endpoint_config-instance_method">
2091
+
2092
+ #<strong>restore_http_endpoint_config</strong> &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
2093
+
2094
+
2095
+
2096
+
2097
+
2098
+ </h3><div class="docstring">
2099
+ <div class="discussion">
2100
+
2101
+ <p>Restore the http endpoint configuration attached to this reserved domain. Only works if the @result is still present from a previous action</p>
2102
+
2103
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
2104
+
2105
+
2106
+ </div>
2107
+ </div>
2108
+ <div class="tags">
2109
+
2110
+ <p class="tag_title">Returns:</p>
2111
+ <ul class="return">
2112
+
2113
+ <li>
2114
+
2115
+
2116
+ <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
2117
+
2118
+
2119
+
2120
+ &mdash;
2121
+ <div class='inline'>
2122
+ <p>result from update request</p>
2123
+ </div>
2124
+
2125
+ </li>
2126
+
2127
+ </ul>
2128
+
2129
+ </div><table class="source_code">
2130
+ <tr>
2131
+ <td>
2132
+ <pre class="lines">
2133
+
2134
+
2135
+ 187
2136
+ 188
2137
+ 189
2138
+ 190
2139
+ 191
2140
+ 192
2141
+ 193</pre>
2142
+ </td>
2143
+ <td>
2144
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 187</span>
2145
+
2146
+ <span class='kw'>def</span> <span class='id identifier rubyid_restore_http_endpoint_config'>restore_http_endpoint_config</span>
2147
+ <span class='ivar'>@http_endpoint_configuration</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2148
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2149
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
2150
+ <span class='label'>http_endpoint_configuration_id:</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2151
+ <span class='rparen'>)</span>
2152
+ <span class='kw'>end</span></pre>
2153
+ </td>
2154
+ </tr>
2155
+ </table>
2156
+ </div>
2157
+
2158
+ <div class="method_details ">
2159
+ <h3 class="signature " id="restore_https_endpoint_config-instance_method">
2160
+
2161
+ #<strong>restore_https_endpoint_config</strong> &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+ </h3><div class="docstring">
2168
+ <div class="discussion">
2169
+
2170
+ <p>Restore the https endpoint configuration attached to this reserved domain. Only works if the @result is still present from a previous action</p>
2171
+
2172
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
2173
+
2174
+
2175
+ </div>
2176
+ </div>
2177
+ <div class="tags">
2178
+
2179
+ <p class="tag_title">Returns:</p>
2180
+ <ul class="return">
2181
+
2182
+ <li>
2183
+
2184
+
2185
+ <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
2186
+
2187
+
2188
+
2189
+ &mdash;
2190
+ <div class='inline'>
2191
+ <p>result from update request</p>
2192
+ </div>
2193
+
2194
+ </li>
2195
+
2196
+ </ul>
2197
+
2198
+ </div><table class="source_code">
2199
+ <tr>
2200
+ <td>
2201
+ <pre class="lines">
2202
+
2203
+
2204
+ 202
2205
+ 203
2206
+ 204
2207
+ 205
2208
+ 206
2209
+ 207
2210
+ 208</pre>
2211
+ </td>
2212
+ <td>
2213
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 202</span>
2214
+
2215
+ <span class='kw'>def</span> <span class='id identifier rubyid_restore_https_endpoint_config'>restore_https_endpoint_config</span>
2216
+ <span class='ivar'>@https_endpoint_configuration</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2217
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2218
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
2219
+ <span class='label'>https_endpoint_configuration_id:</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https_endpoint_configuration</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2220
+ <span class='rparen'>)</span>
2221
+ <span class='kw'>end</span></pre>
2222
+ </td>
2223
+ </tr>
2224
+ </table>
2225
+ </div>
2226
+
2227
+ <div class="method_details ">
2228
+ <h3 class="signature " id="to_s-instance_method">
2229
+
2230
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+ </h3><table class="source_code">
2237
+ <tr>
2238
+ <td>
2239
+ <pre class="lines">
2240
+
2241
+
2242
+ 46
2243
+ 47
2244
+ 48</pre>
2245
+ </td>
2246
+ <td>
2247
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 46</span>
2248
+
2249
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
2250
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
2251
+ <span class='kw'>end</span></pre>
2252
+ </td>
2253
+ </tr>
2254
+ </table>
2255
+ </div>
2256
+
2257
+ <div class="method_details ">
2258
+ <h3 class="signature " id="update-instance_method">
2259
+
2260
+ #<strong>update</strong>(certificate_id: nil, certificate_management_policy: nil, description: &#39;&#39;, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, metadata: &#39;&#39;) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
2261
+
2262
+
2263
+
2264
+
2265
+
2266
+ </h3><div class="docstring">
2267
+ <div class="discussion">
2268
+
2269
+ <p>Update the attributes of this reserved domain.</p>
2270
+
2271
+ <p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
2272
+
2273
+
2274
+ </div>
2275
+ </div>
2276
+ <div class="tags">
2277
+ <p class="tag_title">Parameters:</p>
2278
+ <ul class="param">
2279
+
2280
+ <li>
2281
+
2282
+ <span class='name'>description</span>
2283
+
2284
+
2285
+ <span class='type'>(<tt>string</tt>)</span>
2286
+
2287
+
2288
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
2289
+
2290
+
2291
+ &mdash;
2292
+ <div class='inline'>
2293
+ <p>human-readable description of what this reserved domain will be used for</p>
2294
+ </div>
2295
+
2296
+ </li>
2297
+
2298
+ <li>
2299
+
2300
+ <span class='name'>metadata</span>
2301
+
2302
+
2303
+ <span class='type'>(<tt>string</tt>)</span>
2304
+
2305
+
2306
+ <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
2307
+
2308
+
2309
+ &mdash;
2310
+ <div class='inline'>
2311
+ <p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
2312
+ </div>
2313
+
2314
+ </li>
2315
+
2316
+ <li>
2317
+
2318
+ <span class='name'>http_endpoint_configuration_id</span>
2319
+
2320
+
2321
+ <span class='type'>(<tt>string</tt>)</span>
2322
+
2323
+
2324
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2325
+
2326
+
2327
+ &mdash;
2328
+ <div class='inline'>
2329
+ <p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
2330
+ </div>
2331
+
2332
+ </li>
2333
+
2334
+ <li>
2335
+
2336
+ <span class='name'>https_endpoint_configuration_id</span>
2337
+
2338
+
2339
+ <span class='type'>(<tt>string</tt>)</span>
2340
+
2341
+
2342
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2343
+
2344
+
2345
+ &mdash;
2346
+ <div class='inline'>
2347
+ <p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
2348
+ </div>
2349
+
2350
+ </li>
2351
+
2352
+ <li>
2353
+
2354
+ <span class='name'>certificate_id</span>
2355
+
2356
+
2357
+ <span class='type'>(<tt>string</tt>)</span>
2358
+
2359
+
2360
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2361
+
2362
+
2363
+ &mdash;
2364
+ <div class='inline'>
2365
+ <p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p>
2366
+ </div>
2367
+
2368
+ </li>
2369
+
2370
+ <li>
2371
+
2372
+ <span class='name'>certificate_management_policy</span>
2373
+
2374
+
2375
+ <span class='type'>(<tt>string</tt>)</span>
2376
+
2377
+
2378
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2379
+
2380
+
2381
+ &mdash;
2382
+ <div class='inline'>
2383
+ <p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p>
2384
+ </div>
2385
+
2386
+ </li>
2387
+
2388
+ </ul>
2389
+
2390
+ <p class="tag_title">Returns:</p>
2391
+ <ul class="return">
2392
+
2393
+ <li>
2394
+
2395
+
2396
+ <span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
2397
+
2398
+
2399
+
2400
+ &mdash;
2401
+ <div class='inline'>
2402
+ <p>result from update request</p>
2403
+ </div>
2404
+
2405
+ </li>
2406
+
2407
+ </ul>
2408
+
2409
+ </div><table class="source_code">
2410
+ <tr>
2411
+ <td>
2412
+ <pre class="lines">
2413
+
2414
+
2415
+ 74
2416
+ 75
2417
+ 76
2418
+ 77
2419
+ 78
2420
+ 79
2421
+ 80
2422
+ 81
2423
+ 82
2424
+ 83
2425
+ 84
2426
+ 85
2427
+ 86
2428
+ 87
2429
+ 88
2430
+ 89
2431
+ 90
2432
+ 91
2433
+ 92
2434
+ 93
2435
+ 94
2436
+ 95
2437
+ 96
2438
+ 97
2439
+ 98
2440
+ 99
2441
+ 100
2442
+ 101
2443
+ 102
2444
+ 103
2445
+ 104</pre>
2446
+ </td>
2447
+ <td>
2448
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 74</span>
2449
+
2450
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2451
+ <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2452
+ <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2453
+ <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>
2454
+ <span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2455
+ <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2456
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
2457
+ <span class='rparen'>)</span>
2458
+ <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
2459
+ <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
2460
+ <span class='kw'>end</span>
2461
+ <span class='ivar'>@description</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>
2462
+ <span class='ivar'>@metadata</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>
2463
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
2464
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
2465
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
2466
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
2467
+ <span class='label'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
2468
+ <span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
2469
+ <span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
2470
+ <span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
2471
+ <span class='rparen'>)</span>
2472
+ <span class='comment'># TODO: update @certificate, etc?
2473
+ </span> <span class='comment'># @certificate = new_result[&#39;certificate&#39;] if certificate_id &amp;&amp; new_result[&#39;certificate&#39;]
2474
+ </span> <span class='comment'># if http_endpoint_configuration_id
2475
+ </span> <span class='comment'># @http_endpoint_configuration_id = http_endpoint_configuration_id
2476
+ </span> <span class='comment'># end
2477
+ </span> <span class='comment'># if https_endpoint_configuration_id
2478
+ </span> <span class='comment'># @https_endpoint_configuration_id = https_endpoint_configuration_id
2479
+ </span> <span class='comment'># end
2480
+ </span><span class='kw'>end</span></pre>
2481
+ </td>
2482
+ </tr>
2483
+ </table>
2484
+ </div>
2485
+
2486
+ </div>
2487
+
2488
+ </div>
2489
+
2490
+ <div id="footer">
2491
+ Generated on Fri Sep 24 19:20:29 2021 by
2492
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2493
+ 0.9.26 (ruby-3.0.1).
2494
+ </div>
2495
+
2496
+ </div>
2497
+ </body>
2498
+ </html>