ngrok-api 0.18.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (499) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -1
  3. data/doc/NgrokAPI/Client.html +1 -1
  4. data/doc/NgrokAPI/Error.html +1 -1
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
  6. data/doc/NgrokAPI/Errors.html +1 -1
  7. data/doc/NgrokAPI/HttpClient.html +146 -3
  8. data/doc/NgrokAPI/Models/APIKey.html +119 -67
  9. data/doc/NgrokAPI/Models/AWSAuth.html +82 -30
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +89 -37
  11. data/doc/NgrokAPI/Models/AWSRole.html +74 -22
  12. data/doc/NgrokAPI/Models/AbuseReport.html +108 -56
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +82 -30
  14. data/doc/NgrokAPI/Models/AgentIngress.html +141 -89
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +148 -96
  16. data/doc/NgrokAPI/Models/Credential.html +120 -68
  17. data/doc/NgrokAPI/Models/Endpoint.html +138 -86
  18. data/doc/NgrokAPI/Models/EndpointBackend.html +89 -37
  19. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +89 -37
  20. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +100 -48
  21. data/doc/NgrokAPI/Models/EndpointCompression.html +81 -29
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +89 -37
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +89 -37
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +89 -37
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +89 -37
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +123 -71
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +106 -54
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +115 -63
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +106 -54
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +106 -54
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +105 -53
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +132 -80
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +90 -38
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +90 -38
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +147 -95
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +132 -80
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +90 -38
  38. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +89 -37
  39. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +90 -38
  40. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +81 -29
  41. data/doc/NgrokAPI/Models/EventDestination.html +121 -69
  42. data/doc/NgrokAPI/Models/EventSource.html +91 -39
  43. data/doc/NgrokAPI/Models/EventSourceList.html +75 -23
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +90 -38
  45. data/doc/NgrokAPI/Models/EventSubscription.html +121 -69
  46. data/doc/NgrokAPI/Models/EventTarget.html +105 -53
  47. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +89 -37
  48. data/doc/NgrokAPI/Models/EventTargetFirehose.html +89 -37
  49. data/doc/NgrokAPI/Models/EventTargetKinesis.html +82 -30
  50. data/doc/NgrokAPI/Models/FailoverBackend.html +127 -75
  51. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +135 -83
  52. data/doc/NgrokAPI/Models/HTTPSEdge.html +136 -84
  53. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +163 -111
  54. data/doc/NgrokAPI/Models/IPPolicy.html +119 -67
  55. data/doc/NgrokAPI/Models/IPPolicyRule.html +135 -83
  56. data/doc/NgrokAPI/Models/IPRestriction.html +129 -77
  57. data/doc/NgrokAPI/Models/Listable.html +60 -60
  58. data/doc/NgrokAPI/Models/Ref.html +82 -30
  59. data/doc/NgrokAPI/Models/ReservedAddr.html +129 -77
  60. data/doc/NgrokAPI/Models/ReservedDomain.html +150 -98
  61. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +91 -39
  62. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +89 -37
  63. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +89 -37
  64. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +134 -82
  65. data/doc/NgrokAPI/Models/SSHCredential.html +127 -75
  66. data/doc/NgrokAPI/Models/SSHHostCertificate.html +147 -95
  67. data/doc/NgrokAPI/Models/SSHUserCertificate.html +153 -101
  68. data/doc/NgrokAPI/Models/TCPEdge.html +141 -89
  69. data/doc/NgrokAPI/Models/TLSCertificate.html +164 -112
  70. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +89 -37
  71. data/doc/NgrokAPI/Models/TLSEdge.html +145 -93
  72. data/doc/NgrokAPI/Models/Tunnel.html +136 -84
  73. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +128 -76
  74. data/doc/NgrokAPI/Models/TunnelSession.html +125 -73
  75. data/doc/NgrokAPI/Models/WeightedBackend.html +127 -75
  76. data/doc/NgrokAPI/Models.html +1 -1
  77. data/doc/NgrokAPI/PagedIterator.html +2 -2
  78. data/doc/NgrokAPI/Services/APIKeysClient.html +243 -108
  79. data/doc/NgrokAPI/Services/AbuseReportsClient.html +161 -24
  80. data/doc/NgrokAPI/Services/AgentIngressesClient.html +261 -108
  81. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +261 -108
  82. data/doc/NgrokAPI/Services/CredentialsClient.html +265 -110
  83. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +27 -31
  84. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +27 -31
  85. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +27 -31
  86. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +27 -31
  87. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +27 -31
  88. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +27 -31
  89. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +27 -31
  90. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +27 -31
  91. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +27 -31
  92. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +27 -31
  93. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +27 -31
  94. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +304 -114
  95. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +513 -98
  96. data/doc/NgrokAPI/Services/EdgesTCPClient.html +304 -114
  97. data/doc/NgrokAPI/Services/EdgesTLSClient.html +338 -118
  98. data/doc/NgrokAPI/Services/EndpointsClient.html +19 -23
  99. data/doc/NgrokAPI/Services/EventDestinationsClient.html +287 -112
  100. data/doc/NgrokAPI/Services/EventSourcesClient.html +226 -87
  101. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +287 -112
  102. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +267 -112
  103. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +307 -114
  104. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +27 -31
  105. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +27 -31
  106. data/doc/NgrokAPI/Services/IPPoliciesClient.html +243 -108
  107. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +301 -110
  108. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +303 -112
  109. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +263 -108
  110. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +357 -144
  111. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +303 -108
  112. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +283 -110
  113. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +339 -108
  114. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +380 -109
  115. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +27 -31
  116. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +27 -31
  117. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +279 -108
  118. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +27 -31
  119. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +27 -31
  120. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +27 -31
  121. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +27 -31
  122. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +267 -112
  123. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +43 -47
  124. data/doc/NgrokAPI/Services/TunnelsClient.html +19 -23
  125. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +270 -115
  126. data/doc/NgrokAPI/Services.html +1 -1
  127. data/doc/NgrokAPI.html +1 -1
  128. data/doc/_index.html +1 -1
  129. data/doc/file.README.html +54 -54
  130. data/doc/index.html +54 -54
  131. data/doc/method_list.html +1089 -337
  132. data/doc/top-level-namespace.html +1 -1
  133. data/docs/NgrokAPI/Client.html +1 -1
  134. data/docs/NgrokAPI/Error.html +1 -1
  135. data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
  136. data/docs/NgrokAPI/Errors.html +1 -1
  137. data/docs/NgrokAPI/HttpClient.html +146 -3
  138. data/docs/NgrokAPI/Models/APIKey.html +119 -67
  139. data/docs/NgrokAPI/Models/AWSAuth.html +82 -30
  140. data/docs/NgrokAPI/Models/AWSCredentials.html +89 -37
  141. data/docs/NgrokAPI/Models/AWSRole.html +74 -22
  142. data/docs/NgrokAPI/Models/AbuseReport.html +108 -56
  143. data/docs/NgrokAPI/Models/AbuseReportHostname.html +82 -30
  144. data/docs/NgrokAPI/Models/AgentIngress.html +141 -89
  145. data/docs/NgrokAPI/Models/CertificateAuthority.html +148 -96
  146. data/docs/NgrokAPI/Models/Credential.html +120 -68
  147. data/docs/NgrokAPI/Models/Endpoint.html +138 -86
  148. data/docs/NgrokAPI/Models/EndpointBackend.html +89 -37
  149. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +89 -37
  150. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +100 -48
  151. data/docs/NgrokAPI/Models/EndpointCompression.html +81 -29
  152. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +89 -37
  153. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +89 -37
  154. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +89 -37
  155. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +89 -37
  156. data/docs/NgrokAPI/Models/EndpointOAuth.html +123 -71
  157. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +106 -54
  158. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +115 -63
  159. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +106 -54
  160. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +106 -54
  161. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +105 -53
  162. data/docs/NgrokAPI/Models/EndpointOIDC.html +132 -80
  163. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +90 -38
  164. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +90 -38
  165. data/docs/NgrokAPI/Models/EndpointSAML.html +147 -95
  166. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +132 -80
  167. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +90 -38
  168. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +89 -37
  169. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +90 -38
  170. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +81 -29
  171. data/docs/NgrokAPI/Models/EventDestination.html +121 -69
  172. data/docs/NgrokAPI/Models/EventSource.html +91 -39
  173. data/docs/NgrokAPI/Models/EventSourceList.html +75 -23
  174. data/docs/NgrokAPI/Models/EventSourceReplace.html +90 -38
  175. data/docs/NgrokAPI/Models/EventSubscription.html +121 -69
  176. data/docs/NgrokAPI/Models/EventTarget.html +105 -53
  177. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +89 -37
  178. data/docs/NgrokAPI/Models/EventTargetFirehose.html +89 -37
  179. data/docs/NgrokAPI/Models/EventTargetKinesis.html +82 -30
  180. data/docs/NgrokAPI/Models/FailoverBackend.html +127 -75
  181. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +135 -83
  182. data/docs/NgrokAPI/Models/HTTPSEdge.html +136 -84
  183. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +163 -111
  184. data/docs/NgrokAPI/Models/IPPolicy.html +119 -67
  185. data/docs/NgrokAPI/Models/IPPolicyRule.html +135 -83
  186. data/docs/NgrokAPI/Models/IPRestriction.html +129 -77
  187. data/docs/NgrokAPI/Models/Listable.html +60 -60
  188. data/docs/NgrokAPI/Models/Ref.html +82 -30
  189. data/docs/NgrokAPI/Models/ReservedAddr.html +129 -77
  190. data/docs/NgrokAPI/Models/ReservedDomain.html +150 -98
  191. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +91 -39
  192. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +89 -37
  193. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +89 -37
  194. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +134 -82
  195. data/docs/NgrokAPI/Models/SSHCredential.html +127 -75
  196. data/docs/NgrokAPI/Models/SSHHostCertificate.html +147 -95
  197. data/docs/NgrokAPI/Models/SSHUserCertificate.html +153 -101
  198. data/docs/NgrokAPI/Models/TCPEdge.html +141 -89
  199. data/docs/NgrokAPI/Models/TLSCertificate.html +164 -112
  200. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +89 -37
  201. data/docs/NgrokAPI/Models/TLSEdge.html +145 -93
  202. data/docs/NgrokAPI/Models/Tunnel.html +136 -84
  203. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +128 -76
  204. data/docs/NgrokAPI/Models/TunnelSession.html +125 -73
  205. data/docs/NgrokAPI/Models/WeightedBackend.html +127 -75
  206. data/docs/NgrokAPI/Models.html +1 -1
  207. data/docs/NgrokAPI/PagedIterator.html +2 -2
  208. data/docs/NgrokAPI/Services/APIKeysClient.html +243 -108
  209. data/docs/NgrokAPI/Services/AbuseReportsClient.html +161 -24
  210. data/docs/NgrokAPI/Services/AgentIngressesClient.html +261 -108
  211. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +261 -108
  212. data/docs/NgrokAPI/Services/CredentialsClient.html +265 -110
  213. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +27 -31
  214. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +27 -31
  215. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +27 -31
  216. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +27 -31
  217. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +27 -31
  218. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +27 -31
  219. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +27 -31
  220. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +27 -31
  221. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +27 -31
  222. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +27 -31
  223. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +27 -31
  224. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +304 -114
  225. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +513 -98
  226. data/docs/NgrokAPI/Services/EdgesTCPClient.html +304 -114
  227. data/docs/NgrokAPI/Services/EdgesTLSClient.html +338 -118
  228. data/docs/NgrokAPI/Services/EndpointsClient.html +19 -23
  229. data/docs/NgrokAPI/Services/EventDestinationsClient.html +287 -112
  230. data/docs/NgrokAPI/Services/EventSourcesClient.html +226 -87
  231. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +287 -112
  232. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +267 -112
  233. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +307 -114
  234. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +27 -31
  235. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +27 -31
  236. data/docs/NgrokAPI/Services/IPPoliciesClient.html +243 -108
  237. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +301 -110
  238. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +303 -112
  239. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +263 -108
  240. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +357 -144
  241. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +303 -108
  242. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +283 -110
  243. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +339 -108
  244. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +380 -109
  245. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +27 -31
  246. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +27 -31
  247. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +279 -108
  248. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +27 -31
  249. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +27 -31
  250. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +27 -31
  251. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +27 -31
  252. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +267 -112
  253. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +43 -47
  254. data/docs/NgrokAPI/Services/TunnelsClient.html +19 -23
  255. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +270 -115
  256. data/docs/NgrokAPI/Services.html +1 -1
  257. data/docs/NgrokAPI.html +1 -1
  258. data/docs/_index.html +1 -1
  259. data/docs/file.README.html +54 -54
  260. data/docs/index.html +54 -54
  261. data/docs/method_list.html +1089 -337
  262. data/docs/top-level-namespace.html +1 -1
  263. data/lib/ngrokapi/http_client.rb +21 -2
  264. data/lib/ngrokapi/models/abuse_report.rb +16 -12
  265. data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
  266. data/lib/ngrokapi/models/agent_ingress.rb +17 -13
  267. data/lib/ngrokapi/models/api_key.rb +15 -11
  268. data/lib/ngrokapi/models/aws_auth.rb +11 -7
  269. data/lib/ngrokapi/models/aws_credentials.rb +11 -7
  270. data/lib/ngrokapi/models/aws_role.rb +10 -6
  271. data/lib/ngrokapi/models/certificate_authority.rb +20 -16
  272. data/lib/ngrokapi/models/credential.rb +16 -12
  273. data/lib/ngrokapi/models/endpoint.rb +22 -18
  274. data/lib/ngrokapi/models/endpoint_backend.rb +11 -7
  275. data/lib/ngrokapi/models/endpoint_backend_mutate.rb +11 -7
  276. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
  277. data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
  278. data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
  279. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
  280. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
  281. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
  282. data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
  283. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
  284. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
  285. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
  286. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
  287. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
  288. data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
  289. data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
  290. data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
  291. data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
  292. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
  293. data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
  294. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +11 -7
  295. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
  296. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +10 -6
  297. data/lib/ngrokapi/models/event_destination.rb +16 -12
  298. data/lib/ngrokapi/models/event_source.rb +13 -9
  299. data/lib/ngrokapi/models/event_source_list.rb +11 -7
  300. data/lib/ngrokapi/models/event_source_replace.rb +12 -8
  301. data/lib/ngrokapi/models/event_subscription.rb +16 -12
  302. data/lib/ngrokapi/models/event_target.rb +13 -9
  303. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
  304. data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
  305. data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
  306. data/lib/ngrokapi/models/failover_backend.rb +16 -12
  307. data/lib/ngrokapi/models/http_response_backend.rb +17 -13
  308. data/lib/ngrokapi/models/https_edge.rb +18 -14
  309. data/lib/ngrokapi/models/https_edge_route.rb +28 -24
  310. data/lib/ngrokapi/models/ip_policy.rb +15 -11
  311. data/lib/ngrokapi/models/ip_policy_rule.rb +17 -13
  312. data/lib/ngrokapi/models/ip_restriction.rb +17 -13
  313. data/lib/ngrokapi/models/listable.rb +9 -9
  314. data/lib/ngrokapi/models/ref.rb +11 -7
  315. data/lib/ngrokapi/models/reserved_addr.rb +17 -13
  316. data/lib/ngrokapi/models/reserved_domain.rb +23 -19
  317. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
  318. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
  319. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
  320. data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
  321. data/lib/ngrokapi/models/ssh_credential.rb +16 -12
  322. data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
  323. data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
  324. data/lib/ngrokapi/models/tcp_edge.rb +17 -13
  325. data/lib/ngrokapi/models/tls_certificate.rb +30 -26
  326. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
  327. data/lib/ngrokapi/models/tls_edge.rb +19 -15
  328. data/lib/ngrokapi/models/tunnel.rb +20 -16
  329. data/lib/ngrokapi/models/tunnel_group_backend.rb +17 -13
  330. data/lib/ngrokapi/models/tunnel_session.rb +19 -15
  331. data/lib/ngrokapi/models/weighted_backend.rb +16 -12
  332. data/lib/ngrokapi/paged_iterator.rb +1 -1
  333. data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
  334. data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
  335. data/lib/ngrokapi/services/api_keys_client.rb +30 -11
  336. data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
  337. data/lib/ngrokapi/services/credentials_client.rb +34 -11
  338. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +6 -8
  339. data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +6 -8
  340. data/lib/ngrokapi/services/edge_route_compression_module_client.rb +6 -8
  341. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +6 -8
  342. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +6 -8
  343. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +6 -8
  344. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +6 -8
  345. data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +6 -8
  346. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +6 -8
  347. data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +6 -8
  348. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +6 -8
  349. data/lib/ngrokapi/services/edges_https_client.rb +35 -11
  350. data/lib/ngrokapi/services/edges_https_routes_client.rb +53 -5
  351. data/lib/ngrokapi/services/edges_tcp_client.rb +35 -11
  352. data/lib/ngrokapi/services/edges_tls_client.rb +39 -11
  353. data/lib/ngrokapi/services/endpoints_client.rb +6 -8
  354. data/lib/ngrokapi/services/event_destinations_client.rb +35 -11
  355. data/lib/ngrokapi/services/event_sources_client.rb +27 -7
  356. data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -11
  357. data/lib/ngrokapi/services/failover_backends_client.rb +33 -13
  358. data/lib/ngrokapi/services/http_response_backends_client.rb +32 -11
  359. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +6 -8
  360. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +6 -8
  361. data/lib/ngrokapi/services/ip_policies_client.rb +30 -11
  362. data/lib/ngrokapi/services/ip_policy_rules_client.rb +35 -11
  363. data/lib/ngrokapi/services/ip_restrictions_client.rb +35 -11
  364. data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -11
  365. data/lib/ngrokapi/services/reserved_domains_client.rb +37 -11
  366. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
  367. data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
  368. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
  369. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
  370. data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +6 -8
  371. data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +6 -8
  372. data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
  373. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +6 -8
  374. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +6 -8
  375. data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +6 -8
  376. data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +6 -8
  377. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +33 -13
  378. data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
  379. data/lib/ngrokapi/services/tunnels_client.rb +6 -8
  380. data/lib/ngrokapi/services/weighted_backends_client.rb +36 -16
  381. data/lib/ngrokapi/version.rb +1 -1
  382. data/lib/ngrokapi.rb +1 -1
  383. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
  384. data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
  385. data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
  386. data/spec/ngrokapi/models/api_key_spec.rb +2 -2
  387. data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
  388. data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
  389. data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
  390. data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
  391. data/spec/ngrokapi/models/credential_spec.rb +2 -2
  392. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +2 -2
  393. data/spec/ngrokapi/models/endpoint_backend_spec.rb +2 -2
  394. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
  395. data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
  396. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
  397. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
  398. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
  399. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
  400. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
  401. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
  402. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
  403. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
  404. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
  405. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
  406. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
  407. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
  408. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
  409. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
  410. data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
  411. data/spec/ngrokapi/models/endpoint_spec.rb +2 -2
  412. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +2 -2
  413. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
  414. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
  415. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +2 -2
  416. data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
  417. data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
  418. data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
  419. data/spec/ngrokapi/models/event_source_spec.rb +2 -2
  420. data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
  421. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
  422. data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
  423. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
  424. data/spec/ngrokapi/models/event_target_spec.rb +2 -2
  425. data/spec/ngrokapi/models/failover_backend_spec.rb +2 -2
  426. data/spec/ngrokapi/models/http_response_backend_spec.rb +2 -2
  427. data/spec/ngrokapi/models/https_edge_route_spec.rb +2 -2
  428. data/spec/ngrokapi/models/https_edge_spec.rb +2 -2
  429. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
  430. data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
  431. data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
  432. data/spec/ngrokapi/models/listable_spec.rb +2 -2
  433. data/spec/ngrokapi/models/ref_spec.rb +2 -2
  434. data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
  435. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
  436. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
  437. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
  438. data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
  439. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
  440. data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
  441. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
  442. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
  443. data/spec/ngrokapi/models/tcp_edge_spec.rb +2 -2
  444. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
  445. data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
  446. data/spec/ngrokapi/models/tls_edge_spec.rb +2 -2
  447. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +2 -2
  448. data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
  449. data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
  450. data/spec/ngrokapi/models/weighted_backend_spec.rb +2 -2
  451. data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
  452. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
  453. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
  454. data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
  455. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
  456. data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
  457. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +2 -4
  458. data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +2 -4
  459. data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +2 -4
  460. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +2 -4
  461. data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +2 -4
  462. data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +2 -4
  463. data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +2 -4
  464. data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +2 -4
  465. data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +2 -4
  466. data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +2 -4
  467. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +2 -4
  468. data/spec/ngrokapi/services/edges_https_client_spec.rb +25 -0
  469. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +47 -0
  470. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +25 -0
  471. data/spec/ngrokapi/services/edges_tls_client_spec.rb +29 -0
  472. data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
  473. data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
  474. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
  475. data/spec/ngrokapi/services/failover_backends_client_spec.rb +21 -0
  476. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +25 -0
  477. data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +2 -4
  478. data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +2 -4
  479. data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -0
  480. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +25 -0
  481. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
  482. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -0
  483. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -0
  484. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
  485. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
  486. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
  487. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
  488. data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +2 -4
  489. data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +2 -4
  490. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
  491. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +2 -4
  492. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +2 -4
  493. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +2 -4
  494. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +2 -4
  495. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +21 -0
  496. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +21 -0
  497. metadata +1 -3
  498. data/doc/README +0 -94
  499. data/docs/README +0 -94
