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,1153 @@
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::EdgeRouteOAuthModuleClient
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::EdgeRouteOAuthModuleClient";
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">EdgeRouteOAuthModuleClient</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::EdgeRouteOAuthModuleClient
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::EdgeRouteOAuthModuleClient</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/edge_route_o_auth_module_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module">ngrok.com/docs/api#api-edge-route-o-auth-module</a></p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+ <h2>
116
+ Constant Summary
117
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
118
+ </h2>
119
+
120
+ <dl class="constants">
121
+
122
+ <dt id="PATH-constant" class="">PATH =
123
+ <div class="docstring">
124
+ <div class="discussion">
125
+
126
+ <p>The API path for the requests</p>
127
+
128
+
129
+ </div>
130
+ </div>
131
+ <div class="tags">
132
+
133
+
134
+ </div>
135
+ </dt>
136
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span></pre></dd>
137
+
138
+ </dl>
139
+
140
+
141
+
142
+
143
+
144
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
145
+ <ul class="summary">
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+ <span class="note title readonly">readonly</span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'>
170
+ <p>Returns the value of attribute client.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ </ul>
177
+
178
+
179
+
180
+
181
+
182
+ <h2>
183
+ Instance Method Summary
184
+ <small><a href="#" class="summary_toggle">collapse</a></small>
185
+ </h2>
186
+
187
+ <ul class="summary">
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'>
207
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete">ngrok.com/docs/api#api-edge-route-o-auth-module-delete</a>.</p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+ <span class="summary_desc"><div class='inline'>
231
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete">ngrok.com/docs/api#api-edge-route-o-auth-module-delete</a>.</p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointOAuth </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'>
255
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-get">ngrok.com/docs/api#api-edge-route-o-auth-module-get</a>.</p>
256
+ </div></span>
257
+
258
+ </li>
259
+
260
+
261
+ <li class="public ">
262
+ <span class="summary_signature">
263
+
264
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointOAuth </a>
265
+
266
+
267
+
268
+ </span>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'>
279
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-get">ngrok.com/docs/api#api-edge-route-o-auth-module-get</a>.</p>
280
+ </div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; EdgeRouteOAuthModuleClient </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+ <span class="note title constructor">constructor</span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <span class="summary_desc"><div class='inline'>
305
+ <p>A new instance of EdgeRouteOAuthModuleClient.</p>
306
+ </div></span>
307
+
308
+ </li>
309
+
310
+
311
+ <li class="public ">
312
+ <span class="summary_signature">
313
+
314
+ <a href="#replace-instance_method" title="#replace (instance method)">#<strong>replace</strong>(edge_id: &quot;&quot;, id: &quot;&quot;, a_module: nil) &#x21d2; NgrokAPI::Models::EndpointOAuth </a>
315
+
316
+
317
+
318
+ </span>
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+ <span class="summary_desc"><div class='inline'>
329
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace">ngrok.com/docs/api#api-edge-route-o-auth-module-replace</a>.</p>
330
+ </div></span>
331
+
332
+ </li>
333
+
334
+
335
+ <li class="public ">
336
+ <span class="summary_signature">
337
+
338
+ <a href="#replace!-instance_method" title="#replace! (instance method)">#<strong>replace!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;, a_module: nil) &#x21d2; NgrokAPI::Models::EndpointOAuth </a>
339
+
340
+
341
+
342
+ </span>
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+ <span class="summary_desc"><div class='inline'>
353
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace">ngrok.com/docs/api#api-edge-route-o-auth-module-replace</a>.</p>
354
+ </div></span>
355
+
356
+ </li>
357
+
358
+
359
+ </ul>
360
+
361
+
362
+ <div id="constructor_details" class="method_details_list">
363
+ <h2>Constructor Details</h2>
364
+
365
+ <div class="method_details first">
366
+ <h3 class="signature first" id="initialize-instance_method">
367
+
368
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgeRouteOAuthModuleClient (class)">EdgeRouteOAuthModuleClient</a></span></tt>
369
+
370
+
371
+
372
+
373
+
374
+ </h3><div class="docstring">
375
+ <div class="discussion">
376
+
377
+ <p>Returns a new instance of EdgeRouteOAuthModuleClient.</p>
378
+
379
+
380
+ </div>
381
+ </div>
382
+ <div class="tags">
383
+
384
+
385
+ </div><table class="source_code">
386
+ <tr>
387
+ <td>
388
+ <pre class="lines">
389
+
390
+
391
+ 13
392
+ 14
393
+ 15</pre>
394
+ </td>
395
+ <td>
396
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 13</span>
397
+
398
+ <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>
399
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
400
+ <span class='kw'>end</span></pre>
401
+ </td>
402
+ </tr>
403
+ </table>
404
+ </div>
405
+
406
+ </div>
407
+
408
+ <div id="instance_attr_details" class="attr_details">
409
+ <h2>Instance Attribute Details</h2>
410
+
411
+
412
+ <span id=""></span>
413
+ <div class="method_details first">
414
+ <h3 class="signature first" id="client-instance_method">
415
+
416
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
417
+
418
+
419
+
420
+
421
+
422
+ </h3><div class="docstring">
423
+ <div class="discussion">
424
+
425
+ <p>Returns the value of attribute client.</p>
426
+
427
+
428
+ </div>
429
+ </div>
430
+ <div class="tags">
431
+
432
+
433
+ </div><table class="source_code">
434
+ <tr>
435
+ <td>
436
+ <pre class="lines">
437
+
438
+
439
+ 11
440
+ 12
441
+ 13</pre>
442
+ </td>
443
+ <td>
444
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 11</span>
445
+
446
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
447
+ <span class='ivar'>@client</span>
448
+ <span class='kw'>end</span></pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ </div>
455
+
456
+
457
+ <div id="instance_method_details" class="method_details_list">
458
+ <h2>Instance Method Details</h2>
459
+
460
+
461
+ <div class="method_details first">
462
+ <h3 class="signature first" id="delete-instance_method">
463
+
464
+ #<strong>delete</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
465
+
466
+
467
+
468
+
469
+
470
+ </h3><div class="docstring">
471
+ <div class="discussion">
472
+
473
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete">ngrok.com/docs/api#api-edge-route-o-auth-module-delete</a></p>
474
+
475
+
476
+ </div>
477
+ </div>
478
+ <div class="tags">
479
+ <p class="tag_title">Parameters:</p>
480
+ <ul class="param">
481
+
482
+ <li>
483
+
484
+ <span class='name'>edge_id</span>
485
+
486
+
487
+ <span class='type'>(<tt>string</tt>)</span>
488
+
489
+
490
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
491
+
492
+
493
+ &mdash;
494
+ <div class='inline'>
495
+ <p>unique identifier of this edge</p>
496
+ </div>
497
+
498
+ </li>
499
+
500
+ <li>
501
+
502
+ <span class='name'>id</span>
503
+
504
+
505
+ <span class='type'>(<tt>string</tt>)</span>
506
+
507
+
508
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
509
+
510
+
511
+ &mdash;
512
+ <div class='inline'>
513
+ <p>unique identifier of this edge route</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ </ul>
519
+
520
+ <p class="tag_title">Returns:</p>
521
+ <ul class="return">
522
+
523
+ <li>
524
+
525
+
526
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
527
+
528
+
529
+
530
+ &mdash;
531
+ <div class='inline'>
532
+ <p>result from the API request</p>
533
+ </div>
534
+
535
+ </li>
536
+
537
+ </ul>
538
+
539
+ </div><table class="source_code">
540
+ <tr>
541
+ <td>
542
+ <pre class="lines">
543
+
544
+
545
+ 95
546
+ 96
547
+ 97
548
+ 98
549
+ 99
550
+ 100
551
+ 101
552
+ 102</pre>
553
+ </td>
554
+ <td>
555
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 95</span>
556
+
557
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</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>
558
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
559
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
560
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
561
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
562
+ <span class='rbrace'>}</span>
563
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</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='rparen'>)</span>
564
+ <span class='kw'>end</span></pre>
565
+ </td>
566
+ </tr>
567
+ </table>
568
+ </div>
569
+
570
+ <div class="method_details ">
571
+ <h3 class="signature " id="delete!-instance_method">
572
+
573
+ #<strong>delete!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
574
+
575
+
576
+
577
+
578
+
579
+ </h3><div class="docstring">
580
+ <div class="discussion">
581
+
582
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete">ngrok.com/docs/api#api-edge-route-o-auth-module-delete</a></p>
583
+
584
+
585
+ </div>
586
+ </div>
587
+ <div class="tags">
588
+ <p class="tag_title">Parameters:</p>
589
+ <ul class="param">
590
+
591
+ <li>
592
+
593
+ <span class='name'>edge_id</span>
594
+
595
+
596
+ <span class='type'>(<tt>string</tt>)</span>
597
+
598
+
599
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
600
+
601
+
602
+ &mdash;
603
+ <div class='inline'>
604
+ <p>unique identifier of this edge</p>
605
+ </div>
606
+
607
+ </li>
608
+
609
+ <li>
610
+
611
+ <span class='name'>id</span>
612
+
613
+
614
+ <span class='type'>(<tt>string</tt>)</span>
615
+
616
+
617
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
618
+
619
+
620
+ &mdash;
621
+ <div class='inline'>
622
+ <p>unique identifier of this edge route</p>
623
+ </div>
624
+
625
+ </li>
626
+
627
+ </ul>
628
+
629
+ <p class="tag_title">Returns:</p>
630
+ <ul class="return">
631
+
632
+ <li>
633
+
634
+
635
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
636
+
637
+
638
+
639
+ &mdash;
640
+ <div class='inline'>
641
+ <p>result from the API request</p>
642
+ </div>
643
+
644
+ </li>
645
+
646
+ </ul>
647
+
648
+ </div><table class="source_code">
649
+ <tr>
650
+ <td>
651
+ <pre class="lines">
652
+
653
+
654
+ 110
655
+ 111
656
+ 112
657
+ 113
658
+ 114
659
+ 115
660
+ 116
661
+ 117</pre>
662
+ </td>
663
+ <td>
664
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 110</span>
665
+
666
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</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>
667
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
668
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
669
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
670
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
671
+ <span class='rbrace'>}</span>
672
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</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'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
673
+ <span class='kw'>end</span></pre>
674
+ </td>
675
+ </tr>
676
+ </table>
677
+ </div>
678
+
679
+ <div class="method_details ">
680
+ <h3 class="signature " id="get-instance_method">
681
+
682
+ #<strong>get</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>
683
+
684
+
685
+
686
+
687
+
688
+ </h3><div class="docstring">
689
+ <div class="discussion">
690
+
691
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-get">ngrok.com/docs/api#api-edge-route-o-auth-module-get</a></p>
692
+
693
+
694
+ </div>
695
+ </div>
696
+ <div class="tags">
697
+ <p class="tag_title">Parameters:</p>
698
+ <ul class="param">
699
+
700
+ <li>
701
+
702
+ <span class='name'>edge_id</span>
703
+
704
+
705
+ <span class='type'>(<tt>string</tt>)</span>
706
+
707
+
708
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
709
+
710
+
711
+ &mdash;
712
+ <div class='inline'>
713
+ <p>unique identifier of this edge</p>
714
+ </div>
715
+
716
+ </li>
717
+
718
+ <li>
719
+
720
+ <span class='name'>id</span>
721
+
722
+
723
+ <span class='type'>(<tt>string</tt>)</span>
724
+
725
+
726
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
727
+
728
+
729
+ &mdash;
730
+ <div class='inline'>
731
+ <p>unique identifier of this edge route</p>
732
+ </div>
733
+
734
+ </li>
735
+
736
+ </ul>
737
+
738
+ <p class="tag_title">Returns:</p>
739
+ <ul class="return">
740
+
741
+ <li>
742
+
743
+
744
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>)</span>
745
+
746
+
747
+
748
+ &mdash;
749
+ <div class='inline'>
750
+ <p>result from the API request</p>
751
+ </div>
752
+
753
+ </li>
754
+
755
+ </ul>
756
+
757
+ </div><table class="source_code">
758
+ <tr>
759
+ <td>
760
+ <pre class="lines">
761
+
762
+
763
+ 61
764
+ 62
765
+ 63
766
+ 64
767
+ 65
768
+ 66
769
+ 67
770
+ 68
771
+ 69
772
+ 70</pre>
773
+ </td>
774
+ <td>
775
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 61</span>
776
+
777
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</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>
778
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
779
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
780
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
781
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
782
+ <span class='rbrace'>}</span>
783
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
784
+ <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>
785
+ <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/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointOAuth.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuth#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>
786
+ <span class='kw'>end</span></pre>
787
+ </td>
788
+ </tr>
789
+ </table>
790
+ </div>
791
+
792
+ <div class="method_details ">
793
+ <h3 class="signature " id="get!-instance_method">
794
+
795
+ #<strong>get!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>
796
+
797
+
798
+
799
+
800
+
801
+ </h3><div class="docstring">
802
+ <div class="discussion">
803
+
804
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-get">ngrok.com/docs/api#api-edge-route-o-auth-module-get</a></p>
805
+
806
+
807
+ </div>
808
+ </div>
809
+ <div class="tags">
810
+ <p class="tag_title">Parameters:</p>
811
+ <ul class="param">
812
+
813
+ <li>
814
+
815
+ <span class='name'>edge_id</span>
816
+
817
+
818
+ <span class='type'>(<tt>string</tt>)</span>
819
+
820
+
821
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
822
+
823
+
824
+ &mdash;
825
+ <div class='inline'>
826
+ <p>unique identifier of this edge</p>
827
+ </div>
828
+
829
+ </li>
830
+
831
+ <li>
832
+
833
+ <span class='name'>id</span>
834
+
835
+
836
+ <span class='type'>(<tt>string</tt>)</span>
837
+
838
+
839
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
840
+
841
+
842
+ &mdash;
843
+ <div class='inline'>
844
+ <p>unique identifier of this edge route</p>
845
+ </div>
846
+
847
+ </li>
848
+
849
+ </ul>
850
+
851
+ <p class="tag_title">Returns:</p>
852
+ <ul class="return">
853
+
854
+ <li>
855
+
856
+
857
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>)</span>
858
+
859
+
860
+
861
+ &mdash;
862
+ <div class='inline'>
863
+ <p>result from the API request</p>
864
+ </div>
865
+
866
+ </li>
867
+
868
+ </ul>
869
+
870
+ </div><table class="source_code">
871
+ <tr>
872
+ <td>
873
+ <pre class="lines">
874
+
875
+
876
+ 78
877
+ 79
878
+ 80
879
+ 81
880
+ 82
881
+ 83
882
+ 84
883
+ 85
884
+ 86
885
+ 87</pre>
886
+ </td>
887
+ <td>
888
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 78</span>
889
+
890
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</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>
891
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
892
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
893
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
894
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
895
+ <span class='rbrace'>}</span>
896
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
897
+ <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>
898
+ <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/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointOAuth.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuth#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>
899
+ <span class='kw'>end</span></pre>
900
+ </td>
901
+ </tr>
902
+ </table>
903
+ </div>
904
+
905
+ <div class="method_details ">
906
+ <h3 class="signature " id="replace-instance_method">
907
+
908
+ #<strong>replace</strong>(edge_id: &quot;&quot;, id: &quot;&quot;, a_module: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>
909
+
910
+
911
+
912
+
913
+
914
+ </h3><div class="docstring">
915
+ <div class="discussion">
916
+
917
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace">ngrok.com/docs/api#api-edge-route-o-auth-module-replace</a></p>
918
+
919
+
920
+ </div>
921
+ </div>
922
+ <div class="tags">
923
+ <p class="tag_title">Parameters:</p>
924
+ <ul class="param">
925
+
926
+ <li>
927
+
928
+ <span class='name'>edge_id</span>
929
+
930
+
931
+ <span class='type'>(<tt>string</tt>)</span>
932
+
933
+
934
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
935
+
936
+
937
+ </li>
938
+
939
+ <li>
940
+
941
+ <span class='name'>id</span>
942
+
943
+
944
+ <span class='type'>(<tt>string</tt>)</span>
945
+
946
+
947
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
948
+
949
+
950
+ </li>
951
+
952
+ <li>
953
+
954
+ <span class='name'>a_module</span>
955
+
956
+
957
+ <span class='type'>(<tt>EndpointOAuth</tt>)</span>
958
+
959
+
960
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
961
+
962
+
963
+ </li>
964
+
965
+ </ul>
966
+
967
+ <p class="tag_title">Returns:</p>
968
+ <ul class="return">
969
+
970
+ <li>
971
+
972
+
973
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>)</span>
974
+
975
+
976
+
977
+ &mdash;
978
+ <div class='inline'>
979
+ <p>result from the API request</p>
980
+ </div>
981
+
982
+ </li>
983
+
984
+ </ul>
985
+
986
+ </div><table class="source_code">
987
+ <tr>
988
+ <td>
989
+ <pre class="lines">
990
+
991
+
992
+ 24
993
+ 25
994
+ 26
995
+ 27
996
+ 28
997
+ 29
998
+ 30
999
+ 31
1000
+ 32
1001
+ 33
1002
+ 34</pre>
1003
+ </td>
1004
+ <td>
1005
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 24</span>
1006
+
1007
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>a_module:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1008
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
1009
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1010
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
1011
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1012
+ <span class='rbrace'>}</span>
1013
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1014
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:module</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_a_module'>a_module</span> <span class='kw'>if</span> <span class='id identifier rubyid_a_module'>a_module</span>
1015
+ <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_put'>put</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>
1016
+ <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/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointOAuth.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuth#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>
1017
+ <span class='kw'>end</span></pre>
1018
+ </td>
1019
+ </tr>
1020
+ </table>
1021
+ </div>
1022
+
1023
+ <div class="method_details ">
1024
+ <h3 class="signature " id="replace!-instance_method">
1025
+
1026
+ #<strong>replace!</strong>(edge_id: &quot;&quot;, id: &quot;&quot;, a_module: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+ </h3><div class="docstring">
1033
+ <div class="discussion">
1034
+
1035
+ <p><a href="https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace">ngrok.com/docs/api#api-edge-route-o-auth-module-replace</a></p>
1036
+
1037
+
1038
+ </div>
1039
+ </div>
1040
+ <div class="tags">
1041
+ <p class="tag_title">Parameters:</p>
1042
+ <ul class="param">
1043
+
1044
+ <li>
1045
+
1046
+ <span class='name'>edge_id</span>
1047
+
1048
+
1049
+ <span class='type'>(<tt>string</tt>)</span>
1050
+
1051
+
1052
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1053
+
1054
+
1055
+ </li>
1056
+
1057
+ <li>
1058
+
1059
+ <span class='name'>id</span>
1060
+
1061
+
1062
+ <span class='type'>(<tt>string</tt>)</span>
1063
+
1064
+
1065
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1066
+
1067
+
1068
+ </li>
1069
+
1070
+ <li>
1071
+
1072
+ <span class='name'>a_module</span>
1073
+
1074
+
1075
+ <span class='type'>(<tt>EndpointOAuth</tt>)</span>
1076
+
1077
+
1078
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1079
+
1080
+
1081
+ </li>
1082
+
1083
+ </ul>
1084
+
1085
+ <p class="tag_title">Returns:</p>
1086
+ <ul class="return">
1087
+
1088
+ <li>
1089
+
1090
+
1091
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">NgrokAPI::Models::EndpointOAuth</a></span></tt>)</span>
1092
+
1093
+
1094
+
1095
+ &mdash;
1096
+ <div class='inline'>
1097
+ <p>result from the API request</p>
1098
+ </div>
1099
+
1100
+ </li>
1101
+
1102
+ </ul>
1103
+
1104
+ </div><table class="source_code">
1105
+ <tr>
1106
+ <td>
1107
+ <pre class="lines">
1108
+
1109
+
1110
+ 43
1111
+ 44
1112
+ 45
1113
+ 46
1114
+ 47
1115
+ 48
1116
+ 49
1117
+ 50
1118
+ 51
1119
+ 52
1120
+ 53</pre>
1121
+ </td>
1122
+ <td>
1123
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edge_route_o_auth_module_client.rb', line 43</span>
1124
+
1125
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>a_module:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1126
+ <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'>/edges/https/%{edge_id}/routes/%{id}/oauth</span><span class='tstring_end'>&#39;</span></span>
1127
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1128
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
1129
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1130
+ <span class='rbrace'>}</span>
1131
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1132
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:module</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_a_module'>a_module</span> <span class='kw'>if</span> <span class='id identifier rubyid_a_module'>a_module</span>
1133
+ <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_put'>put</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>
1134
+ <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/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointOAuth.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuth#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>
1135
+ <span class='kw'>end</span></pre>
1136
+ </td>
1137
+ </tr>
1138
+ </table>
1139
+ </div>
1140
+
1141
+ </div>
1142
+
1143
+ </div>
1144
+
1145
+ <div id="footer">
1146
+ Generated on Thu Mar 10 04:54:56 2022 by
1147
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1148
+ 0.9.27 (ruby-2.7.5).
1149
+ </div>
1150
+
1151
+ </div>
1152
+ </body>
1153
+ </html>