ngrok-api 0.14.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (396) 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/CNAME +1 -0
  136. data/docs/NgrokAPI/Client.html +325 -267
  137. data/docs/NgrokAPI/Error.html +3 -3
  138. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  139. data/docs/NgrokAPI/Errors.html +3 -3
  140. data/docs/NgrokAPI/HttpClient.html +30 -36
  141. data/docs/NgrokAPI/Models/APIKey.html +3 -3
  142. data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
  143. data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
  144. data/docs/NgrokAPI/Models/AWSRole.html +3 -3
  145. data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
  146. data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  147. data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
  148. data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
  149. data/docs/NgrokAPI/Models/Credential.html +3 -3
  150. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  151. data/docs/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
  152. data/{doc/NgrokAPI/Models/EndpointLoggingMutate.html → docs/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
  153. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  154. data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
  155. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  156. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  157. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  158. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  159. data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
  160. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  161. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  162. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  163. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  164. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  165. data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
  166. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  167. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  168. data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
  169. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  170. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  171. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  172. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  173. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  174. data/docs/NgrokAPI/Models/EventDestination.html +7 -7
  175. data/docs/NgrokAPI/Models/EventSource.html +3 -3
  176. data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
  177. data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
  178. data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
  179. data/docs/NgrokAPI/Models/EventTarget.html +3 -3
  180. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  181. data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  182. data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  183. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  184. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  185. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +119 -119
  186. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
  187. data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
  188. data/docs/NgrokAPI/Models/IPPolicyRule.html +97 -23
  189. data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
  190. data/docs/NgrokAPI/Models/Listable.html +3 -3
  191. data/docs/NgrokAPI/Models/Ref.html +3 -3
  192. data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
  193. data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
  194. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  195. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  196. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  197. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  198. data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
  199. data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  200. data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  201. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  202. data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
  203. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  204. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  205. data/docs/NgrokAPI/Models/Tunnel.html +314 -18
  206. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  207. data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
  208. data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
  209. data/docs/NgrokAPI/Models.html +5 -5
  210. data/docs/NgrokAPI/PagedIterator.html +3 -3
  211. data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
  212. data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  213. data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  214. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  215. data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
  216. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  217. data/{doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
  218. data/docs/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
  219. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  220. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  221. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  222. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  223. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
  224. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  225. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
  226. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  227. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
  228. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
  229. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  230. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  231. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  232. data/docs/NgrokAPI/Services/EventDestinationsClient.html +119 -187
  233. data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
  234. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
  235. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  236. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  237. data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +101 -129
  238. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
  239. data/docs/NgrokAPI/Services/IPPoliciesClient.html +114 -184
  240. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
  241. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
  242. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
  243. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
  244. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  245. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  246. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  247. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  248. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
  249. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  250. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  251. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
  252. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  253. data/{doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
  254. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
  255. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  256. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  257. data/docs/NgrokAPI/Services/TunnelsClient.html +252 -26
  258. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  259. data/docs/NgrokAPI/Services.html +5 -5
  260. data/docs/NgrokAPI.html +4 -4
  261. data/docs/_index.html +253 -76
  262. data/docs/class_list.html +1 -1
  263. data/docs/file.README.html +3 -3
  264. data/docs/frames.html +1 -1
  265. data/docs/index.html +3 -3
  266. data/docs/method_list.html +3559 -1583
  267. data/docs/top-level-namespace.html +3 -3
  268. data/lib/ngrokapi/client.rb +52 -37
  269. data/lib/ngrokapi/http_client.rb +1 -4
  270. data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
  271. data/lib/ngrokapi/models/endpoint.rb +49 -0
  272. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  273. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  274. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  275. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  276. data/lib/ngrokapi/models/event_destination.rb +1 -2
  277. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  278. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  279. data/lib/ngrokapi/models/https_edge.rb +80 -0
  280. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  281. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  282. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  283. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  284. data/lib/ngrokapi/models/tunnel.rb +9 -1
  285. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  286. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  287. data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
  288. data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
  289. data/lib/ngrokapi/services/api_keys_client.rb +11 -36
  290. data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
  291. data/lib/ngrokapi/services/credentials_client.rb +11 -39
  292. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  293. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -39
  294. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -39
  295. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  296. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → edge_route_o_auth_module_client.rb} +37 -39
  297. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb} +37 -39
  298. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb} +37 -39
  299. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -39
  300. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb} +37 -39
  301. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -39
  302. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  303. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  304. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  305. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  306. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  307. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  308. data/lib/ngrokapi/services/event_destinations_client.rb +13 -49
  309. data/lib/ngrokapi/services/event_sources_client.rb +9 -40
  310. data/lib/ngrokapi/services/event_subscriptions_client.rb +14 -45
  311. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  312. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  313. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +108 -0
  314. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +108 -0
  315. data/lib/ngrokapi/services/ip_policies_client.rb +11 -39
  316. data/lib/ngrokapi/services/ip_policy_rules_client.rb +13 -40
  317. data/lib/ngrokapi/services/ip_restrictions_client.rb +12 -44
  318. data/lib/ngrokapi/services/reserved_addrs_client.rb +11 -81
  319. data/lib/ngrokapi/services/reserved_domains_client.rb +15 -144
  320. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
  321. data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
  322. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
  323. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
  324. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +31 -45
  325. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -35
  326. data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
  327. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +108 -0
  328. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +108 -0
  329. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -35
  330. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -35
  331. data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb} +70 -93
  332. data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
  333. data/lib/ngrokapi/services/tunnels_client.rb +39 -10
  334. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  335. data/lib/ngrokapi/version.rb +1 -1
  336. data/lib/ngrokapi.rb +1 -1
  337. data/ngrok-api.gemspec +1 -1
  338. data/spec/ngrokapi/client_spec.rb +50 -29
  339. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  340. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  341. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  342. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  343. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  344. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  345. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  346. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  347. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  348. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  349. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  350. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  351. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  352. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  353. data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
  354. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  355. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  356. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  357. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  358. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  359. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  360. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  361. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  362. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  363. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  364. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  365. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  366. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  367. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  368. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  369. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  370. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  371. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  372. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  373. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  374. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  375. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  376. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  377. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  378. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  379. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  380. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  381. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  382. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  383. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  384. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  385. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  386. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  387. data/spec/spec_helper.rb +1389 -1045
  388. metadata +176 -83
  389. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -357
  390. data/lib/ngrokapi/services/event_streams_client.rb +0 -259
  391. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  392. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  393. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  394. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  395. data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +0 -42
  396. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -0,0 +1,907 @@
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::EndpointsClient
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::Services::EndpointsClient";
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">EndpointsClient</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::EndpointsClient
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::EndpointsClient</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/endpoints_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-endpoints">ngrok.com/docs/api#api-endpoints</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'>endpoints</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 the requests</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'>/endpoints</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="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Endpoint </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>Get the status of an endpoint by ID.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Endpoint </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>Get the status of an endpoint by ID Throws an exception if API error.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; EndpointsClient </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+ <span class="note title constructor">constructor</span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+ <span class="summary_desc"><div class='inline'>
275
+ <p>A new instance of EndpointsClient.</p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ <li class="public ">
282
+ <span class="summary_signature">
283
+
284
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
285
+
286
+
287
+
288
+ </span>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+ <span class="summary_desc"><div class='inline'>
299
+ <p>List all active endpoints on the account.</p>
300
+ </div></span>
301
+
302
+ </li>
303
+
304
+
305
+ <li class="public ">
306
+ <span class="summary_signature">
307
+
308
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
309
+
310
+
311
+
312
+ </span>
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+ <span class="summary_desc"><div class='inline'>
323
+ <p>List all active endpoints on the account Throws an exception if API error.</p>
324
+ </div></span>
325
+
326
+ </li>
327
+
328
+
329
+ </ul>
330
+
331
+
332
+ <div id="constructor_details" class="method_details_list">
333
+ <h2>Constructor Details</h2>
334
+
335
+ <div class="method_details first">
336
+ <h3 class="signature first" id="initialize-instance_method">
337
+
338
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EndpointsClient (class)">EndpointsClient</a></span></tt>
339
+
340
+
341
+
342
+
343
+
344
+ </h3><div class="docstring">
345
+ <div class="discussion">
346
+
347
+ <p>Returns a new instance of EndpointsClient.</p>
348
+
349
+
350
+ </div>
351
+ </div>
352
+ <div class="tags">
353
+
354
+
355
+ </div><table class="source_code">
356
+ <tr>
357
+ <td>
358
+ <pre class="lines">
359
+
360
+
361
+ 19
362
+ 20
363
+ 21</pre>
364
+ </td>
365
+ <td>
366
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 19</span>
367
+
368
+ <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>
369
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
370
+ <span class='kw'>end</span></pre>
371
+ </td>
372
+ </tr>
373
+ </table>
374
+ </div>
375
+
376
+ </div>
377
+
378
+ <div id="instance_attr_details" class="attr_details">
379
+ <h2>Instance Attribute Details</h2>
380
+
381
+
382
+ <span id=""></span>
383
+ <div class="method_details first">
384
+ <h3 class="signature first" id="client-instance_method">
385
+
386
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
387
+
388
+
389
+
390
+
391
+
392
+ </h3><div class="docstring">
393
+ <div class="discussion">
394
+
395
+ <p>Returns the value of attribute client.</p>
396
+
397
+
398
+ </div>
399
+ </div>
400
+ <div class="tags">
401
+
402
+
403
+ </div><table class="source_code">
404
+ <tr>
405
+ <td>
406
+ <pre class="lines">
407
+
408
+
409
+ 17
410
+ 18
411
+ 19</pre>
412
+ </td>
413
+ <td>
414
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 17</span>
415
+
416
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
417
+ <span class='ivar'>@client</span>
418
+ <span class='kw'>end</span></pre>
419
+ </td>
420
+ </tr>
421
+ </table>
422
+ </div>
423
+
424
+ </div>
425
+
426
+
427
+ <div id="instance_method_details" class="method_details_list">
428
+ <h2>Instance Method Details</h2>
429
+
430
+
431
+ <div class="method_details first">
432
+ <h3 class="signature first" id="get-instance_method">
433
+
434
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
435
+
436
+
437
+
438
+
439
+
440
+ </h3><div class="docstring">
441
+ <div class="discussion">
442
+
443
+ <p>Get the status of an endpoint by ID</p>
444
+
445
+ <p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
446
+
447
+
448
+ </div>
449
+ </div>
450
+ <div class="tags">
451
+ <p class="tag_title">Parameters:</p>
452
+ <ul class="param">
453
+
454
+ <li>
455
+
456
+ <span class='name'>id</span>
457
+
458
+
459
+ <span class='type'>(<tt>string</tt>)</span>
460
+
461
+
462
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
463
+
464
+
465
+ &mdash;
466
+ <div class='inline'>
467
+ <p>a resource identifier</p>
468
+ </div>
469
+
470
+ </li>
471
+
472
+ </ul>
473
+
474
+ <p class="tag_title">Returns:</p>
475
+ <ul class="return">
476
+
477
+ <li>
478
+
479
+
480
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
481
+
482
+
483
+
484
+ &mdash;
485
+ <div class='inline'>
486
+ <p>result from the API request</p>
487
+ </div>
488
+
489
+ </li>
490
+
491
+ </ul>
492
+
493
+ </div><table class="source_code">
494
+ <tr>
495
+ <td>
496
+ <pre class="lines">
497
+
498
+
499
+ 85
500
+ 86
501
+ 87
502
+ 88
503
+ 89
504
+ 90
505
+ 91
506
+ 92
507
+ 93</pre>
508
+ </td>
509
+ <td>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 85</span>
511
+
512
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
513
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>&#39;</span></span>
514
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
515
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
516
+ <span class='rbrace'>}</span>
517
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
518
+ <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='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
519
+ <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/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#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>
520
+ <span class='kw'>end</span></pre>
521
+ </td>
522
+ </tr>
523
+ </table>
524
+ </div>
525
+
526
+ <div class="method_details ">
527
+ <h3 class="signature " id="get!-instance_method">
528
+
529
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
530
+
531
+
532
+
533
+
534
+
535
+ </h3><div class="docstring">
536
+ <div class="discussion">
537
+
538
+ <p>Get the status of an endpoint by ID Throws an exception if API error.</p>
539
+
540
+ <p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
541
+
542
+
543
+ </div>
544
+ </div>
545
+ <div class="tags">
546
+ <p class="tag_title">Parameters:</p>
547
+ <ul class="param">
548
+
549
+ <li>
550
+
551
+ <span class='name'>id</span>
552
+
553
+
554
+ <span class='type'>(<tt>string</tt>)</span>
555
+
556
+
557
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
558
+
559
+
560
+ &mdash;
561
+ <div class='inline'>
562
+ <p>a resource identifier</p>
563
+ </div>
564
+
565
+ </li>
566
+
567
+ </ul>
568
+
569
+ <p class="tag_title">Returns:</p>
570
+ <ul class="return">
571
+
572
+ <li>
573
+
574
+
575
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
576
+
577
+
578
+
579
+ &mdash;
580
+ <div class='inline'>
581
+ <p>result from the API request</p>
582
+ </div>
583
+
584
+ </li>
585
+
586
+ </ul>
587
+
588
+ </div><table class="source_code">
589
+ <tr>
590
+ <td>
591
+ <pre class="lines">
592
+
593
+
594
+ 103
595
+ 104
596
+ 105
597
+ 106
598
+ 107
599
+ 108
600
+ 109
601
+ 110
602
+ 111</pre>
603
+ </td>
604
+ <td>
605
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 103</span>
606
+
607
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
608
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>&#39;</span></span>
609
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
610
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
611
+ <span class='rbrace'>}</span>
612
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
613
+ <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='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
614
+ <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/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#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>
615
+ <span class='kw'>end</span></pre>
616
+ </td>
617
+ </tr>
618
+ </table>
619
+ </div>
620
+
621
+ <div class="method_details ">
622
+ <h3 class="signature " id="list-instance_method">
623
+
624
+ #<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>
625
+
626
+
627
+
628
+
629
+
630
+ </h3><div class="docstring">
631
+ <div class="discussion">
632
+
633
+ <p>List all active endpoints on the account</p>
634
+
635
+ <p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
636
+
637
+
638
+ </div>
639
+ </div>
640
+ <div class="tags">
641
+ <p class="tag_title">Parameters:</p>
642
+ <ul class="param">
643
+
644
+ <li>
645
+
646
+ <span class='name'>before_id</span>
647
+
648
+
649
+ <span class='type'>(<tt>string</tt>)</span>
650
+
651
+
652
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
653
+
654
+
655
+ </li>
656
+
657
+ <li>
658
+
659
+ <span class='name'>limit</span>
660
+
661
+
662
+ <span class='type'>(<tt>string</tt>)</span>
663
+
664
+
665
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
666
+
667
+
668
+ </li>
669
+
670
+ <li>
671
+
672
+ <span class='name'>url</span>
673
+
674
+
675
+ <span class='type'>(<tt>string</tt>)</span>
676
+
677
+
678
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
679
+
680
+
681
+ &mdash;
682
+ <div class='inline'>
683
+ <p>optional and mutually exclusive from before_id and limit</p>
684
+ </div>
685
+
686
+ </li>
687
+
688
+ </ul>
689
+
690
+ <p class="tag_title">Returns:</p>
691
+ <ul class="return">
692
+
693
+ <li>
694
+
695
+
696
+ <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>
697
+
698
+
699
+
700
+ &mdash;
701
+ <div class='inline'>
702
+ <p>result from the API request</p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ </ul>
708
+
709
+ </div><table class="source_code">
710
+ <tr>
711
+ <td>
712
+ <pre class="lines">
713
+
714
+
715
+ 32
716
+ 33
717
+ 34
718
+ 35
719
+ 36
720
+ 37
721
+ 38
722
+ 39
723
+ 40
724
+ 41
725
+ 42
726
+ 43
727
+ 44
728
+ 45
729
+ 46
730
+ 47</pre>
731
+ </td>
732
+ <td>
733
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 32</span>
734
+
735
+ <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>
736
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
737
+ <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>
738
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
739
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
740
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
741
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
742
+ <span class='rparen'>)</span>
743
+
744
+ <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>
745
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
746
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
747
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
748
+ <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/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span>
749
+ <span class='rparen'>)</span>
750
+ <span class='kw'>end</span></pre>
751
+ </td>
752
+ </tr>
753
+ </table>
754
+ </div>
755
+
756
+ <div class="method_details ">
757
+ <h3 class="signature " id="list!-instance_method">
758
+
759
+ #<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>
760
+
761
+
762
+
763
+
764
+
765
+ </h3><div class="docstring">
766
+ <div class="discussion">
767
+
768
+ <p>List all active endpoints on the account Throws an exception if API error.</p>
769
+
770
+ <p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
771
+
772
+
773
+ </div>
774
+ </div>
775
+ <div class="tags">
776
+ <p class="tag_title">Parameters:</p>
777
+ <ul class="param">
778
+
779
+ <li>
780
+
781
+ <span class='name'>before_id</span>
782
+
783
+
784
+ <span class='type'>(<tt>string</tt>)</span>
785
+
786
+
787
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
788
+
789
+
790
+ </li>
791
+
792
+ <li>
793
+
794
+ <span class='name'>limit</span>
795
+
796
+
797
+ <span class='type'>(<tt>string</tt>)</span>
798
+
799
+
800
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
801
+
802
+
803
+ </li>
804
+
805
+ <li>
806
+
807
+ <span class='name'>url</span>
808
+
809
+
810
+ <span class='type'>(<tt>string</tt>)</span>
811
+
812
+
813
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
814
+
815
+
816
+ &mdash;
817
+ <div class='inline'>
818
+ <p>optional and mutually exclusive from before_id and limit</p>
819
+ </div>
820
+
821
+ </li>
822
+
823
+ </ul>
824
+
825
+ <p class="tag_title">Returns:</p>
826
+ <ul class="return">
827
+
828
+ <li>
829
+
830
+
831
+ <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>
832
+
833
+
834
+
835
+ &mdash;
836
+ <div class='inline'>
837
+ <p>result from the API request</p>
838
+ </div>
839
+
840
+ </li>
841
+
842
+ </ul>
843
+
844
+ </div><table class="source_code">
845
+ <tr>
846
+ <td>
847
+ <pre class="lines">
848
+
849
+
850
+ 59
851
+ 60
852
+ 61
853
+ 62
854
+ 63
855
+ 64
856
+ 65
857
+ 66
858
+ 67
859
+ 68
860
+ 69
861
+ 70
862
+ 71
863
+ 72
864
+ 73
865
+ 74
866
+ 75
867
+ 76</pre>
868
+ </td>
869
+ <td>
870
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 59</span>
871
+
872
+ <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>
873
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
874
+ <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>
875
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
876
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
877
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
878
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
879
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
880
+ <span class='rparen'>)</span>
881
+
882
+ <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>
883
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
884
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
885
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
886
+ <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/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='comma'>,</span>
887
+ <span class='label'>danger:</span> <span class='kw'>true</span>
888
+ <span class='rparen'>)</span>
889
+ <span class='kw'>end</span></pre>
890
+ </td>
891
+ </tr>
892
+ </table>
893
+ </div>
894
+
895
+ </div>
896
+
897
+ </div>
898
+
899
+ <div id="footer">
900
+ Generated on Thu Mar 10 04:54:50 2022 by
901
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
902
+ 0.9.27 (ruby-2.7.5).
903
+ </div>
904
+
905
+ </div>
906
+ </body>
907
+ </html>