data/doc/_index.html CHANGED
@@ -1072,7 +1072,7 @@
1072
1072
  </div>
1073
1073
 
1074
1074
  <div id="footer">
1075
- Generated on Thu Mar 10 16:54:38 2022 by
1075
+ Generated on Mon Apr 11 19:32:55 2022 by
1076
1076
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1077
1077
  0.9.27 (ruby-2.7.5).
1078
1078
  </div>
data/doc/file.README.html CHANGED
@@ -58,7 +58,7 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-ngrok-api">ngrok-api</h1>
61
+ <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
64
64
 
@@ -69,81 +69,81 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
- <h2 id="label-Quickstart">Quickstart</h2>
73
-
74
- <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
75
-
76
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
77
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
-
79
- <span class='comment'># Get an instance of the api_keys client and list all API keys
80
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
81
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
82
- </code></pre>
72
+ <h2 id="label-Documentation">Documentation</h2>
83
73
 
84
- <h2 id="label-Automatic+Paging">Automatic Paging</h2>
74
+ <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
85
75
 
86
- <p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
76
+ <h2 id="label-Quickstart">Quickstart</h2>
87
77
 
88
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
89
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
+ <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
90
79
 
91
- <span class='comment'># list all api keys, transparently fetching additional
92
- </span><span class='comment'># pages for you if necessary
93
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
94
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
95
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
96
- <span class='kw'>end</span>
80
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
81
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
+
83
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
84
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
+
87
+ <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
88
+ </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
89
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
90
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
91
+ <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
92
+ <span class='rparen'>)</span>
93
+
94
+ <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
95
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
96
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
97
+ <span class='rparen'>)</span>
98
+
99
+ <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
100
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
101
+ <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
102
+ <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
103
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
104
+ <span class='label'>backend:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
105
+ <span class='label'>compression:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
106
+ <span class='rparen'>)</span>
107
+
108
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
109
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
110
+ <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
111
+ <span class='label'>a_module:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
112
+ <span class='rparen'>)</span>
97
113
  </code></pre>
