ngrok-api 0.9.0 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (424) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +2 -2
  3. data/.yardopts +1 -0
  4. data/LICENSE +7 -0
  5. data/doc/NgrokAPI/Client.html +1469 -125
  6. data/doc/NgrokAPI/Error.html +3 -3
  7. data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
  8. data/doc/NgrokAPI/Errors.html +3 -3
  9. data/doc/NgrokAPI/HttpClient.html +66 -36
  10. data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
  11. data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
  12. data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
  13. data/doc/NgrokAPI/Models/AWSRole.html +543 -0
  14. data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
  15. data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
  16. data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
  17. data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
  18. data/doc/NgrokAPI/Models/Credential.html +1149 -0
  19. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
  20. data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
  21. data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
  24. data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
  25. data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
  26. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
  27. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
  28. data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
  29. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
  30. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
  31. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
  32. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
  33. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
  34. data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
  35. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
  36. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
  37. data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
  38. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
  39. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
  40. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
  41. data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
  42. data/doc/NgrokAPI/Models/EventSource.html +765 -0
  43. data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
  45. data/doc/NgrokAPI/Models/EventStream.html +1309 -0
  46. data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
  47. data/doc/NgrokAPI/Models/EventTarget.html +765 -0
  48. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
  49. data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
  50. data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
  51. data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
  52. data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
  53. data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
  54. data/doc/NgrokAPI/Models/Listable.html +120 -52
  55. data/doc/NgrokAPI/Models/Ref.html +617 -0
  56. data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
  57. data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
  58. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
  59. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
  60. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
  61. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
  62. data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
  63. data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
  64. data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
  65. data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
  66. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
  67. data/doc/NgrokAPI/Models/Tunnel.html +987 -0
  68. data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
  69. data/doc/NgrokAPI/Models.html +6 -6
  70. data/doc/NgrokAPI/PagedIterator.html +16 -12
  71. data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
  72. data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
  73. data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
  74. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
  75. data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
  76. data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
  77. data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
  78. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
  79. data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
  80. data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
  81. data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
  82. data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
  83. data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
  84. data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
  85. data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
  86. data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
  87. data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
  88. data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
  89. data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
  90. data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
  91. data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
  92. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
  93. data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
  94. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
  95. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
  96. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
  97. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
  98. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
  99. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
  100. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
  101. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
  102. data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
  103. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
  104. data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
  105. data/doc/NgrokAPI/Services.html +6 -6
  106. data/doc/NgrokAPI.html +5 -5
  107. data/doc/README +94 -0
  108. data/doc/_index.html +621 -25
  109. data/doc/class_list.html +1 -1
  110. data/doc/file.README.html +55 -28
  111. data/doc/frames.html +1 -1
  112. data/doc/index.html +55 -28
  113. data/doc/method_list.html +7526 -286
  114. data/doc/top-level-namespace.html +3 -3
  115. data/docs/.gitkeep +0 -0
  116. data/docs/CNAME +1 -0
  117. data/docs/NgrokAPI/Client.html +1469 -125
  118. data/docs/NgrokAPI/Error.html +3 -3
  119. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  120. data/docs/NgrokAPI/Errors.html +3 -3
  121. data/docs/NgrokAPI/HttpClient.html +66 -36
  122. data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
  123. data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
  124. data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
  125. data/docs/NgrokAPI/Models/AWSRole.html +543 -0
  126. data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
  127. data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
  128. data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
  129. data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
  130. data/docs/NgrokAPI/Models/Credential.html +1149 -0
  131. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
  132. data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
  133. data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
  134. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
  135. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
  136. data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
  137. data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
  138. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
  139. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
  140. data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
  141. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
  142. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
  143. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
  144. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
  145. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
  146. data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
  147. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
  148. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
  149. data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
  150. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
  151. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
  152. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
  153. data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
  154. data/docs/NgrokAPI/Models/EventSource.html +765 -0
  155. data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
  156. data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
  157. data/docs/NgrokAPI/Models/EventStream.html +1309 -0
  158. data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
  159. data/docs/NgrokAPI/Models/EventTarget.html +765 -0
  160. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
  161. data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
  162. data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
  163. data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
  164. data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
  165. data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
  166. data/docs/NgrokAPI/Models/Listable.html +120 -52
  167. data/docs/NgrokAPI/Models/Ref.html +617 -0
  168. data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
  169. data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
  170. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
  171. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
  172. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
  173. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
  174. data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
  175. data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
  176. data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
  177. data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
  178. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
  179. data/docs/NgrokAPI/Models/Tunnel.html +987 -0
  180. data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
  181. data/docs/NgrokAPI/Models.html +6 -6
  182. data/docs/NgrokAPI/PagedIterator.html +16 -12
  183. data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
  184. data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
  185. data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
  186. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
  187. data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
  188. data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
  189. data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
  190. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
  191. data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
  192. data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
  193. data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
  194. data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
  195. data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
  196. data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
  197. data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
  198. data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
  199. data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
  200. data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
  201. data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
  202. data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
  203. data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
  204. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
  205. data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
  206. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
  207. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
  208. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
  209. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
  210. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
  211. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
  212. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
  213. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
  214. data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
  215. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
  216. data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
  217. data/docs/NgrokAPI/Services.html +6 -6
  218. data/docs/NgrokAPI.html +5 -5
  219. data/docs/README +94 -0
  220. data/docs/_index.html +621 -25
  221. data/docs/class_list.html +1 -1
  222. data/docs/file.README.html +55 -28
  223. data/docs/frames.html +1 -1
  224. data/docs/index.html +55 -28
  225. data/docs/method_list.html +7526 -286
  226. data/docs/top-level-namespace.html +3 -3
  227. data/lib/ngrokapi/client.rb +229 -49
  228. data/lib/ngrokapi/http_client.rb +6 -7
  229. data/lib/ngrokapi/models/abuse_report.rb +37 -0
  230. data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
  231. data/lib/ngrokapi/models/agent_ingress.rb +66 -0
  232. data/lib/ngrokapi/models/api_key.rb +62 -64
  233. data/lib/ngrokapi/models/aws_auth.rb +27 -0
  234. data/lib/ngrokapi/models/aws_credentials.rb +27 -0
  235. data/lib/ngrokapi/models/aws_role.rb +25 -0
  236. data/lib/ngrokapi/models/certificate_authority.rb +72 -0
  237. data/lib/ngrokapi/models/credential.rb +67 -0
  238. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
  239. data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
  240. data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
  241. data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
  242. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
  243. data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
  244. data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
  245. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
  246. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
  247. data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
  248. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
  249. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
  250. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
  251. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
  252. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
  253. data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
  254. data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
  255. data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
  256. data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
  257. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
  258. data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
  259. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
  260. data/lib/ngrokapi/models/event_destination.rb +49 -0
  261. data/lib/ngrokapi/models/event_source.rb +31 -0
  262. data/lib/ngrokapi/models/event_source_list.rb +27 -0
  263. data/lib/ngrokapi/models/event_source_replace.rb +29 -0
  264. data/lib/ngrokapi/models/event_stream.rb +77 -0
  265. data/lib/ngrokapi/models/event_subscription.rb +47 -0
  266. data/lib/ngrokapi/models/event_target.rb +31 -0
  267. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
  268. data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
  269. data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
  270. data/lib/ngrokapi/models/ip_policy.rb +64 -0
  271. data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
  272. data/lib/ngrokapi/models/ip_restriction.rb +49 -0
  273. data/lib/ngrokapi/models/listable.rb +13 -2
  274. data/lib/ngrokapi/models/ref.rb +27 -0
  275. data/lib/ngrokapi/models/reserved_addr.rb +49 -0
  276. data/lib/ngrokapi/models/reserved_domain.rb +61 -211
  277. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
  278. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
  279. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
  280. data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
  281. data/lib/ngrokapi/models/ssh_credential.rb +67 -0
  282. data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
  283. data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
  284. data/lib/ngrokapi/models/tls_certificate.rb +92 -62
  285. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
  286. data/lib/ngrokapi/models/tunnel.rb +37 -0
  287. data/lib/ngrokapi/models/tunnel_session.rb +43 -0
  288. data/lib/ngrokapi/paged_iterator.rb +4 -2
  289. data/lib/ngrokapi/services/.gitkeep +0 -0
  290. data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
  291. data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
  292. data/lib/ngrokapi/services/api_keys_client.rb +210 -144
  293. data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
  294. data/lib/ngrokapi/services/credentials_client.rb +217 -0
  295. data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
  296. data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
  297. data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
  298. data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
  299. data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
  300. data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
  301. data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
  302. data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
  303. data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
  304. data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
  305. data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
  306. data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
  307. data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
  308. data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
  309. data/lib/ngrokapi/services/event_sources_client.rb +185 -0
  310. data/lib/ngrokapi/services/event_streams_client.rb +224 -0
  311. data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
  312. data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
  313. data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
  314. data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
  315. data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
  316. data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
  317. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
  318. data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
  319. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
  320. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
  321. data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
  322. data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
  323. data/lib/ngrokapi/services/tunnels_client.rb +78 -0
  324. data/lib/ngrokapi/version.rb +1 -1
  325. data/lib/ngrokapi.rb +1 -1
  326. data/ngrok-api.gemspec +1 -1
  327. data/spec/ngrokapi/client_spec.rb +158 -33
  328. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
  329. data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
  330. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  331. data/spec/ngrokapi/models/api_key_spec.rb +42 -43
  332. data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
  333. data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
  334. data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
  335. data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
  336. data/spec/ngrokapi/models/credential_spec.rb +45 -0
  337. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
  338. data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
  339. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
  340. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
  341. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
  342. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
  343. data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
  344. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
  345. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
  346. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
  347. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
  348. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
  349. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
  350. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
  351. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
  352. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
  353. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
  354. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
  355. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
  356. data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
  357. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
  358. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
  359. data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
  360. data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
  361. data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
  362. data/spec/ngrokapi/models/event_source_spec.rb +21 -0
  363. data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
  364. data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
  365. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
  366. data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
  367. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
  368. data/spec/ngrokapi/models/event_target_spec.rb +21 -0
  369. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
  370. data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
  371. data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
  372. data/spec/ngrokapi/models/listable_spec.rb +4 -4
  373. data/spec/ngrokapi/models/ref_spec.rb +21 -0
  374. data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
  375. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
  376. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
  377. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
  378. data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
  379. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
  380. data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
  381. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
  382. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
  383. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
  384. data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
  385. data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
  386. data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
  387. data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
  388. data/spec/ngrokapi/services/.gitkeep +0 -0
  389. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
  390. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
  391. data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
  392. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
  393. data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
  394. data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
  395. data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
  396. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
  397. data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
  398. data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
  399. data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
  400. data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
  401. data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
  402. data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
  403. data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
  404. data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
  405. data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
  406. data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
  407. data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
  408. data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
  409. data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
  410. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
  411. data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
  412. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
  413. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
  414. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
  415. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
  416. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
  417. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
  418. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
  419. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
  420. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
  421. data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
  422. data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
  423. data/spec/spec_helper.rb +1096 -80
  424. metadata +360 -11
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: NgrokAPI::Services::EndpointConfigurationsClient
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.27
10
10
 
