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/EndpointConfigurationsClient.html ADDED
@@ -0,0 +1,2201 @@
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::EndpointConfigurationsClient
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::EndpointConfigurationsClient";
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 (E)</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">EndpointConfigurationsClient</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::EndpointConfigurationsClient
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::EndpointConfigurationsClient</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/endpoint_configurations_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 endpoint_configuration API</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</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'>endpoint_configurations</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 endpoint configurations</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'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
+
156
+ </dl>
157
+
158
+
159
+
160
+
161
+
162
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
163
+ <ul class="summary">
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+ <span class="note title readonly">readonly</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Returns the value of attribute client.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+ <h2>
201
+ Instance Method Summary
202
+ <small><a href="#" class="summary_toggle">collapse</a></small>
203
+ </h2>
204
+
205
+ <ul class="summary">
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &#39;&#39;, metadata: &#39;&#39;, type: &#39;&#39;, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Create a new endpoint configuration.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: nil) &#x21d2; nil </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Delete an endpoint configuration.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: nil) &#x21d2; nil </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>Delete an endpoint configuration.</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::EndpointConfiguration </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>Returns detailed information about an endpoint configuration 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::EndpointConfiguration </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>Returns detailed information about an endpoint configuration 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; EndpointConfigurationsClient </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 EndpointConfigurationsClient.</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>Returns a list of all endpoint configurations 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, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </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>Updates an endpoint configuration.</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, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </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>Updates an endpoint configuration.</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::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</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 EndpointConfigurationsClient.</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/endpoint_configurations_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/endpoint_configurations_client.rb', line 15</span>
511
+
512
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
513
+ <span class='ivar'>@client</span>
514
+ <span class='kw'>end</span></pre>
515
+ </td>
516
+ </tr>
517
+ </table>
518
+ </div>
519
+
520
+ </div>
521
+
522
+
523
+ <div id="instance_method_details" class="method_details_list">
524
+ <h2>Instance Method Details</h2>
525
+
526
+
527
+ <div class="method_details first">
528
+ <h3 class="signature first" id="create-instance_method">
529
+
530
+ #<strong>create</strong>(description: &#39;&#39;, metadata: &#39;&#39;, type: &#39;&#39;, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
531
+
532
+
533
+
534
+
535
+
536
+ </h3><div class="docstring">
537
+ <div class="discussion">
538
+
539
+ <p>Create a new endpoint configuration</p>
540
+
541
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-create">ngrok.com/docs/api#api-endpoint-configurations-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 what this endpoint configuration will be do when applied or what traffic it will be applied to. 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 endpoint configuration. Optional, max 4096 bytes.</p>
582
+ </div>
583
+
584
+ </li>
585
+
586
+ <li>
587
+
588
+ <span class='name'>type</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>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ <li>
605
+
606
+ <span class='name'>circuit_breaker</span>
607
+
608
+
609
+ <span class='type'>(<tt>string</tt>)</span>
610
+
611
+
612
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>circuit breaker module configuration</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ <li>
623
+
624
+ <span class='name'>compression</span>
625
+
626
+
627
+ <span class='type'>(<tt>string</tt>)</span>
628
+
629
+
630
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
631
+
632
+
633
+ &mdash;
634
+ <div class='inline'>
635
+ <p>compression module configuration</p>
636
+ </div>
637
+
638
+ </li>
639
+
640
+ <li>
641
+
642
+ <span class='name'>request_headers</span>
643
+
644
+
645
+ <span class='type'>(<tt>string</tt>)</span>
646
+
647
+
648
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
649
+
650
+
651
+ &mdash;
652
+ <div class='inline'>
653
+ <p>request headers module configuration</p>
654
+ </div>
655
+
656
+ </li>
657
+
658
+ <li>
659
+
660
+ <span class='name'>response_headers</span>
661
+
662
+
663
+ <span class='type'>(<tt>string</tt>)</span>
664
+
665
+
666
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
667
+
668
+
669
+ &mdash;
670
+ <div class='inline'>
671
+ <p>response headers module configuration</p>
672
+ </div>
673
+
674
+ </li>
675
+
676
+ <li>
677
+
678
+ <span class='name'>ip_policy</span>
679
+
680
+
681
+ <span class='type'>(<tt>string</tt>)</span>
682
+
683
+
684
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
685
+
686
+
687
+ &mdash;
688
+ <div class='inline'>
689
+ <p>ip policy module configuration</p>
690
+ </div>
691
+
692
+ </li>
693
+
694
+ <li>
695
+
696
+ <span class='name'>mutual_tls</span>
697
+
698
+
699
+ <span class='type'>(<tt>string</tt>)</span>
700
+
701
+
702
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
703
+
704
+
705
+ &mdash;
706
+ <div class='inline'>
707
+ <p>mutual TLS module configuration</p>
708
+ </div>
709
+
710
+ </li>
711
+
712
+ <li>
713
+
714
+ <span class='name'>tls_termination</span>
715
+
716
+
717
+ <span class='type'>(<tt>string</tt>)</span>
718
+
719
+
720
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
721
+
722
+
723
+ &mdash;
724
+ <div class='inline'>
725
+ <p>TLS termination module configuration</p>
726
+ </div>
727
+
728
+ </li>
729
+
730
+ <li>
731
+
732
+ <span class='name'>webhook_validation</span>
733
+
734
+
735
+ <span class='type'>(<tt>string</tt>)</span>
736
+
737
+
738
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
739
+
740
+
741
+ &mdash;
742
+ <div class='inline'>
743
+ <p>webhook validation module configuration</p>
744
+ </div>
745
+
746
+ </li>
747
+
748
+ <li>
749
+
750
+ <span class='name'>oauth</span>
751
+
752
+
753
+ <span class='type'>(<tt>string</tt>)</span>
754
+
755
+
756
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
757
+
758
+
759
+ &mdash;
760
+ <div class='inline'>
761
+ <p>oauth module configuration</p>
762
+ </div>
763
+
764
+ </li>
765
+
766
+ <li>
767
+
768
+ <span class='name'>logging</span>
769
+
770
+
771
+ <span class='type'>(<tt>string</tt>)</span>
772
+
773
+
774
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
775
+
776
+
777
+ &mdash;
778
+ <div class='inline'>
779
+ <p>logging module configuration</p>
780
+ </div>
781
+
782
+ </li>
783
+
784
+ <li>
785
+
786
+ <span class='name'>saml</span>
787
+
788
+
789
+ <span class='type'>(<tt>string</tt>)</span>
790
+
791
+
792
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
793
+
794
+
795
+ &mdash;
796
+ <div class='inline'>
797
+ <p>saml module configuration</p>
798
+ </div>
799
+
800
+ </li>
801
+
802
+ <li>
803
+
804
+ <span class='name'>oidc</span>
805
+
806
+
807
+ <span class='type'>(<tt>string</tt>)</span>
808
+
809
+
810
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
811
+
812
+
813
+ &mdash;
814
+ <div class='inline'>
815
+ <p>oidc module configuration</p>
816
+ </div>
817
+
818
+ </li>
819
+
820
+ </ul>
821
+
822
+ <p class="tag_title">Returns:</p>
823
+ <ul class="return">
824
+
825
+ <li>
826
+
827
+
828
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
829
+
830
+
831
+
832
+ &mdash;
833
+ <div class='inline'>
834
+ <p>result from create request</p>
835
+ </div>
836
+
837
+ </li>
838
+
839
+ </ul>
840
+
841
+ </div><table class="source_code">
842
+ <tr>
843
+ <td>
844
+ <pre class="lines">
845
+
846
+
847
+ 44
848
+ 45
849
+ 46
850
+ 47
851
+ 48
852
+ 49
853
+ 50
854
+ 51
855
+ 52
856
+ 53
857
+ 54
858
+ 55
859
+ 56
860
+ 57
861
+ 58
862
+ 59
863
+ 60
864
+ 61
865
+ 62
866
+ 63
867
+ 64
868
+ 65
869
+ 66
870
+ 67
871
+ 68
872
+ 69
873
+ 70
874
+ 71
875
+ 72
876
+ 73
877
+ 74
878
+ 75
879
+ 76
880
+ 77
881
+ 78
882
+ 79
883
+ 80</pre>
884
+ </td>
885
+ <td>
886
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 44</span>
887
+
888
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
889
+ <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>
890
+ <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>
891
+ <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
892
+ <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
893
+ <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
894
+ <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
895
+ <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
896
+ <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
897
+ <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
898
+ <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
899
+ <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
900
+ <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
901
+ <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
902
+ <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
903
+ <span class='label'>oidc:</span> <span class='kw'>nil</span>
904
+ <span class='rparen'>)</span>
905
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
906
+ <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
907
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
908
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
909
+ <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
910
+ <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
911
+ <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
912
+ <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
913
+ <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
914
+ <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
915
+ <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
916
+ <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
917
+ <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
918
+ <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
919
+ <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
920
+ <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span><span class='comma'>,</span>
921
+ <span class='rbrace'>}</span>
922
+ <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::EndpointConfigurationsClient::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>
923
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
924
+ <span class='kw'>end</span></pre>
925
+ </td>
926
+ </tr>
927
+ </table>
928
+ </div>
929
+
930
+ <div class="method_details ">
931
+ <h3 class="signature " id="delete-instance_method">
932
+
933
+ #<strong>delete</strong>(id: nil) &#x21d2; <tt>nil</tt>
934
+
935
+
936
+
937
+
938
+
939
+ </h3><div class="docstring">
940
+ <div class="discussion">
941
+
942
+ <p>Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</p>
943
+
944
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
945
+
946
+
947
+ </div>
948
+ </div>
949
+ <div class="tags">
950
+ <p class="tag_title">Parameters:</p>
951
+ <ul class="param">
952
+
953
+ <li>
954
+
955
+ <span class='name'>id</span>
956
+
957
+
958
+ <span class='type'>(<tt>string</tt>)</span>
959
+
960
+
961
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
962
+
963
+
964
+ &mdash;
965
+ <div class='inline'>
966
+ <p>a resource identifier</p>
967
+ </div>
968
+
969
+ </li>
970
+
971
+ </ul>
972
+
973
+ <p class="tag_title">Returns:</p>
974
+ <ul class="return">
975
+
976
+ <li>
977
+
978
+
979
+ <span class='type'>(<tt>nil</tt>)</span>
980
+
981
+
982
+
983
+ &mdash;
984
+ <div class='inline'>
985
+ <p>result from delete request</p>
986
+ </div>
987
+
988
+ </li>
989
+
990
+ </ul>
991
+
992
+ </div><table class="source_code">
993
+ <tr>
994
+ <td>
995
+ <pre class="lines">
996
+
997
+
998
+ 92
999
+ 93
1000
+ 94</pre>
1001
+ </td>
1002
+ <td>
1003
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 92</span>
1004
+
1005
+ <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>
1006
+ <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::EndpointConfigurationsClient::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>
1007
+ <span class='kw'>end</span></pre>
1008
+ </td>
1009
+ </tr>
1010
+ </table>
1011
+ </div>
1012
+
1013
+ <div class="method_details ">
1014
+ <h3 class="signature " id="delete!-instance_method">
1015
+
1016
+ #<strong>delete!</strong>(id: nil) &#x21d2; <tt>nil</tt>
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+ </h3><div class="docstring">
1023
+ <div class="discussion">
1024
+
1025
+ <p>Delete an endpoint configuration. Throw an exception if 404. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</p>
1026
+
1027
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
1028
+
1029
+
1030
+ </div>
1031
+ </div>
1032
+ <div class="tags">
1033
+ <p class="tag_title">Parameters:</p>
1034
+ <ul class="param">
1035
+
1036
+ <li>
1037
+
1038
+ <span class='name'>id</span>
1039
+
1040
+
1041
+ <span class='type'>(<tt>string</tt>)</span>
1042
+
1043
+
1044
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1045
+
1046
+
1047
+ &mdash;
1048
+ <div class='inline'>
1049
+ <p>a resource identifier</p>
1050
+ </div>
1051
+
1052
+ </li>
1053
+
1054
+ </ul>
1055
+
1056
+ <p class="tag_title">Returns:</p>
1057
+ <ul class="return">
1058
+
1059
+ <li>
1060
+
1061
+
1062
+ <span class='type'>(<tt>nil</tt>)</span>
1063
+
1064
+
1065
+
1066
+ &mdash;
1067
+ <div class='inline'>
1068
+ <p>result from delete request</p>
1069
+ </div>
1070
+
1071
+ </li>
1072
+
1073
+ </ul>
1074
+
1075
+ </div><table class="source_code">
1076
+ <tr>
1077
+ <td>
1078
+ <pre class="lines">
1079
+
1080
+
1081
+ 105
1082
+ 106
1083
+ 107</pre>
1084
+ </td>
1085
+ <td>
1086
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 105</span>
1087
+
1088
+ <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>
1089
+ <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::EndpointConfigurationsClient::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>
1090
+ <span class='kw'>end</span></pre>
1091
+ </td>
1092
+ </tr>
1093
+ </table>
1094
+ </div>
1095
+
1096
+ <div class="method_details ">
1097
+ <h3 class="signature " id="get-instance_method">
1098
+
1099
+ #<strong>get</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+ </h3><div class="docstring">
1106
+ <div class="discussion">
1107
+
1108
+ <p>Returns detailed information about an endpoint configuration by ID.</p>
1109
+
1110
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
1111
+
1112
+
1113
+ </div>
1114
+ </div>
1115
+ <div class="tags">
1116
+ <p class="tag_title">Parameters:</p>
1117
+ <ul class="param">
1118
+
1119
+ <li>
1120
+
1121
+ <span class='name'>id</span>
1122
+
1123
+
1124
+ <span class='type'>(<tt>string</tt>)</span>
1125
+
1126
+
1127
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1128
+
1129
+
1130
+ &mdash;
1131
+ <div class='inline'>
1132
+ <p>a resource identifier</p>
1133
+ </div>
1134
+
1135
+ </li>
1136
+
1137
+ </ul>
1138
+
1139
+ <p class="tag_title">Returns:</p>
1140
+ <ul class="return">
1141
+
1142
+ <li>
1143
+
1144
+
1145
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
1146
+
1147
+
1148
+
1149
+ &mdash;
1150
+ <div class='inline'>
1151
+ <p>result from get request</p>
1152
+ </div>
1153
+
1154
+ </li>
1155
+
1156
+ </ul>
1157
+
1158
+ </div><table class="source_code">
1159
+ <tr>
1160
+ <td>
1161
+ <pre class="lines">
1162
+
1163
+
1164
+ 116
1165
+ 117
1166
+ 118
1167
+ 119</pre>
1168
+ </td>
1169
+ <td>
1170
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 116</span>
1171
+
1172
+ <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>
1173
+ <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::EndpointConfigurationsClient::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>
1174
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
1175
+ <span class='kw'>end</span></pre>
1176
+ </td>
1177
+ </tr>
1178
+ </table>
1179
+ </div>
1180
+
1181
+ <div class="method_details ">
1182
+ <h3 class="signature " id="get!-instance_method">
1183
+
1184
+ #<strong>get!</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+ </h3><div class="docstring">
1191
+ <div class="discussion">
1192
+
1193
+ <p>Returns detailed information about an endpoint configuration by ID. Throw an execption if 404.</p>
1194
+
1195
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
1196
+
1197
+
1198
+ </div>
1199
+ </div>
1200
+ <div class="tags">
1201
+ <p class="tag_title">Parameters:</p>
1202
+ <ul class="param">
1203
+
1204
+ <li>
1205
+
1206
+ <span class='name'>id</span>
1207
+
1208
+
1209
+ <span class='type'>(<tt>string</tt>)</span>
1210
+
1211
+
1212
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1213
+
1214
+
1215
+ &mdash;
1216
+ <div class='inline'>
1217
+ <p>a resource identifier</p>
1218
+ </div>
1219
+
1220
+ </li>
1221
+
1222
+ </ul>
1223
+
1224
+ <p class="tag_title">Returns:</p>
1225
+ <ul class="return">
1226
+
1227
+ <li>
1228
+
1229
+
1230
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
1231
+
1232
+
1233
+
1234
+ &mdash;
1235
+ <div class='inline'>
1236
+ <p>result from get request</p>
1237
+ </div>
1238
+
1239
+ </li>
1240
+
1241
+ </ul>
1242
+
1243
+ </div><table class="source_code">
1244
+ <tr>
1245
+ <td>
1246
+ <pre class="lines">
1247
+
1248
+
1249
+ 128
1250
+ 129
1251
+ 130
1252
+ 131</pre>
1253
+ </td>
1254
+ <td>
1255
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 128</span>
1256
+
1257
+ <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>
1258
+ <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::EndpointConfigurationsClient::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>
1259
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
1260
+ <span class='kw'>end</span></pre>
1261
+ </td>
1262
+ </tr>
1263
+ </table>
1264
+ </div>
1265
+
1266
+ <div class="method_details ">
1267
+ <h3 class="signature " id="list-instance_method">
1268
+
1269
+ #<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>
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+ </h3><div class="docstring">
1276
+ <div class="discussion">
1277
+
1278
+ <p>Returns a list of all endpoint configurations on this account.</p>
1279
+
1280
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
1281
+
1282
+
1283
+ </div>
1284
+ </div>
1285
+ <div class="tags">
1286
+ <p class="tag_title">Parameters:</p>
1287
+ <ul class="param">
1288
+
1289
+ <li>
1290
+
1291
+ <span class='name'>before_id</span>
1292
+
1293
+
1294
+ <span class='type'>(<tt>string</tt>)</span>
1295
+
1296
+
1297
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1298
+
1299
+
1300
+ </li>
1301
+
1302
+ <li>
1303
+
1304
+ <span class='name'>limit</span>
1305
+
1306
+
1307
+ <span class='type'>(<tt>integer</tt>)</span>
1308
+
1309
+
1310
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1311
+
1312
+
1313
+ </li>
1314
+
1315
+ <li>
1316
+
1317
+ <span class='name'>url</span>
1318
+
1319
+
1320
+ <span class='type'>(<tt>string</tt>)</span>
1321
+
1322
+
1323
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1324
+
1325
+
1326
+ &mdash;
1327
+ <div class='inline'>
1328
+ <p>optional and mutually exclusive from before_id and limit</p>
1329
+ </div>
1330
+
1331
+ </li>
1332
+
1333
+ </ul>
1334
+
1335
+ <p class="tag_title">Returns:</p>
1336
+ <ul class="return">
1337
+
1338
+ <li>
1339
+
1340
+
1341
+ <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>
1342
+
1343
+
1344
+
1345
+ &mdash;
1346
+ <div class='inline'>
1347
+ <p>the result listable</p>
1348
+ </div>
1349
+
1350
+ </li>
1351
+
1352
+ </ul>
1353
+
1354
+ </div><table class="source_code">
1355
+ <tr>
1356
+ <td>
1357
+ <pre class="lines">
1358
+
1359
+
1360
+ 142
1361
+ 143
1362
+ 144
1363
+ 145
1364
+ 146
1365
+ 147
1366
+ 148
1367
+ 149
1368
+ 150</pre>
1369
+ </td>
1370
+ <td>
1371
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 142</span>
1372
+
1373
+ <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>
1374
+ <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::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='rparen'>)</span>
1375
+ <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>
1376
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1377
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1378
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1379
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span>
1380
+ <span class='rparen'>)</span>
1381
+ <span class='kw'>end</span></pre>
1382
+ </td>
1383
+ </tr>
1384
+ </table>
1385
+ </div>
1386
+
1387
+ <div class="method_details ">
1388
+ <h3 class="signature " id="update-instance_method">
1389
+
1390
+ #<strong>update</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+ </h3><div class="docstring">
1397
+ <div class="discussion">
1398
+
1399
+ <p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
1400
+
1401
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
1402
+
1403
+
1404
+ </div>
1405
+ </div>
1406
+ <div class="tags">
1407
+ <p class="tag_title">Parameters:</p>
1408
+ <ul class="param">
1409
+
1410
+ <li>
1411
+
1412
+ <span class='name'>id</span>
1413
+
1414
+
1415
+ <span class='type'>(<tt>string</tt>)</span>
1416
+
1417
+
1418
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1419
+
1420
+
1421
+ &mdash;
1422
+ <div class='inline'>
1423
+ <p>unique identifier of this endpoint configuration</p>
1424
+ </div>
1425
+
1426
+ </li>
1427
+
1428
+ <li>
1429
+
1430
+ <span class='name'>description</span>
1431
+
1432
+
1433
+ <span class='type'>(<tt>string</tt>)</span>
1434
+
1435
+
1436
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1437
+
1438
+
1439
+ &mdash;
1440
+ <div class='inline'>
1441
+ <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
1442
+ </div>
1443
+
1444
+ </li>
1445
+
1446
+ <li>
1447
+
1448
+ <span class='name'>metadata</span>
1449
+
1450
+
1451
+ <span class='type'>(<tt>string</tt>)</span>
1452
+
1453
+
1454
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1455
+
1456
+
1457
+ &mdash;
1458
+ <div class='inline'>
1459
+ <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
1460
+ </div>
1461
+
1462
+ </li>
1463
+
1464
+ <li>
1465
+
1466
+ <span class='name'>circuit_breaker</span>
1467
+
1468
+
1469
+ <span class='type'>(<tt>string</tt>)</span>
1470
+
1471
+
1472
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1473
+
1474
+
1475
+ &mdash;
1476
+ <div class='inline'>
1477
+ <p>circuit breaker module configuration</p>
1478
+ </div>
1479
+
1480
+ </li>
1481
+
1482
+ <li>
1483
+
1484
+ <span class='name'>compression</span>
1485
+
1486
+
1487
+ <span class='type'>(<tt>string</tt>)</span>
1488
+
1489
+
1490
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1491
+
1492
+
1493
+ &mdash;
1494
+ <div class='inline'>
1495
+ <p>compression module configuration</p>
1496
+ </div>
1497
+
1498
+ </li>
1499
+
1500
+ <li>
1501
+
1502
+ <span class='name'>request_headers</span>
1503
+
1504
+
1505
+ <span class='type'>(<tt>string</tt>)</span>
1506
+
1507
+
1508
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1509
+
1510
+
1511
+ &mdash;
1512
+ <div class='inline'>
1513
+ <p>request headers module configuration</p>
1514
+ </div>
1515
+
1516
+ </li>
1517
+
1518
+ <li>
1519
+
1520
+ <span class='name'>response_headers</span>
1521
+
1522
+
1523
+ <span class='type'>(<tt>string</tt>)</span>
1524
+
1525
+
1526
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1527
+
1528
+
1529
+ &mdash;
1530
+ <div class='inline'>
1531
+ <p>response headers module configuration</p>
1532
+ </div>
1533
+
1534
+ </li>
1535
+
1536
+ <li>
1537
+
1538
+ <span class='name'>ip_policy</span>
1539
+
1540
+
1541
+ <span class='type'>(<tt>string</tt>)</span>
1542
+
1543
+
1544
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1545
+
1546
+
1547
+ &mdash;
1548
+ <div class='inline'>
1549
+ <p>ip policy module configuration</p>
1550
+ </div>
1551
+
1552
+ </li>
1553
+
1554
+ <li>
1555
+
1556
+ <span class='name'>mutual_tls</span>
1557
+
1558
+
1559
+ <span class='type'>(<tt>string</tt>)</span>
1560
+
1561
+
1562
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1563
+
1564
+
1565
+ &mdash;
1566
+ <div class='inline'>
1567
+ <p>mutual TLS module configuration</p>
1568
+ </div>
1569
+
1570
+ </li>
1571
+
1572
+ <li>
1573
+
1574
+ <span class='name'>tls_termination</span>
1575
+
1576
+
1577
+ <span class='type'>(<tt>string</tt>)</span>
1578
+
1579
+
1580
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1581
+
1582
+
1583
+ &mdash;
1584
+ <div class='inline'>
1585
+ <p>TLS termination module configuration</p>
1586
+ </div>
1587
+
1588
+ </li>
1589
+
1590
+ <li>
1591
+
1592
+ <span class='name'>webhook_validation</span>
1593
+
1594
+
1595
+ <span class='type'>(<tt>string</tt>)</span>
1596
+
1597
+
1598
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1599
+
1600
+
1601
+ &mdash;
1602
+ <div class='inline'>
1603
+ <p>webhook validation module configuration</p>
1604
+ </div>
1605
+
1606
+ </li>
1607
+
1608
+ <li>
1609
+
1610
+ <span class='name'>oauth</span>
1611
+
1612
+
1613
+ <span class='type'>(<tt>string</tt>)</span>
1614
+
1615
+
1616
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1617
+
1618
+
1619
+ &mdash;
1620
+ <div class='inline'>
1621
+ <p>oauth module configuration</p>
1622
+ </div>
1623
+
1624
+ </li>
1625
+
1626
+ <li>
1627
+
1628
+ <span class='name'>logging</span>
1629
+
1630
+
1631
+ <span class='type'>(<tt>string</tt>)</span>
1632
+
1633
+
1634
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1635
+
1636
+
1637
+ &mdash;
1638
+ <div class='inline'>
1639
+ <p>logging module configuration</p>
1640
+ </div>
1641
+
1642
+ </li>
1643
+
1644
+ <li>
1645
+
1646
+ <span class='name'>saml</span>
1647
+
1648
+
1649
+ <span class='type'>(<tt>string</tt>)</span>
1650
+
1651
+
1652
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1653
+
1654
+
1655
+ &mdash;
1656
+ <div class='inline'>
1657
+ <p>saml module configuration</p>
1658
+ </div>
1659
+
1660
+ </li>
1661
+
1662
+ <li>
1663
+
1664
+ <span class='name'>oidc</span>
1665
+
1666
+
1667
+ <span class='type'>(<tt>string</tt>)</span>
1668
+
1669
+
1670
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1671
+
1672
+
1673
+ &mdash;
1674
+ <div class='inline'>
1675
+ <p>oidc module configuration</p>
1676
+ </div>
1677
+
1678
+ </li>
1679
+
1680
+ </ul>
1681
+
1682
+ <p class="tag_title">Returns:</p>
1683
+ <ul class="return">
1684
+
1685
+ <li>
1686
+
1687
+
1688
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
1689
+
1690
+
1691
+
1692
+ &mdash;
1693
+ <div class='inline'>
1694
+ <p>result from update request</p>
1695
+ </div>
1696
+
1697
+ </li>
1698
+
1699
+ </ul>
1700
+
1701
+ </div><table class="source_code">
1702
+ <tr>
1703
+ <td>
1704
+ <pre class="lines">
1705
+
1706
+
1707
+ 177
1708
+ 178
1709
+ 179
1710
+ 180
1711
+ 181
1712
+ 182
1713
+ 183
1714
+ 184
1715
+ 185
1716
+ 186
1717
+ 187
1718
+ 188
1719
+ 189
1720
+ 190
1721
+ 191
1722
+ 192
1723
+ 193
1724
+ 194
1725
+ 195
1726
+ 196
1727
+ 197
1728
+ 198
1729
+ 199
1730
+ 200
1731
+ 201
1732
+ 202
1733
+ 203
1734
+ 204
1735
+ 205
1736
+ 206
1737
+ 207
1738
+ 208
1739
+ 209
1740
+ 210
1741
+ 211
1742
+ 212</pre>
1743
+ </td>
1744
+ <td>
1745
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 177</span>
1746
+
1747
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1748
+ <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1749
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1750
+ <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1751
+ <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1752
+ <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1753
+ <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1754
+ <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1755
+ <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1756
+ <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1757
+ <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1758
+ <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1759
+ <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1760
+ <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1761
+ <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1762
+ <span class='label'>oidc:</span> <span class='kw'>nil</span>
1763
+ <span class='rparen'>)</span>
1764
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
1765
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
1766
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
1767
+ <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
1768
+ <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
1769
+ <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
1770
+ <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
1771
+ <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
1772
+ <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
1773
+ <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
1774
+ <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
1775
+ <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
1776
+ <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
1777
+ <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
1778
+ <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span>
1779
+ <span class='rparen'>)</span>
1780
+ <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::EndpointConfigurationsClient::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>
1781
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
1782
+ <span class='kw'>end</span></pre>
1783
+ </td>
1784
+ </tr>
1785
+ </table>
1786
+ </div>
1787
+
1788
+ <div class="method_details ">
1789
+ <h3 class="signature " id="update!-instance_method">
1790
+
1791
+ #<strong>update!</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+ </h3><div class="docstring">
1798
+ <div class="discussion">
1799
+
1800
+ <p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throw an exception if 404.</p>
1801
+
1802
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
1803
+
1804
+
1805
+ </div>
1806
+ </div>
1807
+ <div class="tags">
1808
+ <p class="tag_title">Parameters:</p>
1809
+ <ul class="param">
1810
+
1811
+ <li>
1812
+
1813
+ <span class='name'>id</span>
1814
+
1815
+
1816
+ <span class='type'>(<tt>string</tt>)</span>
1817
+
1818
+
1819
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1820
+
1821
+
1822
+ &mdash;
1823
+ <div class='inline'>
1824
+ <p>unique identifier of this endpoint configuration</p>
1825
+ </div>
1826
+
1827
+ </li>
1828
+
1829
+ <li>
1830
+
1831
+ <span class='name'>description</span>
1832
+
1833
+
1834
+ <span class='type'>(<tt>string</tt>)</span>
1835
+
1836
+
1837
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1838
+
1839
+
1840
+ &mdash;
1841
+ <div class='inline'>
1842
+ <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
1843
+ </div>
1844
+
1845
+ </li>
1846
+
1847
+ <li>
1848
+
1849
+ <span class='name'>metadata</span>
1850
+
1851
+
1852
+ <span class='type'>(<tt>string</tt>)</span>
1853
+
1854
+
1855
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1856
+
1857
+
1858
+ &mdash;
1859
+ <div class='inline'>
1860
+ <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
1861
+ </div>
1862
+
1863
+ </li>
1864
+
1865
+ <li>
1866
+
1867
+ <span class='name'>circuit_breaker</span>
1868
+
1869
+
1870
+ <span class='type'>(<tt>string</tt>)</span>
1871
+
1872
+
1873
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1874
+
1875
+
1876
+ &mdash;
1877
+ <div class='inline'>
1878
+ <p>circuit breaker module configuration</p>
1879
+ </div>
1880
+
1881
+ </li>
1882
+
1883
+ <li>
1884
+
1885
+ <span class='name'>compression</span>
1886
+
1887
+
1888
+ <span class='type'>(<tt>string</tt>)</span>
1889
+
1890
+
1891
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1892
+
1893
+
1894
+ &mdash;
1895
+ <div class='inline'>
1896
+ <p>compression module configuration</p>
1897
+ </div>
1898
+
1899
+ </li>
1900
+
1901
+ <li>
1902
+
1903
+ <span class='name'>request_headers</span>
1904
+
1905
+
1906
+ <span class='type'>(<tt>string</tt>)</span>
1907
+
1908
+
1909
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1910
+
1911
+
1912
+ &mdash;
1913
+ <div class='inline'>
1914
+ <p>request headers module configuration</p>
1915
+ </div>
1916
+
1917
+ </li>
1918
+
1919
+ <li>
1920
+
1921
+ <span class='name'>response_headers</span>
1922
+
1923
+
1924
+ <span class='type'>(<tt>string</tt>)</span>
1925
+
1926
+
1927
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1928
+
1929
+
1930
+ &mdash;
1931
+ <div class='inline'>
1932
+ <p>response headers module configuration</p>
1933
+ </div>
1934
+
1935
+ </li>
1936
+
1937
+ <li>
1938
+
1939
+ <span class='name'>ip_policy</span>
1940
+
1941
+
1942
+ <span class='type'>(<tt>string</tt>)</span>
1943
+
1944
+
1945
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1946
+
1947
+
1948
+ &mdash;
1949
+ <div class='inline'>
1950
+ <p>ip policy module configuration</p>
1951
+ </div>
1952
+
1953
+ </li>
1954
+
1955
+ <li>
1956
+
1957
+ <span class='name'>mutual_tls</span>
1958
+
1959
+
1960
+ <span class='type'>(<tt>string</tt>)</span>
1961
+
1962
+
1963
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1964
+
1965
+
1966
+ &mdash;
1967
+ <div class='inline'>
1968
+ <p>mutual TLS module configuration</p>
1969
+ </div>
1970
+
1971
+ </li>
1972
+
1973
+ <li>
1974
+
1975
+ <span class='name'>tls_termination</span>
1976
+
1977
+
1978
+ <span class='type'>(<tt>string</tt>)</span>
1979
+
1980
+
1981
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1982
+
1983
+
1984
+ &mdash;
1985
+ <div class='inline'>
1986
+ <p>TLS termination module configuration</p>
1987
+ </div>
1988
+
1989
+ </li>
1990
+
1991
+ <li>
1992
+
1993
+ <span class='name'>webhook_validation</span>
1994
+
1995
+
1996
+ <span class='type'>(<tt>string</tt>)</span>
1997
+
1998
+
1999
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2000
+
2001
+
2002
+ &mdash;
2003
+ <div class='inline'>
2004
+ <p>webhook validation module configuration</p>
2005
+ </div>
2006
+
2007
+ </li>
2008
+
2009
+ <li>
2010
+
2011
+ <span class='name'>oauth</span>
2012
+
2013
+
2014
+ <span class='type'>(<tt>string</tt>)</span>
2015
+
2016
+
2017
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2018
+
2019
+
2020
+ &mdash;
2021
+ <div class='inline'>
2022
+ <p>oauth module configuration</p>
2023
+ </div>
2024
+
2025
+ </li>
2026
+
2027
+ <li>
2028
+
2029
+ <span class='name'>logging</span>
2030
+
2031
+
2032
+ <span class='type'>(<tt>string</tt>)</span>
2033
+
2034
+
2035
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2036
+
2037
+
2038
+ &mdash;
2039
+ <div class='inline'>
2040
+ <p>logging module configuration</p>
2041
+ </div>
2042
+
2043
+ </li>
2044
+
2045
+ <li>
2046
+
2047
+ <span class='name'>saml</span>
2048
+
2049
+
2050
+ <span class='type'>(<tt>string</tt>)</span>
2051
+
2052
+
2053
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2054
+
2055
+
2056
+ &mdash;
2057
+ <div class='inline'>
2058
+ <p>saml module configuration</p>
2059
+ </div>
2060
+
2061
+ </li>
2062
+
2063
+ <li>
2064
+
2065
+ <span class='name'>oidc</span>
2066
+
2067
+
2068
+ <span class='type'>(<tt>string</tt>)</span>
2069
+
2070
+
2071
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2072
+
2073
+
2074
+ &mdash;
2075
+ <div class='inline'>
2076
+ <p>oidc module configuration</p>
2077
+ </div>
2078
+
2079
+ </li>
2080
+
2081
+ </ul>
2082
+
2083
+ <p class="tag_title">Returns:</p>
2084
+ <ul class="return">
2085
+
2086
+ <li>
2087
+
2088
+
2089
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>)</span>
2090
+
2091
+
2092
+
2093
+ &mdash;
2094
+ <div class='inline'>
2095
+ <p>result from update request</p>
2096
+ </div>
2097
+
2098
+ </li>
2099
+
2100
+ </ul>
2101
+
2102
+ </div><table class="source_code">
2103
+ <tr>
2104
+ <td>
2105
+ <pre class="lines">
2106
+
2107
+
2108
+ 238
2109
+ 239
2110
+ 240
2111
+ 241
2112
+ 242
2113
+ 243
2114
+ 244
2115
+ 245
2116
+ 246
2117
+ 247
2118
+ 248
2119
+ 249
2120
+ 250
2121
+ 251
2122
+ 252
2123
+ 253
2124
+ 254
2125
+ 255
2126
+ 256
2127
+ 257
2128
+ 258
2129
+ 259
2130
+ 260
2131
+ 261
2132
+ 262
2133
+ 263
2134
+ 264
2135
+ 265
2136
+ 266
2137
+ 267
2138
+ 268
2139
+ 269
2140
+ 270
2141
+ 271
2142
+ 272
2143
+ 273</pre>
2144
+ </td>
2145
+ <td>
2146
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 238</span>
2147
+
2148
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
2149
+ <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2150
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2151
+ <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2152
+ <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2153
+ <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2154
+ <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2155
+ <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2156
+ <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2157
+ <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2158
+ <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2159
+ <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2160
+ <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2161
+ <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2162
+ <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2163
+ <span class='label'>oidc:</span> <span class='kw'>nil</span>
2164
+ <span class='rparen'>)</span>
2165
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
2166
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
2167
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
2168
+ <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
2169
+ <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
2170
+ <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
2171
+ <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
2172
+ <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
2173
+ <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
2174
+ <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
2175
+ <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
2176
+ <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
2177
+ <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
2178
+ <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
2179
+ <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span>
2180
+ <span class='rparen'>)</span>
2181
+ <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::EndpointConfigurationsClient::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>
2182
+ <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
2183
+ <span class='kw'>end</span></pre>
2184
+ </td>
2185
+ </tr>
2186
+ </table>
2187
+ </div>
2188
+
2189
+ </div>
2190
+
2191
+ </div>
2192
+
2193
+ <div id="footer">
2194
+ Generated on Fri Sep 24 19:20:29 2021 by
2195
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2196
+ 0.9.26 (ruby-3.0.1).
2197
+ </div>
2198
+
2199
+ </div>
2200
+ </body>
2201
+ </html>