98
114
 
99
- <h2 id="label-Instance+Methods">Instance Methods</h2>
100
-
101
- <p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
115
+ <h2 id="label-Local+Documentation">Local Documentation</h2>
102
116
 
103
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
104
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
117
+ <p>Documentation can be generated with the command:</p>
105
118
 
106
- <span class='comment'># update the metadata of a credential
107
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
108
- <span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
109
-
110
- <span class='comment'># or do it in single call
111
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
119
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
112
120
  </code></pre>
113
121
 
114
- <h2 id="label-Bang+Methods">Bang Methods</h2>
115
-
116
- <p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
122
+ <p>This will generate documentation which can be viewed within the doc folder.</p>
117
123
 
118
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
119
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
124
+ <h2 id="label-Specs">Specs</h2>
120
125
 
121
- <span class='comment'># no error raised, even though it&#39;s a bad identifier
122
- </span><span class='comment'># the error is simply returned
123
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
126
+ <p>Specs can be run with the command:</p>
124
127
 
125
- <span class='comment'># this raises an NgrokAPI::Error
126
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
128
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
127
129
  </code></pre>
128
130
 
129
- <h2 id="label-Error+Handling">Error Handling</h2>
131
+ <p>This will generate a coverage report which can be viewed within the coverage folder.</p>
130
132
 