11
11
  </title>
12
12
 
@@ -102,7 +102,7 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p>A client for interacting with the endpoint_configuration API</p>
105
+ <p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p>
106
106
 
107
107
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p>
108
108
 
@@ -121,11 +121,11 @@
121
121
 
122
122
  <dl class="constants">
123
123
 
124
- <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
124
+ <dt id="PATH-constant" class="">PATH =
125
125
  <div class="docstring">
126
126
  <div class="discussion">
127
127
 
128
- <p>The List Property from the resulting API for list calls</p>
128
+ <p>The API path for the requests</p>
129
129
 
130
130
 
131
131
  </div>
@@ -135,13 +135,13 @@
135
135
 
136
136
  </div>
137
137
  </dt>
138
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
139
139
 
140
- <dt id="PATH-constant" class="">PATH =
140
+ <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
141
141
  <div class="docstring">
142
142
  <div class="discussion">
143
143
 
144
- <p>The API path for endpoint configurations</p>
144
+ <p>The List Property from the resulting API for list calls</p>
145
145
 
146
146
 
147
147
  </div>
@@ -151,7 +151,7 @@
151
151
 
152
152
  </div>
153
153
  </dt>
154
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>endpoint_configurations</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
155
 
156
156
  </dl>
157
157
 
@@ -207,7 +207,7 @@
207
207
  <li class="public ">
208
208
  <span class="summary_signature">
209
209
 
210
- <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &#39;&#39;, metadata: &#39;&#39;, type: &#39;&#39;, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(type: &quot;&quot;, description: &quot;&quot;, metadata: &quot;&quot;, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
211
211
 
212
212
 
213
213
 
@@ -231,7 +231,7 @@
231
231
  <li class="public ">
232
232
  <span class="summary_signature">
233
233
 
234
- <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: nil) &#x21d2; nil </a>
234
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
235
235
 
236
236
 
237
237
 
@@ -255,7 +255,7 @@
255
255
  <li class="public ">
256
256
  <span class="summary_signature">
257
257
 
258
- <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: nil) &#x21d2; nil </a>
258
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
259
259
 
260
260
 
261
261
 
@@ -279,7 +279,7 @@
279
279
  <li class="public ">
280
280
  <span class="summary_signature">
281
281
 
282
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
282
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
283
283
 
284
284
 
285
285
 
@@ -294,7 +294,7 @@
294
294
 
295
295
 
296
296
  <span class="summary_desc"><div class='inline'>
297
- <p>Returns detailed information about an endpoint configuration by ID.</p>
297
+ <p>Returns detailed information about an endpoint configuration.</p>
298
298
  </div></span>
299
299
 
300
300
  </li>
@@ -303,7 +303,7 @@
303
303
  <li class="public ">
304
304
  <span class="summary_signature">
305
305
 
306
- <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
306
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
307
307
 
308
308
 
309
309
 
@@ -318,7 +318,7 @@
318
318
 
319
319
 
320
320
  <span class="summary_desc"><div class='inline'>
321
- <p>Returns detailed information about an endpoint configuration by ID.</p>
321
+ <p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
322
322
  </div></span>
323
323
 
324
324
  </li>
@@ -377,7 +377,31 @@
377
377
  <li class="public ">
378
378
  <span class="summary_signature">
379
379
 
380
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
380
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
381
+
382
+
383
+
384
+ </span>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+ <span class="summary_desc"><div class='inline'>
395
+ <p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ <li class="public ">
402
+ <span class="summary_signature">
403
+
404
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
381
405
 
382
406
 
383
407
 
@@ -401,7 +425,7 @@
401
425
  <li class="public ">
402
426
  <span class="summary_signature">
403
427
 
404
- <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
428
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; NgrokAPI::Models::EndpointConfiguration </a>
405
429
 
406
430
 
407
431
 
@@ -454,15 +478,15 @@
454
478
  <pre class="lines">
455
479
 
456
480
 
457
- 17
458
- 18
459
- 19</pre>
481
+ 19
482
+ 20
483
+ 21</pre>
460
484
  </td>
461
485
  <td>
462
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 17</span>
486
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 19</span>
463
487
 
464
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
465
- <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
488
+ <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>
489
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
466
490
  <span class='kw'>end</span></pre>
467
491
  </td>
468
492
  </tr>
