ngrok-api 0.15.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (395) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -1
  3. data/doc/NgrokAPI/Client.html +325 -267
  4. data/doc/NgrokAPI/Error.html +3 -3
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
  6. data/doc/NgrokAPI/Errors.html +3 -3
  7. data/doc/NgrokAPI/HttpClient.html +30 -36
  8. data/doc/NgrokAPI/Models/APIKey.html +3 -3
  9. data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
  11. data/doc/NgrokAPI/Models/AWSRole.html +3 -3
  12. data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  14. data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
  16. data/doc/NgrokAPI/Models/Credential.html +3 -3
  17. data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
  18. data/doc/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
  19. data/{docs/NgrokAPI/Models/EndpointLoggingMutate.html → doc/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
  20. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  21. data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  38. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  39. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  40. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  41. data/doc/NgrokAPI/Models/EventDestination.html +7 -7
  42. data/doc/NgrokAPI/Models/EventSource.html +3 -3
  43. data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
  45. data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
  46. data/doc/NgrokAPI/Models/EventTarget.html +3 -3
  47. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  48. data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  49. data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  50. data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
  51. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  52. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +119 -119
  53. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
  54. data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
  55. data/doc/NgrokAPI/Models/IPPolicyRule.html +97 -23
  56. data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
  57. data/doc/NgrokAPI/Models/Listable.html +3 -3
  58. data/doc/NgrokAPI/Models/Ref.html +3 -3
  59. data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
  60. data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
  61. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  62. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  63. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  64. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  65. data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
  66. data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  67. data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  68. data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
  69. data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
  70. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  71. data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
  72. data/doc/NgrokAPI/Models/Tunnel.html +314 -18
  73. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  74. data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
  75. data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
  76. data/doc/NgrokAPI/Models.html +5 -5
  77. data/doc/NgrokAPI/PagedIterator.html +3 -3
  78. data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
  79. data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  80. data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  81. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  82. data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
  83. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  84. data/{docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
  85. data/doc/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
  86. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  87. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  88. data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +177 -95
  89. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  90. data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
  91. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +177 -95
  92. data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
  93. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  94. data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
  95. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
  96. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  97. data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  98. data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
  99. data/doc/NgrokAPI/Services/EventDestinationsClient.html +119 -187
  100. data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
  101. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
  102. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  103. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  104. data/doc/NgrokAPI/Services/{EndpointSAMLModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +101 -129
  105. data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
  106. data/doc/NgrokAPI/Services/IPPoliciesClient.html +114 -184
  107. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
  108. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
  109. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
  110. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
  111. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  112. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  113. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  114. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  115. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
  116. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html} +83 -111
  117. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  118. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
  119. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TLSEdgeIPRestrictionModuleClient.html} +83 -111
  120. data/{docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
  121. data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
  122. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  123. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  124. data/doc/NgrokAPI/Services/TunnelsClient.html +252 -26
  125. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  126. data/doc/NgrokAPI/Services.html +5 -5
  127. data/doc/NgrokAPI.html +4 -4
  128. data/doc/_index.html +253 -76
  129. data/doc/class_list.html +1 -1
  130. data/doc/file.README.html +3 -3
  131. data/doc/frames.html +1 -1
  132. data/doc/index.html +3 -3
  133. data/doc/method_list.html +3559 -1583
  134. data/doc/top-level-namespace.html +3 -3
  135. data/docs/NgrokAPI/Client.html +325 -267
  136. data/docs/NgrokAPI/Error.html +3 -3
  137. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  138. data/docs/NgrokAPI/Errors.html +3 -3
  139. data/docs/NgrokAPI/HttpClient.html +30 -36
  140. data/docs/NgrokAPI/Models/APIKey.html +3 -3
  141. data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
  142. data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
  143. data/docs/NgrokAPI/Models/AWSRole.html +3 -3
  144. data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
  145. data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  146. data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
  147. data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
  148. data/docs/NgrokAPI/Models/Credential.html +3 -3
  149. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  150. data/docs/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
  151. data/{doc/NgrokAPI/Models/EndpointLoggingMutate.html → docs/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
  152. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  153. data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
  154. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  155. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  156. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  157. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  158. data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
  159. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  160. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  161. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  162. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  163. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  164. data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
  165. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  166. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  167. data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
  168. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  169. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  170. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  171. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  172. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  173. data/docs/NgrokAPI/Models/EventDestination.html +7 -7
  174. data/docs/NgrokAPI/Models/EventSource.html +3 -3
  175. data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
  176. data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
  177. data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
  178. data/docs/NgrokAPI/Models/EventTarget.html +3 -3
  179. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  180. data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  181. data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  182. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  183. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  184. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +119 -119
  185. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
  186. data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
  187. data/docs/NgrokAPI/Models/IPPolicyRule.html +97 -23
  188. data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
  189. data/docs/NgrokAPI/Models/Listable.html +3 -3
  190. data/docs/NgrokAPI/Models/Ref.html +3 -3
  191. data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
  192. data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
  193. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  194. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  195. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  196. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  197. data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
  198. data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  199. data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  200. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  201. data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
  202. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  203. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  204. data/docs/NgrokAPI/Models/Tunnel.html +314 -18
  205. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  206. data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
  207. data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
  208. data/docs/NgrokAPI/Models.html +5 -5
  209. data/docs/NgrokAPI/PagedIterator.html +3 -3
  210. data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
  211. data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  212. data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  213. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  214. data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
  215. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  216. data/{doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
  217. data/docs/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
  218. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  219. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  220. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  221. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  222. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
  223. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  224. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
  225. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  226. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
  227. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
  228. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  229. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  230. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  231. data/docs/NgrokAPI/Services/EventDestinationsClient.html +119 -187
  232. data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
  233. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
  234. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  235. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  236. data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +101 -129
  237. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
  238. data/docs/NgrokAPI/Services/IPPoliciesClient.html +114 -184
  239. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
  240. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
  241. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
  242. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
  243. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  244. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  245. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  246. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  247. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
  248. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  249. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  250. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
  251. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  252. data/{doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
  253. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
  254. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  255. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  256. data/docs/NgrokAPI/Services/TunnelsClient.html +252 -26
  257. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  258. data/docs/NgrokAPI/Services.html +5 -5
  259. data/docs/NgrokAPI.html +4 -4
  260. data/docs/_index.html +253 -76
  261. data/docs/class_list.html +1 -1
  262. data/docs/file.README.html +3 -3
  263. data/docs/frames.html +1 -1
  264. data/docs/index.html +3 -3
  265. data/docs/method_list.html +3559 -1583
  266. data/docs/top-level-namespace.html +3 -3
  267. data/lib/ngrokapi/client.rb +52 -37
  268. data/lib/ngrokapi/http_client.rb +1 -4
  269. data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
  270. data/lib/ngrokapi/models/endpoint.rb +49 -0
  271. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  272. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  273. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  274. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  275. data/lib/ngrokapi/models/event_destination.rb +1 -2
  276. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  277. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  278. data/lib/ngrokapi/models/https_edge.rb +80 -0
  279. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  280. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  281. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  282. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  283. data/lib/ngrokapi/models/tunnel.rb +9 -1
  284. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  285. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  286. data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
  287. data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
  288. data/lib/ngrokapi/services/api_keys_client.rb +11 -36
  289. data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
  290. data/lib/ngrokapi/services/credentials_client.rb +11 -39
  291. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  292. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -39
  293. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -39
  294. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  295. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → edge_route_o_auth_module_client.rb} +37 -39
  296. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb} +37 -39
  297. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb} +37 -39
  298. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -39
  299. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb} +37 -39
  300. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -39
  301. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  302. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  303. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  304. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  305. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  306. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  307. data/lib/ngrokapi/services/event_destinations_client.rb +13 -49
  308. data/lib/ngrokapi/services/event_sources_client.rb +9 -40
  309. data/lib/ngrokapi/services/event_subscriptions_client.rb +14 -45
  310. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  311. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  312. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +108 -0
  313. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +108 -0
  314. data/lib/ngrokapi/services/ip_policies_client.rb +11 -39
  315. data/lib/ngrokapi/services/ip_policy_rules_client.rb +13 -40
  316. data/lib/ngrokapi/services/ip_restrictions_client.rb +12 -44
  317. data/lib/ngrokapi/services/reserved_addrs_client.rb +11 -81
  318. data/lib/ngrokapi/services/reserved_domains_client.rb +15 -144
  319. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
  320. data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
  321. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
  322. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
  323. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +31 -45
  324. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -35
  325. data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
  326. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +108 -0
  327. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +108 -0
  328. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -35
  329. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -35
  330. data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb} +70 -93
  331. data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
  332. data/lib/ngrokapi/services/tunnels_client.rb +39 -10
  333. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  334. data/lib/ngrokapi/version.rb +1 -1
  335. data/lib/ngrokapi.rb +1 -1
  336. data/ngrok-api.gemspec +1 -1
  337. data/spec/ngrokapi/client_spec.rb +50 -29
  338. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  339. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  340. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  341. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  342. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  343. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  344. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  345. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  346. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  347. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  348. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  349. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  350. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  351. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  352. data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
  353. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  354. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  355. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  356. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  357. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  358. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  359. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  360. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  361. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  362. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  363. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  364. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  365. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  366. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  367. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  368. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  369. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  370. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  371. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  372. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  373. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  374. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  375. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  376. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  377. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  378. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  379. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  380. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  381. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  382. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  383. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  384. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  385. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  386. data/spec/spec_helper.rb +1389 -1045
  387. metadata +175 -83
  388. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -357
  389. data/lib/ngrokapi/services/event_streams_client.rb +0 -259
  390. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  391. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  392. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  393. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  394. data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +0 -42
  395. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -0,0 +1,1149 @@
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::TunnelGroupBackend
8
+
9
+ &mdash; Documentation by YARD 0.9.27
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::TunnelGroupBackend";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (T)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
41
+ &raquo;
42
+ <span class="title">TunnelGroupBackend</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::TunnelGroupBackend
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::TunnelGroupBackend</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/tunnel_group_backend.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+
103
+
104
+
105
+
106
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
107
+ <ul class="summary">
108
+
109
+ <li class="public ">
110
+ <span class="summary_signature">
111
+
112
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
113
+
114
+
115
+
116
+ </span>
117
+
118
+
119
+
120
+
121
+ <span class="note title readonly">readonly</span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Returns the value of attribute client.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+ <span class="note title readonly">readonly</span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>Returns the value of attribute created_at.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> &#x21d2; Object </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+
178
+
179
+ <span class="note title readonly">readonly</span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'>
190
+ <p>Returns the value of attribute description.</p>
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+ <span class="note title readonly">readonly</span>
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <span class="summary_desc"><div class='inline'>
219
+ <p>Returns the value of attribute id.</p>
220
+ </div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#labels-instance_method" title="#labels (instance method)">#<strong>labels</strong> &#x21d2; Object </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+
236
+
237
+ <span class="note title readonly">readonly</span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'>
248
+ <p>Returns the value of attribute labels.</p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong> &#x21d2; Object </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+
265
+
266
+ <span class="note title readonly">readonly</span>
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>Returns the value of attribute metadata.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ <li class="public ">
284
+ <span class="summary_signature">
285
+
286
+ <a href="#result-instance_method" title="#result (instance method)">#<strong>result</strong> &#x21d2; Object </a>
287
+
288
+
289
+
290
+ </span>
291
+
292
+
293
+
294
+
295
+ <span class="note title readonly">readonly</span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <span class="summary_desc"><div class='inline'>
306
+ <p>Returns the value of attribute result.</p>
307
+ </div></span>
308
+
309
+ </li>
310
+
311
+
312
+ <li class="public ">
313
+ <span class="summary_signature">
314
+
315
+ <a href="#tunnels-instance_method" title="#tunnels (instance method)">#<strong>tunnels</strong> &#x21d2; Object </a>
316
+
317
+
318
+
319
+ </span>
320
+
321
+
322
+
323
+
324
+ <span class="note title readonly">readonly</span>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <span class="summary_desc"><div class='inline'>
335
+ <p>Returns the value of attribute tunnels.</p>
336
+ </div></span>
337
+
338
+ </li>
339
+
340
+
341
+ <li class="public ">
342
+ <span class="summary_signature">
343
+
344
+ <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</strong> &#x21d2; Object </a>
345
+
346
+
347
+
348
+ </span>
349
+
350
+
351
+
352
+
353
+ <span class="note title readonly">readonly</span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'>
364
+ <p>Returns the value of attribute uri.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ </ul>
371
+
372
+
373
+
374
+
375
+
376
+ <h2>
377
+ Instance Method Summary
378
+ <small><a href="#" class="summary_toggle">collapse</a></small>
379
+ </h2>
380
+
381
+ <ul class="summary">
382
+
383
+ <li class="public ">
384
+ <span class="summary_signature">
385
+
386
+ <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Object </a>
387
+
388
+
389
+
390
+ </span>
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+ <span class="summary_desc"><div class='inline'></div></span>
401
+
402
+ </li>
403
+
404
+
405
+ <li class="public ">
406
+ <span class="summary_signature">
407
+
408
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> &#x21d2; Object </a>
409
+
410
+
411
+
412
+ </span>
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+ <span class="summary_desc"><div class='inline'>
423
+ <p>Delete a TunnelGroup backend by ID.</p>
424
+ </div></span>
425
+
426
+ </li>
427
+
428
+
429
+ <li class="public ">
430
+ <span class="summary_signature">
431
+
432
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) &#x21d2; TunnelGroupBackend </a>
433
+
434
+
435
+
436
+ </span>
437
+
438
+
439
+ <span class="note title constructor">constructor</span>
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ <span class="summary_desc"><div class='inline'>
449
+ <p>A new instance of TunnelGroupBackend.</p>
450
+ </div></span>
451
+
452
+ </li>
453
+
454
+
455
+ <li class="public ">
456
+ <span class="summary_signature">
457
+
458
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
459
+
460
+
461
+
462
+ </span>
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+ <span class="summary_desc"><div class='inline'></div></span>
473
+
474
+ </li>
475
+
476
+
477
+ <li class="public ">
478
+ <span class="summary_signature">
479
+
480
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil, labels: {}) &#x21d2; Object </a>
481
+
482
+
483
+
484
+ </span>
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+ <span class="summary_desc"><div class='inline'>
495
+ <p>Update TunnelGroup backend by ID.</p>
496
+ </div></span>
497
+
498
+ </li>
499
+
500
+
501
+ </ul>
502
+
503
+
504
+ <div id="constructor_details" class="method_details_list">
505
+ <h2>Constructor Details</h2>
506
+
507
+ <div class="method_details first">
508
+ <h3 class="signature first" id="initialize-instance_method">
509
+
510
+ #<strong>initialize</strong>(client:, result:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span></tt>
511
+
512
+
513
+
514
+
515
+
516
+ </h3><div class="docstring">
517
+ <div class="discussion">
518
+
519
+ <p>Returns a new instance of TunnelGroupBackend.</p>
520
+
521
+
522
+ </div>
523
+ </div>
524
+ <div class="tags">
525
+
526
+
527
+ </div><table class="source_code">
528
+ <tr>
529
+ <td>
530
+ <pre class="lines">
531
+
532
+
533
+ 16
534
+ 17
535
+ 18
536
+ 19
537
+ 20
538
+ 21
539
+ 22
540
+ 23
541
+ 24
542
+ 25
543
+ 26</pre>
544
+ </td>
545
+ <td>
546
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 16</span>
547
+
548
+ <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>
549
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
550
+ <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
551
+ <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>
552
+ <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>
553
+ <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>
554
+ <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>
555
+ <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>
556
+ <span class='ivar'>@labels</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'>labels</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
557
+ <span class='ivar'>@tunnels</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'>tunnels</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
558
+ <span class='kw'>end</span></pre>
559
+ </td>
560
+ </tr>
561
+ </table>
562
+ </div>
563
+
564
+ </div>
565
+
566
+ <div id="instance_attr_details" class="attr_details">
567
+ <h2>Instance Attribute Details</h2>
568
+
569
+
570
+ <span id=""></span>
571
+ <div class="method_details first">
572
+ <h3 class="signature first" id="client-instance_method">
573
+
574
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
575
+
576
+
577
+
578
+
579
+
580
+ </h3><div class="docstring">
581
+ <div class="discussion">
582
+
583
+ <p>Returns the value of attribute client.</p>
584
+
585
+
586
+ </div>
587
+ </div>
588
+ <div class="tags">
589
+
590
+
591
+ </div><table class="source_code">
592
+ <tr>
593
+ <td>
594
+ <pre class="lines">
595
+
596
+
597
+ 6
598
+ 7
599
+ 8</pre>
600
+ </td>
601
+ <td>
602
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
603
+
604
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
605
+ <span class='ivar'>@client</span>
606
+ <span class='kw'>end</span></pre>
607
+ </td>
608
+ </tr>
609
+ </table>
610
+ </div>
611
+
612
+
613
+ <span id=""></span>
614
+ <div class="method_details ">
615
+ <h3 class="signature " id="created_at-instance_method">
616
+
617
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
618
+
619
+
620
+
621
+
622
+
623
+ </h3><div class="docstring">
624
+ <div class="discussion">
625
+
626
+ <p>Returns the value of attribute created_at.</p>
627
+
628
+
629
+ </div>
630
+ </div>
631
+ <div class="tags">
632
+
633
+
634
+ </div><table class="source_code">
635
+ <tr>
636
+ <td>
637
+ <pre class="lines">
638
+
639
+
640
+ 6
641
+ 7
642
+ 8</pre>
643
+ </td>
644
+ <td>
645
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
646
+
647
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
648
+ <span class='ivar'>@created_at</span>
649
+ <span class='kw'>end</span></pre>
650
+ </td>
651
+ </tr>
652
+ </table>
653
+ </div>
654
+
655
+
656
+ <span id=""></span>
657
+ <div class="method_details ">
658
+ <h3 class="signature " id="description-instance_method">
659
+
660
+ #<strong>description</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
661
+
662
+
663
+
664
+
665
+
666
+ </h3><div class="docstring">
667
+ <div class="discussion">
668
+
669
+ <p>Returns the value of attribute description.</p>
670
+
671
+
672
+ </div>
673
+ </div>
674
+ <div class="tags">
675
+
676
+
677
+ </div><table class="source_code">
678
+ <tr>
679
+ <td>
680
+ <pre class="lines">
681
+
682
+
683
+ 6
684
+ 7
685
+ 8</pre>
686
+ </td>
687
+ <td>
688
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
689
+
690
+ <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
691
+ <span class='ivar'>@description</span>
692
+ <span class='kw'>end</span></pre>
693
+ </td>
694
+ </tr>
695
+ </table>
696
+ </div>
697
+
698
+
699
+ <span id=""></span>
700
+ <div class="method_details ">
701
+ <h3 class="signature " id="id-instance_method">
702
+
703
+ #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
704
+
705
+
706
+
707
+
708
+
709
+ </h3><div class="docstring">
710
+ <div class="discussion">
711
+
712
+ <p>Returns the value of attribute id.</p>
713
+
714
+
715
+ </div>
716
+ </div>
717
+ <div class="tags">
718
+
719
+
720
+ </div><table class="source_code">
721
+ <tr>
722
+ <td>
723
+ <pre class="lines">
724
+
725
+
726
+ 6
727
+ 7
728
+ 8</pre>
729
+ </td>
730
+ <td>
731
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
732
+
733
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
734
+ <span class='ivar'>@id</span>
735
+ <span class='kw'>end</span></pre>
736
+ </td>
737
+ </tr>
738
+ </table>
739
+ </div>
740
+
741
+
742
+ <span id=""></span>
743
+ <div class="method_details ">
744
+ <h3 class="signature " id="labels-instance_method">
745
+
746
+ #<strong>labels</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
747
+
748
+
749
+
750
+
751
+
752
+ </h3><div class="docstring">
753
+ <div class="discussion">
754
+
755
+ <p>Returns the value of attribute labels.</p>
756
+
757
+
758
+ </div>
759
+ </div>
760
+ <div class="tags">
761
+
762
+
763
+ </div><table class="source_code">
764
+ <tr>
765
+ <td>
766
+ <pre class="lines">
767
+
768
+
769
+ 6
770
+ 7
771
+ 8</pre>
772
+ </td>
773
+ <td>
774
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
775
+
776
+ <span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
777
+ <span class='ivar'>@labels</span>
778
+ <span class='kw'>end</span></pre>
779
+ </td>
780
+ </tr>
781
+ </table>
782
+ </div>
783
+
784
+
785
+ <span id=""></span>
786
+ <div class="method_details ">
787
+ <h3 class="signature " id="metadata-instance_method">
788
+
789
+ #<strong>metadata</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
790
+
791
+
792
+
793
+
794
+
795
+ </h3><div class="docstring">
796
+ <div class="discussion">
797
+
798
+ <p>Returns the value of attribute metadata.</p>
799
+
800
+
801
+ </div>
802
+ </div>
803
+ <div class="tags">
804
+
805
+
806
+ </div><table class="source_code">
807
+ <tr>
808
+ <td>
809
+ <pre class="lines">
810
+
811
+
812
+ 6
813
+ 7
814
+ 8</pre>
815
+ </td>
816
+ <td>
817
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
818
+
819
+ <span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
820
+ <span class='ivar'>@metadata</span>
821
+ <span class='kw'>end</span></pre>
822
+ </td>
823
+ </tr>
824
+ </table>
825
+ </div>
826
+
827
+
828
+ <span id=""></span>
829
+ <div class="method_details ">
830
+ <h3 class="signature " id="result-instance_method">
831
+
832
+ #<strong>result</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
833
+
834
+
835
+
836
+
837
+
838
+ </h3><div class="docstring">
839
+ <div class="discussion">
840
+
841
+ <p>Returns the value of attribute result.</p>
842
+
843
+
844
+ </div>
845
+ </div>
846
+ <div class="tags">
847
+
848
+
849
+ </div><table class="source_code">
850
+ <tr>
851
+ <td>
852
+ <pre class="lines">
853
+
854
+
855
+ 6
856
+ 7
857
+ 8</pre>
858
+ </td>
859
+ <td>
860
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
861
+
862
+ <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
863
+ <span class='ivar'>@result</span>
864
+ <span class='kw'>end</span></pre>
865
+ </td>
866
+ </tr>
867
+ </table>
868
+ </div>
869
+
870
+
871
+ <span id=""></span>
872
+ <div class="method_details ">
873
+ <h3 class="signature " id="tunnels-instance_method">
874
+
875
+ #<strong>tunnels</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
876
+
877
+
878
+
879
+
880
+
881
+ </h3><div class="docstring">
882
+ <div class="discussion">
883
+
884
+ <p>Returns the value of attribute tunnels.</p>
885
+
886
+
887
+ </div>
888
+ </div>
889
+ <div class="tags">
890
+
891
+
892
+ </div><table class="source_code">
893
+ <tr>
894
+ <td>
895
+ <pre class="lines">
896
+
897
+
898
+ 6
899
+ 7
900
+ 8</pre>
901
+ </td>
902
+ <td>
903
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
904
+
905
+ <span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
906
+ <span class='ivar'>@tunnels</span>
907
+ <span class='kw'>end</span></pre>
908
+ </td>
909
+ </tr>
910
+ </table>
911
+ </div>
912
+
913
+
914
+ <span id=""></span>
915
+ <div class="method_details ">
916
+ <h3 class="signature " id="uri-instance_method">
917
+
918
+ #<strong>uri</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
919
+
920
+
921
+
922
+
923
+
924
+ </h3><div class="docstring">
925
+ <div class="discussion">
926
+
927
+ <p>Returns the value of attribute uri.</p>
928
+
929
+
930
+ </div>
931
+ </div>
932
+ <div class="tags">
933
+
934
+
935
+ </div><table class="source_code">
936
+ <tr>
937
+ <td>
938
+ <pre class="lines">
939
+
940
+
941
+ 6
942
+ 7
943
+ 8</pre>
944
+ </td>
945
+ <td>
946
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 6</span>
947
+
948
+ <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
949
+ <span class='ivar'>@uri</span>
950
+ <span class='kw'>end</span></pre>
951
+ </td>
952
+ </tr>
953
+ </table>
954
+ </div>
955
+
956
+ </div>
957
+
958
+
959
+ <div id="instance_method_details" class="method_details_list">
960
+ <h2>Instance Method Details</h2>
961
+
962
+
963
+ <div class="method_details first">
964
+ <h3 class="signature first" id="==-instance_method">
965
+
966
+ #<strong>==</strong>(other) &#x21d2; <tt>Object</tt>
967
+
968
+
969
+
970
+
971
+
972
+ </h3><table class="source_code">
973
+ <tr>
974
+ <td>
975
+ <pre class="lines">
976
+
977
+
978
+ 28
979
+ 29
980
+ 30</pre>
981
+ </td>
982
+ <td>
983
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 28</span>
984
+
985
+ <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>
986
+ <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>
987
+ <span class='kw'>end</span></pre>
988
+ </td>
989
+ </tr>
990
+ </table>
991
+ </div>
992
+
993
+ <div class="method_details ">
994
+ <h3 class="signature " id="delete-instance_method">
995
+
996
+ #<strong>delete</strong> &#x21d2; <tt>Object</tt>
997
+
998
+
999
+
1000
+
1001
+
1002
+ </h3><div class="docstring">
1003
+ <div class="discussion">
1004
+
1005
+ <p>Delete a TunnelGroup backend by ID. TODO what if used?</p>
1006
+
1007
+ <p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-delete">ngrok.com/docs/api#api-tunnel-group-backends-delete</a></p>
1008
+
1009
+
1010
+ </div>
1011
+ </div>
1012
+ <div class="tags">
1013
+
1014
+
1015
+ </div><table class="source_code">
1016
+ <tr>
1017
+ <td>
1018
+ <pre class="lines">
1019
+
1020
+
1021
+ 40
1022
+ 41
1023
+ 42
1024
+ 43
1025
+ 44</pre>
1026
+ </td>
1027
+ <td>
1028
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 40</span>
1029
+
1030
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
1031
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
1032
+ <span class='label'>id:</span> <span class='ivar'>@id</span>
1033
+ <span class='rparen'>)</span>
1034
+ <span class='kw'>end</span></pre>
1035
+ </td>
1036
+ </tr>
1037
+ </table>
1038
+ </div>
1039
+
1040
+ <div class="method_details ">
1041
+ <h3 class="signature " id="to_s-instance_method">
1042
+
1043
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+ </h3><table class="source_code">
1050
+ <tr>
1051
+ <td>
1052
+ <pre class="lines">
1053
+
1054
+
1055
+ 32
1056
+ 33
1057
+ 34</pre>
1058
+ </td>
1059
+ <td>
1060
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 32</span>
1061
+
1062
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
1063
+ <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
1064
+ <span class='kw'>end</span></pre>
1065
+ </td>
1066
+ </tr>
1067
+ </table>
1068
+ </div>
1069
+
1070
+ <div class="method_details ">
1071
+ <h3 class="signature " id="update-instance_method">
1072
+
1073
+ #<strong>update</strong>(description: nil, metadata: nil, labels: {}) &#x21d2; <tt>Object</tt>
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+ </h3><div class="docstring">
1080
+ <div class="discussion">
1081
+
1082
+ <p>Update TunnelGroup backend by ID</p>
1083
+
1084
+ <p><a href="https://ngrok.com/docs/api#api-tunnel-group-backends-update">ngrok.com/docs/api#api-tunnel-group-backends-update</a></p>
1085
+
1086
+
1087
+ </div>
1088
+ </div>
1089
+ <div class="tags">
1090
+
1091
+
1092
+ </div><table class="source_code">
1093
+ <tr>
1094
+ <td>
1095
+ <pre class="lines">
1096
+
1097
+
1098
+ 50
1099
+ 51
1100
+ 52
1101
+ 53
1102
+ 54
1103
+ 55
1104
+ 56
1105
+ 57
1106
+ 58
1107
+ 59
1108
+ 60
1109
+ 61
1110
+ 62
1111
+ 63
1112
+ 64</pre>
1113
+ </td>
1114
+ <td>
1115
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/tunnel_group_backend.rb', line 50</span>
1116
+
1117
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1118
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1119
+ <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1120
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1121
+ <span class='rparen'>)</span>
1122
+ <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>
1123
+ <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>
1124
+ <span class='ivar'>@labels</span> <span class='op'>=</span> <span class='id identifier rubyid_labels'>labels</span> <span class='kw'>if</span> <span class='id identifier rubyid_labels'>labels</span>
1125
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1126
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
1127
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
1128
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
1129
+ <span class='label'>labels:</span> <span class='id identifier rubyid_labels'>labels</span>
1130
+ <span class='rparen'>)</span>
1131
+ <span class='kw'>end</span></pre>
1132
+ </td>
1133
+ </tr>
1134
+ </table>
1135
+ </div>
1136
+
1137
+ </div>
1138
+
1139
+ </div>
1140
+
1141
+ <div id="footer">
1142
+ Generated on Thu Mar 10 16:54:42 2022 by
1143
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1144
+ 0.9.27 (ruby-2.7.5).
1145
+ </div>
1146
+
1147
+ </div>
1148
+ </body>
1149
+ </html>