131
- <p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
133
+ <h2 id="label-Rubocop">Rubocop</h2>
132
134
 
133
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
134
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
135
+ <p>Rubocop can be run with the command:</p>
135
136
 
136
- <span class='kw'>begin</span>
137
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
138
- <span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
139
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
140
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
141
- <span class='kw'>end</span>
137
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
138
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
139
+
140
+ <span class='comment'># Run rubcop on all files
141
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
142
142
  </code></pre>
143
143
  </div></div>
144
144
 
145
145
  <div id="footer">
146
- Generated on Thu Mar 10 16:54:38 2022 by
146
+ Generated on Mon Apr 11 19:32:55 2022 by
147
147
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
148
  0.9.27 (ruby-2.7.5).
149
149
  </div>
data/doc/index.html CHANGED
@@ -58,7 +58,7 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-ngrok-api">ngrok-api</h1>
61
+ <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
64
64
 
@@ -69,81 +69,81 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
- <h2 id="label-Quickstart">Quickstart</h2>
73
-
74
- <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
75
-
76
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
77
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
-
79
- <span class='comment'># Get an instance of the api_keys client and list all API keys
80
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
81
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
82
- </code></pre>
72
+ <h2 id="label-Documentation">Documentation</h2>
83
73
 
84
- <h2 id="label-Automatic+Paging">Automatic Paging</h2>
74
+ <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
85
75
 