@@ -502,12 +526,12 @@
502
526
  <pre class="lines">
503
527
 
504
528
 
505
- 15
506
- 16
507
- 17</pre>
529
+ 17
530
+ 18
531
+ 19</pre>
508
532
  </td>
509
533
  <td>
510
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 15</span>
534
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 17</span>
511
535
 
512
536
  <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
513
537
  <span class='ivar'>@client</span>
@@ -527,7 +551,7 @@
527
551
  <div class="method_details first">
528
552
  <h3 class="signature first" id="create-instance_method">
529
553
 
530
- #<strong>create</strong>(description: &#39;&#39;, metadata: &#39;&#39;, type: &#39;&#39;, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
554
+ #<strong>create</strong>(type: &quot;&quot;, description: &quot;&quot;, metadata: &quot;&quot;, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
531
555
 
532
556
 
533
557
 
@@ -549,54 +573,54 @@
549
573
 
550
574
  <li>
551
575
 
552
- <span class='name'>description</span>
576
+ <span class='name'>type</span>
553
577
 
554
578
 
555
579
  <span class='type'>(<tt>string</tt>)</span>
556
580
 
557
581
 
558
- <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
582
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
559
583
 
560
584
 
561
585
  &mdash;
562
586
  <div class='inline'>
563
- <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
587
+ <p>they type of traffic this endpoint configuration can be applied to. one of: <code>http</code>, <code>https</code>, <code>tcp</code></p>
564
588
  </div>
565
589
 
566
590
  </li>
567
591
 
568
592
  <li>
569
593
 
570
- <span class='name'>metadata</span>
594
+ <span class='name'>description</span>
571
595
 
572
596
 
573
597
  <span class='type'>(<tt>string</tt>)</span>
574
598
 
575
599
 
576
- <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
600
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
577
601
 
578
602
 
579
603
  &mdash;
580
604
  <div class='inline'>
581
- <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
605
+ <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
582
606
  </div>
583
607
 
584
608
  </li>
585
609
 
586
610
  <li>
587
611
 
588
- <span class='name'>type</span>
612
+ <span class='name'>metadata</span>
589
613
 
590
614
 
591
615
  <span class='type'>(<tt>string</tt>)</span>
592
616
 
593
617
 
594
- <em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
618
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
595
619
 
596
620
 
597
621
  &mdash;
598
622
  <div class='inline'>
599
- <p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p>
623
+ <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
600
624
  </div>
601
625
 
602
626
  </li>
@@ -606,7 +630,7 @@
606
630
  <span class='name'>circuit_breaker</span>
607
631
 
608
632
 
609
- <span class='type'>(<tt>string</tt>)</span>
633
+ <span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
610
634
 
611
635
 
612
636
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -614,7 +638,7 @@
614
638
 
615
639
  &mdash;
616
640
  <div class='inline'>
617
- <p>circuit breaker module configuration</p>
641
+ <p>circuit breaker module configuration or <code>null</code></p>
618
642
  </div>
619
643
 
620
644
  </li>
@@ -624,7 +648,7 @@
624
648
  <span class='name'>compression</span>
625
649
 
626
650
 
627
- <span class='type'>(<tt>string</tt>)</span>
651
+ <span class='type'>(<tt>EndpointCompression</tt>)</span>
628
652
 
629
653
 
630
654
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -632,7 +656,7 @@
632
656
 
633
657
  &mdash;
634
658
  <div class='inline'>
635
- <p>compression module configuration</p>
659
+ <p>compression module configuration or <code>null</code></p>
636
660
  </div>
637
661
 
638
662
  </li>
@@ -642,7 +666,7 @@
642
666
  <span class='name'>request_headers</span>
643
667
 
644
668
 
645
- <span class='type'>(<tt>string</tt>)</span>
669
+ <span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
646
670
 
647
671
 
648
672
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -650,7 +674,7 @@
650
674
 
651
675
  &mdash;
652
676
  <div class='inline'>
653
- <p>request headers module configuration</p>
677
+ <p>request headers module configuration or <code>null</code></p>
654
678
  </div>
655
679
 
656
680
  </li>
@@ -660,7 +684,7 @@
660
684
  <span class='name'>response_headers</span>
661
685
 
662
686
 
663
- <span class='type'>(<tt>string</tt>)</span>
687
+ <span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
664
688
 
665
689
 
666
690
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -668,7 +692,7 @@
668
692
 
669
693
  &mdash;
670
694
  <div class='inline'>
671
- <p>response headers module configuration</p>
695
+ <p>response headers module configuration or <code>null</code></p>
672
696
  </div>
673
697
 
674
698
  </li>
@@ -678,7 +702,7 @@
678
702
  <span class='name'>ip_policy</span>
679
703
 
680
704
 
681
- <span class='type'>(<tt>string</tt>)</span>
705
+ <span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
682
706
 
683
707
 
684
708
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -686,7 +710,7 @@
686
710
 
687
711
  &mdash;
688
712
  <div class='inline'>
689
- <p>ip policy module configuration</p>
713
+ <p>ip policy module configuration or <code>null</code></p>
690
714
  </div>
691
715
 
692
716
  </li>
@@ -696,7 +720,7 @@
696
720
  <span class='name'>mutual_tls</span>
697
721
 
698
722
 
699
- <span class='type'>(<tt>string</tt>)</span>
723
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
700
724
 
701
725
 
702
726
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -704,7 +728,7 @@
704
728
 
705
729
  &mdash;
706
730
  <div class='inline'>
707
- <p>mutual TLS module configuration</p>
731
+ <p>mutual TLS module configuration or <code>null</code></p>
708
732
  </div>
709
733
 
710
734
  </li>
@@ -714,7 +738,7 @@
714
738
  <span class='name'>tls_termination</span>
715
739
 
716
740
 
717
- <span class='type'>(<tt>string</tt>)</span>
741
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
718
742
 
719
743
 
720
744
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -722,7 +746,7 @@
722
746
 
723
747
  &mdash;
724
748
  <div class='inline'>
725
- <p>TLS termination module configuration</p>
749
+ <p>TLS termination module configuration or <code>null</code></p>
726
750
  </div>
727
751
 
728
752
  </li>
@@ -732,7 +756,7 @@
732
756
  <span class='name'>webhook_validation</span>
733
757
 
734
758
 
735
- <span class='type'>(<tt>string</tt>)</span>
759
+ <span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
736
760
 
737
761
 
738
762
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -740,7 +764,7 @@
740
764
 
741
765
  &mdash;
742
766
  <div class='inline'>
743
- <p>webhook validation module configuration</p>
767
+ <p>webhook validation module configuration or <code>null</code></p>
744
768
  </div>
745
769
 
746
770
  </li>
@@ -750,7 +774,7 @@
750
774
  <span class='name'>oauth</span>
751
775
 
752
776
 
753
- <span class='type'>(<tt>string</tt>)</span>
777
+ <span class='type'>(<tt>EndpointOAuth</tt>)</span>
754
778
 
755
779
 
756
780
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -758,7 +782,7 @@
758
782
 
759
783
  &mdash;
760
784
  <div class='inline'>
761
- <p>oauth module configuration</p>
785
+ <p>oauth module configuration or <code>null</code></p>
762
786
  </div>
763
787
 
764
788
  </li>
@@ -768,7 +792,7 @@
768
792
  <span class='name'>logging</span>
769
793
 
770
794
 
771
- <span class='type'>(<tt>string</tt>)</span>
795
+ <span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
772
796
 
773
797
 
774
798
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -776,7 +800,7 @@
776
800
 
777
801
  &mdash;
778
802
  <div class='inline'>
779
- <p>logging module configuration</p>
803
+ <p>logging module configuration or <code>null</code></p>
780
804
  </div>
781
805
 
782
806
  </li>
