ngrok-api 0.25.0 → 0.27.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/CHANGELOG.md +10 -0
- data/Gemfile.lock +1 -1
- data/doc/NgrokAPI/Client.html +100 -48
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/doc/NgrokAPI/Models/BotUser.html +2 -2
- data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +5 -5
- data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/doc/NgrokAPI/Models/EventDestination.html +2 -2
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Location.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/Secret.html +95 -21
- data/doc/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
- data/doc/NgrokAPI/Models/Tunnel.html +2 -2
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/UserAgent.html +2 -2
- data/doc/NgrokAPI/Models/Vault.html +2 -2
- data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +97 -47
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +99 -49
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
- data/doc/NgrokAPI/Services/BotUsersClient.html +47 -31
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +101 -51
- data/doc/NgrokAPI/Services/CredentialsClient.html +105 -55
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +63 -47
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +63 -47
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +63 -47
- data/doc/NgrokAPI/Services/EndpointsClient.html +167 -117
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +101 -51
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +101 -51
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +97 -47
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +99 -49
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +101 -51
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +97 -47
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +133 -83
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +101 -51
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +105 -55
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +51 -35
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +51 -35
- data/doc/NgrokAPI/Services/SecretsClient.html +175 -81
- data/doc/NgrokAPI/Services/ServiceUsersClient.html +1767 -0
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +97 -47
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +141 -91
- data/doc/NgrokAPI/Services/TunnelsClient.html +47 -31
- data/doc/NgrokAPI/Services/VaultsClient.html +477 -33
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +16 -2
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +1216 -984
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +100 -48
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/docs/NgrokAPI/Models/BotUser.html +2 -2
- data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +5 -5
- data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/docs/NgrokAPI/Models/EventDestination.html +2 -2
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Location.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/Secret.html +95 -21
- data/docs/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
- data/docs/NgrokAPI/Models/Tunnel.html +2 -2
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/UserAgent.html +2 -2
- data/docs/NgrokAPI/Models/Vault.html +2 -2
- data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +97 -47
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +99 -49
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
- data/docs/NgrokAPI/Services/BotUsersClient.html +47 -31
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +101 -51
- data/docs/NgrokAPI/Services/CredentialsClient.html +105 -55
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +63 -47
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +63 -47
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +63 -47
- data/docs/NgrokAPI/Services/EndpointsClient.html +167 -117
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +101 -51
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +101 -51
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +97 -47
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +99 -49
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +101 -51
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +97 -47
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +133 -83
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +101 -51
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +105 -55
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +51 -35
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +51 -35
- data/docs/NgrokAPI/Services/SecretsClient.html +175 -81
- data/docs/NgrokAPI/Services/ServiceUsersClient.html +1767 -0
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +97 -47
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +141 -91
- data/docs/NgrokAPI/Services/TunnelsClient.html +47 -31
- data/docs/NgrokAPI/Services/VaultsClient.html +477 -33
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +16 -2
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +2 -2
- data/docs/index.html +2 -2
- data/docs/method_list.html +1216 -984
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +4 -0
- data/lib/ngrokapi/models/endpoint.rb +1 -1
- data/lib/ngrokapi/models/secret.rb +3 -1
- data/lib/ngrokapi/models/service_user.rb +70 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +16 -2
- data/lib/ngrokapi/services/api_keys_client.rb +16 -2
- data/lib/ngrokapi/services/application_sessions_client.rb +10 -2
- data/lib/ngrokapi/services/application_users_client.rb +10 -2
- data/lib/ngrokapi/services/bot_users_client.rb +10 -2
- data/lib/ngrokapi/services/certificate_authorities_client.rb +18 -4
- data/lib/ngrokapi/services/credentials_client.rb +18 -4
- data/lib/ngrokapi/services/edges_https_client.rb +10 -2
- data/lib/ngrokapi/services/edges_tcp_client.rb +10 -2
- data/lib/ngrokapi/services/edges_tls_client.rb +10 -2
- data/lib/ngrokapi/services/endpoints_client.rb +28 -14
- data/lib/ngrokapi/services/event_destinations_client.rb +16 -2
- data/lib/ngrokapi/services/event_subscriptions_client.rb +16 -2
- data/lib/ngrokapi/services/failover_backends_client.rb +10 -2
- data/lib/ngrokapi/services/http_response_backends_client.rb +10 -2
- data/lib/ngrokapi/services/ip_policies_client.rb +16 -2
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +16 -2
- data/lib/ngrokapi/services/ip_restrictions_client.rb +16 -2
- data/lib/ngrokapi/services/reserved_addrs_client.rb +16 -2
- data/lib/ngrokapi/services/reserved_domains_client.rb +16 -2
- data/lib/ngrokapi/services/secrets_client.rb +22 -4
- data/lib/ngrokapi/services/service_users_client.rb +237 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +18 -4
- data/lib/ngrokapi/services/ssh_credentials_client.rb +18 -4
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +12 -4
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +12 -4
- data/lib/ngrokapi/services/static_backends_client.rb +10 -2
- data/lib/ngrokapi/services/tls_certificates_client.rb +16 -2
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +10 -2
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +16 -2
- data/lib/ngrokapi/services/tunnels_client.rb +10 -2
- data/lib/ngrokapi/services/vaults_client.rb +91 -2
- data/lib/ngrokapi/services/weighted_backends_client.rb +10 -2
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +6 -0
- data/spec/ngrokapi/models/service_user_spec.rb +44 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/secrets_client_spec.rb +6 -2
- data/spec/ngrokapi/services/service_users_client_spec.rb +178 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/vaults_client_spec.rb +15 -0
- data/spec/spec_helper.rb +27 -0
- metadata +10 -2
|
@@ -0,0 +1,1767 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::ServiceUsersClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.36
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::ServiceUsersClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ServiceUsersClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::ServiceUsersClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::ServiceUsersClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/service_users_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users">ngrok.com/docs/api#api-service-users</a></p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Constant Summary
|
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="PATH-constant" class="">PATH =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>The API path for the requests</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
137
|
+
|
|
138
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>service_users</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
153
|
+
|
|
154
|
+
</dl>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
161
|
+
<ul class="summary">
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="note title readonly">readonly</span>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
|
186
|
+
<p>Returns the value of attribute client.</p>
|
|
187
|
+
</div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</ul>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<h2>
|
|
199
|
+
Instance Method Summary
|
|
200
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
201
|
+
</h2>
|
|
202
|
+
|
|
203
|
+
<ul class="summary">
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name: "", active: nil) ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'>
|
|
223
|
+
<p>Create a new service user.</p>
|
|
224
|
+
</div></span>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<li class="public ">
|
|
230
|
+
<span class="summary_signature">
|
|
231
|
+
|
|
232
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(name: "", active: nil) ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<span class="summary_desc"><div class='inline'>
|
|
247
|
+
<p>Create a new service user Throws an exception if API error.</p>
|
|
248
|
+
</div></span>
|
|
249
|
+
|
|
250
|
+
</li>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<li class="public ">
|
|
254
|
+
<span class="summary_signature">
|
|
255
|
+
|
|
256
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class="summary_desc"><div class='inline'>
|
|
271
|
+
<p>Delete a service user by ID.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'>
|
|
295
|
+
<p>Delete a service user by ID Throws an exception if API error.</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<span class="summary_desc"><div class='inline'>
|
|
319
|
+
<p>Get the details of a Bot User by ID.</p>
|
|
320
|
+
</div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="summary_desc"><div class='inline'>
|
|
343
|
+
<p>Get the details of a Bot User by ID.</p>
|
|
344
|
+
</div></span>
|
|
345
|
+
|
|
346
|
+
</li>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<li class="public ">
|
|
350
|
+
<span class="summary_signature">
|
|
351
|
+
|
|
352
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ ServiceUsersClient </a>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</span>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<span class="note title constructor">constructor</span>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>A new instance of ServiceUsersClient.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>List all service users in this account.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'>
|
|
417
|
+
<p>List all service users in this account.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<li class="public ">
|
|
424
|
+
<span class="summary_signature">
|
|
425
|
+
|
|
426
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", name: nil, active: nil) ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span class="summary_desc"><div class='inline'>
|
|
441
|
+
<p>Update attributes of a service user by ID.</p>
|
|
442
|
+
</div></span>
|
|
443
|
+
|
|
444
|
+
</li>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<li class="public ">
|
|
448
|
+
<span class="summary_signature">
|
|
449
|
+
|
|
450
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", name: nil, active: nil) ⇒ NgrokAPI::Models::ServiceUser </a>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
</span>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<span class="summary_desc"><div class='inline'>
|
|
465
|
+
<p>Update attributes of a service user by ID.</p>
|
|
466
|
+
</div></span>
|
|
467
|
+
|
|
468
|
+
</li>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</ul>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<div id="constructor_details" class="method_details_list">
|
|
475
|
+
<h2>Constructor Details</h2>
|
|
476
|
+
|
|
477
|
+
<div class="method_details first">
|
|
478
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
479
|
+
|
|
480
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::ServiceUsersClient (class)">ServiceUsersClient</a></span></tt>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</h3><div class="docstring">
|
|
487
|
+
<div class="discussion">
|
|
488
|
+
|
|
489
|
+
<p>Returns a new instance of ServiceUsersClient.</p>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
</div>
|
|
494
|
+
<div class="tags">
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div><table class="source_code">
|
|
498
|
+
<tr>
|
|
499
|
+
<td>
|
|
500
|
+
<pre class="lines">
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
17
|
|
504
|
+
18
|
|
505
|
+
19</pre>
|
|
506
|
+
</td>
|
|
507
|
+
<td>
|
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 17</span>
|
|
509
|
+
|
|
510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
511
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
512
|
+
<span class='kw'>end</span></pre>
|
|
513
|
+
</td>
|
|
514
|
+
</tr>
|
|
515
|
+
</table>
|
|
516
|
+
</div>
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
<div id="instance_attr_details" class="attr_details">
|
|
521
|
+
<h2>Instance Attribute Details</h2>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<span id=""></span>
|
|
525
|
+
<div class="method_details first">
|
|
526
|
+
<h3 class="signature first" id="client-instance_method">
|
|
527
|
+
|
|
528
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</h3><div class="docstring">
|
|
535
|
+
<div class="discussion">
|
|
536
|
+
|
|
537
|
+
<p>Returns the value of attribute client.</p>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
</div>
|
|
541
|
+
</div>
|
|
542
|
+
<div class="tags">
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
</div><table class="source_code">
|
|
546
|
+
<tr>
|
|
547
|
+
<td>
|
|
548
|
+
<pre class="lines">
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
15
|
|
552
|
+
16
|
|
553
|
+
17</pre>
|
|
554
|
+
</td>
|
|
555
|
+
<td>
|
|
556
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 15</span>
|
|
557
|
+
|
|
558
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
559
|
+
<span class='ivar'>@client</span>
|
|
560
|
+
<span class='kw'>end</span></pre>
|
|
561
|
+
</td>
|
|
562
|
+
</tr>
|
|
563
|
+
</table>
|
|
564
|
+
</div>
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<div id="instance_method_details" class="method_details_list">
|
|
570
|
+
<h2>Instance Method Details</h2>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<div class="method_details first">
|
|
574
|
+
<h3 class="signature first" id="create-instance_method">
|
|
575
|
+
|
|
576
|
+
#<strong>create</strong>(name: "", active: nil) ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</h3><div class="docstring">
|
|
583
|
+
<div class="discussion">
|
|
584
|
+
|
|
585
|
+
<p>Create a new service user</p>
|
|
586
|
+
|
|
587
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-create">ngrok.com/docs/api#api-service-users-create</a></p>
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
</div>
|
|
591
|
+
</div>
|
|
592
|
+
<div class="tags">
|
|
593
|
+
<p class="tag_title">Parameters:</p>
|
|
594
|
+
<ul class="param">
|
|
595
|
+
|
|
596
|
+
<li>
|
|
597
|
+
|
|
598
|
+
<span class='name'>name</span>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
—
|
|
608
|
+
<div class='inline'>
|
|
609
|
+
<p>human-readable name used to identify the service</p>
|
|
610
|
+
</div>
|
|
611
|
+
|
|
612
|
+
</li>
|
|
613
|
+
|
|
614
|
+
<li>
|
|
615
|
+
|
|
616
|
+
<span class='name'>active</span>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
—
|
|
626
|
+
<div class='inline'>
|
|
627
|
+
<p>whether or not the service is active</p>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
</li>
|
|
631
|
+
|
|
632
|
+
</ul>
|
|
633
|
+
|
|
634
|
+
<p class="tag_title">Returns:</p>
|
|
635
|
+
<ul class="return">
|
|
636
|
+
|
|
637
|
+
<li>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
—
|
|
645
|
+
<div class='inline'>
|
|
646
|
+
<p>result from the API request</p>
|
|
647
|
+
</div>
|
|
648
|
+
|
|
649
|
+
</li>
|
|
650
|
+
|
|
651
|
+
</ul>
|
|
652
|
+
|
|
653
|
+
</div><table class="source_code">
|
|
654
|
+
<tr>
|
|
655
|
+
<td>
|
|
656
|
+
<pre class="lines">
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
29
|
|
660
|
+
30
|
|
661
|
+
31
|
|
662
|
+
32
|
|
663
|
+
33
|
|
664
|
+
34
|
|
665
|
+
35
|
|
666
|
+
36
|
|
667
|
+
37
|
|
668
|
+
38</pre>
|
|
669
|
+
</td>
|
|
670
|
+
<td>
|
|
671
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 29</span>
|
|
672
|
+
|
|
673
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
674
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>'</span></span>
|
|
675
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
676
|
+
<span class='rbrace'>}</span>
|
|
677
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
678
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
|
679
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
|
|
680
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
681
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
682
|
+
<span class='kw'>end</span></pre>
|
|
683
|
+
</td>
|
|
684
|
+
</tr>
|
|
685
|
+
</table>
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
<div class="method_details ">
|
|
689
|
+
<h3 class="signature " id="create!-instance_method">
|
|
690
|
+
|
|
691
|
+
#<strong>create!</strong>(name: "", active: nil) ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
</h3><div class="docstring">
|
|
698
|
+
<div class="discussion">
|
|
699
|
+
|
|
700
|
+
<p>Create a new service user Throws an exception if API error.</p>
|
|
701
|
+
|
|
702
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-create">ngrok.com/docs/api#api-service-users-create</a></p>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
</div>
|
|
706
|
+
</div>
|
|
707
|
+
<div class="tags">
|
|
708
|
+
<p class="tag_title">Parameters:</p>
|
|
709
|
+
<ul class="param">
|
|
710
|
+
|
|
711
|
+
<li>
|
|
712
|
+
|
|
713
|
+
<span class='name'>name</span>
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
—
|
|
723
|
+
<div class='inline'>
|
|
724
|
+
<p>human-readable name used to identify the service</p>
|
|
725
|
+
</div>
|
|
726
|
+
|
|
727
|
+
</li>
|
|
728
|
+
|
|
729
|
+
<li>
|
|
730
|
+
|
|
731
|
+
<span class='name'>active</span>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
—
|
|
741
|
+
<div class='inline'>
|
|
742
|
+
<p>whether or not the service is active</p>
|
|
743
|
+
</div>
|
|
744
|
+
|
|
745
|
+
</li>
|
|
746
|
+
|
|
747
|
+
</ul>
|
|
748
|
+
|
|
749
|
+
<p class="tag_title">Returns:</p>
|
|
750
|
+
<ul class="return">
|
|
751
|
+
|
|
752
|
+
<li>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
—
|
|
760
|
+
<div class='inline'>
|
|
761
|
+
<p>result from the API request</p>
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
</li>
|
|
765
|
+
|
|
766
|
+
</ul>
|
|
767
|
+
|
|
768
|
+
</div><table class="source_code">
|
|
769
|
+
<tr>
|
|
770
|
+
<td>
|
|
771
|
+
<pre class="lines">
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
49
|
|
775
|
+
50
|
|
776
|
+
51
|
|
777
|
+
52
|
|
778
|
+
53
|
|
779
|
+
54
|
|
780
|
+
55
|
|
781
|
+
56
|
|
782
|
+
57
|
|
783
|
+
58</pre>
|
|
784
|
+
</td>
|
|
785
|
+
<td>
|
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 49</span>
|
|
787
|
+
|
|
788
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
789
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>'</span></span>
|
|
790
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
791
|
+
<span class='rbrace'>}</span>
|
|
792
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
793
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
|
794
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
|
|
795
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
796
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
797
|
+
<span class='kw'>end</span></pre>
|
|
798
|
+
</td>
|
|
799
|
+
</tr>
|
|
800
|
+
</table>
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
<div class="method_details ">
|
|
804
|
+
<h3 class="signature " id="delete-instance_method">
|
|
805
|
+
|
|
806
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</h3><div class="docstring">
|
|
813
|
+
<div class="discussion">
|
|
814
|
+
|
|
815
|
+
<p>Delete a service user by ID</p>
|
|
816
|
+
|
|
817
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-delete">ngrok.com/docs/api#api-service-users-delete</a></p>
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
</div>
|
|
821
|
+
</div>
|
|
822
|
+
<div class="tags">
|
|
823
|
+
<p class="tag_title">Parameters:</p>
|
|
824
|
+
<ul class="param">
|
|
825
|
+
|
|
826
|
+
<li>
|
|
827
|
+
|
|
828
|
+
<span class='name'>id</span>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
—
|
|
838
|
+
<div class='inline'>
|
|
839
|
+
<p>a resource identifier</p>
|
|
840
|
+
</div>
|
|
841
|
+
|
|
842
|
+
</li>
|
|
843
|
+
|
|
844
|
+
</ul>
|
|
845
|
+
|
|
846
|
+
<p class="tag_title">Returns:</p>
|
|
847
|
+
<ul class="return">
|
|
848
|
+
|
|
849
|
+
<li>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
—
|
|
857
|
+
<div class='inline'>
|
|
858
|
+
<p>result from the API request</p>
|
|
859
|
+
</div>
|
|
860
|
+
|
|
861
|
+
</li>
|
|
862
|
+
|
|
863
|
+
</ul>
|
|
864
|
+
|
|
865
|
+
</div><table class="source_code">
|
|
866
|
+
<tr>
|
|
867
|
+
<td>
|
|
868
|
+
<pre class="lines">
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
67
|
|
872
|
+
68
|
|
873
|
+
69
|
|
874
|
+
70
|
|
875
|
+
71
|
|
876
|
+
72
|
|
877
|
+
73</pre>
|
|
878
|
+
</td>
|
|
879
|
+
<td>
|
|
880
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 67</span>
|
|
881
|
+
|
|
882
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
883
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
884
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
885
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
886
|
+
<span class='rbrace'>}</span>
|
|
887
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
888
|
+
<span class='kw'>end</span></pre>
|
|
889
|
+
</td>
|
|
890
|
+
</tr>
|
|
891
|
+
</table>
|
|
892
|
+
</div>
|
|
893
|
+
|
|
894
|
+
<div class="method_details ">
|
|
895
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
896
|
+
|
|
897
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
</h3><div class="docstring">
|
|
904
|
+
<div class="discussion">
|
|
905
|
+
|
|
906
|
+
<p>Delete a service user by ID Throws an exception if API error.</p>
|
|
907
|
+
|
|
908
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-delete">ngrok.com/docs/api#api-service-users-delete</a></p>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
</div>
|
|
912
|
+
</div>
|
|
913
|
+
<div class="tags">
|
|
914
|
+
<p class="tag_title">Parameters:</p>
|
|
915
|
+
<ul class="param">
|
|
916
|
+
|
|
917
|
+
<li>
|
|
918
|
+
|
|
919
|
+
<span class='name'>id</span>
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
—
|
|
929
|
+
<div class='inline'>
|
|
930
|
+
<p>a resource identifier</p>
|
|
931
|
+
</div>
|
|
932
|
+
|
|
933
|
+
</li>
|
|
934
|
+
|
|
935
|
+
</ul>
|
|
936
|
+
|
|
937
|
+
<p class="tag_title">Returns:</p>
|
|
938
|
+
<ul class="return">
|
|
939
|
+
|
|
940
|
+
<li>
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
—
|
|
948
|
+
<div class='inline'>
|
|
949
|
+
<p>result from the API request</p>
|
|
950
|
+
</div>
|
|
951
|
+
|
|
952
|
+
</li>
|
|
953
|
+
|
|
954
|
+
</ul>
|
|
955
|
+
|
|
956
|
+
</div><table class="source_code">
|
|
957
|
+
<tr>
|
|
958
|
+
<td>
|
|
959
|
+
<pre class="lines">
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
83
|
|
963
|
+
84
|
|
964
|
+
85
|
|
965
|
+
86
|
|
966
|
+
87
|
|
967
|
+
88
|
|
968
|
+
89</pre>
|
|
969
|
+
</td>
|
|
970
|
+
<td>
|
|
971
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 83</span>
|
|
972
|
+
|
|
973
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
974
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
975
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
976
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
977
|
+
<span class='rbrace'>}</span>
|
|
978
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
979
|
+
<span class='kw'>end</span></pre>
|
|
980
|
+
</td>
|
|
981
|
+
</tr>
|
|
982
|
+
</table>
|
|
983
|
+
</div>
|
|
984
|
+
|
|
985
|
+
<div class="method_details ">
|
|
986
|
+
<h3 class="signature " id="get-instance_method">
|
|
987
|
+
|
|
988
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
</h3><div class="docstring">
|
|
995
|
+
<div class="discussion">
|
|
996
|
+
|
|
997
|
+
<p>Get the details of a Bot User by ID.</p>
|
|
998
|
+
|
|
999
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-get">ngrok.com/docs/api#api-service-users-get</a></p>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
</div>
|
|
1003
|
+
</div>
|
|
1004
|
+
<div class="tags">
|
|
1005
|
+
<p class="tag_title">Parameters:</p>
|
|
1006
|
+
<ul class="param">
|
|
1007
|
+
|
|
1008
|
+
<li>
|
|
1009
|
+
|
|
1010
|
+
<span class='name'>id</span>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
—
|
|
1020
|
+
<div class='inline'>
|
|
1021
|
+
<p>a resource identifier</p>
|
|
1022
|
+
</div>
|
|
1023
|
+
|
|
1024
|
+
</li>
|
|
1025
|
+
|
|
1026
|
+
</ul>
|
|
1027
|
+
|
|
1028
|
+
<p class="tag_title">Returns:</p>
|
|
1029
|
+
<ul class="return">
|
|
1030
|
+
|
|
1031
|
+
<li>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
—
|
|
1039
|
+
<div class='inline'>
|
|
1040
|
+
<p>result from the API request</p>
|
|
1041
|
+
</div>
|
|
1042
|
+
|
|
1043
|
+
</li>
|
|
1044
|
+
|
|
1045
|
+
</ul>
|
|
1046
|
+
|
|
1047
|
+
</div><table class="source_code">
|
|
1048
|
+
<tr>
|
|
1049
|
+
<td>
|
|
1050
|
+
<pre class="lines">
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
98
|
|
1054
|
+
99
|
|
1055
|
+
100
|
|
1056
|
+
101
|
|
1057
|
+
102
|
|
1058
|
+
103
|
|
1059
|
+
104
|
|
1060
|
+
105
|
|
1061
|
+
106</pre>
|
|
1062
|
+
</td>
|
|
1063
|
+
<td>
|
|
1064
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 98</span>
|
|
1065
|
+
|
|
1066
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1067
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1068
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1069
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1070
|
+
<span class='rbrace'>}</span>
|
|
1071
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1072
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1073
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1074
|
+
<span class='kw'>end</span></pre>
|
|
1075
|
+
</td>
|
|
1076
|
+
</tr>
|
|
1077
|
+
</table>
|
|
1078
|
+
</div>
|
|
1079
|
+
|
|
1080
|
+
<div class="method_details ">
|
|
1081
|
+
<h3 class="signature " id="get!-instance_method">
|
|
1082
|
+
|
|
1083
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</h3><div class="docstring">
|
|
1090
|
+
<div class="discussion">
|
|
1091
|
+
|
|
1092
|
+
<p>Get the details of a Bot User by ID. Throws an exception if API error.</p>
|
|
1093
|
+
|
|
1094
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-get">ngrok.com/docs/api#api-service-users-get</a></p>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
</div>
|
|
1098
|
+
</div>
|
|
1099
|
+
<div class="tags">
|
|
1100
|
+
<p class="tag_title">Parameters:</p>
|
|
1101
|
+
<ul class="param">
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
<span class='name'>id</span>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
—
|
|
1115
|
+
<div class='inline'>
|
|
1116
|
+
<p>a resource identifier</p>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</li>
|
|
1120
|
+
|
|
1121
|
+
</ul>
|
|
1122
|
+
|
|
1123
|
+
<p class="tag_title">Returns:</p>
|
|
1124
|
+
<ul class="return">
|
|
1125
|
+
|
|
1126
|
+
<li>
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
—
|
|
1134
|
+
<div class='inline'>
|
|
1135
|
+
<p>result from the API request</p>
|
|
1136
|
+
</div>
|
|
1137
|
+
|
|
1138
|
+
</li>
|
|
1139
|
+
|
|
1140
|
+
</ul>
|
|
1141
|
+
|
|
1142
|
+
</div><table class="source_code">
|
|
1143
|
+
<tr>
|
|
1144
|
+
<td>
|
|
1145
|
+
<pre class="lines">
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
116
|
|
1149
|
+
117
|
|
1150
|
+
118
|
|
1151
|
+
119
|
|
1152
|
+
120
|
|
1153
|
+
121
|
|
1154
|
+
122
|
|
1155
|
+
123
|
|
1156
|
+
124</pre>
|
|
1157
|
+
</td>
|
|
1158
|
+
<td>
|
|
1159
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 116</span>
|
|
1160
|
+
|
|
1161
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1162
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1163
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1164
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1165
|
+
<span class='rbrace'>}</span>
|
|
1166
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1167
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1168
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1169
|
+
<span class='kw'>end</span></pre>
|
|
1170
|
+
</td>
|
|
1171
|
+
</tr>
|
|
1172
|
+
</table>
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
<div class="method_details ">
|
|
1176
|
+
<h3 class="signature " id="list-instance_method">
|
|
1177
|
+
|
|
1178
|
+
#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
</h3><div class="docstring">
|
|
1185
|
+
<div class="discussion">
|
|
1186
|
+
|
|
1187
|
+
<p>List all service users in this account.</p>
|
|
1188
|
+
|
|
1189
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-list">ngrok.com/docs/api#api-service-users-list</a></p>
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
</div>
|
|
1193
|
+
</div>
|
|
1194
|
+
<div class="tags">
|
|
1195
|
+
<p class="tag_title">Parameters:</p>
|
|
1196
|
+
<ul class="param">
|
|
1197
|
+
|
|
1198
|
+
<li>
|
|
1199
|
+
|
|
1200
|
+
<span class='name'>before_id</span>
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
</li>
|
|
1210
|
+
|
|
1211
|
+
<li>
|
|
1212
|
+
|
|
1213
|
+
<span class='name'>limit</span>
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
</li>
|
|
1223
|
+
|
|
1224
|
+
<li>
|
|
1225
|
+
|
|
1226
|
+
<span class='name'>filter</span>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
</li>
|
|
1236
|
+
|
|
1237
|
+
<li>
|
|
1238
|
+
|
|
1239
|
+
<span class='name'>url</span>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
—
|
|
1249
|
+
<div class='inline'>
|
|
1250
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1251
|
+
</div>
|
|
1252
|
+
|
|
1253
|
+
</li>
|
|
1254
|
+
|
|
1255
|
+
</ul>
|
|
1256
|
+
|
|
1257
|
+
<p class="tag_title">Returns:</p>
|
|
1258
|
+
<ul class="return">
|
|
1259
|
+
|
|
1260
|
+
<li>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
—
|
|
1268
|
+
<div class='inline'>
|
|
1269
|
+
<p>result from the API request</p>
|
|
1270
|
+
</div>
|
|
1271
|
+
|
|
1272
|
+
</li>
|
|
1273
|
+
|
|
1274
|
+
</ul>
|
|
1275
|
+
|
|
1276
|
+
</div><table class="source_code">
|
|
1277
|
+
<tr>
|
|
1278
|
+
<td>
|
|
1279
|
+
<pre class="lines">
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
136
|
|
1283
|
+
137
|
|
1284
|
+
138
|
|
1285
|
+
139
|
|
1286
|
+
140
|
|
1287
|
+
141
|
|
1288
|
+
142
|
|
1289
|
+
143
|
|
1290
|
+
144
|
|
1291
|
+
145
|
|
1292
|
+
146
|
|
1293
|
+
147
|
|
1294
|
+
148
|
|
1295
|
+
149
|
|
1296
|
+
150
|
|
1297
|
+
151
|
|
1298
|
+
152
|
|
1299
|
+
153
|
|
1300
|
+
154
|
|
1301
|
+
155
|
|
1302
|
+
156</pre>
|
|
1303
|
+
</td>
|
|
1304
|
+
<td>
|
|
1305
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 136</span>
|
|
1306
|
+
|
|
1307
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1308
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1309
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1310
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1311
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1312
|
+
<span class='rparen'>)</span>
|
|
1313
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1314
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1315
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1316
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1317
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1318
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ServiceUsersClient::PATH (constant)">PATH</a></span></span>
|
|
1319
|
+
<span class='rparen'>)</span>
|
|
1320
|
+
|
|
1321
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1322
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1323
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1324
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ServiceUsersClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1325
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span>
|
|
1326
|
+
<span class='rparen'>)</span>
|
|
1327
|
+
<span class='kw'>end</span></pre>
|
|
1328
|
+
</td>
|
|
1329
|
+
</tr>
|
|
1330
|
+
</table>
|
|
1331
|
+
</div>
|
|
1332
|
+
|
|
1333
|
+
<div class="method_details ">
|
|
1334
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1335
|
+
|
|
1336
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
</h3><div class="docstring">
|
|
1343
|
+
<div class="discussion">
|
|
1344
|
+
|
|
1345
|
+
<p>List all service users in this account. Throws an exception if API error.</p>
|
|
1346
|
+
|
|
1347
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-list">ngrok.com/docs/api#api-service-users-list</a></p>
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
</div>
|
|
1351
|
+
</div>
|
|
1352
|
+
<div class="tags">
|
|
1353
|
+
<p class="tag_title">Parameters:</p>
|
|
1354
|
+
<ul class="param">
|
|
1355
|
+
|
|
1356
|
+
<li>
|
|
1357
|
+
|
|
1358
|
+
<span class='name'>before_id</span>
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
</li>
|
|
1368
|
+
|
|
1369
|
+
<li>
|
|
1370
|
+
|
|
1371
|
+
<span class='name'>limit</span>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
</li>
|
|
1381
|
+
|
|
1382
|
+
<li>
|
|
1383
|
+
|
|
1384
|
+
<span class='name'>filter</span>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
</li>
|
|
1394
|
+
|
|
1395
|
+
<li>
|
|
1396
|
+
|
|
1397
|
+
<span class='name'>url</span>
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
—
|
|
1407
|
+
<div class='inline'>
|
|
1408
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1409
|
+
</div>
|
|
1410
|
+
|
|
1411
|
+
</li>
|
|
1412
|
+
|
|
1413
|
+
</ul>
|
|
1414
|
+
|
|
1415
|
+
<p class="tag_title">Returns:</p>
|
|
1416
|
+
<ul class="return">
|
|
1417
|
+
|
|
1418
|
+
<li>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
—
|
|
1426
|
+
<div class='inline'>
|
|
1427
|
+
<p>result from the API request</p>
|
|
1428
|
+
</div>
|
|
1429
|
+
|
|
1430
|
+
</li>
|
|
1431
|
+
|
|
1432
|
+
</ul>
|
|
1433
|
+
|
|
1434
|
+
</div><table class="source_code">
|
|
1435
|
+
<tr>
|
|
1436
|
+
<td>
|
|
1437
|
+
<pre class="lines">
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
169
|
|
1441
|
+
170
|
|
1442
|
+
171
|
|
1443
|
+
172
|
|
1444
|
+
173
|
|
1445
|
+
174
|
|
1446
|
+
175
|
|
1447
|
+
176
|
|
1448
|
+
177
|
|
1449
|
+
178
|
|
1450
|
+
179
|
|
1451
|
+
180
|
|
1452
|
+
181
|
|
1453
|
+
182
|
|
1454
|
+
183
|
|
1455
|
+
184
|
|
1456
|
+
185
|
|
1457
|
+
186
|
|
1458
|
+
187
|
|
1459
|
+
188
|
|
1460
|
+
189
|
|
1461
|
+
190
|
|
1462
|
+
191</pre>
|
|
1463
|
+
</td>
|
|
1464
|
+
<td>
|
|
1465
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 169</span>
|
|
1466
|
+
|
|
1467
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1468
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1469
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1470
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1471
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1472
|
+
<span class='rparen'>)</span>
|
|
1473
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1474
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1475
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1476
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1477
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1478
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1479
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ServiceUsersClient::PATH (constant)">PATH</a></span></span>
|
|
1480
|
+
<span class='rparen'>)</span>
|
|
1481
|
+
|
|
1482
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1483
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1484
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1485
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ServiceUsersClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1486
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='comma'>,</span>
|
|
1487
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1488
|
+
<span class='rparen'>)</span>
|
|
1489
|
+
<span class='kw'>end</span></pre>
|
|
1490
|
+
</td>
|
|
1491
|
+
</tr>
|
|
1492
|
+
</table>
|
|
1493
|
+
</div>
|
|
1494
|
+
|
|
1495
|
+
<div class="method_details ">
|
|
1496
|
+
<h3 class="signature " id="update-instance_method">
|
|
1497
|
+
|
|
1498
|
+
#<strong>update</strong>(id: "", name: nil, active: nil) ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
</h3><div class="docstring">
|
|
1505
|
+
<div class="discussion">
|
|
1506
|
+
|
|
1507
|
+
<p>Update attributes of a service user by ID.</p>
|
|
1508
|
+
|
|
1509
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-update">ngrok.com/docs/api#api-service-users-update</a></p>
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
</div>
|
|
1513
|
+
</div>
|
|
1514
|
+
<div class="tags">
|
|
1515
|
+
<p class="tag_title">Parameters:</p>
|
|
1516
|
+
<ul class="param">
|
|
1517
|
+
|
|
1518
|
+
<li>
|
|
1519
|
+
|
|
1520
|
+
<span class='name'>id</span>
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
</li>
|
|
1530
|
+
|
|
1531
|
+
<li>
|
|
1532
|
+
|
|
1533
|
+
<span class='name'>name</span>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
—
|
|
1543
|
+
<div class='inline'>
|
|
1544
|
+
<p>human-readable name used to identify the service</p>
|
|
1545
|
+
</div>
|
|
1546
|
+
|
|
1547
|
+
</li>
|
|
1548
|
+
|
|
1549
|
+
<li>
|
|
1550
|
+
|
|
1551
|
+
<span class='name'>active</span>
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
—
|
|
1561
|
+
<div class='inline'>
|
|
1562
|
+
<p>whether or not the service is active</p>
|
|
1563
|
+
</div>
|
|
1564
|
+
|
|
1565
|
+
</li>
|
|
1566
|
+
|
|
1567
|
+
</ul>
|
|
1568
|
+
|
|
1569
|
+
<p class="tag_title">Returns:</p>
|
|
1570
|
+
<ul class="return">
|
|
1571
|
+
|
|
1572
|
+
<li>
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
—
|
|
1580
|
+
<div class='inline'>
|
|
1581
|
+
<p>result from the API request</p>
|
|
1582
|
+
</div>
|
|
1583
|
+
|
|
1584
|
+
</li>
|
|
1585
|
+
|
|
1586
|
+
</ul>
|
|
1587
|
+
|
|
1588
|
+
</div><table class="source_code">
|
|
1589
|
+
<tr>
|
|
1590
|
+
<td>
|
|
1591
|
+
<pre class="lines">
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
202
|
|
1595
|
+
203
|
|
1596
|
+
204
|
|
1597
|
+
205
|
|
1598
|
+
206
|
|
1599
|
+
207
|
|
1600
|
+
208
|
|
1601
|
+
209
|
|
1602
|
+
210
|
|
1603
|
+
211
|
|
1604
|
+
212</pre>
|
|
1605
|
+
</td>
|
|
1606
|
+
<td>
|
|
1607
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 202</span>
|
|
1608
|
+
|
|
1609
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1610
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1611
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1612
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1613
|
+
<span class='rbrace'>}</span>
|
|
1614
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1615
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
|
1616
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
|
|
1617
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1618
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1619
|
+
<span class='kw'>end</span></pre>
|
|
1620
|
+
</td>
|
|
1621
|
+
</tr>
|
|
1622
|
+
</table>
|
|
1623
|
+
</div>
|
|
1624
|
+
|
|
1625
|
+
<div class="method_details ">
|
|
1626
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1627
|
+
|
|
1628
|
+
#<strong>update!</strong>(id: "", name: nil, active: nil) ⇒ <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
</h3><div class="docstring">
|
|
1635
|
+
<div class="discussion">
|
|
1636
|
+
|
|
1637
|
+
<p>Update attributes of a service user by ID. Throws an exception if API error.</p>
|
|
1638
|
+
|
|
1639
|
+
<p><a href="https://ngrok.com/docs/api#api-service-users-update">ngrok.com/docs/api#api-service-users-update</a></p>
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
</div>
|
|
1643
|
+
</div>
|
|
1644
|
+
<div class="tags">
|
|
1645
|
+
<p class="tag_title">Parameters:</p>
|
|
1646
|
+
<ul class="param">
|
|
1647
|
+
|
|
1648
|
+
<li>
|
|
1649
|
+
|
|
1650
|
+
<span class='name'>id</span>
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
</li>
|
|
1660
|
+
|
|
1661
|
+
<li>
|
|
1662
|
+
|
|
1663
|
+
<span class='name'>name</span>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
—
|
|
1673
|
+
<div class='inline'>
|
|
1674
|
+
<p>human-readable name used to identify the service</p>
|
|
1675
|
+
</div>
|
|
1676
|
+
|
|
1677
|
+
</li>
|
|
1678
|
+
|
|
1679
|
+
<li>
|
|
1680
|
+
|
|
1681
|
+
<span class='name'>active</span>
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
—
|
|
1691
|
+
<div class='inline'>
|
|
1692
|
+
<p>whether or not the service is active</p>
|
|
1693
|
+
</div>
|
|
1694
|
+
|
|
1695
|
+
</li>
|
|
1696
|
+
|
|
1697
|
+
</ul>
|
|
1698
|
+
|
|
1699
|
+
<p class="tag_title">Returns:</p>
|
|
1700
|
+
<ul class="return">
|
|
1701
|
+
|
|
1702
|
+
<li>
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
—
|
|
1710
|
+
<div class='inline'>
|
|
1711
|
+
<p>result from the API request</p>
|
|
1712
|
+
</div>
|
|
1713
|
+
|
|
1714
|
+
</li>
|
|
1715
|
+
|
|
1716
|
+
</ul>
|
|
1717
|
+
|
|
1718
|
+
</div><table class="source_code">
|
|
1719
|
+
<tr>
|
|
1720
|
+
<td>
|
|
1721
|
+
<pre class="lines">
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
224
|
|
1725
|
+
225
|
|
1726
|
+
226
|
|
1727
|
+
227
|
|
1728
|
+
228
|
|
1729
|
+
229
|
|
1730
|
+
230
|
|
1731
|
+
231
|
|
1732
|
+
232
|
|
1733
|
+
233
|
|
1734
|
+
234</pre>
|
|
1735
|
+
</td>
|
|
1736
|
+
<td>
|
|
1737
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 224</span>
|
|
1738
|
+
|
|
1739
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1740
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1741
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1742
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1743
|
+
<span class='rbrace'>}</span>
|
|
1744
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1745
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
|
1746
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
|
|
1747
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1748
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1749
|
+
<span class='kw'>end</span></pre>
|
|
1750
|
+
</td>
|
|
1751
|
+
</tr>
|
|
1752
|
+
</table>
|
|
1753
|
+
</div>
|
|
1754
|
+
|
|
1755
|
+
</div>
|
|
1756
|
+
|
|
1757
|
+
</div>
|
|
1758
|
+
|
|
1759
|
+
<div id="footer">
|
|
1760
|
+
Generated on Tue Dec 16 19:21:59 2025 by
|
|
1761
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1762
|
+
0.9.36 (ruby-3.3.10).
|
|
1763
|
+
</div>
|
|
1764
|
+
|
|
1765
|
+
</div>
|
|
1766
|
+
</body>
|
|
1767
|
+
</html>
|