86
- <p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
76
+ <h2 id="label-Quickstart">Quickstart</h2>
87
77
 
88
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
89
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
+ <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
90
79
 
91
- <span class='comment'># list all api keys, transparently fetching additional
92
- </span><span class='comment'># pages for you if necessary
93
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
94
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
95
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
96
- <span class='kw'>end</span>
80
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
81
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
+
83
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
84
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
+
87
+ <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
88
+ </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
89
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
90
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
91
+ <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
92
+ <span class='rparen'>)</span>
93
+
94
+ <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
95
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
96
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
97
+ <span class='rparen'>)</span>
98
+
99
+ <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
100
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
101
+ <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
102
+ <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
103
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
104
+ <span class='label'>backend:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
105
+ <span class='label'>compression:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
106
+ <span class='rparen'>)</span>
107
+
108
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
109
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
110
+ <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
111
+ <span class='label'>a_module:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
112
+ <span class='rparen'>)</span>
97
113
  </code></pre>
98
114
 
99
- <h2 id="label-Instance+Methods">Instance Methods</h2>
100
-
101
- <p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
115
+ <h2 id="label-Local+Documentation">Local Documentation</h2>
102
116
 
103
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
104
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
117
+ <p>Documentation can be generated with the command:</p>
105
118
 
106
- <span class='comment'># update the metadata of a credential
107
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
108
- <span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
109
-
110
- <span class='comment'># or do it in single call
111
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
119
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
112
120
  </code></pre>