@@ -786,7 +810,7 @@
786
810
  <span class='name'>saml</span>
787
811
 
788
812
 
789
- <span class='type'>(<tt>string</tt>)</span>
813
+ <span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
790
814
 
791
815
 
792
816
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -794,7 +818,7 @@
794
818
 
795
819
  &mdash;
796
820
  <div class='inline'>
797
- <p>saml module configuration</p>
821
+ <p>saml module configuration or <code>null</code></p>
798
822
  </div>
799
823
 
800
824
  </li>
@@ -804,7 +828,7 @@
804
828
  <span class='name'>oidc</span>
805
829
 
806
830
 
807
- <span class='type'>(<tt>string</tt>)</span>
831
+ <span class='type'>(<tt>EndpointOIDC</tt>)</span>
808
832
 
809
833
 
810
834
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -812,7 +836,7 @@
812
836
 
813
837
  &mdash;
814
838
  <div class='inline'>
815
- <p>oidc module configuration</p>
839
+ <p>oidc module configuration or <code>null</code></p>
816
840
  </div>
817
841
 
818
842
  </li>
@@ -831,7 +855,7 @@
831
855
 
832
856
  &mdash;
833
857
  <div class='inline'>
834
- <p>result from create request</p>
858
+ <p>result from the API request</p>
835
859
  </div>
836
860
 
837
861
  </li>
@@ -866,61 +890,33 @@
866
890
  63
867
891
  64
868
892
  65
869
- 66
870
- 67
871
- 68
872
- 69
873
- 70
874
- 71
875
- 72
876
- 73
877
- 74
878
- 75
879
- 76
880
- 77
881
- 78
882
- 79
883
- 80</pre>
893
+ 66</pre>
884
894
  </td>
885
895
  <td>
886
896
  <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 44</span>
887
897
 
888
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
889
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
890
- <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
891
- <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
892
- <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
893
- <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
894
- <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
895
- <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
896
- <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
897
- <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
898
- <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
899
- <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
900
- <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
901
- <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
902
- <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
903
- <span class='label'>oidc:</span> <span class='kw'>nil</span>
904
- <span class='rparen'>)</span>
905
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span>
906
- <span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
907
- <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
908
- <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
909
- <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
910
- <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
911
- <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
912
- <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
913
- <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
914
- <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
915
- <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
916
- <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
917
- <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
918
- <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
919
- <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
920
- <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span><span class='comma'>,</span>
921
- <span class='rbrace'>}</span>
922
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
923
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
898
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
899
+ <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'>/endpoint_configurations</span><span class='tstring_end'>&#39;</span></span>
900
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
901
+ <span class='rbrace'>}</span>
902
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
903
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
904
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
905
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
906
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
907
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
908
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
909
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
910
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
911
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
912
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
913
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
914
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
915
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
916
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
917
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
918
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='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>
919
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
924
920
  <span class='kw'>end</span></pre>
925
921
  </td>
926
922
  </tr>
@@ -930,7 +926,7 @@
930
926
  <div class="method_details ">
931
927
  <h3 class="signature " id="delete-instance_method">
932
928
 
933
- #<strong>delete</strong>(id: nil) &#x21d2; <tt>nil</tt>
929
+ #<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
934
930
 
935
931
 
936
932
 
@@ -958,7 +954,7 @@
958
954
  <span class='type'>(<tt>string</tt>)</span>
959
955
 
960
956
 
961
- <em class="default">(defaults to: <tt>nil</tt>)</em>
957
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
962
958
 
963
959
 
964
960
  &mdash;
@@ -976,13 +972,13 @@
976
972
  <li>
977
973
 
978
974
 
979
- <span class='type'>(<tt>nil</tt>)</span>
975
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
980
976
 
981
977
 
982
978
 
983
979
  &mdash;
984
980
  <div class='inline'>
985
- <p>result from delete request</p>
981
+ <p>result from the API request</p>
986
982
  </div>
987
983
 
988
984
  </li>
@@ -995,15 +991,23 @@
995
991
  <pre class="lines">
996
992
 
997
993
 
998
- 92
999
- 93
1000
- 94</pre>
994
+ 76
995
+ 77
996
+ 78
997
+ 79
998
+ 80
999
+ 81
1000
+ 82</pre>
1001
1001
  </td>
1002
1002
  <td>
1003
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 92</span>
1004
-
1005
- <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1006
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1003
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 76</span>
1004
+
1005
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1006
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
1007
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1008
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1009
+ <span class='rbrace'>}</span>
1010
+ <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>
1007
1011
  <span class='kw'>end</span></pre>
1008
1012
  </td>
1009
1013
  </tr>
@@ -1013,7 +1017,7 @@
1013
1017
  <div class="method_details ">
1014
1018
  <h3 class="signature " id="delete!-instance_method">
1015
1019
 
1016
- #<strong>delete!</strong>(id: nil) &#x21d2; <tt>nil</tt>
1020
+ #<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
1017
1021
 
1018
1022
 
1019
1023
 
@@ -1022,7 +1026,7 @@
1022
1026
  </h3><div class="docstring">
1023
1027
  <div class="discussion">
1024
1028
 
1025
- <p>Delete an endpoint configuration. Throw an exception if 404. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.</p>
1029
+ <p>Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address. Throws an exception if API error.</p>
1026
1030
 
1027
1031
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
1028
1032
 
@@ -1041,7 +1045,7 @@
1041
1045
  <span class='type'>(<tt>string</tt>)</span>
1042
1046
 
1043
1047
 
1044
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1048
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1045
1049
 
1046
1050
 
1047
1051
  &mdash;
@@ -1059,13 +1063,13 @@
1059
1063
  <li>
1060
1064
 
1061
1065
 
1062
- <span class='type'>(<tt>nil</tt>)</span>
1066
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
1063
1067
 
1064
1068
 
1065
1069
 
1066
1070
  &mdash;
1067
1071
  <div class='inline'>
1068
- <p>result from delete request</p>
1072
+ <p>result from the API request</p>
1069
1073
  </div>
1070
1074
 
1071
1075
  </li>
@@ -1078,15 +1082,23 @@
1078
1082
  <pre class="lines">
1079
1083
 
1080
1084
 
1081
- 105
1082
- 106
1083
- 107</pre>
1085
+ 93
1086
+ 94
1087
+ 95
1088
+ 96
1089
+ 97
1090
+ 98
1091
+ 99</pre>
1084
1092
  </td>
1085
1093
  <td>
1086
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 105</span>
1087
-
1088
- <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1089
- <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1094
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 93</span>
1095
+
1096
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1097
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
1098
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1099
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1100
+ <span class='rbrace'>}</span>
1101
+ <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>
1090
1102
  <span class='kw'>end</span></pre>
1091
1103
  </td>
1092
1104
  </tr>
@@ -1096,7 +1108,7 @@
1096
1108
  <div class="method_details ">
1097
1109
  <h3 class="signature " id="get-instance_method">
1098
1110
 
1099
- #<strong>get</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1111
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1100
1112
 
1101
1113
 
1102
1114
 
@@ -1105,7 +1117,7 @@
1105
1117
  </h3><div class="docstring">
1106
1118
  <div class="discussion">
1107
1119
 
1108
- <p>Returns detailed information about an endpoint configuration by ID.</p>
1120
+ <p>Returns detailed information about an endpoint configuration</p>
1109
1121
 
1110
1122
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
1111
1123
 
@@ -1124,7 +1136,7 @@
1124
1136
  <span class='type'>(<tt>string</tt>)</span>
1125
1137
 
1126
1138
 
1127
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1139
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1128
1140
 
1129
1141
 
1130
1142
  &mdash;
@@ -1148,7 +1160,7 @@
1148
1160
 
1149
1161
  &mdash;
1150
1162
  <div class='inline'>
