ngrok-api 0.18.0 → 0.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +7 -7
- data/.gitignore +15 -13
- data/.rubocop.yml +30 -28
- data/.rubocop_airbnb.yml +4 -2
- data/.simplecov +3 -1
- data/CHANGELOG.md +8 -0
- data/CODE_OF_CONDUCT.md +45 -0
- data/Gemfile +34 -32
- data/Guardfile +18 -16
- data/README.md +94 -61
- data/Rakefile +9 -7
- data/doc/NgrokAPI/Client.html +229 -125
- data/doc/NgrokAPI/Error.html +12 -12
- data/doc/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/doc/NgrokAPI/Errors.html +4 -4
- data/doc/NgrokAPI/HttpClient.html +208 -65
- data/doc/NgrokAPI/Models/APIKey.html +220 -90
- data/doc/NgrokAPI/Models/AWSAuth.html +113 -61
- data/doc/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/doc/NgrokAPI/Models/AWSRole.html +101 -49
- data/doc/NgrokAPI/Models/AbuseReport.html +165 -109
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/doc/NgrokAPI/Models/AgentIngress.html +365 -155
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/doc/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/doc/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/doc/NgrokAPI/Models/BrowserSession.html +743 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +223 -167
- data/doc/NgrokAPI/Models/Credential.html +225 -95
- data/doc/NgrokAPI/Models/Endpoint.html +215 -159
- data/doc/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/doc/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/doc/NgrokAPI/Models/EventDestination.html +178 -122
- data/doc/NgrokAPI/Models/EventSource.html +136 -80
- data/doc/NgrokAPI/Models/EventSourceList.html +112 -56
- data/doc/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/doc/NgrokAPI/Models/EventSubscription.html +178 -122
- data/doc/NgrokAPI/Models/EventTarget.html +206 -80
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/doc/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/doc/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/doc/NgrokAPI/Models/IPPolicy.html +178 -122
- data/doc/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/doc/NgrokAPI/Models/IPRestriction.html +190 -134
- data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/doc/NgrokAPI/Models/Listable.html +130 -130
- data/doc/NgrokAPI/Models/Location.html +817 -0
- data/doc/NgrokAPI/Models/Ref.html +119 -63
- data/doc/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/doc/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/doc/NgrokAPI/Models/SSHCredential.html +232 -102
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/doc/NgrokAPI/Models/TCPEdge.html +204 -148
- data/doc/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/doc/NgrokAPI/Models/TLSEdge.html +216 -160
- data/doc/NgrokAPI/Models/Tunnel.html +205 -149
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/doc/NgrokAPI/Models/TunnelSession.html +193 -137
- data/doc/NgrokAPI/Models/UserAgent.html +965 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +53 -53
- data/doc/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/doc/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/doc/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/doc/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +6 -6
- data/doc/_index.html +139 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -51
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -51
- data/doc/method_list.html +4383 -2175
- data/doc/top-level-namespace.html +4 -4
- data/docs/NgrokAPI/Client.html +229 -125
- data/docs/NgrokAPI/Error.html +12 -12
- data/docs/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/docs/NgrokAPI/Errors.html +4 -4
- data/docs/NgrokAPI/HttpClient.html +208 -65
- data/docs/NgrokAPI/Models/APIKey.html +220 -90
- data/docs/NgrokAPI/Models/AWSAuth.html +113 -61
- data/docs/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/docs/NgrokAPI/Models/AWSRole.html +101 -49
- data/docs/NgrokAPI/Models/AbuseReport.html +165 -109
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/docs/NgrokAPI/Models/AgentIngress.html +365 -155
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/docs/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/docs/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/docs/NgrokAPI/Models/BrowserSession.html +743 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +223 -167
- data/docs/NgrokAPI/Models/Credential.html +225 -95
- data/docs/NgrokAPI/Models/Endpoint.html +215 -159
- data/docs/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/docs/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/docs/NgrokAPI/Models/EventDestination.html +178 -122
- data/docs/NgrokAPI/Models/EventSource.html +136 -80
- data/docs/NgrokAPI/Models/EventSourceList.html +112 -56
- data/docs/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/docs/NgrokAPI/Models/EventSubscription.html +178 -122
- data/docs/NgrokAPI/Models/EventTarget.html +206 -80
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/docs/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/docs/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/docs/NgrokAPI/Models/IPPolicy.html +178 -122
- data/docs/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/docs/NgrokAPI/Models/IPRestriction.html +190 -134
- data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/docs/NgrokAPI/Models/Listable.html +130 -130
- data/docs/NgrokAPI/Models/Location.html +817 -0
- data/docs/NgrokAPI/Models/Ref.html +119 -63
- data/docs/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/docs/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/docs/NgrokAPI/Models/SSHCredential.html +232 -102
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/docs/NgrokAPI/Models/TCPEdge.html +204 -148
- data/docs/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/docs/NgrokAPI/Models/TLSEdge.html +216 -160
- data/docs/NgrokAPI/Models/Tunnel.html +205 -149
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/docs/NgrokAPI/Models/TunnelSession.html +193 -137
- data/docs/NgrokAPI/Models/UserAgent.html +965 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +53 -53
- data/docs/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/docs/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/docs/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/docs/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +6 -6
- data/docs/_index.html +139 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -51
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -51
- data/docs/method_list.html +4383 -2175
- data/docs/top-level-namespace.html +4 -4
- data/lib/ngrokapi/client.rb +21 -11
- data/lib/ngrokapi/error.rb +2 -0
- data/lib/ngrokapi/errors/not_found_error.rb +2 -0
- data/lib/ngrokapi/http_client.rb +153 -131
- data/lib/ngrokapi/models/abuse_report.rb +22 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +13 -7
- data/lib/ngrokapi/models/agent_ingress.rb +33 -16
- data/lib/ngrokapi/models/agent_ingress_cert_job.rb +37 -0
- data/lib/ngrokapi/models/agent_ingress_cert_policy.rb +33 -0
- data/lib/ngrokapi/models/agent_ingress_cert_status.rb +33 -0
- data/lib/ngrokapi/models/api_key.rb +24 -12
- data/lib/ngrokapi/models/application_session.rb +67 -0
- data/lib/ngrokapi/models/application_user.rb +63 -0
- data/lib/ngrokapi/models/aws_auth.rb +13 -7
- data/lib/ngrokapi/models/aws_credentials.rb +13 -7
- data/lib/ngrokapi/models/aws_role.rb +12 -6
- data/lib/ngrokapi/models/browser_session.rb +35 -0
- data/lib/ngrokapi/models/certificate_authority.rb +26 -16
- data/lib/ngrokapi/models/credential.rb +25 -13
- data/lib/ngrokapi/models/endpoint.rb +28 -18
- data/lib/ngrokapi/models/endpoint_backend.rb +13 -7
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +17 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +12 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +13 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +24 -10
- data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +20 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +37 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +26 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +14 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +13 -7
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +14 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +12 -6
- data/lib/ngrokapi/models/event_destination.rb +22 -12
- data/lib/ngrokapi/models/event_source.rb +19 -9
- data/lib/ngrokapi/models/event_source_list.rb +17 -7
- data/lib/ngrokapi/models/event_source_replace.rb +14 -8
- data/lib/ngrokapi/models/event_subscription.rb +22 -12
- data/lib/ngrokapi/models/event_target.rb +18 -10
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +13 -7
- data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +13 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +13 -7
- data/lib/ngrokapi/models/failover_backend.rb +22 -12
- data/lib/ngrokapi/models/http_response_backend.rb +23 -13
- data/lib/ngrokapi/models/https_edge.rb +24 -14
- data/lib/ngrokapi/models/https_edge_route.rb +34 -24
- data/lib/ngrokapi/models/identity_provider.rb +33 -0
- data/lib/ngrokapi/models/ip_policy.rb +21 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +23 -13
- data/lib/ngrokapi/models/ip_restriction.rb +23 -13
- data/lib/ngrokapi/models/listable.rb +55 -53
- data/lib/ngrokapi/models/location.rb +37 -0
- data/lib/ngrokapi/models/ref.rb +17 -7
- data/lib/ngrokapi/models/reserved_addr.rb +23 -13
- data/lib/ngrokapi/models/reserved_domain.rb +29 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +15 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +13 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +13 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +22 -12
- data/lib/ngrokapi/models/ssh_credential.rb +25 -13
- data/lib/ngrokapi/models/ssh_host_certificate.rb +27 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +29 -19
- data/lib/ngrokapi/models/tcp_edge.rb +23 -13
- data/lib/ngrokapi/models/tls_certificate.rb +36 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +13 -7
- data/lib/ngrokapi/models/tls_edge.rb +25 -15
- data/lib/ngrokapi/models/tunnel.rb +26 -16
- data/lib/ngrokapi/models/tunnel_group_backend.rb +23 -13
- data/lib/ngrokapi/models/tunnel_session.rb +25 -15
- data/lib/ngrokapi/models/user_agent.rb +41 -0
- data/lib/ngrokapi/models/weighted_backend.rb +22 -12
- data/lib/ngrokapi/paged_iterator.rb +44 -42
- data/lib/ngrokapi/services/abuse_reports_client.rb +27 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +45 -14
- data/lib/ngrokapi/services/api_keys_client.rb +37 -12
- data/lib/ngrokapi/services/application_sessions_client.rb +141 -0
- data/lib/ngrokapi/services/application_users_client.rb +141 -0
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -11
- data/lib/ngrokapi/services/credentials_client.rb +45 -16
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +8 -8
- data/lib/ngrokapi/services/edges_https_client.rb +37 -11
- data/lib/ngrokapi/services/edges_https_routes_client.rb +55 -5
- data/lib/ngrokapi/services/edges_tcp_client.rb +37 -11
- data/lib/ngrokapi/services/edges_tls_client.rb +41 -11
- data/lib/ngrokapi/services/endpoints_client.rb +8 -8
- data/lib/ngrokapi/services/event_destinations_client.rb +37 -13
- data/lib/ngrokapi/services/event_sources_client.rb +29 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +35 -11
- data/lib/ngrokapi/services/failover_backends_client.rb +35 -13
- data/lib/ngrokapi/services/http_response_backends_client.rb +34 -11
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/ip_policies_client.rb +32 -11
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
- data/lib/ngrokapi/services/ip_restrictions_client.rb +37 -11
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -11
- data/lib/ngrokapi/services/reserved_domains_client.rb +44 -16
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +37 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +44 -15
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +41 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +48 -14
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_certificates_client.rb +37 -13
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +35 -13
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +8 -8
- data/lib/ngrokapi/services/tunnels_client.rb +8 -8
- data/lib/ngrokapi/services/weighted_backends_client.rb +38 -16
- data/lib/ngrokapi/version.rb +9 -7
- data/lib/ngrokapi.rb +15 -13
- data/ngrok-api.gemspec +29 -27
- data/spec/ngrokapi/client_spec.rb +20 -6
- data/spec/ngrokapi/http_client_spec.rb +77 -75
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +4 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +4 -2
- data/spec/ngrokapi/models/agent_ingress_cert_job_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_status_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +8 -3
- data/spec/ngrokapi/models/api_key_spec.rb +4 -2
- data/spec/ngrokapi/models/application_session_spec.rb +30 -0
- data/spec/ngrokapi/models/application_user_spec.rb +30 -0
- data/spec/ngrokapi/models/aws_auth_spec.rb +4 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +4 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +4 -2
- data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/credential_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +4 -2
- data/spec/ngrokapi/models/event_destination_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_spec.rb +4 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_spec.rb +4 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/http_response_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_route_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +4 -2
- data/spec/ngrokapi/models/listable_spec.rb +45 -43
- data/spec/ngrokapi/models/location_spec.rb +23 -0
- data/spec/ngrokapi/models/ref_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_session_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +4 -2
- data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +4 -2
- data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +21 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +34 -3
- data/spec/ngrokapi/services/api_keys_client_spec.rb +28 -1
- data/spec/ngrokapi/services/application_sessions_client_spec.rb +100 -0
- data/spec/ngrokapi/services/application_users_client_spec.rb +100 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +23 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +30 -1
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edges_https_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +49 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +31 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +26 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +23 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +23 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +27 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +22 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +27 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +24 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +38 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +32 -1
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +31 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +35 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +25 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +23 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +2 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +23 -0
- data/spec/spec_helper.rb +94 -2
- metadata +68 -4
- data/doc/README +0 -94
- data/docs/README +0 -94
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: NgrokAPI::Services::AgentIngressesClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -205,7 +205,31 @@
|
|
|
205
205
|
<li class="public ">
|
|
206
206
|
<span class="summary_signature">
|
|
207
207
|
|
|
208
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", domain:) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress </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 Agent Ingress.</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>(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
209
233
|
|
|
210
234
|
|
|
211
235
|
|
|
@@ -399,7 +423,7 @@
|
|
|
399
423
|
<li class="public ">
|
|
400
424
|
<span class="summary_signature">
|
|
401
425
|
|
|
402
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
426
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
403
427
|
|
|
404
428
|
|
|
405
429
|
|
|
@@ -423,7 +447,7 @@
|
|
|
423
447
|
<li class="public ">
|
|
424
448
|
<span class="summary_signature">
|
|
425
449
|
|
|
426
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
450
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
427
451
|
|
|
428
452
|
|
|
429
453
|
|
|
@@ -476,12 +500,12 @@
|
|
|
476
500
|
<pre class="lines">
|
|
477
501
|
|
|
478
502
|
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
503
|
+
17
|
|
504
|
+
18
|
|
505
|
+
19</pre>
|
|
482
506
|
</td>
|
|
483
507
|
<td>
|
|
484
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 17</span>
|
|
485
509
|
|
|
486
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>
|
|
487
511
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
@@ -524,12 +548,12 @@
|
|
|
524
548
|
<pre class="lines">
|
|
525
549
|
|
|
526
550
|
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
551
|
+
15
|
|
552
|
+
16
|
|
553
|
+
17</pre>
|
|
530
554
|
</td>
|
|
531
555
|
<td>
|
|
532
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
556
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 15</span>
|
|
533
557
|
|
|
534
558
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
535
559
|
<span class='ivar'>@client</span>
|
|
@@ -549,7 +573,7 @@
|
|
|
549
573
|
<div class="method_details first">
|
|
550
574
|
<h3 class="signature first" id="create-instance_method">
|
|
551
575
|
|
|
552
|
-
#<strong>create</strong>(description: "", metadata: "", domain:) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
576
|
+
#<strong>create</strong>(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
553
577
|
|
|
554
578
|
|
|
555
579
|
|
|
@@ -617,6 +641,24 @@
|
|
|
617
641
|
—
|
|
618
642
|
<div class='inline'>
|
|
619
643
|
<p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
|
|
644
|
+
</div>
|
|
645
|
+
|
|
646
|
+
</li>
|
|
647
|
+
|
|
648
|
+
<li>
|
|
649
|
+
|
|
650
|
+
<span class='name'>certificate_management_policy</span>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
<span class='type'>(<tt>AgentIngressCertPolicy</tt>)</span>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
—
|
|
660
|
+
<div class='inline'>
|
|
661
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
620
662
|
</div>
|
|
621
663
|
|
|
622
664
|
</li>
|
|
@@ -648,9 +690,6 @@
|
|
|
648
690
|
<pre class="lines">
|
|
649
691
|
|
|
650
692
|
|
|
651
|
-
29
|
|
652
|
-
30
|
|
653
|
-
31
|
|
654
693
|
32
|
|
655
694
|
33
|
|
656
695
|
34
|
|
@@ -658,12 +697,16 @@
|
|
|
658
697
|
36
|
|
659
698
|
37
|
|
660
699
|
38
|
|
661
|
-
39
|
|
700
|
+
39
|
|
701
|
+
40
|
|
702
|
+
41
|
|
703
|
+
42
|
|
704
|
+
43</pre>
|
|
662
705
|
</td>
|
|
663
706
|
<td>
|
|
664
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
707
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 32</span>
|
|
665
708
|
|
|
666
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>domain:</span><span class='rparen'>)</span>
|
|
709
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>domain:</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
667
710
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>'</span></span>
|
|
668
711
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
669
712
|
<span class='rbrace'>}</span>
|
|
@@ -671,8 +714,162 @@
|
|
|
671
714
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
672
715
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
673
716
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:domain</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_domain'>domain</span> <span class='kw'>if</span> <span class='id identifier rubyid_domain'>domain</span>
|
|
717
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
674
718
|
<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>
|
|
675
|
-
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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'>
|
|
719
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
720
|
+
<span class='kw'>end</span></pre>
|
|
721
|
+
</td>
|
|
722
|
+
</tr>
|
|
723
|
+
</table>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
<div class="method_details ">
|
|
727
|
+
<h3 class="signature " id="create!-instance_method">
|
|
728
|
+
|
|
729
|
+
#<strong>create!</strong>(description: "", metadata: "", domain:, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
</h3><div class="docstring">
|
|
736
|
+
<div class="discussion">
|
|
737
|
+
|
|
738
|
+
<p>Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress. Throws an exception if API error.</p>
|
|
739
|
+
|
|
740
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-create">ngrok.com/docs/api#api-agent-ingresses-create</a></p>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</div>
|
|
744
|
+
</div>
|
|
745
|
+
<div class="tags">
|
|
746
|
+
<p class="tag_title">Parameters:</p>
|
|
747
|
+
<ul class="param">
|
|
748
|
+
|
|
749
|
+
<li>
|
|
750
|
+
|
|
751
|
+
<span class='name'>description</span>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
—
|
|
761
|
+
<div class='inline'>
|
|
762
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
763
|
+
</div>
|
|
764
|
+
|
|
765
|
+
</li>
|
|
766
|
+
|
|
767
|
+
<li>
|
|
768
|
+
|
|
769
|
+
<span class='name'>metadata</span>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
—
|
|
779
|
+
<div class='inline'>
|
|
780
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
781
|
+
</div>
|
|
782
|
+
|
|
783
|
+
</li>
|
|
784
|
+
|
|
785
|
+
<li>
|
|
786
|
+
|
|
787
|
+
<span class='name'>domain</span>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
—
|
|
795
|
+
<div class='inline'>
|
|
796
|
+
<p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
|
|
797
|
+
</div>
|
|
798
|
+
|
|
799
|
+
</li>
|
|
800
|
+
|
|
801
|
+
<li>
|
|
802
|
+
|
|
803
|
+
<span class='name'>certificate_management_policy</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<span class='type'>(<tt>AgentIngressCertPolicy</tt>)</span>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
—
|
|
813
|
+
<div class='inline'>
|
|
814
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
815
|
+
</div>
|
|
816
|
+
|
|
817
|
+
</li>
|
|
818
|
+
|
|
819
|
+
</ul>
|
|
820
|
+
|
|
821
|
+
<p class="tag_title">Returns:</p>
|
|
822
|
+
<ul class="return">
|
|
823
|
+
|
|
824
|
+
<li>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
—
|
|
832
|
+
<div class='inline'>
|
|
833
|
+
<p>result from the API request</p>
|
|
834
|
+
</div>
|
|
835
|
+
|
|
836
|
+
</li>
|
|
837
|
+
|
|
838
|
+
</ul>
|
|
839
|
+
|
|
840
|
+
</div><table class="source_code">
|
|
841
|
+
<tr>
|
|
842
|
+
<td>
|
|
843
|
+
<pre class="lines">
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
57
|
|
847
|
+
58
|
|
848
|
+
59
|
|
849
|
+
60
|
|
850
|
+
61
|
|
851
|
+
62
|
|
852
|
+
63
|
|
853
|
+
64
|
|
854
|
+
65
|
|
855
|
+
66
|
|
856
|
+
67
|
|
857
|
+
68</pre>
|
|
858
|
+
</td>
|
|
859
|
+
<td>
|
|
860
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 57</span>
|
|
861
|
+
|
|
862
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>domain:</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
863
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>'</span></span>
|
|
864
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
865
|
+
<span class='rbrace'>}</span>
|
|
866
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
867
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
868
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
869
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:domain</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_domain'>domain</span> <span class='kw'>if</span> <span class='id identifier rubyid_domain'>domain</span>
|
|
870
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
871
|
+
<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>
|
|
872
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
676
873
|
<span class='kw'>end</span></pre>
|
|
677
874
|
</td>
|
|
678
875
|
</tr>
|
|
@@ -747,16 +944,16 @@
|
|
|
747
944
|
<pre class="lines">
|
|
748
945
|
|
|
749
946
|
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
947
|
+
77
|
|
948
|
+
78
|
|
949
|
+
79
|
|
950
|
+
80
|
|
951
|
+
81
|
|
952
|
+
82
|
|
953
|
+
83</pre>
|
|
757
954
|
</td>
|
|
758
955
|
<td>
|
|
759
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
956
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 77</span>
|
|
760
957
|
|
|
761
958
|
<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>
|
|
762
959
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -838,16 +1035,16 @@
|
|
|
838
1035
|
<pre class="lines">
|
|
839
1036
|
|
|
840
1037
|
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
1038
|
+
93
|
|
1039
|
+
94
|
|
1040
|
+
95
|
|
1041
|
+
96
|
|
1042
|
+
97
|
|
1043
|
+
98
|
|
1044
|
+
99</pre>
|
|
848
1045
|
</td>
|
|
849
1046
|
<td>
|
|
850
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1047
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 93</span>
|
|
851
1048
|
|
|
852
1049
|
<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>
|
|
853
1050
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -929,18 +1126,18 @@
|
|
|
929
1126
|
<pre class="lines">
|
|
930
1127
|
|
|
931
1128
|
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
1129
|
+
108
|
|
1130
|
+
109
|
|
1131
|
+
110
|
|
1132
|
+
111
|
|
1133
|
+
112
|
|
1134
|
+
113
|
|
1135
|
+
114
|
|
1136
|
+
115
|
|
1137
|
+
116</pre>
|
|
941
1138
|
</td>
|
|
942
1139
|
<td>
|
|
943
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1140
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 108</span>
|
|
944
1141
|
|
|
945
1142
|
<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>
|
|
946
1143
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -949,7 +1146,7 @@
|
|
|
949
1146
|
<span class='rbrace'>}</span>
|
|
950
1147
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
951
1148
|
<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>
|
|
952
|
-
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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'>
|
|
1149
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
953
1150
|
<span class='kw'>end</span></pre>
|
|
954
1151
|
</td>
|
|
955
1152
|
</tr>
|
|
@@ -1024,18 +1221,18 @@
|
|
|
1024
1221
|
<pre class="lines">
|
|
1025
1222
|
|
|
1026
1223
|
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1224
|
+
126
|
|
1225
|
+
127
|
|
1226
|
+
128
|
|
1227
|
+
129
|
|
1228
|
+
130
|
|
1229
|
+
131
|
|
1230
|
+
132
|
|
1231
|
+
133
|
|
1232
|
+
134</pre>
|
|
1036
1233
|
</td>
|
|
1037
1234
|
<td>
|
|
1038
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1235
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 126</span>
|
|
1039
1236
|
|
|
1040
1237
|
<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>
|
|
1041
1238
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1044,7 +1241,7 @@
|
|
|
1044
1241
|
<span class='rbrace'>}</span>
|
|
1045
1242
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1046
1243
|
<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>
|
|
1047
|
-
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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'>
|
|
1244
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
1048
1245
|
<span class='kw'>end</span></pre>
|
|
1049
1246
|
</td>
|
|
1050
1247
|
</tr>
|
|
@@ -1145,28 +1342,26 @@
|
|
|
1145
1342
|
<pre class="lines">
|
|
1146
1343
|
|
|
1147
1344
|
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
131</pre>
|
|
1345
|
+
145
|
|
1346
|
+
146
|
|
1347
|
+
147
|
|
1348
|
+
148
|
|
1349
|
+
149
|
|
1350
|
+
150
|
|
1351
|
+
151
|
|
1352
|
+
152
|
|
1353
|
+
153
|
|
1354
|
+
154
|
|
1355
|
+
155
|
|
1356
|
+
156
|
|
1357
|
+
157
|
|
1358
|
+
158
|
|
1359
|
+
159</pre>
|
|
1164
1360
|
</td>
|
|
1165
1361
|
<td>
|
|
1166
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1362
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 145</span>
|
|
1167
1363
|
|
|
1168
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1169
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1364
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1170
1365
|
<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>
|
|
1171
1366
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1172
1367
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
@@ -1176,7 +1371,7 @@
|
|
|
1176
1371
|
|
|
1177
1372
|
<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>
|
|
1178
1373
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1179
|
-
<span class='label'>
|
|
1374
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1180
1375
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1181
1376
|
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span>
|
|
1182
1377
|
<span class='rparen'>)</span>
|
|
@@ -1280,30 +1475,28 @@
|
|
|
1280
1475
|
<pre class="lines">
|
|
1281
1476
|
|
|
1282
1477
|
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
160</pre>
|
|
1478
|
+
171
|
|
1479
|
+
172
|
|
1480
|
+
173
|
|
1481
|
+
174
|
|
1482
|
+
175
|
|
1483
|
+
176
|
|
1484
|
+
177
|
|
1485
|
+
178
|
|
1486
|
+
179
|
|
1487
|
+
180
|
|
1488
|
+
181
|
|
1489
|
+
182
|
|
1490
|
+
183
|
|
1491
|
+
184
|
|
1492
|
+
185
|
|
1493
|
+
186
|
|
1494
|
+
187</pre>
|
|
1301
1495
|
</td>
|
|
1302
1496
|
<td>
|
|
1303
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1497
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 171</span>
|
|
1304
1498
|
|
|
1305
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1306
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1499
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1307
1500
|
<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>
|
|
1308
1501
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1309
1502
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
@@ -1314,7 +1507,7 @@
|
|
|
1314
1507
|
|
|
1315
1508
|
<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>
|
|
1316
1509
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1317
|
-
<span class='label'>
|
|
1510
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1318
1511
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1319
1512
|
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='comma'>,</span>
|
|
1320
1513
|
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
@@ -1328,7 +1521,7 @@
|
|
|
1328
1521
|
<div class="method_details ">
|
|
1329
1522
|
<h3 class="signature " id="update-instance_method">
|
|
1330
1523
|
|
|
1331
|
-
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
1524
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
1332
1525
|
|
|
1333
1526
|
|
|
1334
1527
|
|
|
@@ -1393,6 +1586,24 @@
|
|
|
1393
1586
|
—
|
|
1394
1587
|
<div class='inline'>
|
|
1395
1588
|
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
1589
|
+
</div>
|
|
1590
|
+
|
|
1591
|
+
</li>
|
|
1592
|
+
|
|
1593
|
+
<li>
|
|
1594
|
+
|
|
1595
|
+
<span class='name'>certificate_management_policy</span>
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
<span class='type'>(<tt>AgentIngressCertPolicy</tt>)</span>
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
—
|
|
1605
|
+
<div class='inline'>
|
|
1606
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
1396
1607
|
</div>
|
|
1397
1608
|
|
|
1398
1609
|
</li>
|
|
@@ -1424,22 +1635,23 @@
|
|
|
1424
1635
|
<pre class="lines">
|
|
1425
1636
|
|
|
1426
1637
|
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1638
|
+
199
|
|
1639
|
+
200
|
|
1640
|
+
201
|
|
1641
|
+
202
|
|
1642
|
+
203
|
|
1643
|
+
204
|
|
1644
|
+
205
|
|
1645
|
+
206
|
|
1646
|
+
207
|
|
1647
|
+
208
|
|
1648
|
+
209
|
|
1649
|
+
210</pre>
|
|
1438
1650
|
</td>
|
|
1439
1651
|
<td>
|
|
1440
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1652
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 199</span>
|
|
1441
1653
|
|
|
1442
|
-
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1654
|
+
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1443
1655
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1444
1656
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1445
1657
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
@@ -1447,8 +1659,9 @@
|
|
|
1447
1659
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1448
1660
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1449
1661
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1662
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
1450
1663
|
<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>
|
|
1451
|
-
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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'>
|
|
1664
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
1452
1665
|
<span class='kw'>end</span></pre>
|
|
1453
1666
|
</td>
|
|
1454
1667
|
</tr>
|
|
@@ -1458,7 +1671,7 @@
|
|
|
1458
1671
|
<div class="method_details ">
|
|
1459
1672
|
<h3 class="signature " id="update!-instance_method">
|
|
1460
1673
|
|
|
1461
|
-
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
1674
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
|
|
1462
1675
|
|
|
1463
1676
|
|
|
1464
1677
|
|
|
@@ -1523,6 +1736,24 @@
|
|
|
1523
1736
|
—
|
|
1524
1737
|
<div class='inline'>
|
|
1525
1738
|
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
1739
|
+
</div>
|
|
1740
|
+
|
|
1741
|
+
</li>
|
|
1742
|
+
|
|
1743
|
+
<li>
|
|
1744
|
+
|
|
1745
|
+
<span class='name'>certificate_management_policy</span>
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
<span class='type'>(<tt>AgentIngressCertPolicy</tt>)</span>
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
—
|
|
1755
|
+
<div class='inline'>
|
|
1756
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
1526
1757
|
</div>
|
|
1527
1758
|
|
|
1528
1759
|
</li>
|
|
@@ -1554,22 +1785,23 @@
|
|
|
1554
1785
|
<pre class="lines">
|
|
1555
1786
|
|
|
1556
1787
|
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1788
|
+
223
|
|
1789
|
+
224
|
|
1790
|
+
225
|
|
1791
|
+
226
|
|
1792
|
+
227
|
|
1793
|
+
228
|
|
1794
|
+
229
|
|
1795
|
+
230
|
|
1796
|
+
231
|
|
1797
|
+
232
|
|
1798
|
+
233
|
|
1799
|
+
234</pre>
|
|
1568
1800
|
</td>
|
|
1569
1801
|
<td>
|
|
1570
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1802
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 223</span>
|
|
1571
1803
|
|
|
1572
|
-
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1804
|
+
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1573
1805
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1574
1806
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1575
1807
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
@@ -1577,8 +1809,9 @@
|
|
|
1577
1809
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1578
1810
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1579
1811
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1812
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
|
1580
1813
|
<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>
|
|
1581
|
-
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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'>
|
|
1814
|
+
<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/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#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>
|
|
1582
1815
|
<span class='kw'>end</span></pre>
|
|
1583
1816
|
</td>
|
|
1584
1817
|
</tr>
|
|
@@ -1590,9 +1823,9 @@
|
|
|
1590
1823
|
</div>
|
|
1591
1824
|
|
|
1592
1825
|
<div id="footer">
|
|
1593
|
-
Generated on Thu
|
|
1594
|
-
<a href="
|
|
1595
|
-
0.9.
|
|
1826
|
+
Generated on Thu Aug 24 20:57:33 2023 by
|
|
1827
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1828
|
+
0.9.34 (ruby-3.0.6).
|
|
1596
1829
|
</div>
|
|
1597
1830
|
|
|
1598
1831
|
</div>
|