113
121
 
114
- <h2 id="label-Bang+Methods">Bang Methods</h2>
115
-
116
- <p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
122
+ <p>This will generate documentation which can be viewed within the doc folder.</p>
117
123
 
118
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
119
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
124
+ <h2 id="label-Specs">Specs</h2>
120
125
 
121
- <span class='comment'># no error raised, even though it&#39;s a bad identifier
122
- </span><span class='comment'># the error is simply returned
123
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
126
+ <p>Specs can be run with the command:</p>
124
127
 
125
- <span class='comment'># this raises an NgrokAPI::Error
126
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
128
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
127
129
  </code></pre>
128
130
 
129
- <h2 id="label-Error+Handling">Error Handling</h2>
131
+ <p>This will generate a coverage report which can be viewed within the coverage folder.</p>
130
132
 
131
- <p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
133
+ <h2 id="label-Rubocop">Rubocop</h2>
132
134
 
133
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
134
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
135
+ <p>Rubocop can be run with the command:</p>
135
136
 
136
- <span class='kw'>begin</span>
137
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
138
- <span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
139
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
140
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
141
- <span class='kw'>end</span>
137
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
138
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
139
+
140
+ <span class='comment'># Run rubcop on all files
141
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
142
142
  </code></pre>
143
143
  </div></div>
144
144
 
145
145
  <div id="footer">
146
- Generated on Thu Mar 10 16:54:38 2022 by
146
+ Generated on Mon Apr 11 19:32:55 2022 by
147
147
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
148
  0.9.27 (ruby-2.7.5).
149
149
  </div>