1151
- <p>result from get request</p>
1163
+ <p>result from the API request</p>
1152
1164
  </div>
1153
1165
 
1154
1166
  </li>
@@ -1161,17 +1173,27 @@
1161
1173
  <pre class="lines">
1162
1174
 
1163
1175
 
1164
- 116
1165
- 117
1166
- 118
1167
- 119</pre>
1176
+ 108
1177
+ 109
1178
+ 110
1179
+ 111
1180
+ 112
1181
+ 113
1182
+ 114
1183
+ 115
1184
+ 116</pre>
1168
1185
  </td>
1169
1186
  <td>
1170
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 116</span>
1171
-
1172
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1173
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1174
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1187
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 108</span>
1188
+
1189
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1190
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
1191
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1192
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1193
+ <span class='rbrace'>}</span>
1194
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1195
+ <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>
1196
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1175
1197
  <span class='kw'>end</span></pre>
1176
1198
  </td>
1177
1199
  </tr>
@@ -1181,7 +1203,7 @@
1181
1203
  <div class="method_details ">
1182
1204
  <h3 class="signature " id="get!-instance_method">
1183
1205
 
1184
- #<strong>get!</strong>(id: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1206
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1185
1207
 
1186
1208
 
1187
1209
 
@@ -1190,7 +1212,7 @@
1190
1212
  </h3><div class="docstring">
1191
1213
  <div class="discussion">
1192
1214
 
1193
- <p>Returns detailed information about an endpoint configuration by ID. Throw an execption if 404.</p>
1215
+ <p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
1194
1216
 
1195
1217
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
1196
1218
 
@@ -1209,7 +1231,7 @@
1209
1231
  <span class='type'>(<tt>string</tt>)</span>
1210
1232
 
1211
1233
 
1212
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1234
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1213
1235
 
1214
1236
 
1215
1237
  &mdash;
@@ -1233,7 +1255,7 @@
1233
1255
 
1234
1256
  &mdash;
1235
1257
  <div class='inline'>
1236
- <p>result from get request</p>
1258
+ <p>result from the API request</p>
1237
1259
  </div>
1238
1260
 
1239
1261
  </li>
@@ -1246,17 +1268,27 @@
1246
1268
  <pre class="lines">
1247
1269
 
1248
1270
 
1271
+ 126
1272
+ 127
1249
1273
  128
1250
1274
  129
1251
1275
  130
1252
- 131</pre>
1276
+ 131
1277
+ 132
1278
+ 133
1279
+ 134</pre>
1253
1280
  </td>
1254
1281
  <td>
1255
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 128</span>
1256
-
1257
- <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1258
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1259
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1282
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 126</span>
1283
+
1284
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1285
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
1286
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1287
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1288
+ <span class='rbrace'>}</span>
1289
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1290
+ <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>
1291
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1260
1292
  <span class='kw'>end</span></pre>
1261
1293
  </td>
1262
1294
  </tr>
@@ -1275,7 +1307,7 @@
1275
1307
  </h3><div class="docstring">
1276
1308
  <div class="discussion">
1277
1309
 
1278
- <p>Returns a list of all endpoint configurations on this account.</p>
1310
+ <p>Returns a list of all endpoint configurations on this account</p>
1279
1311
 
1280
1312
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
1281
1313
 
@@ -1304,7 +1336,7 @@
1304
1336
  <span class='name'>limit</span>
1305
1337
 
1306
1338
 
1307
- <span class='type'>(<tt>integer</tt>)</span>
1339
+ <span class='type'>(<tt>string</tt>)</span>
1308
1340
 
1309
1341
 
1310
1342
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1344,7 +1376,7 @@
1344
1376
 
1345
1377
  &mdash;
1346
1378
  <div class='inline'>
1347
- <p>the result listable</p>
1379
+ <p>result from the API request</p>
1348
1380
  </div>
1349
1381
 
1350
1382
  </li>
@@ -1357,27 +1389,180 @@
1357
1389
  <pre class="lines">
1358
1390
 
1359
1391
 
1360
- 142
1361
- 143
1362
- 144
1363
1392
  145
1364
1393
  146
1365
1394
  147
1366
1395
  148
1367
1396
  149
1368
- 150</pre>
1397
+ 150
1398
+ 151
1399
+ 152
1400
+ 153
1401
+ 154
1402
+ 155
1403
+ 156
1404
+ 157
1405
+ 158
1406
+ 159
1407
+ 160</pre>
1408
+ </td>
1409
+ <td>
1410
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 145</span>
1411
+
1412
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1413
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1414
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1415
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1416
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1417
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1418
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span>
1419
+ <span class='rparen'>)</span>
1420
+
1421
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1422
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1423
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1424
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1425
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span>
1426
+ <span class='rparen'>)</span>
1427
+ <span class='kw'>end</span></pre>
1428
+ </td>
1429
+ </tr>
1430
+ </table>
1431
+ </div>
1432
+
1433
+ <div class="method_details ">
1434
+ <h3 class="signature " id="list!-instance_method">
1435
+
1436
+ #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+ </h3><div class="docstring">
1443
+ <div class="discussion">
1444
+
1445
+ <p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
1446
+
1447
+ <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
1448
+
1449
+
1450
+ </div>
1451
+ </div>
1452
+ <div class="tags">
1453
+ <p class="tag_title">Parameters:</p>
1454
+ <ul class="param">
1455
+
1456
+ <li>
1457
+
1458
+ <span class='name'>before_id</span>
1459
+
1460
+
1461
+ <span class='type'>(<tt>string</tt>)</span>
1462
+
1463
+
1464
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1465
+
1466
+
1467
+ </li>
1468
+
1469
+ <li>
1470
+
1471
+ <span class='name'>limit</span>
1472
+
1473
+
1474
+ <span class='type'>(<tt>string</tt>)</span>
1475
+
1476
+
1477
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1478
+
1479
+
1480
+ </li>
1481
+
1482
+ <li>
1483
+
1484
+ <span class='name'>url</span>
1485
+
1486
+
1487
+ <span class='type'>(<tt>string</tt>)</span>
1488
+
1489
+
1490
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1491
+
1492
+
1493
+ &mdash;
1494
+ <div class='inline'>
1495
+ <p>optional and mutually exclusive from before_id and limit</p>
1496
+ </div>
1497
+
1498
+ </li>
1499
+
1500
+ </ul>
1501
+
1502
+ <p class="tag_title">Returns:</p>
1503
+ <ul class="return">
1504
+
1505
+ <li>
1506
+
1507
+
1508
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1509
+
1510
+
1511
+
1512
+ &mdash;
1513
+ <div class='inline'>
1514
+ <p>result from the API request</p>
1515
+ </div>
1516
+
1517
+ </li>
1518
+
1519
+ </ul>
1520
+
1521
+ </div><table class="source_code">
1522
+ <tr>
1523
+ <td>
1524
+ <pre class="lines">
1525
+
1526
+
1527
+ 172
1528
+ 173
1529
+ 174
1530
+ 175
1531
+ 176
1532
+ 177
1533
+ 178
1534
+ 179
1535
+ 180
1536
+ 181
1537
+ 182
1538
+ 183
1539
+ 184
1540
+ 185
1541
+ 186
1542
+ 187
1543
+ 188
1544
+ 189</pre>
1369
1545
  </td>
1370
1546
  <td>
1371
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 142</span>
1372
-
1373
- <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1374
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='rparen'>)</span>
1375
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1376
- <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1377
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1378
- <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1379
- <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span>
1380
- <span class='rparen'>)</span>
1547
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 172</span>
1548
+
1549
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1550
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1551
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1552
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1553
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1554
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1555
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1556
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span>
1557
+ <span class='rparen'>)</span>
1558
+
1559
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1560
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1561
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1562
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1563
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='comma'>,</span>
1564
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1565
+ <span class='rparen'>)</span>
1381
1566
  <span class='kw'>end</span></pre>
