ngrok-api 0.19.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 -88
- 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 +73 -73
- data/doc/NgrokAPI/Models/APIKey.html +150 -72
- data/doc/NgrokAPI/Models/AWSAuth.html +36 -36
- data/doc/NgrokAPI/Models/AWSCredentials.html +36 -36
- data/doc/NgrokAPI/Models/AWSRole.html +32 -32
- data/doc/NgrokAPI/Models/AbuseReport.html +63 -59
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +36 -36
- data/doc/NgrokAPI/Models/AgentIngress.html +245 -87
- 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 +93 -89
- data/doc/NgrokAPI/Models/Credential.html +154 -76
- data/doc/NgrokAPI/Models/Endpoint.html +87 -83
- data/doc/NgrokAPI/Models/EndpointBackend.html +36 -36
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
- data/doc/NgrokAPI/Models/EndpointCompression.html +32 -32
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointOAuth.html +56 -56
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +64 -64
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
- data/doc/NgrokAPI/Models/EndpointSAML.html +114 -98
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
- data/doc/NgrokAPI/Models/EventDestination.html +69 -65
- data/doc/NgrokAPI/Models/EventSource.html +51 -47
- data/doc/NgrokAPI/Models/EventSourceList.html +43 -39
- data/doc/NgrokAPI/Models/EventSourceReplace.html +40 -40
- data/doc/NgrokAPI/Models/EventSubscription.html +69 -65
- data/doc/NgrokAPI/Models/EventTarget.html +119 -45
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +36 -36
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +36 -36
- data/doc/NgrokAPI/Models/FailoverBackend.html +73 -69
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
- data/doc/NgrokAPI/Models/HTTPSEdge.html +85 -81
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
- data/doc/NgrokAPI/Models/IPPolicy.html +73 -69
- data/doc/NgrokAPI/Models/IPPolicyRule.html +81 -77
- data/doc/NgrokAPI/Models/IPRestriction.html +73 -69
- data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/doc/NgrokAPI/Models/Listable.html +79 -79
- data/doc/NgrokAPI/Models/Location.html +817 -0
- data/doc/NgrokAPI/Models/Ref.html +43 -39
- data/doc/NgrokAPI/Models/ReservedAddr.html +73 -69
- data/doc/NgrokAPI/Models/ReservedDomain.html +97 -93
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
- data/doc/NgrokAPI/Models/SSHCredential.html +154 -76
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +97 -93
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +105 -101
- data/doc/NgrokAPI/Models/TCPEdge.html +81 -77
- data/doc/NgrokAPI/Models/TLSCertificate.html +133 -129
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
- data/doc/NgrokAPI/Models/TLSEdge.html +89 -85
- data/doc/NgrokAPI/Models/Tunnel.html +79 -75
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
- data/doc/NgrokAPI/Models/TunnelSession.html +75 -71
- data/doc/NgrokAPI/Models/UserAgent.html +965 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +73 -69
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +53 -53
- data/doc/NgrokAPI/Services/APIKeysClient.html +134 -94
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +28 -28
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +184 -104
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +52 -52
- data/doc/NgrokAPI/Services/CredentialsClient.html +139 -99
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +52 -52
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +52 -52
- data/doc/NgrokAPI/Services/EndpointsClient.html +28 -28
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +17 -17
- data/doc/NgrokAPI/Services/EventSourcesClient.html +52 -52
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +52 -52
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
- data/doc/NgrokAPI/Services/TunnelsClient.html +28 -28
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
- 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 +45 -41
- data/doc/frames.html +1 -1
- data/doc/index.html +45 -41
- data/doc/method_list.html +2127 -671
- 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 +73 -73
- data/docs/NgrokAPI/Models/APIKey.html +150 -72
- data/docs/NgrokAPI/Models/AWSAuth.html +36 -36
- data/docs/NgrokAPI/Models/AWSCredentials.html +36 -36
- data/docs/NgrokAPI/Models/AWSRole.html +32 -32
- data/docs/NgrokAPI/Models/AbuseReport.html +63 -59
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +36 -36
- data/docs/NgrokAPI/Models/AgentIngress.html +245 -87
- 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 +93 -89
- data/docs/NgrokAPI/Models/Credential.html +154 -76
- data/docs/NgrokAPI/Models/Endpoint.html +87 -83
- data/docs/NgrokAPI/Models/EndpointBackend.html +36 -36
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
- data/docs/NgrokAPI/Models/EndpointCompression.html +32 -32
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointOAuth.html +56 -56
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +64 -64
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
- data/docs/NgrokAPI/Models/EndpointSAML.html +114 -98
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
- data/docs/NgrokAPI/Models/EventDestination.html +69 -65
- data/docs/NgrokAPI/Models/EventSource.html +51 -47
- data/docs/NgrokAPI/Models/EventSourceList.html +43 -39
- data/docs/NgrokAPI/Models/EventSourceReplace.html +40 -40
- data/docs/NgrokAPI/Models/EventSubscription.html +69 -65
- data/docs/NgrokAPI/Models/EventTarget.html +119 -45
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +36 -36
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +36 -36
- data/docs/NgrokAPI/Models/FailoverBackend.html +73 -69
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
- data/docs/NgrokAPI/Models/HTTPSEdge.html +85 -81
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
- data/docs/NgrokAPI/Models/IPPolicy.html +73 -69
- data/docs/NgrokAPI/Models/IPPolicyRule.html +81 -77
- data/docs/NgrokAPI/Models/IPRestriction.html +73 -69
- data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/docs/NgrokAPI/Models/Listable.html +79 -79
- data/docs/NgrokAPI/Models/Location.html +817 -0
- data/docs/NgrokAPI/Models/Ref.html +43 -39
- data/docs/NgrokAPI/Models/ReservedAddr.html +73 -69
- data/docs/NgrokAPI/Models/ReservedDomain.html +97 -93
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
- data/docs/NgrokAPI/Models/SSHCredential.html +154 -76
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +97 -93
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +105 -101
- data/docs/NgrokAPI/Models/TCPEdge.html +81 -77
- data/docs/NgrokAPI/Models/TLSCertificate.html +133 -129
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
- data/docs/NgrokAPI/Models/TLSEdge.html +89 -85
- data/docs/NgrokAPI/Models/Tunnel.html +79 -75
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
- data/docs/NgrokAPI/Models/TunnelSession.html +75 -71
- data/docs/NgrokAPI/Models/UserAgent.html +965 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +73 -69
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +53 -53
- data/docs/NgrokAPI/Services/APIKeysClient.html +134 -94
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +28 -28
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +184 -104
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +52 -52
- data/docs/NgrokAPI/Services/CredentialsClient.html +139 -99
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +52 -52
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +52 -52
- data/docs/NgrokAPI/Services/EndpointsClient.html +28 -28
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +17 -17
- data/docs/NgrokAPI/Services/EventSourcesClient.html +52 -52
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +52 -52
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
- data/docs/NgrokAPI/Services/TunnelsClient.html +28 -28
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
- 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 +45 -41
- data/docs/frames.html +1 -1
- data/docs/index.html +45 -41
- data/docs/method_list.html +2127 -671
- 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 -150
- data/lib/ngrokapi/models/abuse_report.rb +7 -1
- data/lib/ngrokapi/models/abuse_report_hostname.rb +2 -0
- data/lib/ngrokapi/models/agent_ingress.rb +17 -4
- 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 +10 -2
- 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 +2 -0
- data/lib/ngrokapi/models/aws_credentials.rb +2 -0
- data/lib/ngrokapi/models/aws_role.rb +2 -0
- data/lib/ngrokapi/models/browser_session.rb +35 -0
- data/lib/ngrokapi/models/certificate_authority.rb +7 -1
- data/lib/ngrokapi/models/credential.rb +10 -2
- data/lib/ngrokapi/models/endpoint.rb +7 -1
- data/lib/ngrokapi/models/endpoint_backend.rb +2 -0
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +2 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +2 -0
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +2 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +2 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +11 -1
- data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +2 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +2 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +2 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +16 -4
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +7 -1
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +2 -0
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +2 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +2 -0
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +2 -0
- data/lib/ngrokapi/models/event_destination.rb +7 -1
- data/lib/ngrokapi/models/event_source.rb +7 -1
- data/lib/ngrokapi/models/event_source_list.rb +7 -1
- data/lib/ngrokapi/models/event_source_replace.rb +2 -0
- data/lib/ngrokapi/models/event_subscription.rb +7 -1
- data/lib/ngrokapi/models/event_target.rb +5 -1
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +2 -0
- data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +2 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +2 -0
- data/lib/ngrokapi/models/failover_backend.rb +7 -1
- data/lib/ngrokapi/models/http_response_backend.rb +7 -1
- data/lib/ngrokapi/models/https_edge.rb +7 -1
- data/lib/ngrokapi/models/https_edge_route.rb +7 -1
- data/lib/ngrokapi/models/identity_provider.rb +33 -0
- data/lib/ngrokapi/models/ip_policy.rb +7 -1
- data/lib/ngrokapi/models/ip_policy_rule.rb +7 -1
- data/lib/ngrokapi/models/ip_restriction.rb +7 -1
- data/lib/ngrokapi/models/listable.rb +55 -53
- data/lib/ngrokapi/models/location.rb +37 -0
- data/lib/ngrokapi/models/ref.rb +7 -1
- data/lib/ngrokapi/models/reserved_addr.rb +7 -1
- data/lib/ngrokapi/models/reserved_domain.rb +7 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +2 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +2 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +2 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +7 -1
- data/lib/ngrokapi/models/ssh_credential.rb +10 -2
- data/lib/ngrokapi/models/ssh_host_certificate.rb +7 -1
- data/lib/ngrokapi/models/ssh_user_certificate.rb +7 -1
- data/lib/ngrokapi/models/tcp_edge.rb +7 -1
- data/lib/ngrokapi/models/tls_certificate.rb +7 -1
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +2 -0
- data/lib/ngrokapi/models/tls_edge.rb +7 -1
- data/lib/ngrokapi/models/tunnel.rb +7 -1
- data/lib/ngrokapi/models/tunnel_group_backend.rb +7 -1
- data/lib/ngrokapi/models/tunnel_session.rb +7 -1
- data/lib/ngrokapi/models/user_agent.rb +41 -0
- data/lib/ngrokapi/models/weighted_backend.rb +7 -1
- data/lib/ngrokapi/paged_iterator.rb +44 -42
- data/lib/ngrokapi/services/abuse_reports_client.rb +2 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +14 -4
- data/lib/ngrokapi/services/api_keys_client.rb +8 -2
- 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 +2 -0
- data/lib/ngrokapi/services/credentials_client.rb +13 -7
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +2 -0
- data/lib/ngrokapi/services/edges_https_client.rb +2 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +2 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +2 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +2 -0
- data/lib/ngrokapi/services/endpoints_client.rb +2 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +4 -4
- data/lib/ngrokapi/services/event_sources_client.rb +2 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +2 -0
- data/lib/ngrokapi/services/failover_backends_client.rb +2 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +2 -0
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +2 -0
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +2 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +2 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +4 -2
- data/lib/ngrokapi/services/ip_restrictions_client.rb +2 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +2 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +10 -8
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +2 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +6 -4
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +6 -4
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +2 -0
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +2 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +2 -0
- data/lib/ngrokapi/services/tunnels_client.rb +2 -0
- data/lib/ngrokapi/services/weighted_backends_client.rb +2 -0
- 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 +2 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +2 -0
- 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 +6 -1
- data/spec/ngrokapi/models/api_key_spec.rb +2 -0
- 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 +2 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +2 -0
- data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -0
- data/spec/ngrokapi/models/credential_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +2 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_spec.rb +2 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_spec.rb +2 -0
- data/spec/ngrokapi/models/failover_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +2 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -0
- 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 +2 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +2 -0
- data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +2 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +2 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +14 -4
- data/spec/ngrokapi/services/api_keys_client_spec.rb +10 -2
- 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 +2 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +10 -2
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_https_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +2 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +2 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +2 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +2 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +10 -4
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +10 -2
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +2 -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 +2 -0
- data/spec/spec_helper.rb +94 -2
- metadata +68 -2
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
|
4
|
+
|
|
5
|
+
module NgrokAPI
|
|
6
|
+
module Services
|
|
7
|
+
##
|
|
8
|
+
# https://ngrok.com/docs/api#api-application-users
|
|
9
|
+
class ApplicationUsersClient
|
|
10
|
+
# The API path for the requests
|
|
11
|
+
PATH = '/app/users/%{id}'
|
|
12
|
+
# The List Property from the resulting API for list calls
|
|
13
|
+
LIST_PROPERTY = 'application_users'
|
|
14
|
+
|
|
15
|
+
attr_reader :client
|
|
16
|
+
|
|
17
|
+
def initialize(client:)
|
|
18
|
+
@client = client
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
##
|
|
22
|
+
# Get an application user by ID.
|
|
23
|
+
#
|
|
24
|
+
# @param [string] id a resource identifier
|
|
25
|
+
# @return [NgrokAPI::Models::ApplicationUser] result from the API request
|
|
26
|
+
#
|
|
27
|
+
# https://ngrok.com/docs/api#api-application-users-get
|
|
28
|
+
def get(id: "")
|
|
29
|
+
path = '/app/users/%{id}'
|
|
30
|
+
replacements = {
|
|
31
|
+
id: id,
|
|
32
|
+
}
|
|
33
|
+
data = {}
|
|
34
|
+
result = @client.get(path % replacements, data: data)
|
|
35
|
+
NgrokAPI::Models::ApplicationUser.new(client: self, attrs: result)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
##
|
|
39
|
+
# Get an application user by ID.
|
|
40
|
+
# Throws an exception if API error.
|
|
41
|
+
#
|
|
42
|
+
# @param [string] id a resource identifier
|
|
43
|
+
# @return [NgrokAPI::Models::ApplicationUser] result from the API request
|
|
44
|
+
#
|
|
45
|
+
# https://ngrok.com/docs/api#api-application-users-get
|
|
46
|
+
def get!(id: "")
|
|
47
|
+
path = '/app/users/%{id}'
|
|
48
|
+
replacements = {
|
|
49
|
+
id: id,
|
|
50
|
+
}
|
|
51
|
+
data = {}
|
|
52
|
+
result = @client.get(path % replacements, data: data, danger: true)
|
|
53
|
+
NgrokAPI::Models::ApplicationUser.new(client: self, attrs: result)
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
##
|
|
57
|
+
# Delete an application user by ID.
|
|
58
|
+
#
|
|
59
|
+
# @param [string] id a resource identifier
|
|
60
|
+
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
61
|
+
#
|
|
62
|
+
# https://ngrok.com/docs/api#api-application-users-delete
|
|
63
|
+
def delete(id: "")
|
|
64
|
+
path = '/app/users/%{id}'
|
|
65
|
+
replacements = {
|
|
66
|
+
id: id,
|
|
67
|
+
}
|
|
68
|
+
@client.delete(path % replacements)
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
##
|
|
72
|
+
# Delete an application user by ID.
|
|
73
|
+
# Throws an exception if API error.
|
|
74
|
+
#
|
|
75
|
+
# @param [string] id a resource identifier
|
|
76
|
+
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
77
|
+
#
|
|
78
|
+
# https://ngrok.com/docs/api#api-application-users-delete
|
|
79
|
+
def delete!(id: "")
|
|
80
|
+
path = '/app/users/%{id}'
|
|
81
|
+
replacements = {
|
|
82
|
+
id: id,
|
|
83
|
+
}
|
|
84
|
+
@client.delete(path % replacements, danger: true)
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
##
|
|
88
|
+
# List all application users for this account.
|
|
89
|
+
#
|
|
90
|
+
# @param [string] before_id
|
|
91
|
+
# @param [string] limit
|
|
92
|
+
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
93
|
+
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
94
|
+
#
|
|
95
|
+
# https://ngrok.com/docs/api#api-application-users-list
|
|
96
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
97
|
+
result = @client.list(
|
|
98
|
+
before_id: before_id,
|
|
99
|
+
limit: limit,
|
|
100
|
+
url: url,
|
|
101
|
+
path: PATH
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
NgrokAPI::Models::Listable.new(
|
|
105
|
+
client: self,
|
|
106
|
+
attrs: result,
|
|
107
|
+
list_property: LIST_PROPERTY,
|
|
108
|
+
klass: NgrokAPI::Models::ApplicationUser
|
|
109
|
+
)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
##
|
|
113
|
+
# List all application users for this account.
|
|
114
|
+
# Throws an exception if API error.
|
|
115
|
+
#
|
|
116
|
+
# @param [string] before_id
|
|
117
|
+
# @param [string] limit
|
|
118
|
+
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
119
|
+
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
120
|
+
#
|
|
121
|
+
# https://ngrok.com/docs/api#api-application-users-list
|
|
122
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
123
|
+
result = @client.list(
|
|
124
|
+
before_id: before_id,
|
|
125
|
+
limit: limit,
|
|
126
|
+
danger: true,
|
|
127
|
+
url: url,
|
|
128
|
+
path: PATH
|
|
129
|
+
)
|
|
130
|
+
|
|
131
|
+
NgrokAPI::Models::Listable.new(
|
|
132
|
+
client: self,
|
|
133
|
+
attrs: result,
|
|
134
|
+
list_property: LIST_PROPERTY,
|
|
135
|
+
klass: NgrokAPI::Models::ApplicationUser,
|
|
136
|
+
danger: true
|
|
137
|
+
)
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
|
4
|
+
|
|
3
5
|
module NgrokAPI
|
|
4
6
|
module Services
|
|
5
7
|
##
|
|
6
8
|
# Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
7
9
|
# agent to connect the ngrok service as your account. They are installed with
|
|
8
|
-
# the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
|
|
10
|
+
# the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
|
|
9
11
|
# configuration file with the `authtoken` property.
|
|
10
12
|
#
|
|
11
13
|
# https://ngrok.com/docs/api#api-credentials
|
|
@@ -29,11 +31,12 @@ module NgrokAPI
|
|
|
29
31
|
#
|
|
30
32
|
# @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
|
31
33
|
# @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
|
32
|
-
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and
|
|
34
|
+
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
|
35
|
+
# @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
|
33
36
|
# @return [NgrokAPI::Models::Credential] result from the API request
|
|
34
37
|
#
|
|
35
38
|
# https://ngrok.com/docs/api#api-credentials-create
|
|
36
|
-
def create(description: "", metadata: "", acl: [])
|
|
39
|
+
def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
|
|
37
40
|
path = '/credentials'
|
|
38
41
|
replacements = {
|
|
39
42
|
}
|
|
@@ -41,6 +44,7 @@ module NgrokAPI
|
|
|
41
44
|
data[:description] = description if description
|
|
42
45
|
data[:metadata] = metadata if metadata
|
|
43
46
|
data[:acl] = acl if acl
|
|
47
|
+
data[:owner_id] = owner_id if owner_id
|
|
44
48
|
result = @client.post(path % replacements, data: data)
|
|
45
49
|
NgrokAPI::Models::Credential.new(client: self, attrs: result)
|
|
46
50
|
end
|
|
@@ -54,11 +58,12 @@ module NgrokAPI
|
|
|
54
58
|
#
|
|
55
59
|
# @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
|
56
60
|
# @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
|
57
|
-
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and
|
|
61
|
+
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
|
62
|
+
# @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
|
58
63
|
# @return [NgrokAPI::Models::Credential] result from the API request
|
|
59
64
|
#
|
|
60
65
|
# https://ngrok.com/docs/api#api-credentials-create
|
|
61
|
-
def create!(description: "", metadata: "", acl: [])
|
|
66
|
+
def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
|
|
62
67
|
path = '/credentials'
|
|
63
68
|
replacements = {
|
|
64
69
|
}
|
|
@@ -66,6 +71,7 @@ module NgrokAPI
|
|
|
66
71
|
data[:description] = description if description
|
|
67
72
|
data[:metadata] = metadata if metadata
|
|
68
73
|
data[:acl] = acl if acl
|
|
74
|
+
data[:owner_id] = owner_id if owner_id
|
|
69
75
|
result = @client.post(path % replacements, data: data, danger: true)
|
|
70
76
|
NgrokAPI::Models::Credential.new(client: self, attrs: result)
|
|
71
77
|
end
|
|
@@ -195,7 +201,7 @@ module NgrokAPI
|
|
|
195
201
|
# @param [string] id
|
|
196
202
|
# @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
|
197
203
|
# @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
|
198
|
-
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and
|
|
204
|
+
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
|
199
205
|
# @return [NgrokAPI::Models::Credential] result from the API request
|
|
200
206
|
#
|
|
201
207
|
# https://ngrok.com/docs/api#api-credentials-update
|
|
@@ -219,7 +225,7 @@ module NgrokAPI
|
|
|
219
225
|
# @param [string] id
|
|
220
226
|
# @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
|
221
227
|
# @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
|
222
|
-
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and
|
|
228
|
+
# @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
|
223
229
|
# @return [NgrokAPI::Models::Credential] result from the API request
|
|
224
230
|
#
|
|
225
231
|
# https://ngrok.com/docs/api#api-credentials-update
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
|
4
|
+
|
|
3
5
|
module NgrokAPI
|
|
4
6
|
module Services
|
|
5
7
|
##
|
|
@@ -18,8 +20,7 @@ module NgrokAPI
|
|
|
18
20
|
|
|
19
21
|
##
|
|
20
22
|
# Create a new Event Destination. It will not apply to anything until it is
|
|
21
|
-
# associated with an Event
|
|
22
|
-
# Endpoint Config.
|
|
23
|
+
# associated with an Event Subscription.
|
|
23
24
|
#
|
|
24
25
|
# @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
|
|
25
26
|
# @param [string] description Human-readable description of the Event Destination. Optional, max 255 bytes.
|
|
@@ -43,8 +44,7 @@ module NgrokAPI
|
|
|
43
44
|
|
|
44
45
|
##
|
|
45
46
|
# Create a new Event Destination. It will not apply to anything until it is
|
|
46
|
-
# associated with an Event
|
|
47
|
-
# Endpoint Config.
|
|
47
|
+
# associated with an Event Subscription.
|
|
48
48
|
# Throws an exception if API error.
|
|
49
49
|
#
|
|
50
50
|
# @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
|
4
|
+
|
|
3
5
|
module NgrokAPI
|
|
4
6
|
module Services
|
|
5
7
|
##
|
|
@@ -30,7 +32,7 @@ module NgrokAPI
|
|
|
30
32
|
# @return [NgrokAPI::Models::IPPolicyRule] result from the API request
|
|
31
33
|
#
|
|
32
34
|
# https://ngrok.com/docs/api#api-ip-policy-rules-create
|
|
33
|
-
def create(description: "", metadata: "", cidr:, ip_policy_id:, action:
|
|
35
|
+
def create(description: "", metadata: "", cidr:, ip_policy_id:, action:)
|
|
34
36
|
path = '/ip_policy_rules'
|
|
35
37
|
replacements = {
|
|
36
38
|
}
|
|
@@ -56,7 +58,7 @@ module NgrokAPI
|
|
|
56
58
|
# @return [NgrokAPI::Models::IPPolicyRule] result from the API request
|
|
57
59
|
#
|
|
58
60
|
# https://ngrok.com/docs/api#api-ip-policy-rules-create
|
|
59
|
-
def create!(description: "", metadata: "", cidr:, ip_policy_id:, action:
|
|
61
|
+
def create!(description: "", metadata: "", cidr:, ip_policy_id:, action:)
|
|
60
62
|
path = '/ip_policy_rules'
|
|
61
63
|
replacements = {
|
|
62
64
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
|
4
|
+
|
|
3
5
|
module NgrokAPI
|
|
4
6
|
module Services
|
|
5
7
|
##
|
|
@@ -24,7 +26,7 @@ module NgrokAPI
|
|
|
24
26
|
##
|
|
25
27
|
# Create a new reserved domain.
|
|
26
28
|
#
|
|
27
|
-
# @param [string]
|
|
29
|
+
# @param [string] domain hostname of the reserved domain
|
|
28
30
|
# @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
|
29
31
|
# @param [string] description human-readable description of what this reserved domain will be used for
|
|
30
32
|
# @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
|
|
@@ -33,12 +35,12 @@ module NgrokAPI
|
|
|
33
35
|
# @return [NgrokAPI::Models::ReservedDomain] result from the API request
|
|
34
36
|
#
|
|
35
37
|
# https://ngrok.com/docs/api#api-reserved-domains-create
|
|
36
|
-
def create(name
|
|
38
|
+
def create(name: "", domain: "", region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
|
|
37
39
|
path = '/reserved_domains'
|
|
38
40
|
replacements = {
|
|
39
41
|
}
|
|
40
42
|
data = {}
|
|
41
|
-
data[:
|
|
43
|
+
data[:domain] = domain if domain
|
|
42
44
|
data[:region] = region if region
|
|
43
45
|
data[:description] = description if description
|
|
44
46
|
data[:metadata] = metadata if metadata
|
|
@@ -52,7 +54,7 @@ module NgrokAPI
|
|
|
52
54
|
# Create a new reserved domain.
|
|
53
55
|
# Throws an exception if API error.
|
|
54
56
|
#
|
|
55
|
-
# @param [string]
|
|
57
|
+
# @param [string] domain hostname of the reserved domain
|
|
56
58
|
# @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
|
57
59
|
# @param [string] description human-readable description of what this reserved domain will be used for
|
|
58
60
|
# @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
|
|
@@ -61,12 +63,12 @@ module NgrokAPI
|
|
|
61
63
|
# @return [NgrokAPI::Models::ReservedDomain] result from the API request
|
|
62
64
|
#
|
|
63
65
|
# https://ngrok.com/docs/api#api-reserved-domains-create
|
|
64
|
-
def create!(name
|
|
66
|
+
def create!(name: "", domain: "", region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
|
|
65
67
|
path = '/reserved_domains'
|
|
66
68
|
replacements = {
|
|
67
69
|
}
|
|
68
70
|
data = {}
|
|
69
|
-
data[:
|
|
71
|
+
data[:domain] = domain if domain
|
|
70
72
|
data[:region] = region if region
|
|
71
73
|
data[:description] = description if description
|
|
72
74
|
data[:metadata] = metadata if metadata
|
|
@@ -206,7 +208,7 @@ module NgrokAPI
|
|
|
206
208
|
# @return [NgrokAPI::Models::ReservedDomain] result from the API request
|
|
207
209
|
#
|
|
208
210
|
# https://ngrok.com/docs/api#api-reserved-domains-update
|
|
209
|
-
def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
|
|
211
|
+
def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil, region: nil)
|
|
210
212
|
path = '/reserved_domains/%{id}'
|
|
211
213
|
replacements = {
|
|
212
214
|
id: id,
|
|
@@ -232,7 +234,7 @@ module NgrokAPI
|
|
|
232
234
|
# @return [NgrokAPI::Models::ReservedDomain] result from the API request
|
|
233
235
|
#
|
|
234
236
|
# https://ngrok.com/docs/api#api-reserved-domains-update
|
|
235
|
-
def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
|
|
237
|
+
def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil, region: nil)
|
|
236
238
|
path = '/reserved_domains/%{id}'
|
|
237
239
|
replacements = {
|
|
238
240
|
id: id,
|