ngrok-api 0.18.0 → 0.19.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/README.md +28 -1
- data/doc/NgrokAPI/Client.html +1 -1
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +146 -3
- data/doc/NgrokAPI/Models/APIKey.html +119 -67
- data/doc/NgrokAPI/Models/AWSAuth.html +82 -30
- data/doc/NgrokAPI/Models/AWSCredentials.html +89 -37
- data/doc/NgrokAPI/Models/AWSRole.html +74 -22
- data/doc/NgrokAPI/Models/AbuseReport.html +108 -56
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +82 -30
- data/doc/NgrokAPI/Models/AgentIngress.html +141 -89
- data/doc/NgrokAPI/Models/CertificateAuthority.html +148 -96
- data/doc/NgrokAPI/Models/Credential.html +120 -68
- data/doc/NgrokAPI/Models/Endpoint.html +138 -86
- data/doc/NgrokAPI/Models/EndpointBackend.html +89 -37
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +89 -37
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +100 -48
- data/doc/NgrokAPI/Models/EndpointCompression.html +81 -29
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +89 -37
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +89 -37
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +89 -37
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +89 -37
- data/doc/NgrokAPI/Models/EndpointOAuth.html +123 -71
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +106 -54
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +115 -63
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +106 -54
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +106 -54
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +105 -53
- data/doc/NgrokAPI/Models/EndpointOIDC.html +132 -80
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +90 -38
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +90 -38
- data/doc/NgrokAPI/Models/EndpointSAML.html +147 -95
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +132 -80
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +90 -38
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +89 -37
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +90 -38
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +81 -29
- data/doc/NgrokAPI/Models/EventDestination.html +121 -69
- data/doc/NgrokAPI/Models/EventSource.html +91 -39
- data/doc/NgrokAPI/Models/EventSourceList.html +75 -23
- data/doc/NgrokAPI/Models/EventSourceReplace.html +90 -38
- data/doc/NgrokAPI/Models/EventSubscription.html +121 -69
- data/doc/NgrokAPI/Models/EventTarget.html +105 -53
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +89 -37
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +89 -37
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +82 -30
- data/doc/NgrokAPI/Models/FailoverBackend.html +127 -75
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +135 -83
- data/doc/NgrokAPI/Models/HTTPSEdge.html +136 -84
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +163 -111
- data/doc/NgrokAPI/Models/IPPolicy.html +119 -67
- data/doc/NgrokAPI/Models/IPPolicyRule.html +135 -83
- data/doc/NgrokAPI/Models/IPRestriction.html +129 -77
- data/doc/NgrokAPI/Models/Listable.html +60 -60
- data/doc/NgrokAPI/Models/Ref.html +82 -30
- data/doc/NgrokAPI/Models/ReservedAddr.html +129 -77
- data/doc/NgrokAPI/Models/ReservedDomain.html +150 -98
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +91 -39
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +89 -37
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +89 -37
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +134 -82
- data/doc/NgrokAPI/Models/SSHCredential.html +127 -75
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +147 -95
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +153 -101
- data/doc/NgrokAPI/Models/TCPEdge.html +141 -89
- data/doc/NgrokAPI/Models/TLSCertificate.html +164 -112
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +89 -37
- data/doc/NgrokAPI/Models/TLSEdge.html +145 -93
- data/doc/NgrokAPI/Models/Tunnel.html +136 -84
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +128 -76
- data/doc/NgrokAPI/Models/TunnelSession.html +125 -73
- data/doc/NgrokAPI/Models/WeightedBackend.html +127 -75
- data/doc/NgrokAPI/Models.html +1 -1
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +243 -108
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +161 -24
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +261 -108
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +261 -108
- data/doc/NgrokAPI/Services/CredentialsClient.html +265 -110
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +304 -114
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +513 -98
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +304 -114
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +338 -118
- data/doc/NgrokAPI/Services/EndpointsClient.html +19 -23
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +287 -112
- data/doc/NgrokAPI/Services/EventSourcesClient.html +226 -87
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +287 -112
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +267 -112
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +307 -114
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +243 -108
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +301 -110
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +303 -112
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +263 -108
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +357 -144
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +303 -108
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +283 -110
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +339 -108
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +380 -109
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +279 -108
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +27 -31
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +267 -112
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +43 -47
- data/doc/NgrokAPI/Services/TunnelsClient.html +19 -23
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +270 -115
- data/doc/NgrokAPI/Services.html +1 -1
- data/doc/NgrokAPI.html +1 -1
- data/doc/_index.html +1 -1
- data/doc/file.README.html +54 -54
- data/doc/index.html +54 -54
- data/doc/method_list.html +1089 -337
- data/doc/top-level-namespace.html +1 -1
- data/docs/NgrokAPI/Client.html +1 -1
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +146 -3
- data/docs/NgrokAPI/Models/APIKey.html +119 -67
- data/docs/NgrokAPI/Models/AWSAuth.html +82 -30
- data/docs/NgrokAPI/Models/AWSCredentials.html +89 -37
- data/docs/NgrokAPI/Models/AWSRole.html +74 -22
- data/docs/NgrokAPI/Models/AbuseReport.html +108 -56
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +82 -30
- data/docs/NgrokAPI/Models/AgentIngress.html +141 -89
- data/docs/NgrokAPI/Models/CertificateAuthority.html +148 -96
- data/docs/NgrokAPI/Models/Credential.html +120 -68
- data/docs/NgrokAPI/Models/Endpoint.html +138 -86
- data/docs/NgrokAPI/Models/EndpointBackend.html +89 -37
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +89 -37
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +100 -48
- data/docs/NgrokAPI/Models/EndpointCompression.html +81 -29
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +89 -37
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +89 -37
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +89 -37
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +89 -37
- data/docs/NgrokAPI/Models/EndpointOAuth.html +123 -71
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +106 -54
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +115 -63
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +106 -54
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +106 -54
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +105 -53
- data/docs/NgrokAPI/Models/EndpointOIDC.html +132 -80
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +90 -38
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +90 -38
- data/docs/NgrokAPI/Models/EndpointSAML.html +147 -95
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +132 -80
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +90 -38
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +89 -37
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +90 -38
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +81 -29
- data/docs/NgrokAPI/Models/EventDestination.html +121 -69
- data/docs/NgrokAPI/Models/EventSource.html +91 -39
- data/docs/NgrokAPI/Models/EventSourceList.html +75 -23
- data/docs/NgrokAPI/Models/EventSourceReplace.html +90 -38
- data/docs/NgrokAPI/Models/EventSubscription.html +121 -69
- data/docs/NgrokAPI/Models/EventTarget.html +105 -53
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +89 -37
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +89 -37
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +82 -30
- data/docs/NgrokAPI/Models/FailoverBackend.html +127 -75
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +135 -83
- data/docs/NgrokAPI/Models/HTTPSEdge.html +136 -84
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +163 -111
- data/docs/NgrokAPI/Models/IPPolicy.html +119 -67
- data/docs/NgrokAPI/Models/IPPolicyRule.html +135 -83
- data/docs/NgrokAPI/Models/IPRestriction.html +129 -77
- data/docs/NgrokAPI/Models/Listable.html +60 -60
- data/docs/NgrokAPI/Models/Ref.html +82 -30
- data/docs/NgrokAPI/Models/ReservedAddr.html +129 -77
- data/docs/NgrokAPI/Models/ReservedDomain.html +150 -98
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +91 -39
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +89 -37
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +89 -37
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +134 -82
- data/docs/NgrokAPI/Models/SSHCredential.html +127 -75
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +147 -95
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +153 -101
- data/docs/NgrokAPI/Models/TCPEdge.html +141 -89
- data/docs/NgrokAPI/Models/TLSCertificate.html +164 -112
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +89 -37
- data/docs/NgrokAPI/Models/TLSEdge.html +145 -93
- data/docs/NgrokAPI/Models/Tunnel.html +136 -84
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +128 -76
- data/docs/NgrokAPI/Models/TunnelSession.html +125 -73
- data/docs/NgrokAPI/Models/WeightedBackend.html +127 -75
- data/docs/NgrokAPI/Models.html +1 -1
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +243 -108
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +161 -24
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +261 -108
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +261 -108
- data/docs/NgrokAPI/Services/CredentialsClient.html +265 -110
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +304 -114
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +513 -98
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +304 -114
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +338 -118
- data/docs/NgrokAPI/Services/EndpointsClient.html +19 -23
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +287 -112
- data/docs/NgrokAPI/Services/EventSourcesClient.html +226 -87
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +287 -112
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +267 -112
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +307 -114
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +243 -108
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +301 -110
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +303 -112
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +263 -108
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +357 -144
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +303 -108
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +283 -110
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +339 -108
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +380 -109
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +279 -108
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +27 -31
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +267 -112
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +43 -47
- data/docs/NgrokAPI/Services/TunnelsClient.html +19 -23
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +270 -115
- data/docs/NgrokAPI/Services.html +1 -1
- data/docs/NgrokAPI.html +1 -1
- data/docs/_index.html +1 -1
- data/docs/file.README.html +54 -54
- data/docs/index.html +54 -54
- data/docs/method_list.html +1089 -337
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/http_client.rb +21 -2
- data/lib/ngrokapi/models/abuse_report.rb +16 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
- data/lib/ngrokapi/models/agent_ingress.rb +17 -13
- data/lib/ngrokapi/models/api_key.rb +15 -11
- data/lib/ngrokapi/models/aws_auth.rb +11 -7
- data/lib/ngrokapi/models/aws_credentials.rb +11 -7
- data/lib/ngrokapi/models/aws_role.rb +10 -6
- data/lib/ngrokapi/models/certificate_authority.rb +20 -16
- data/lib/ngrokapi/models/credential.rb +16 -12
- data/lib/ngrokapi/models/endpoint.rb +22 -18
- data/lib/ngrokapi/models/endpoint_backend.rb +11 -7
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
- data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +11 -7
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +10 -6
- data/lib/ngrokapi/models/event_destination.rb +16 -12
- data/lib/ngrokapi/models/event_source.rb +13 -9
- data/lib/ngrokapi/models/event_source_list.rb +11 -7
- data/lib/ngrokapi/models/event_source_replace.rb +12 -8
- data/lib/ngrokapi/models/event_subscription.rb +16 -12
- data/lib/ngrokapi/models/event_target.rb +13 -9
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
- data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
- data/lib/ngrokapi/models/failover_backend.rb +16 -12
- data/lib/ngrokapi/models/http_response_backend.rb +17 -13
- data/lib/ngrokapi/models/https_edge.rb +18 -14
- data/lib/ngrokapi/models/https_edge_route.rb +28 -24
- data/lib/ngrokapi/models/ip_policy.rb +15 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +17 -13
- data/lib/ngrokapi/models/ip_restriction.rb +17 -13
- data/lib/ngrokapi/models/listable.rb +9 -9
- data/lib/ngrokapi/models/ref.rb +11 -7
- data/lib/ngrokapi/models/reserved_addr.rb +17 -13
- data/lib/ngrokapi/models/reserved_domain.rb +23 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
- data/lib/ngrokapi/models/ssh_credential.rb +16 -12
- data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
- data/lib/ngrokapi/models/tcp_edge.rb +17 -13
- data/lib/ngrokapi/models/tls_certificate.rb +30 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
- data/lib/ngrokapi/models/tls_edge.rb +19 -15
- data/lib/ngrokapi/models/tunnel.rb +20 -16
- data/lib/ngrokapi/models/tunnel_group_backend.rb +17 -13
- data/lib/ngrokapi/models/tunnel_session.rb +19 -15
- data/lib/ngrokapi/models/weighted_backend.rb +16 -12
- data/lib/ngrokapi/paged_iterator.rb +1 -1
- data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
- data/lib/ngrokapi/services/api_keys_client.rb +30 -11
- data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
- data/lib/ngrokapi/services/credentials_client.rb +34 -11
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +6 -8
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +6 -8
- data/lib/ngrokapi/services/edges_https_client.rb +35 -11
- data/lib/ngrokapi/services/edges_https_routes_client.rb +53 -5
- data/lib/ngrokapi/services/edges_tcp_client.rb +35 -11
- data/lib/ngrokapi/services/edges_tls_client.rb +39 -11
- data/lib/ngrokapi/services/endpoints_client.rb +6 -8
- data/lib/ngrokapi/services/event_destinations_client.rb +35 -11
- data/lib/ngrokapi/services/event_sources_client.rb +27 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -11
- data/lib/ngrokapi/services/failover_backends_client.rb +33 -13
- data/lib/ngrokapi/services/http_response_backends_client.rb +32 -11
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +6 -8
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +6 -8
- data/lib/ngrokapi/services/ip_policies_client.rb +30 -11
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +35 -11
- data/lib/ngrokapi/services/ip_restrictions_client.rb +35 -11
- data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -11
- data/lib/ngrokapi/services/reserved_domains_client.rb +37 -11
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +6 -8
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +6 -8
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +6 -8
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +6 -8
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +6 -8
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +6 -8
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +33 -13
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
- data/lib/ngrokapi/services/tunnels_client.rb +6 -8
- data/lib/ngrokapi/services/weighted_backends_client.rb +36 -16
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
- data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
- data/spec/ngrokapi/models/api_key_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
- data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/credential_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +2 -2
- data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_spec.rb +2 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_spec.rb +2 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +2 -2
- data/spec/ngrokapi/models/http_response_backend_spec.rb +2 -2
- data/spec/ngrokapi/models/https_edge_route_spec.rb +2 -2
- data/spec/ngrokapi/models/https_edge_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
- data/spec/ngrokapi/models/listable_spec.rb +2 -2
- data/spec/ngrokapi/models/ref_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +2 -2
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +2 -2
- data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
- data/spec/ngrokapi/models/weighted_backend_spec.rb +2 -2
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/edges_https_client_spec.rb +25 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +47 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +25 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +29 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +21 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +25 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +25 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +2 -4
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +21 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +21 -0
- metadata +1 -3
- data/doc/README +0 -94
- data/docs/README +0 -94
|
@@ -38,7 +38,28 @@ module NgrokAPI
|
|
|
38
38
|
data[:description] = description if description
|
|
39
39
|
data[:metadata] = metadata if metadata
|
|
40
40
|
result = @client.post(path % replacements, data: data)
|
|
41
|
-
NgrokAPI::Models::IPPolicy.new(client: self,
|
|
41
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
##
|
|
45
|
+
# Create a new IP policy. It will not apply to any traffic until you associate to
|
|
46
|
+
# a traffic source via an endpoint configuration or IP restriction.
|
|
47
|
+
# Throws an exception if API error.
|
|
48
|
+
#
|
|
49
|
+
# @param [string] description human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
|
|
50
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
|
|
51
|
+
# @return [NgrokAPI::Models::IPPolicy] result from the API request
|
|
52
|
+
#
|
|
53
|
+
# https://ngrok.com/docs/api#api-ip-policies-create
|
|
54
|
+
def create!(description: "", metadata: "", action: nil)
|
|
55
|
+
path = '/ip_policies'
|
|
56
|
+
replacements = {
|
|
57
|
+
}
|
|
58
|
+
data = {}
|
|
59
|
+
data[:description] = description if description
|
|
60
|
+
data[:metadata] = metadata if metadata
|
|
61
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
62
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
42
63
|
end
|
|
43
64
|
|
|
44
65
|
##
|
|
@@ -90,7 +111,7 @@ module NgrokAPI
|
|
|
90
111
|
}
|
|
91
112
|
data = {}
|
|
92
113
|
result = @client.get(path % replacements, data: data)
|
|
93
|
-
NgrokAPI::Models::IPPolicy.new(client: self,
|
|
114
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
94
115
|
end
|
|
95
116
|
|
|
96
117
|
##
|
|
@@ -108,7 +129,7 @@ module NgrokAPI
|
|
|
108
129
|
}
|
|
109
130
|
data = {}
|
|
110
131
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
111
|
-
NgrokAPI::Models::IPPolicy.new(client: self,
|
|
132
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
112
133
|
end
|
|
113
134
|
|
|
114
135
|
##
|
|
@@ -120,8 +141,7 @@ module NgrokAPI
|
|
|
120
141
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
121
142
|
#
|
|
122
143
|
# https://ngrok.com/docs/api#api-ip-policies-list
|
|
123
|
-
def list(before_id: nil, limit: nil,
|
|
124
|
-
url: nil)
|
|
144
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
125
145
|
result = @client.list(
|
|
126
146
|
before_id: before_id,
|
|
127
147
|
limit: limit,
|
|
@@ -131,7 +151,7 @@ module NgrokAPI
|
|
|
131
151
|
|
|
132
152
|
NgrokAPI::Models::Listable.new(
|
|
133
153
|
client: self,
|
|
134
|
-
|
|
154
|
+
attrs: result,
|
|
135
155
|
list_property: LIST_PROPERTY,
|
|
136
156
|
klass: NgrokAPI::Models::IPPolicy
|
|
137
157
|
)
|
|
@@ -147,8 +167,7 @@ module NgrokAPI
|
|
|
147
167
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
148
168
|
#
|
|
149
169
|
# https://ngrok.com/docs/api#api-ip-policies-list
|
|
150
|
-
def list!(before_id: nil, limit: nil,
|
|
151
|
-
url: nil)
|
|
170
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
152
171
|
result = @client.list(
|
|
153
172
|
before_id: before_id,
|
|
154
173
|
limit: limit,
|
|
@@ -159,7 +178,7 @@ module NgrokAPI
|
|
|
159
178
|
|
|
160
179
|
NgrokAPI::Models::Listable.new(
|
|
161
180
|
client: self,
|
|
162
|
-
|
|
181
|
+
attrs: result,
|
|
163
182
|
list_property: LIST_PROPERTY,
|
|
164
183
|
klass: NgrokAPI::Models::IPPolicy,
|
|
165
184
|
danger: true
|
|
@@ -184,7 +203,7 @@ module NgrokAPI
|
|
|
184
203
|
data[:description] = description if description
|
|
185
204
|
data[:metadata] = metadata if metadata
|
|
186
205
|
result = @client.patch(path % replacements, data: data)
|
|
187
|
-
NgrokAPI::Models::IPPolicy.new(client: self,
|
|
206
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
188
207
|
end
|
|
189
208
|
|
|
190
209
|
##
|
|
@@ -206,7 +225,7 @@ module NgrokAPI
|
|
|
206
225
|
data[:description] = description if description
|
|
207
226
|
data[:metadata] = metadata if metadata
|
|
208
227
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
209
|
-
NgrokAPI::Models::IPPolicy.new(client: self,
|
|
228
|
+
NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
|
|
210
229
|
end
|
|
211
230
|
end
|
|
212
231
|
end
|
|
@@ -41,7 +41,33 @@ module NgrokAPI
|
|
|
41
41
|
data[:ip_policy_id] = ip_policy_id if ip_policy_id
|
|
42
42
|
data[:action] = action if action
|
|
43
43
|
result = @client.post(path % replacements, data: data)
|
|
44
|
-
NgrokAPI::Models::IPPolicyRule.new(client: self,
|
|
44
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
##
|
|
48
|
+
# Create a new IP policy rule attached to an IP Policy.
|
|
49
|
+
# Throws an exception if API error.
|
|
50
|
+
#
|
|
51
|
+
# @param [string] description human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
|
|
52
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
|
|
53
|
+
# @param [string] cidr an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
|
|
54
|
+
# @param [string] ip_policy_id ID of the IP policy this IP policy rule will be attached to
|
|
55
|
+
# @param [string] action the action to apply to the policy rule, either ``allow`` or ``deny``
|
|
56
|
+
# @return [NgrokAPI::Models::IPPolicyRule] result from the API request
|
|
57
|
+
#
|
|
58
|
+
# https://ngrok.com/docs/api#api-ip-policy-rules-create
|
|
59
|
+
def create!(description: "", metadata: "", cidr:, ip_policy_id:, action: nil)
|
|
60
|
+
path = '/ip_policy_rules'
|
|
61
|
+
replacements = {
|
|
62
|
+
}
|
|
63
|
+
data = {}
|
|
64
|
+
data[:description] = description if description
|
|
65
|
+
data[:metadata] = metadata if metadata
|
|
66
|
+
data[:cidr] = cidr if cidr
|
|
67
|
+
data[:ip_policy_id] = ip_policy_id if ip_policy_id
|
|
68
|
+
data[:action] = action if action
|
|
69
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
70
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
45
71
|
end
|
|
46
72
|
|
|
47
73
|
##
|
|
@@ -89,7 +115,7 @@ module NgrokAPI
|
|
|
89
115
|
}
|
|
90
116
|
data = {}
|
|
91
117
|
result = @client.get(path % replacements, data: data)
|
|
92
|
-
NgrokAPI::Models::IPPolicyRule.new(client: self,
|
|
118
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
93
119
|
end
|
|
94
120
|
|
|
95
121
|
##
|
|
@@ -107,7 +133,7 @@ module NgrokAPI
|
|
|
107
133
|
}
|
|
108
134
|
data = {}
|
|
109
135
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
110
|
-
NgrokAPI::Models::IPPolicyRule.new(client: self,
|
|
136
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
111
137
|
end
|
|
112
138
|
|
|
113
139
|
##
|
|
@@ -119,8 +145,7 @@ module NgrokAPI
|
|
|
119
145
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
120
146
|
#
|
|
121
147
|
# https://ngrok.com/docs/api#api-ip-policy-rules-list
|
|
122
|
-
def list(before_id: nil, limit: nil,
|
|
123
|
-
url: nil)
|
|
148
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
124
149
|
result = @client.list(
|
|
125
150
|
before_id: before_id,
|
|
126
151
|
limit: limit,
|
|
@@ -130,7 +155,7 @@ module NgrokAPI
|
|
|
130
155
|
|
|
131
156
|
NgrokAPI::Models::Listable.new(
|
|
132
157
|
client: self,
|
|
133
|
-
|
|
158
|
+
attrs: result,
|
|
134
159
|
list_property: LIST_PROPERTY,
|
|
135
160
|
klass: NgrokAPI::Models::IPPolicyRule
|
|
136
161
|
)
|
|
@@ -146,8 +171,7 @@ module NgrokAPI
|
|
|
146
171
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
147
172
|
#
|
|
148
173
|
# https://ngrok.com/docs/api#api-ip-policy-rules-list
|
|
149
|
-
def list!(before_id: nil, limit: nil,
|
|
150
|
-
url: nil)
|
|
174
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
151
175
|
result = @client.list(
|
|
152
176
|
before_id: before_id,
|
|
153
177
|
limit: limit,
|
|
@@ -158,7 +182,7 @@ module NgrokAPI
|
|
|
158
182
|
|
|
159
183
|
NgrokAPI::Models::Listable.new(
|
|
160
184
|
client: self,
|
|
161
|
-
|
|
185
|
+
attrs: result,
|
|
162
186
|
list_property: LIST_PROPERTY,
|
|
163
187
|
klass: NgrokAPI::Models::IPPolicyRule,
|
|
164
188
|
danger: true
|
|
@@ -185,7 +209,7 @@ module NgrokAPI
|
|
|
185
209
|
data[:metadata] = metadata if metadata
|
|
186
210
|
data[:cidr] = cidr if cidr
|
|
187
211
|
result = @client.patch(path % replacements, data: data)
|
|
188
|
-
NgrokAPI::Models::IPPolicyRule.new(client: self,
|
|
212
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
189
213
|
end
|
|
190
214
|
|
|
191
215
|
##
|
|
@@ -209,7 +233,7 @@ module NgrokAPI
|
|
|
209
233
|
data[:metadata] = metadata if metadata
|
|
210
234
|
data[:cidr] = cidr if cidr
|
|
211
235
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
212
|
-
NgrokAPI::Models::IPPolicyRule.new(client: self,
|
|
236
|
+
NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
|
|
213
237
|
end
|
|
214
238
|
end
|
|
215
239
|
end
|
|
@@ -45,7 +45,33 @@ module NgrokAPI
|
|
|
45
45
|
data[:type] = type if type
|
|
46
46
|
data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
|
|
47
47
|
result = @client.post(path % replacements, data: data)
|
|
48
|
-
NgrokAPI::Models::IPRestriction.new(client: self,
|
|
48
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
##
|
|
52
|
+
# Create a new IP restriction
|
|
53
|
+
# Throws an exception if API error.
|
|
54
|
+
#
|
|
55
|
+
# @param [string] description human-readable description of this IP restriction. optional, max 255 bytes.
|
|
56
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
|
|
57
|
+
# @param [boolean] enforced true if the IP restriction will be enforced. if false, only warnings will be issued
|
|
58
|
+
# @param [string] type the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``
|
|
59
|
+
# @param [List<string>] ip_policy_ids the set of IP policy identifiers that are used to enforce the restriction
|
|
60
|
+
# @return [NgrokAPI::Models::IPRestriction] result from the API request
|
|
61
|
+
#
|
|
62
|
+
# https://ngrok.com/docs/api#api-ip-restrictions-create
|
|
63
|
+
def create!(description: "", metadata: "", enforced: False, type:, ip_policy_ids:)
|
|
64
|
+
path = '/ip_restrictions'
|
|
65
|
+
replacements = {
|
|
66
|
+
}
|
|
67
|
+
data = {}
|
|
68
|
+
data[:description] = description if description
|
|
69
|
+
data[:metadata] = metadata if metadata
|
|
70
|
+
data[:enforced] = enforced if enforced
|
|
71
|
+
data[:type] = type if type
|
|
72
|
+
data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
|
|
73
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
74
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
49
75
|
end
|
|
50
76
|
|
|
51
77
|
##
|
|
@@ -93,7 +119,7 @@ module NgrokAPI
|
|
|
93
119
|
}
|
|
94
120
|
data = {}
|
|
95
121
|
result = @client.get(path % replacements, data: data)
|
|
96
|
-
NgrokAPI::Models::IPRestriction.new(client: self,
|
|
122
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
97
123
|
end
|
|
98
124
|
|
|
99
125
|
##
|
|
@@ -111,7 +137,7 @@ module NgrokAPI
|
|
|
111
137
|
}
|
|
112
138
|
data = {}
|
|
113
139
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
114
|
-
NgrokAPI::Models::IPRestriction.new(client: self,
|
|
140
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
115
141
|
end
|
|
116
142
|
|
|
117
143
|
##
|
|
@@ -123,8 +149,7 @@ module NgrokAPI
|
|
|
123
149
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
124
150
|
#
|
|
125
151
|
# https://ngrok.com/docs/api#api-ip-restrictions-list
|
|
126
|
-
def list(before_id: nil, limit: nil,
|
|
127
|
-
url: nil)
|
|
152
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
128
153
|
result = @client.list(
|
|
129
154
|
before_id: before_id,
|
|
130
155
|
limit: limit,
|
|
@@ -134,7 +159,7 @@ module NgrokAPI
|
|
|
134
159
|
|
|
135
160
|
NgrokAPI::Models::Listable.new(
|
|
136
161
|
client: self,
|
|
137
|
-
|
|
162
|
+
attrs: result,
|
|
138
163
|
list_property: LIST_PROPERTY,
|
|
139
164
|
klass: NgrokAPI::Models::IPRestriction
|
|
140
165
|
)
|
|
@@ -150,8 +175,7 @@ module NgrokAPI
|
|
|
150
175
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
151
176
|
#
|
|
152
177
|
# https://ngrok.com/docs/api#api-ip-restrictions-list
|
|
153
|
-
def list!(before_id: nil, limit: nil,
|
|
154
|
-
url: nil)
|
|
178
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
155
179
|
result = @client.list(
|
|
156
180
|
before_id: before_id,
|
|
157
181
|
limit: limit,
|
|
@@ -162,7 +186,7 @@ module NgrokAPI
|
|
|
162
186
|
|
|
163
187
|
NgrokAPI::Models::Listable.new(
|
|
164
188
|
client: self,
|
|
165
|
-
|
|
189
|
+
attrs: result,
|
|
166
190
|
list_property: LIST_PROPERTY,
|
|
167
191
|
klass: NgrokAPI::Models::IPRestriction,
|
|
168
192
|
danger: true
|
|
@@ -191,7 +215,7 @@ module NgrokAPI
|
|
|
191
215
|
data[:enforced] = enforced if enforced
|
|
192
216
|
data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
|
|
193
217
|
result = @client.patch(path % replacements, data: data)
|
|
194
|
-
NgrokAPI::Models::IPRestriction.new(client: self,
|
|
218
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
195
219
|
end
|
|
196
220
|
|
|
197
221
|
##
|
|
@@ -217,7 +241,7 @@ module NgrokAPI
|
|
|
217
241
|
data[:enforced] = enforced if enforced
|
|
218
242
|
data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
|
|
219
243
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
220
|
-
NgrokAPI::Models::IPRestriction.new(client: self,
|
|
244
|
+
NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
|
|
221
245
|
end
|
|
222
246
|
end
|
|
223
247
|
end
|
|
@@ -38,7 +38,29 @@ module NgrokAPI
|
|
|
38
38
|
data[:metadata] = metadata if metadata
|
|
39
39
|
data[:region] = region if region
|
|
40
40
|
result = @client.post(path % replacements, data: data)
|
|
41
|
-
NgrokAPI::Models::ReservedAddr.new(client: self,
|
|
41
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
##
|
|
45
|
+
# Create a new reserved address.
|
|
46
|
+
# Throws an exception if API error.
|
|
47
|
+
#
|
|
48
|
+
# @param [string] description human-readable description of what this reserved address will be used for
|
|
49
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
|
|
50
|
+
# @param [string] region reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
|
51
|
+
# @return [NgrokAPI::Models::ReservedAddr] result from the API request
|
|
52
|
+
#
|
|
53
|
+
# https://ngrok.com/docs/api#api-reserved-addrs-create
|
|
54
|
+
def create!(description: "", metadata: "", region: "", endpoint_configuration_id: nil)
|
|
55
|
+
path = '/reserved_addrs'
|
|
56
|
+
replacements = {
|
|
57
|
+
}
|
|
58
|
+
data = {}
|
|
59
|
+
data[:description] = description if description
|
|
60
|
+
data[:metadata] = metadata if metadata
|
|
61
|
+
data[:region] = region if region
|
|
62
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
63
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
42
64
|
end
|
|
43
65
|
|
|
44
66
|
##
|
|
@@ -86,7 +108,7 @@ module NgrokAPI
|
|
|
86
108
|
}
|
|
87
109
|
data = {}
|
|
88
110
|
result = @client.get(path % replacements, data: data)
|
|
89
|
-
NgrokAPI::Models::ReservedAddr.new(client: self,
|
|
111
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
90
112
|
end
|
|
91
113
|
|
|
92
114
|
##
|
|
@@ -104,7 +126,7 @@ module NgrokAPI
|
|
|
104
126
|
}
|
|
105
127
|
data = {}
|
|
106
128
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
107
|
-
NgrokAPI::Models::ReservedAddr.new(client: self,
|
|
129
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
108
130
|
end
|
|
109
131
|
|
|
110
132
|
##
|
|
@@ -116,8 +138,7 @@ module NgrokAPI
|
|
|
116
138
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
117
139
|
#
|
|
118
140
|
# https://ngrok.com/docs/api#api-reserved-addrs-list
|
|
119
|
-
def list(before_id: nil, limit: nil,
|
|
120
|
-
url: nil)
|
|
141
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
121
142
|
result = @client.list(
|
|
122
143
|
before_id: before_id,
|
|
123
144
|
limit: limit,
|
|
@@ -127,7 +148,7 @@ module NgrokAPI
|
|
|
127
148
|
|
|
128
149
|
NgrokAPI::Models::Listable.new(
|
|
129
150
|
client: self,
|
|
130
|
-
|
|
151
|
+
attrs: result,
|
|
131
152
|
list_property: LIST_PROPERTY,
|
|
132
153
|
klass: NgrokAPI::Models::ReservedAddr
|
|
133
154
|
)
|
|
@@ -143,8 +164,7 @@ module NgrokAPI
|
|
|
143
164
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
144
165
|
#
|
|
145
166
|
# https://ngrok.com/docs/api#api-reserved-addrs-list
|
|
146
|
-
def list!(before_id: nil, limit: nil,
|
|
147
|
-
url: nil)
|
|
167
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
148
168
|
result = @client.list(
|
|
149
169
|
before_id: before_id,
|
|
150
170
|
limit: limit,
|
|
@@ -155,7 +175,7 @@ module NgrokAPI
|
|
|
155
175
|
|
|
156
176
|
NgrokAPI::Models::Listable.new(
|
|
157
177
|
client: self,
|
|
158
|
-
|
|
178
|
+
attrs: result,
|
|
159
179
|
list_property: LIST_PROPERTY,
|
|
160
180
|
klass: NgrokAPI::Models::ReservedAddr,
|
|
161
181
|
danger: true
|
|
@@ -180,7 +200,7 @@ module NgrokAPI
|
|
|
180
200
|
data[:description] = description if description
|
|
181
201
|
data[:metadata] = metadata if metadata
|
|
182
202
|
result = @client.patch(path % replacements, data: data)
|
|
183
|
-
NgrokAPI::Models::ReservedAddr.new(client: self,
|
|
203
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
184
204
|
end
|
|
185
205
|
|
|
186
206
|
##
|
|
@@ -202,7 +222,7 @@ module NgrokAPI
|
|
|
202
222
|
data[:description] = description if description
|
|
203
223
|
data[:metadata] = metadata if metadata
|
|
204
224
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
205
|
-
NgrokAPI::Models::ReservedAddr.new(client: self,
|
|
225
|
+
NgrokAPI::Models::ReservedAddr.new(client: self, attrs: result)
|
|
206
226
|
end
|
|
207
227
|
end
|
|
208
228
|
end
|
|
@@ -45,7 +45,35 @@ module NgrokAPI
|
|
|
45
45
|
data[:certificate_id] = certificate_id if certificate_id
|
|
46
46
|
data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
|
|
47
47
|
result = @client.post(path % replacements, data: data)
|
|
48
|
-
NgrokAPI::Models::ReservedDomain.new(client: self,
|
|
48
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
##
|
|
52
|
+
# Create a new reserved domain.
|
|
53
|
+
# Throws an exception if API error.
|
|
54
|
+
#
|
|
55
|
+
# @param [string] name the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
|
|
56
|
+
# @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
|
57
|
+
# @param [string] description human-readable description of what this reserved domain will be used for
|
|
58
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
|
|
59
|
+
# @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
|
|
60
|
+
# @param [ReservedDomainCertPolicy] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
|
|
61
|
+
# @return [NgrokAPI::Models::ReservedDomain] result from the API request
|
|
62
|
+
#
|
|
63
|
+
# https://ngrok.com/docs/api#api-reserved-domains-create
|
|
64
|
+
def create!(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
|
|
65
|
+
path = '/reserved_domains'
|
|
66
|
+
replacements = {
|
|
67
|
+
}
|
|
68
|
+
data = {}
|
|
69
|
+
data[:name] = name if name
|
|
70
|
+
data[:region] = region if region
|
|
71
|
+
data[:description] = description if description
|
|
72
|
+
data[:metadata] = metadata if metadata
|
|
73
|
+
data[:certificate_id] = certificate_id if certificate_id
|
|
74
|
+
data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
|
|
75
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
76
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
49
77
|
end
|
|
50
78
|
|
|
51
79
|
##
|
|
@@ -93,7 +121,7 @@ module NgrokAPI
|
|
|
93
121
|
}
|
|
94
122
|
data = {}
|
|
95
123
|
result = @client.get(path % replacements, data: data)
|
|
96
|
-
NgrokAPI::Models::ReservedDomain.new(client: self,
|
|
124
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
97
125
|
end
|
|
98
126
|
|
|
99
127
|
##
|
|
@@ -111,7 +139,7 @@ module NgrokAPI
|
|
|
111
139
|
}
|
|
112
140
|
data = {}
|
|
113
141
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
114
|
-
NgrokAPI::Models::ReservedDomain.new(client: self,
|
|
142
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
115
143
|
end
|
|
116
144
|
|
|
117
145
|
##
|
|
@@ -123,8 +151,7 @@ module NgrokAPI
|
|
|
123
151
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
124
152
|
#
|
|
125
153
|
# https://ngrok.com/docs/api#api-reserved-domains-list
|
|
126
|
-
def list(before_id: nil, limit: nil,
|
|
127
|
-
url: nil)
|
|
154
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
128
155
|
result = @client.list(
|
|
129
156
|
before_id: before_id,
|
|
130
157
|
limit: limit,
|
|
@@ -134,7 +161,7 @@ module NgrokAPI
|
|
|
134
161
|
|
|
135
162
|
NgrokAPI::Models::Listable.new(
|
|
136
163
|
client: self,
|
|
137
|
-
|
|
164
|
+
attrs: result,
|
|
138
165
|
list_property: LIST_PROPERTY,
|
|
139
166
|
klass: NgrokAPI::Models::ReservedDomain
|
|
140
167
|
)
|
|
@@ -150,8 +177,7 @@ module NgrokAPI
|
|
|
150
177
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
151
178
|
#
|
|
152
179
|
# https://ngrok.com/docs/api#api-reserved-domains-list
|
|
153
|
-
def list!(before_id: nil, limit: nil,
|
|
154
|
-
url: nil)
|
|
180
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
155
181
|
result = @client.list(
|
|
156
182
|
before_id: before_id,
|
|
157
183
|
limit: limit,
|
|
@@ -162,7 +188,7 @@ module NgrokAPI
|
|
|
162
188
|
|
|
163
189
|
NgrokAPI::Models::Listable.new(
|
|
164
190
|
client: self,
|
|
165
|
-
|
|
191
|
+
attrs: result,
|
|
166
192
|
list_property: LIST_PROPERTY,
|
|
167
193
|
klass: NgrokAPI::Models::ReservedDomain,
|
|
168
194
|
danger: true
|
|
@@ -191,7 +217,7 @@ module NgrokAPI
|
|
|
191
217
|
data[:certificate_id] = certificate_id if certificate_id
|
|
192
218
|
data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
|
|
193
219
|
result = @client.patch(path % replacements, data: data)
|
|
194
|
-
NgrokAPI::Models::ReservedDomain.new(client: self,
|
|
220
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
195
221
|
end
|
|
196
222
|
|
|
197
223
|
##
|
|
@@ -217,7 +243,7 @@ module NgrokAPI
|
|
|
217
243
|
data[:certificate_id] = certificate_id if certificate_id
|
|
218
244
|
data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy
|
|
219
245
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
220
|
-
NgrokAPI::Models::ReservedDomain.new(client: self,
|
|
246
|
+
NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result)
|
|
221
247
|
end
|
|
222
248
|
|
|
223
249
|
##
|
|
@@ -41,7 +41,33 @@ module NgrokAPI
|
|
|
41
41
|
data[:elliptic_curve] = elliptic_curve if elliptic_curve
|
|
42
42
|
data[:key_size] = key_size if key_size
|
|
43
43
|
result = @client.post(path % replacements, data: data)
|
|
44
|
-
NgrokAPI::Models::SSHCertificateAuthority.new(client: self,
|
|
44
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
##
|
|
48
|
+
# Create a new SSH Certificate Authority
|
|
49
|
+
# Throws an exception if API error.
|
|
50
|
+
#
|
|
51
|
+
# @param [string] description human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
|
|
52
|
+
# @param [string] metadata arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
|
|
53
|
+
# @param [string] private_key_type the type of private key to generate. one of ``rsa``, ``ecdsa``, ``ed25519``
|
|
54
|
+
# @param [string] elliptic_curve the type of elliptic curve to use when creating an ECDSA key
|
|
55
|
+
# @param [int64] key_size the key size to use when creating an RSA key. one of ``2048`` or ``4096``
|
|
56
|
+
# @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
|
|
57
|
+
#
|
|
58
|
+
# https://ngrok.com/docs/api#api-ssh-certificate-authorities-create
|
|
59
|
+
def create!(description: "", metadata: "", private_key_type: "", elliptic_curve: "", key_size: 0)
|
|
60
|
+
path = '/ssh_certificate_authorities'
|
|
61
|
+
replacements = {
|
|
62
|
+
}
|
|
63
|
+
data = {}
|
|
64
|
+
data[:description] = description if description
|
|
65
|
+
data[:metadata] = metadata if metadata
|
|
66
|
+
data[:private_key_type] = private_key_type if private_key_type
|
|
67
|
+
data[:elliptic_curve] = elliptic_curve if elliptic_curve
|
|
68
|
+
data[:key_size] = key_size if key_size
|
|
69
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
|
70
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
45
71
|
end
|
|
46
72
|
|
|
47
73
|
##
|
|
@@ -89,7 +115,7 @@ module NgrokAPI
|
|
|
89
115
|
}
|
|
90
116
|
data = {}
|
|
91
117
|
result = @client.get(path % replacements, data: data)
|
|
92
|
-
NgrokAPI::Models::SSHCertificateAuthority.new(client: self,
|
|
118
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
93
119
|
end
|
|
94
120
|
|
|
95
121
|
##
|
|
@@ -107,7 +133,7 @@ module NgrokAPI
|
|
|
107
133
|
}
|
|
108
134
|
data = {}
|
|
109
135
|
result = @client.get(path % replacements, data: data, danger: true)
|
|
110
|
-
NgrokAPI::Models::SSHCertificateAuthority.new(client: self,
|
|
136
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
111
137
|
end
|
|
112
138
|
|
|
113
139
|
##
|
|
@@ -119,8 +145,7 @@ module NgrokAPI
|
|
|
119
145
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
120
146
|
#
|
|
121
147
|
# https://ngrok.com/docs/api#api-ssh-certificate-authorities-list
|
|
122
|
-
def list(before_id: nil, limit: nil,
|
|
123
|
-
url: nil)
|
|
148
|
+
def list(before_id: nil, limit: nil, url: nil)
|
|
124
149
|
result = @client.list(
|
|
125
150
|
before_id: before_id,
|
|
126
151
|
limit: limit,
|
|
@@ -130,7 +155,7 @@ module NgrokAPI
|
|
|
130
155
|
|
|
131
156
|
NgrokAPI::Models::Listable.new(
|
|
132
157
|
client: self,
|
|
133
|
-
|
|
158
|
+
attrs: result,
|
|
134
159
|
list_property: LIST_PROPERTY,
|
|
135
160
|
klass: NgrokAPI::Models::SSHCertificateAuthority
|
|
136
161
|
)
|
|
@@ -146,8 +171,7 @@ module NgrokAPI
|
|
|
146
171
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
147
172
|
#
|
|
148
173
|
# https://ngrok.com/docs/api#api-ssh-certificate-authorities-list
|
|
149
|
-
def list!(before_id: nil, limit: nil,
|
|
150
|
-
url: nil)
|
|
174
|
+
def list!(before_id: nil, limit: nil, url: nil)
|
|
151
175
|
result = @client.list(
|
|
152
176
|
before_id: before_id,
|
|
153
177
|
limit: limit,
|
|
@@ -158,7 +182,7 @@ module NgrokAPI
|
|
|
158
182
|
|
|
159
183
|
NgrokAPI::Models::Listable.new(
|
|
160
184
|
client: self,
|
|
161
|
-
|
|
185
|
+
attrs: result,
|
|
162
186
|
list_property: LIST_PROPERTY,
|
|
163
187
|
klass: NgrokAPI::Models::SSHCertificateAuthority,
|
|
164
188
|
danger: true
|
|
@@ -183,7 +207,7 @@ module NgrokAPI
|
|
|
183
207
|
data[:description] = description if description
|
|
184
208
|
data[:metadata] = metadata if metadata
|
|
185
209
|
result = @client.patch(path % replacements, data: data)
|
|
186
|
-
NgrokAPI::Models::SSHCertificateAuthority.new(client: self,
|
|
210
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
187
211
|
end
|
|
188
212
|
|
|
189
213
|
##
|
|
@@ -205,7 +229,7 @@ module NgrokAPI
|
|
|
205
229
|
data[:description] = description if description
|
|
206
230
|
data[:metadata] = metadata if metadata
|
|
207
231
|
result = @client.patch(path % replacements, data: data, danger: true)
|
|
208
|
-
NgrokAPI::Models::SSHCertificateAuthority.new(client: self,
|
|
232
|
+
NgrokAPI::Models::SSHCertificateAuthority.new(client: self, attrs: result)
|
|
209
233
|
end
|
|
210
234
|
end
|
|
211
235
|
end
|