1382
1567
  </td>
1383
1568
  </tr>
@@ -1387,7 +1572,7 @@
1387
1572
  <div class="method_details ">
1388
1573
  <h3 class="signature " id="update-instance_method">
1389
1574
 
1390
- #<strong>update</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1575
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1391
1576
 
1392
1577
 
1393
1578
 
@@ -1415,7 +1600,7 @@
1415
1600
  <span class='type'>(<tt>string</tt>)</span>
1416
1601
 
1417
1602
 
1418
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1603
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1419
1604
 
1420
1605
 
1421
1606
  &mdash;
@@ -1466,7 +1651,7 @@
1466
1651
  <span class='name'>circuit_breaker</span>
1467
1652
 
1468
1653
 
1469
- <span class='type'>(<tt>string</tt>)</span>
1654
+ <span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
1470
1655
 
1471
1656
 
1472
1657
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1474,7 +1659,7 @@
1474
1659
 
1475
1660
  &mdash;
1476
1661
  <div class='inline'>
1477
- <p>circuit breaker module configuration</p>
1662
+ <p>circuit breaker module configuration or <code>null</code></p>
1478
1663
  </div>
1479
1664
 
1480
1665
  </li>
@@ -1484,7 +1669,7 @@
1484
1669
  <span class='name'>compression</span>
1485
1670
 
1486
1671
 
1487
- <span class='type'>(<tt>string</tt>)</span>
1672
+ <span class='type'>(<tt>EndpointCompression</tt>)</span>
1488
1673
 
1489
1674
 
1490
1675
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1492,7 +1677,7 @@
1492
1677
 
1493
1678
  &mdash;
1494
1679
  <div class='inline'>
1495
- <p>compression module configuration</p>
1680
+ <p>compression module configuration or <code>null</code></p>
1496
1681
  </div>
1497
1682
 
1498
1683
  </li>
@@ -1502,7 +1687,7 @@
1502
1687
  <span class='name'>request_headers</span>
1503
1688
 
1504
1689
 
1505
- <span class='type'>(<tt>string</tt>)</span>
1690
+ <span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
1506
1691
 
1507
1692
 
1508
1693
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1510,7 +1695,7 @@
1510
1695
 
1511
1696
  &mdash;
1512
1697
  <div class='inline'>
1513
- <p>request headers module configuration</p>
1698
+ <p>request headers module configuration or <code>null</code></p>
1514
1699
  </div>
1515
1700
 
1516
1701
  </li>
@@ -1520,7 +1705,7 @@
1520
1705
  <span class='name'>response_headers</span>
1521
1706
 
1522
1707
 
1523
- <span class='type'>(<tt>string</tt>)</span>
1708
+ <span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
1524
1709
 
1525
1710
 
1526
1711
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1528,7 +1713,7 @@
1528
1713
 
1529
1714
  &mdash;
1530
1715
  <div class='inline'>
1531
- <p>response headers module configuration</p>
1716
+ <p>response headers module configuration or <code>null</code></p>
1532
1717
  </div>
1533
1718
 
1534
1719
  </li>
@@ -1538,7 +1723,7 @@
1538
1723
  <span class='name'>ip_policy</span>
1539
1724
 
1540
1725
 
1541
- <span class='type'>(<tt>string</tt>)</span>
1726
+ <span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
1542
1727
 
1543
1728
 
1544
1729
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1546,7 +1731,7 @@
1546
1731
 
1547
1732
  &mdash;
1548
1733
  <div class='inline'>
1549
- <p>ip policy module configuration</p>
1734
+ <p>ip policy module configuration or <code>null</code></p>
1550
1735
  </div>
1551
1736
 
1552
1737
  </li>
@@ -1556,7 +1741,7 @@
1556
1741
  <span class='name'>mutual_tls</span>
1557
1742
 
1558
1743
 
1559
- <span class='type'>(<tt>string</tt>)</span>
1744
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
1560
1745
 
1561
1746
 
1562
1747
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1564,7 +1749,7 @@
1564
1749
 
1565
1750
  &mdash;
1566
1751
  <div class='inline'>
1567
- <p>mutual TLS module configuration</p>
1752
+ <p>mutual TLS module configuration or <code>null</code></p>
1568
1753
  </div>
1569
1754
 
1570
1755
  </li>
@@ -1574,7 +1759,7 @@
1574
1759
  <span class='name'>tls_termination</span>
1575
1760
 
1576
1761
 
1577
- <span class='type'>(<tt>string</tt>)</span>
1762
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
1578
1763
 
1579
1764
 
1580
1765
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1582,7 +1767,7 @@
1582
1767
 
1583
1768
  &mdash;
1584
1769
  <div class='inline'>
1585
- <p>TLS termination module configuration</p>
1770
+ <p>TLS termination module configuration or <code>null</code></p>
1586
1771
  </div>
1587
1772
 
1588
1773
  </li>
@@ -1592,7 +1777,7 @@
1592
1777
  <span class='name'>webhook_validation</span>
1593
1778
 
1594
1779
 
1595
- <span class='type'>(<tt>string</tt>)</span>
1780
+ <span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
1596
1781
 
1597
1782
 
1598
1783
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1600,7 +1785,7 @@
1600
1785
 
1601
1786
  &mdash;
1602
1787
  <div class='inline'>
1603
- <p>webhook validation module configuration</p>
1788
+ <p>webhook validation module configuration or <code>null</code></p>
1604
1789
  </div>
1605
1790
 
1606
1791
  </li>
@@ -1610,7 +1795,7 @@
1610
1795
  <span class='name'>oauth</span>
1611
1796
 
1612
1797
 
1613
- <span class='type'>(<tt>string</tt>)</span>
1798
+ <span class='type'>(<tt>EndpointOAuth</tt>)</span>
1614
1799
 
1615
1800
 
1616
1801
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1618,7 +1803,7 @@
1618
1803
 
1619
1804
  &mdash;
1620
1805
  <div class='inline'>
1621
- <p>oauth module configuration</p>
1806
+ <p>oauth module configuration or <code>null</code></p>
1622
1807
  </div>
1623
1808
 
1624
1809
  </li>
@@ -1628,7 +1813,7 @@
1628
1813
  <span class='name'>logging</span>
1629
1814
 
1630
1815
 
1631
- <span class='type'>(<tt>string</tt>)</span>
1816
+ <span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
1632
1817
 
1633
1818
 
1634
1819
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1636,7 +1821,7 @@
1636
1821
 
1637
1822
  &mdash;
1638
1823
  <div class='inline'>
1639
- <p>logging module configuration</p>
1824
+ <p>logging module configuration or <code>null</code></p>
1640
1825
  </div>
1641
1826
 
1642
1827
  </li>
@@ -1646,7 +1831,7 @@
1646
1831
  <span class='name'>saml</span>
1647
1832
 
1648
1833
 
1649
- <span class='type'>(<tt>string</tt>)</span>
1834
+ <span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
1650
1835
 
1651
1836
 
1652
1837
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1654,7 +1839,7 @@
1654
1839
 
1655
1840
  &mdash;
1656
1841
  <div class='inline'>
1657
- <p>saml module configuration</p>
1842
+ <p>saml module configuration or <code>null</code></p>
1658
1843
  </div>
1659
1844
 
1660
1845
  </li>
@@ -1664,7 +1849,7 @@
1664
1849
  <span class='name'>oidc</span>
1665
1850
 
1666
1851
 
1667
- <span class='type'>(<tt>string</tt>)</span>
1852
+ <span class='type'>(<tt>EndpointOIDC</tt>)</span>
1668
1853
 
1669
1854
 
1670
1855
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1672,7 +1857,7 @@
1672
1857
 
