ngrok-api 0.18.0 → 0.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +7 -7
- data/.gitignore +15 -13
- data/.rubocop.yml +30 -28
- data/.rubocop_airbnb.yml +4 -2
- data/.simplecov +3 -1
- data/CHANGELOG.md +8 -0
- data/CODE_OF_CONDUCT.md +45 -0
- data/Gemfile +34 -32
- data/Guardfile +18 -16
- data/README.md +94 -61
- data/Rakefile +9 -7
- data/doc/NgrokAPI/Client.html +229 -125
- data/doc/NgrokAPI/Error.html +12 -12
- data/doc/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/doc/NgrokAPI/Errors.html +4 -4
- data/doc/NgrokAPI/HttpClient.html +208 -65
- data/doc/NgrokAPI/Models/APIKey.html +220 -90
- data/doc/NgrokAPI/Models/AWSAuth.html +113 -61
- data/doc/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/doc/NgrokAPI/Models/AWSRole.html +101 -49
- data/doc/NgrokAPI/Models/AbuseReport.html +165 -109
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/doc/NgrokAPI/Models/AgentIngress.html +365 -155
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/doc/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/doc/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/doc/NgrokAPI/Models/BrowserSession.html +743 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +223 -167
- data/doc/NgrokAPI/Models/Credential.html +225 -95
- data/doc/NgrokAPI/Models/Endpoint.html +215 -159
- data/doc/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/doc/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/doc/NgrokAPI/Models/EventDestination.html +178 -122
- data/doc/NgrokAPI/Models/EventSource.html +136 -80
- data/doc/NgrokAPI/Models/EventSourceList.html +112 -56
- data/doc/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/doc/NgrokAPI/Models/EventSubscription.html +178 -122
- data/doc/NgrokAPI/Models/EventTarget.html +206 -80
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/doc/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/doc/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/doc/NgrokAPI/Models/IPPolicy.html +178 -122
- data/doc/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/doc/NgrokAPI/Models/IPRestriction.html +190 -134
- data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/doc/NgrokAPI/Models/Listable.html +130 -130
- data/doc/NgrokAPI/Models/Location.html +817 -0
- data/doc/NgrokAPI/Models/Ref.html +119 -63
- data/doc/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/doc/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/doc/NgrokAPI/Models/SSHCredential.html +232 -102
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/doc/NgrokAPI/Models/TCPEdge.html +204 -148
- data/doc/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/doc/NgrokAPI/Models/TLSEdge.html +216 -160
- data/doc/NgrokAPI/Models/Tunnel.html +205 -149
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/doc/NgrokAPI/Models/TunnelSession.html +193 -137
- data/doc/NgrokAPI/Models/UserAgent.html +965 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +53 -53
- data/doc/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/doc/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/doc/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/doc/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +6 -6
- data/doc/_index.html +139 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -51
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -51
- data/doc/method_list.html +4383 -2175
- data/doc/top-level-namespace.html +4 -4
- data/docs/NgrokAPI/Client.html +229 -125
- data/docs/NgrokAPI/Error.html +12 -12
- data/docs/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/docs/NgrokAPI/Errors.html +4 -4
- data/docs/NgrokAPI/HttpClient.html +208 -65
- data/docs/NgrokAPI/Models/APIKey.html +220 -90
- data/docs/NgrokAPI/Models/AWSAuth.html +113 -61
- data/docs/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/docs/NgrokAPI/Models/AWSRole.html +101 -49
- data/docs/NgrokAPI/Models/AbuseReport.html +165 -109
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/docs/NgrokAPI/Models/AgentIngress.html +365 -155
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/docs/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/docs/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/docs/NgrokAPI/Models/BrowserSession.html +743 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +223 -167
- data/docs/NgrokAPI/Models/Credential.html +225 -95
- data/docs/NgrokAPI/Models/Endpoint.html +215 -159
- data/docs/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/docs/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/docs/NgrokAPI/Models/EventDestination.html +178 -122
- data/docs/NgrokAPI/Models/EventSource.html +136 -80
- data/docs/NgrokAPI/Models/EventSourceList.html +112 -56
- data/docs/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/docs/NgrokAPI/Models/EventSubscription.html +178 -122
- data/docs/NgrokAPI/Models/EventTarget.html +206 -80
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/docs/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/docs/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/docs/NgrokAPI/Models/IPPolicy.html +178 -122
- data/docs/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/docs/NgrokAPI/Models/IPRestriction.html +190 -134
- data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/docs/NgrokAPI/Models/Listable.html +130 -130
- data/docs/NgrokAPI/Models/Location.html +817 -0
- data/docs/NgrokAPI/Models/Ref.html +119 -63
- data/docs/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/docs/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/docs/NgrokAPI/Models/SSHCredential.html +232 -102
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/docs/NgrokAPI/Models/TCPEdge.html +204 -148
- data/docs/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/docs/NgrokAPI/Models/TLSEdge.html +216 -160
- data/docs/NgrokAPI/Models/Tunnel.html +205 -149
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/docs/NgrokAPI/Models/TunnelSession.html +193 -137
- data/docs/NgrokAPI/Models/UserAgent.html +965 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +53 -53
- data/docs/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/docs/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/docs/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/docs/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +6 -6
- data/docs/_index.html +139 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -51
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -51
- data/docs/method_list.html +4383 -2175
- data/docs/top-level-namespace.html +4 -4
- data/lib/ngrokapi/client.rb +21 -11
- data/lib/ngrokapi/error.rb +2 -0
- data/lib/ngrokapi/errors/not_found_error.rb +2 -0
- data/lib/ngrokapi/http_client.rb +153 -131
- data/lib/ngrokapi/models/abuse_report.rb +22 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +13 -7
- data/lib/ngrokapi/models/agent_ingress.rb +33 -16
- data/lib/ngrokapi/models/agent_ingress_cert_job.rb +37 -0
- data/lib/ngrokapi/models/agent_ingress_cert_policy.rb +33 -0
- data/lib/ngrokapi/models/agent_ingress_cert_status.rb +33 -0
- data/lib/ngrokapi/models/api_key.rb +24 -12
- data/lib/ngrokapi/models/application_session.rb +67 -0
- data/lib/ngrokapi/models/application_user.rb +63 -0
- data/lib/ngrokapi/models/aws_auth.rb +13 -7
- data/lib/ngrokapi/models/aws_credentials.rb +13 -7
- data/lib/ngrokapi/models/aws_role.rb +12 -6
- data/lib/ngrokapi/models/browser_session.rb +35 -0
- data/lib/ngrokapi/models/certificate_authority.rb +26 -16
- data/lib/ngrokapi/models/credential.rb +25 -13
- data/lib/ngrokapi/models/endpoint.rb +28 -18
- data/lib/ngrokapi/models/endpoint_backend.rb +13 -7
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +17 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +12 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +13 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +24 -10
- data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +20 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +37 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +26 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +14 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +13 -7
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +14 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +12 -6
- data/lib/ngrokapi/models/event_destination.rb +22 -12
- data/lib/ngrokapi/models/event_source.rb +19 -9
- data/lib/ngrokapi/models/event_source_list.rb +17 -7
- data/lib/ngrokapi/models/event_source_replace.rb +14 -8
- data/lib/ngrokapi/models/event_subscription.rb +22 -12
- data/lib/ngrokapi/models/event_target.rb +18 -10
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +13 -7
- data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +13 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +13 -7
- data/lib/ngrokapi/models/failover_backend.rb +22 -12
- data/lib/ngrokapi/models/http_response_backend.rb +23 -13
- data/lib/ngrokapi/models/https_edge.rb +24 -14
- data/lib/ngrokapi/models/https_edge_route.rb +34 -24
- data/lib/ngrokapi/models/identity_provider.rb +33 -0
- data/lib/ngrokapi/models/ip_policy.rb +21 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +23 -13
- data/lib/ngrokapi/models/ip_restriction.rb +23 -13
- data/lib/ngrokapi/models/listable.rb +55 -53
- data/lib/ngrokapi/models/location.rb +37 -0
- data/lib/ngrokapi/models/ref.rb +17 -7
- data/lib/ngrokapi/models/reserved_addr.rb +23 -13
- data/lib/ngrokapi/models/reserved_domain.rb +29 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +15 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +13 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +13 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +22 -12
- data/lib/ngrokapi/models/ssh_credential.rb +25 -13
- data/lib/ngrokapi/models/ssh_host_certificate.rb +27 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +29 -19
- data/lib/ngrokapi/models/tcp_edge.rb +23 -13
- data/lib/ngrokapi/models/tls_certificate.rb +36 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +13 -7
- data/lib/ngrokapi/models/tls_edge.rb +25 -15
- data/lib/ngrokapi/models/tunnel.rb +26 -16
- data/lib/ngrokapi/models/tunnel_group_backend.rb +23 -13
- data/lib/ngrokapi/models/tunnel_session.rb +25 -15
- data/lib/ngrokapi/models/user_agent.rb +41 -0
- data/lib/ngrokapi/models/weighted_backend.rb +22 -12
- data/lib/ngrokapi/paged_iterator.rb +44 -42
- data/lib/ngrokapi/services/abuse_reports_client.rb +27 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +45 -14
- data/lib/ngrokapi/services/api_keys_client.rb +37 -12
- data/lib/ngrokapi/services/application_sessions_client.rb +141 -0
- data/lib/ngrokapi/services/application_users_client.rb +141 -0
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -11
- data/lib/ngrokapi/services/credentials_client.rb +45 -16
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +8 -8
- data/lib/ngrokapi/services/edges_https_client.rb +37 -11
- data/lib/ngrokapi/services/edges_https_routes_client.rb +55 -5
- data/lib/ngrokapi/services/edges_tcp_client.rb +37 -11
- data/lib/ngrokapi/services/edges_tls_client.rb +41 -11
- data/lib/ngrokapi/services/endpoints_client.rb +8 -8
- data/lib/ngrokapi/services/event_destinations_client.rb +37 -13
- data/lib/ngrokapi/services/event_sources_client.rb +29 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +35 -11
- data/lib/ngrokapi/services/failover_backends_client.rb +35 -13
- data/lib/ngrokapi/services/http_response_backends_client.rb +34 -11
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/ip_policies_client.rb +32 -11
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
- data/lib/ngrokapi/services/ip_restrictions_client.rb +37 -11
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -11
- data/lib/ngrokapi/services/reserved_domains_client.rb +44 -16
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +37 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +44 -15
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +41 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +48 -14
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_certificates_client.rb +37 -13
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +35 -13
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +8 -8
- data/lib/ngrokapi/services/tunnels_client.rb +8 -8
- data/lib/ngrokapi/services/weighted_backends_client.rb +38 -16
- data/lib/ngrokapi/version.rb +9 -7
- data/lib/ngrokapi.rb +15 -13
- data/ngrok-api.gemspec +29 -27
- data/spec/ngrokapi/client_spec.rb +20 -6
- data/spec/ngrokapi/http_client_spec.rb +77 -75
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +4 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +4 -2
- data/spec/ngrokapi/models/agent_ingress_cert_job_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_status_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +8 -3
- data/spec/ngrokapi/models/api_key_spec.rb +4 -2
- data/spec/ngrokapi/models/application_session_spec.rb +30 -0
- data/spec/ngrokapi/models/application_user_spec.rb +30 -0
- data/spec/ngrokapi/models/aws_auth_spec.rb +4 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +4 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +4 -2
- data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/credential_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +4 -2
- data/spec/ngrokapi/models/event_destination_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_spec.rb +4 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_spec.rb +4 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/http_response_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_route_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +4 -2
- data/spec/ngrokapi/models/listable_spec.rb +45 -43
- data/spec/ngrokapi/models/location_spec.rb +23 -0
- data/spec/ngrokapi/models/ref_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_session_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +4 -2
- data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +4 -2
- data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +21 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +34 -3
- data/spec/ngrokapi/services/api_keys_client_spec.rb +28 -1
- data/spec/ngrokapi/services/application_sessions_client_spec.rb +100 -0
- data/spec/ngrokapi/services/application_users_client_spec.rb +100 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +23 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +30 -1
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edges_https_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +49 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +31 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +26 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +23 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +23 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +27 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +22 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +27 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +24 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +38 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +32 -1
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +31 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +35 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +25 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +23 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +2 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +23 -0
- data/spec/spec_helper.rb +94 -2
- metadata +68 -4
- data/doc/README +0 -94
- data/docs/README +0 -94
data/doc/NgrokAPI/Error.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Exception: NgrokAPI::Error
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -224,13 +224,13 @@
|
|
|
224
224
|
<pre class="lines">
|
|
225
225
|
|
|
226
226
|
|
|
227
|
-
9
|
|
228
|
-
10
|
|
229
227
|
11
|
|
230
|
-
12
|
|
228
|
+
12
|
|
229
|
+
13
|
|
230
|
+
14</pre>
|
|
231
231
|
</td>
|
|
232
232
|
<td>
|
|
233
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line
|
|
233
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line 11</span>
|
|
234
234
|
|
|
235
235
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>An error occurred with the NgrokAPI</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
236
236
|
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
|
|
@@ -274,12 +274,12 @@
|
|
|
274
274
|
<pre class="lines">
|
|
275
275
|
|
|
276
276
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
277
|
+
9
|
|
278
|
+
10
|
|
279
|
+
11</pre>
|
|
280
280
|
</td>
|
|
281
281
|
<td>
|
|
282
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line
|
|
282
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/error.rb', line 9</span>
|
|
283
283
|
|
|
284
284
|
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
|
285
285
|
<span class='ivar'>@response</span>
|
|
@@ -295,9 +295,9 @@
|
|
|
295
295
|
</div>
|
|
296
296
|
|
|
297
297
|
<div id="footer">
|
|
298
|
-
Generated on Thu
|
|
299
|
-
<a href="
|
|
300
|
-
0.9.
|
|
298
|
+
Generated on Thu Aug 24 20:57:26 2023 by
|
|
299
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
300
|
+
0.9.34 (ruby-3.0.6).
|
|
301
301
|
</div>
|
|
302
302
|
|
|
303
303
|
</div>
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Exception: NgrokAPI::Errors::NotFoundError
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -228,13 +228,13 @@
|
|
|
228
228
|
<pre class="lines">
|
|
229
229
|
|
|
230
230
|
|
|
231
|
-
10
|
|
232
|
-
11
|
|
233
231
|
12
|
|
234
|
-
13
|
|
232
|
+
13
|
|
233
|
+
14
|
|
234
|
+
15</pre>
|
|
235
235
|
</td>
|
|
236
236
|
<td>
|
|
237
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/errors/not_found_error.rb', line
|
|
237
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/errors/not_found_error.rb', line 12</span>
|
|
238
238
|
|
|
239
239
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>msg:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Resource not found</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>response:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
240
240
|
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
|
|
@@ -278,12 +278,12 @@
|
|
|
278
278
|
<pre class="lines">
|
|
279
279
|
|
|
280
280
|
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
281
|
+
10
|
|
282
|
+
11
|
|
283
|
+
12</pre>
|
|
284
284
|
</td>
|
|
285
285
|
<td>
|
|
286
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/errors/not_found_error.rb', line
|
|
286
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/errors/not_found_error.rb', line 10</span>
|
|
287
287
|
|
|
288
288
|
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
|
|
289
289
|
<span class='ivar'>@response</span>
|
|
@@ -299,9 +299,9 @@
|
|
|
299
299
|
</div>
|
|
300
300
|
|
|
301
301
|
<div id="footer">
|
|
302
|
-
Generated on Thu
|
|
303
|
-
<a href="
|
|
304
|
-
0.9.
|
|
302
|
+
Generated on Thu Aug 24 20:57:29 2023 by
|
|
303
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
304
|
+
0.9.34 (ruby-3.0.6).
|
|
305
305
|
</div>
|
|
306
306
|
|
|
307
307
|
</div>
|
data/doc/NgrokAPI/Errors.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Module: NgrokAPI::Errors
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -105,9 +105,9 @@
|
|
|
105
105
|
</div>
|
|
106
106
|
|
|
107
107
|
<div id="footer">
|
|
108
|
-
Generated on Thu
|
|
109
|
-
<a href="
|
|
110
|
-
0.9.
|
|
108
|
+
Generated on Thu Aug 24 20:57:26 2023 by
|
|
109
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
110
|
+
0.9.34 (ruby-3.0.6).
|
|
111
111
|
</div>
|
|
112
112
|
|
|
113
113
|
</div>
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: NgrokAPI::HttpClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -331,6 +331,30 @@
|
|
|
331
331
|
<p>Make a POST request to a given URI with optional data.</p>
|
|
332
332
|
</div></span>
|
|
333
333
|
|
|
334
|
+
</li>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<li class="public ">
|
|
338
|
+
<span class="summary_signature">
|
|
339
|
+
|
|
340
|
+
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, danger: false, data: {}) ⇒ json </a>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</span>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<span class="summary_desc"><div class='inline'>
|
|
355
|
+
<p>Make a PUT request to a given URI with optional data.</p>
|
|
356
|
+
</div></span>
|
|
357
|
+
|
|
334
358
|
</li>
|
|
335
359
|
|
|
336
360
|
|
|
@@ -366,17 +390,17 @@
|
|
|
366
390
|
<pre class="lines">
|
|
367
391
|
|
|
368
392
|
|
|
369
|
-
11
|
|
370
|
-
12
|
|
371
393
|
13
|
|
372
|
-
14
|
|
394
|
+
14
|
|
395
|
+
15
|
|
396
|
+
16</pre>
|
|
373
397
|
</td>
|
|
374
398
|
<td>
|
|
375
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
399
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 13</span>
|
|
376
400
|
|
|
377
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>api_key:</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
378
|
-
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
|
379
|
-
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
|
401
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>api_key:</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
402
|
+
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
|
403
|
+
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
|
380
404
|
<span class='kw'>end</span></pre>
|
|
381
405
|
</td>
|
|
382
406
|
</tr>
|
|
@@ -416,12 +440,12 @@
|
|
|
416
440
|
<pre class="lines">
|
|
417
441
|
|
|
418
442
|
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
443
|
+
10
|
|
444
|
+
11
|
|
445
|
+
12</pre>
|
|
422
446
|
</td>
|
|
423
447
|
<td>
|
|
424
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
448
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 10</span>
|
|
425
449
|
|
|
426
450
|
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
|
427
451
|
<span class='ivar'>@api_key</span>
|
|
@@ -459,12 +483,12 @@
|
|
|
459
483
|
<pre class="lines">
|
|
460
484
|
|
|
461
485
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
486
|
+
10
|
|
487
|
+
11
|
|
488
|
+
12</pre>
|
|
465
489
|
</td>
|
|
466
490
|
<td>
|
|
467
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
491
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 10</span>
|
|
468
492
|
|
|
469
493
|
<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
|
470
494
|
<span class='ivar'>@base_url</span>
|
|
@@ -558,19 +582,19 @@
|
|
|
558
582
|
<pre class="lines">
|
|
559
583
|
|
|
560
584
|
|
|
561
|
-
22
|
|
562
|
-
23
|
|
563
585
|
24
|
|
564
586
|
25
|
|
565
|
-
26
|
|
587
|
+
26
|
|
588
|
+
27
|
|
589
|
+
28</pre>
|
|
566
590
|
</td>
|
|
567
591
|
<td>
|
|
568
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
592
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 24</span>
|
|
569
593
|
|
|
570
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
571
|
-
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
572
|
-
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Delete</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
573
|
-
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
|
|
594
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
595
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
596
|
+
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Delete</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
597
|
+
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
|
|
574
598
|
<span class='kw'>end</span></pre>
|
|
575
599
|
</td>
|
|
576
600
|
</tr>
|
|
@@ -677,19 +701,19 @@
|
|
|
677
701
|
<pre class="lines">
|
|
678
702
|
|
|
679
703
|
|
|
680
|
-
35
|
|
681
|
-
36
|
|
682
704
|
37
|
|
683
705
|
38
|
|
684
|
-
39
|
|
706
|
+
39
|
|
707
|
+
40
|
|
708
|
+
41</pre>
|
|
685
709
|
</td>
|
|
686
710
|
<td>
|
|
687
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
711
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 37</span>
|
|
688
712
|
|
|
689
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
690
|
-
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
691
|
-
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
692
|
-
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
|
|
713
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
714
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
715
|
+
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Get</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
716
|
+
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='rparen'>)</span>
|
|
693
717
|
<span class='kw'>end</span></pre>
|
|
694
718
|
</td>
|
|
695
719
|
</tr>
|
|
@@ -852,8 +876,6 @@
|
|
|
852
876
|
<pre class="lines">
|
|
853
877
|
|
|
854
878
|
|
|
855
|
-
51
|
|
856
|
-
52
|
|
857
879
|
53
|
|
858
880
|
54
|
|
859
881
|
55
|
|
@@ -861,20 +883,22 @@
|
|
|
861
883
|
57
|
|
862
884
|
58
|
|
863
885
|
59
|
|
864
|
-
60
|
|
886
|
+
60
|
|
887
|
+
61
|
|
888
|
+
62</pre>
|
|
865
889
|
</td>
|
|
866
890
|
<td>
|
|
867
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
868
|
-
|
|
869
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</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'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
870
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
|
871
|
-
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
|
872
|
-
<span class='kw'>else</span>
|
|
873
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
874
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:before_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_before_id'>before_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_before_id'>before_id</span>
|
|
875
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_limit'>limit</span> <span class='kw'>if</span> <span class='id identifier rubyid_limit'>limit</span>
|
|
876
|
-
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
877
|
-
<span class='kw'>end</span>
|
|
891
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 53</span>
|
|
892
|
+
|
|
893
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</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'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
894
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
|
895
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
|
896
|
+
<span class='kw'>else</span>
|
|
897
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
898
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:before_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_before_id'>before_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_before_id'>before_id</span>
|
|
899
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_limit'>limit</span> <span class='kw'>if</span> <span class='id identifier rubyid_limit'>limit</span>
|
|
900
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
901
|
+
<span class='kw'>end</span>
|
|
878
902
|
<span class='kw'>end</span></pre>
|
|
879
903
|
</td>
|
|
880
904
|
</tr>
|
|
@@ -981,19 +1005,19 @@
|
|
|
981
1005
|
<pre class="lines">
|
|
982
1006
|
|
|
983
1007
|
|
|
984
|
-
69
|
|
985
|
-
70
|
|
986
1008
|
71
|
|
987
1009
|
72
|
|
988
|
-
73
|
|
1010
|
+
73
|
|
1011
|
+
74
|
|
1012
|
+
75</pre>
|
|
989
1013
|
</td>
|
|
990
1014
|
<td>
|
|
991
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
1015
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 71</span>
|
|
992
1016
|
|
|
993
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
994
|
-
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
995
|
-
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Patch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
|
|
996
|
-
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
|
1017
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1018
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1019
|
+
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Patch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
|
|
1020
|
+
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
|
997
1021
|
<span class='kw'>end</span></pre>
|
|
998
1022
|
</td>
|
|
999
1023
|
</tr>
|
|
@@ -1100,19 +1124,138 @@
|
|
|
1100
1124
|
<pre class="lines">
|
|
1101
1125
|
|
|
1102
1126
|
|
|
1103
|
-
82
|
|
1104
|
-
83
|
|
1105
1127
|
84
|
|
1106
1128
|
85
|
|
1107
|
-
86
|
|
1129
|
+
86
|
|
1130
|
+
87
|
|
1131
|
+
88</pre>
|
|
1132
|
+
</td>
|
|
1133
|
+
<td>
|
|
1134
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 84</span>
|
|
1135
|
+
|
|
1136
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1137
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1138
|
+
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
|
|
1139
|
+
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
|
1140
|
+
<span class='kw'>end</span></pre>
|
|
1141
|
+
</td>
|
|
1142
|
+
</tr>
|
|
1143
|
+
</table>
|
|
1144
|
+
</div>
|
|
1145
|
+
|
|
1146
|
+
<div class="method_details ">
|
|
1147
|
+
<h3 class="signature " id="put-instance_method">
|
|
1148
|
+
|
|
1149
|
+
#<strong>put</strong>(path, danger: false, data: {}) ⇒ <tt>json</tt>
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
</h3><div class="docstring">
|
|
1156
|
+
<div class="discussion">
|
|
1157
|
+
|
|
1158
|
+
<p>Make a PUT request to a given URI with optional data</p>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
</div>
|
|
1162
|
+
</div>
|
|
1163
|
+
<div class="tags">
|
|
1164
|
+
<p class="tag_title">Parameters:</p>
|
|
1165
|
+
<ul class="param">
|
|
1166
|
+
|
|
1167
|
+
<li>
|
|
1168
|
+
|
|
1169
|
+
<span class='name'>path</span>
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
—
|
|
1177
|
+
<div class='inline'>
|
|
1178
|
+
<p>URL resource path</p>
|
|
1179
|
+
</div>
|
|
1180
|
+
|
|
1181
|
+
</li>
|
|
1182
|
+
|
|
1183
|
+
<li>
|
|
1184
|
+
|
|
1185
|
+
<span class='name'>danger</span>
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
—
|
|
1195
|
+
<div class='inline'>
|
|
1196
|
+
<p>determine if we should throw an exception on 404 or not</p>
|
|
1197
|
+
</div>
|
|
1198
|
+
|
|
1199
|
+
</li>
|
|
1200
|
+
|
|
1201
|
+
<li>
|
|
1202
|
+
|
|
1203
|
+
<span class='name'>data</span>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
<span class='type'>(<tt>hash</tt>)</span>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
—
|
|
1213
|
+
<div class='inline'>
|
|
1214
|
+
<p>hash which will be converted to query parameters or form data</p>
|
|
1215
|
+
</div>
|
|
1216
|
+
|
|
1217
|
+
</li>
|
|
1218
|
+
|
|
1219
|
+
</ul>
|
|
1220
|
+
|
|
1221
|
+
<p class="tag_title">Returns:</p>
|
|
1222
|
+
<ul class="return">
|
|
1223
|
+
|
|
1224
|
+
<li>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<span class='type'>(<tt>json</tt>)</span>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
—
|
|
1232
|
+
<div class='inline'>
|
|
1233
|
+
<p>response body</p>
|
|
1234
|
+
</div>
|
|
1235
|
+
|
|
1236
|
+
</li>
|
|
1237
|
+
|
|
1238
|
+
</ul>
|
|
1239
|
+
|
|
1240
|
+
</div><table class="source_code">
|
|
1241
|
+
<tr>
|
|
1242
|
+
<td>
|
|
1243
|
+
<pre class="lines">
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
97
|
|
1247
|
+
98
|
|
1248
|
+
99
|
|
1249
|
+
100
|
|
1250
|
+
101</pre>
|
|
1108
1251
|
</td>
|
|
1109
1252
|
<td>
|
|
1110
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line
|
|
1253
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 97</span>
|
|
1111
1254
|
|
|
1112
|
-
<span class='kw'>def</span> <span class='id identifier
|
|
1113
|
-
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1114
|
-
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>
|
|
1115
|
-
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
|
1255
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1256
|
+
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1257
|
+
<span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Put</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
|
|
1258
|
+
<span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
|
1116
1259
|
<span class='kw'>end</span></pre>
|
|
1117
1260
|
</td>
|
|
1118
1261
|
</tr>
|
|
@@ -1124,9 +1267,9 @@
|
|
|
1124
1267
|
</div>
|
|
1125
1268
|
|
|
1126
1269
|
<div id="footer">
|
|
1127
|
-
Generated on Thu
|
|
1128
|
-
<a href="
|
|
1129
|
-
0.9.
|
|
1270
|
+
Generated on Thu Aug 24 20:57:27 2023 by
|
|
1271
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1272
|
+
0.9.34 (ruby-3.0.6).
|
|
1130
1273
|
</div>
|
|
1131
1274
|
|
|
1132
1275
|
</div>
|