1673
1858
  &mdash;
1674
1859
  <div class='inline'>
1675
- <p>oidc module configuration</p>
1860
+ <p>oidc module configuration or <code>null</code></p>
1676
1861
  </div>
1677
1862
 
1678
1863
  </li>
@@ -1691,7 +1876,7 @@
1691
1876
 
1692
1877
  &mdash;
1693
1878
  <div class='inline'>
1694
- <p>result from update request</p>
1879
+ <p>result from the API request</p>
1695
1880
  </div>
1696
1881
 
1697
1882
  </li>
@@ -1704,81 +1889,55 @@
1704
1889
  <pre class="lines">
1705
1890
 
1706
1891
 
1707
- 177
1708
- 178
1709
- 179
1710
- 180
1711
- 181
1712
- 182
1713
- 183
1714
- 184
1715
- 185
1716
- 186
1717
- 187
1718
- 188
1719
- 189
1720
- 190
1721
- 191
1722
- 192
1723
- 193
1724
- 194
1725
- 195
1726
- 196
1727
- 197
1728
- 198
1729
- 199
1730
- 200
1731
- 201
1732
- 202
1733
- 203
1734
- 204
1735
- 205
1736
- 206
1737
- 207
1738
- 208
1739
- 209
1740
- 210
1741
- 211
1742
- 212</pre>
1892
+ 215
1893
+ 216
1894
+ 217
1895
+ 218
1896
+ 219
1897
+ 220
1898
+ 221
1899
+ 222
1900
+ 223
1901
+ 224
1902
+ 225
1903
+ 226
1904
+ 227
1905
+ 228
1906
+ 229
1907
+ 230
1908
+ 231
1909
+ 232
1910
+ 233
1911
+ 234
1912
+ 235
1913
+ 236
1914
+ 237</pre>
1743
1915
  </td>
1744
1916
  <td>
1745
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 177</span>
1746
-
1747
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1748
- <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1749
- <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1750
- <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1751
- <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1752
- <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1753
- <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1754
- <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1755
- <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1756
- <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1757
- <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1758
- <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1759
- <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1760
- <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1761
- <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1762
- <span class='label'>oidc:</span> <span class='kw'>nil</span>
1763
- <span class='rparen'>)</span>
1764
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
1765
- <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
1766
- <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
1767
- <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
1768
- <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
1769
- <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
1770
- <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
1771
- <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
1772
- <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
1773
- <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
1774
- <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
1775
- <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
1776
- <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
1777
- <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
1778
- <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span>
1779
- <span class='rparen'>)</span>
1780
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1781
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1917
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 215</span>
1918
+
1919
+ <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1920
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
1921
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1922
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1923
+ <span class='rbrace'>}</span>
1924
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1925
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1926
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1927
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
1928
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
1929
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
1930
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
1931
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
1932
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
1933
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
1934
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
1935
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
1936
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
1937
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
1938
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
1939
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='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>
1940
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1782
1941
  <span class='kw'>end</span></pre>
1783
1942
  </td>
1784
1943
  </tr>
@@ -1788,7 +1947,7 @@
1788
1947
  <div class="method_details ">
1789
1948
  <h3 class="signature " id="update!-instance_method">
1790
1949
 
1791
- #<strong>update!</strong>(id: nil, description: nil, metadata: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1950
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
1792
1951
 
1793
1952
 
1794
1953
 
@@ -1797,7 +1956,7 @@
1797
1956
  </h3><div class="docstring">
1798
1957
  <div class="discussion">
1799
1958
 
1800
- <p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throw an exception if 404.</p>
1959
+ <p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
1801
1960
 
1802
1961
  <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
1803
1962
 
@@ -1816,7 +1975,7 @@
1816
1975
  <span class='type'>(<tt>string</tt>)</span>
1817
1976
 
1818
1977
 
1819
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1978
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1820
1979
 
1821
1980
 
1822
1981
  &mdash;
@@ -1867,7 +2026,7 @@
1867
2026
  <span class='name'>circuit_breaker</span>
1868
2027
 
1869
2028
 
1870
- <span class='type'>(<tt>string</tt>)</span>
2029
+ <span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
1871
2030
 
1872
2031
 
1873
2032
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1875,7 +2034,7 @@
1875
2034
 
1876
2035
  &mdash;
1877
2036
  <div class='inline'>
1878
- <p>circuit breaker module configuration</p>
2037
+ <p>circuit breaker module configuration or <code>null</code></p>
1879
2038
  </div>
1880
2039
 
1881
2040
  </li>
@@ -1885,7 +2044,7 @@
1885
2044
  <span class='name'>compression</span>
1886
2045
 
1887
2046
 
1888
- <span class='type'>(<tt>string</tt>)</span>
2047
+ <span class='type'>(<tt>EndpointCompression</tt>)</span>
1889
2048
 
1890
2049
 
1891
2050
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1893,7 +2052,7 @@
1893
2052
 
1894
2053
  &mdash;
1895
2054
  <div class='inline'>
1896
- <p>compression module configuration</p>
2055
+ <p>compression module configuration or <code>null</code></p>
1897
2056
  </div>
1898
2057
 
1899
2058
  </li>
@@ -1903,7 +2062,7 @@
1903
2062
  <span class='name'>request_headers</span>
1904
2063
 
1905
2064
 
1906
- <span class='type'>(<tt>string</tt>)</span>
2065
+ <span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
1907
2066
 
1908
2067
 
1909
2068
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1911,7 +2070,7 @@
1911
2070
 
1912
2071
  &mdash;
1913
2072
  <div class='inline'>
1914
- <p>request headers module configuration</p>
2073
+ <p>request headers module configuration or <code>null</code></p>
1915
2074
  </div>
1916
2075
 
1917
2076
  </li>
@@ -1921,7 +2080,7 @@
1921
2080
  <span class='name'>response_headers</span>
1922
2081
 
1923
2082
 
1924
- <span class='type'>(<tt>string</tt>)</span>
2083
+ <span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
1925
2084
 
1926
2085
 
1927
2086
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1929,7 +2088,7 @@
1929
2088
 
1930
2089
  &mdash;
1931
2090
  <div class='inline'>
1932
- <p>response headers module configuration</p>
2091
+ <p>response headers module configuration or <code>null</code></p>
1933
2092
  </div>
1934
2093
 
1935
2094
  </li>
@@ -1939,7 +2098,7 @@
1939
2098
  <span class='name'>ip_policy</span>
1940
2099
 
1941
2100
 
1942
- <span class='type'>(<tt>string</tt>)</span>
2101
+ <span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
1943
2102
 
1944
2103
 
1945
2104
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1947,7 +2106,7 @@
1947
2106
 
1948
2107
  &mdash;
1949
2108
  <div class='inline'>
1950
- <p>ip policy module configuration</p>
2109
+ <p>ip policy module configuration or <code>null</code></p>
1951
2110
  </div>
1952
2111
 
1953
2112
  </li>
@@ -1957,7 +2116,7 @@
1957
2116
  <span class='name'>mutual_tls</span>
1958
2117
 
1959
2118
 
1960
- <span class='type'>(<tt>string</tt>)</span>
2119
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
1961
2120
 
1962
2121
 
1963
2122
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1965,7 +2124,7 @@
1965
2124
 
1966
2125
  &mdash;
1967
2126
  <div class='inline'>
1968
- <p>mutual TLS module configuration</p>
2127
+ <p>mutual TLS module configuration or <code>null</code></p>
1969
2128
  </div>
1970
2129
 
1971
2130
  </li>
@@ -1975,7 +2134,7 @@
1975
2134
  <span class='name'>tls_termination</span>
1976
2135
 
1977
2136
 
1978
- <span class='type'>(<tt>string</tt>)</span>
2137
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
1979
2138
 
1980
2139
 
1981
2140
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1983,7 +2142,7 @@
1983
2142
 
1984
2143
  &mdash;
1985
2144
  <div class='inline'>
1986
- <p>TLS termination module configuration</p>
2145
+ <p>TLS termination module configuration or <code>null</code></p>
1987
2146
  </div>
1988
2147
 
1989
2148
  </li>
@@ -1993,7 +2152,7 @@
1993
2152
  <span class='name'>webhook_validation</span>
1994
2153
 
1995
2154
 
1996
- <span class='type'>(<tt>string</tt>)</span>
2155
+ <span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
1997
2156
 
1998
2157
 
1999
2158
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -2001,7 +2160,7 @@
2001
2160
 
2002
2161
  &mdash;
2003
2162
  <div class='inline'>
2004
- <p>webhook validation module configuration</p>
2163
+ <p>webhook validation module configuration or <code>null</code></p>
2005
2164
  </div>
2006
2165
 
2007
2166
  </li>
@@ -2011,7 +2170,7 @@
2011
2170
  <span class='name'>oauth</span>
2012
2171
 
2013
2172
 
2014
- <span class='type'>(<tt>string</tt>)</span>
2173
+ <span class='type'>(<tt>EndpointOAuth</tt>)</span>
2015
2174
 
2016
2175
 
2017
2176
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -2019,7 +2178,7 @@
2019
2178
 
2020
2179
  &mdash;
2021
2180
  <div class='inline'>
2022
- <p>oauth module configuration</p>
2181
+ <p>oauth module configuration or <code>null</code></p>
2023
2182
  </div>
2024
2183
 
2025
2184
  </li>
@@ -2029,7 +2188,7 @@
2029
2188
  <span class='name'>logging</span>
2030
2189
 
2031
2190
 
2032
- <span class='type'>(<tt>string</tt>)</span>
2191
+ <span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
2033
2192
 
2034
2193
 
2035
2194
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -2037,7 +2196,7 @@
2037
2196
 
2038
2197
  &mdash;
2039
2198
  <div class='inline'>
2040
- <p>logging module configuration</p>
2199
+ <p>logging module configuration or <code>null</code></p>
2041
2200
  </div>
2042
2201
 
2043
2202
  </li>
@@ -2047,7 +2206,7 @@
2047
2206
  <span class='name'>saml</span>
2048
2207
 
2049
2208
 
2050
- <span class='type'>(<tt>string</tt>)</span>
2209
+ <span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
2051
2210
 
2052
2211
 
2053
2212
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -2055,7 +2214,7 @@
2055
2214
 
2056
2215
  &mdash;
2057
2216
  <div class='inline'>
2058
- <p>saml module configuration</p>
2217
+ <p>saml module configuration or <code>null</code></p>
2059
2218
  </div>
2060
2219
 
2061
2220
  </li>
@@ -2065,7 +2224,7 @@
2065
2224
  <span class='name'>oidc</span>
2066
2225
 
2067
2226
 
2068
- <span class='type'>(<tt>string</tt>)</span>
2227
+ <span class='type'>(<tt>EndpointOIDC</tt>)</span>
2069
2228
 
2070
2229
 
2071
2230
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -2073,7 +2232,7 @@
2073
2232
 
2074
2233
  &mdash;
2075
2234
  <div class='inline'>
2076
- <p>oidc module configuration</p>
2235
+ <p>oidc module configuration or <code>null</code></p>
2077
2236
  </div>
2078
2237
 
2079
2238
  </li>
@@ -2092,7 +2251,7 @@
2092
2251
 
2093
2252
  &mdash;
2094
2253
  <div class='inline'>
2095
- <p>result from update request</p>
2254
+ <p>result from the API request</p>
2096
2255
  </div>
2097
2256
 
2098
2257
  </li>
@@ -2105,32 +2264,6 @@
2105
2264
  <pre class="lines">
2106
2265
 
2107
2266
 
2108
- 238
2109
- 239
2110
- 240
2111
- 241
2112
- 242
2113
- 243
2114
- 244
2115
- 245
2116
- 246
2117
- 247
2118
- 248
2119
- 249
2120
- 250
2121
- 251
2122
- 252
2123
- 253
2124
- 254
2125
- 255
2126
- 256
2127
- 257
2128
- 258
2129
- 259
2130
- 260
2131
- 261
2132
- 262
2133
- 263
2134
2267
  264
2135
2268
  265
2136
2269
  266
@@ -2140,46 +2273,46 @@
2140
2273
  270
2141
2274
  271
2142
2275
  272
2143
- 273</pre>
2276
+ 273
2277
+ 274
2278
+ 275
2279
+ 276
2280
+ 277
2281
+ 278
2282
+ 279
2283
+ 280
2284
+ 281
2285
+ 282
2286
+ 283
2287
+ 284
2288
+ 285
2289
+ 286</pre>
2144
2290
  </td>
2145
2291
  <td>
2146
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 238</span>
2147
-
2148
- <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
2149
- <span class='label'>id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2150
- <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2151
- <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2152
- <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2153
- <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2154
- <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2155
- <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2156
- <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2157
- <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2158
- <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2159
- <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2160
- <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2161
- <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2162
- <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
2163
- <span class='label'>oidc:</span> <span class='kw'>nil</span>
2164
- <span class='rparen'>)</span>
2165
- <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_build_data'>build_data</span><span class='lparen'>(</span>
2166
- <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
2167
- <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
2168
- <span class='label'>circuit_breaker:</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span><span class='comma'>,</span>
2169
- <span class='label'>compression:</span> <span class='id identifier rubyid_compression'>compression</span><span class='comma'>,</span>
2170
- <span class='label'>request_headers:</span> <span class='id identifier rubyid_request_headers'>request_headers</span><span class='comma'>,</span>
2171
- <span class='label'>response_headers:</span> <span class='id identifier rubyid_response_headers'>response_headers</span><span class='comma'>,</span>
2172
- <span class='label'>ip_policy:</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span><span class='comma'>,</span>
2173
- <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
2174
- <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span><span class='comma'>,</span>
2175
- <span class='label'>webhook_validation:</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span><span class='comma'>,</span>
2176
- <span class='label'>oauth:</span> <span class='id identifier rubyid_oauth'>oauth</span><span class='comma'>,</span>
2177
- <span class='label'>logging:</span> <span class='id identifier rubyid_logging'>logging</span><span class='comma'>,</span>
2178
- <span class='label'>saml:</span> <span class='id identifier rubyid_saml'>saml</span><span class='comma'>,</span>
2179
- <span class='label'>oidc:</span> <span class='id identifier rubyid_oidc'>oidc</span>
2180
- <span class='rparen'>)</span>
2181
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
2182
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
2292
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 264</span>
2293
+
2294
+ <span class='kw'>def</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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
2295
+ <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'>/endpoint_configurations/%{id}</span><span class='tstring_end'>&#39;</span></span>
2296
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
2297
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
2298
+ <span class='rbrace'>}</span>
2299
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2300
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
2301
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
2302
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
2303
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
2304
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
2305
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
2306
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
2307
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
2308
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
2309
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
2310
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
2311
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
2312
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
2313
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
2314
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='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>
2315
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
2183
2316
  <span class='kw'>end</span></pre>
2184
2317
  </td>
2185
2318
  </tr>
@@ -2191,9 +2324,9 @@
2191
2324
  </div>
2192
2325
 
2193
2326
  <div id="footer">
2194
- Generated on Fri Sep 24 19:20:29 2021 by
2327
+ Generated on Thu Dec 2 18:48:57 2021 by
2195
2328
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2196
- 0.9.26 (ruby-3.0.1).
2329
+ 0.9.27 (ruby-3.0.1).
2197
2330
  </div>
2198
2331
 
2199
2332
  </div>