diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..0c2754b --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +--markup markdown --readme doc/README diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c130837 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2021 ngrok, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/doc/.gitkeep b/doc/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/doc/NgrokAPI.html b/doc/NgrokAPI.html index d1b1a63..2545e7d 100644 --- a/doc/NgrokAPI.html +++ b/doc/NgrokAPI.html @@ -79,7 +79,7 @@
Defined in:
lib/ngrokapi.rb,
- lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_stream.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/endpoint_logging.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/ip_whitelist_entry.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/services/ip_whitelist_client.rb,
lib/ngrokapi/models/endpoint_configuration.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/services/event_streams_client.rb,
lib/ngrokapi/models/endpoint_logging_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/endpoint_oidc_module_client.rb,
lib/ngrokapi/services/endpoint_saml_module_client.rb,
lib/ngrokapi/models/reserved_domain_cert_ns_target.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/endpoint_o_auth_module_client.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/endpoint_configurations_client.rb,
lib/ngrokapi/services/endpoint_logging_module_client.rb,
lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,
lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,
lib/ngrokapi/services/endpoint_compression_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,
lib/ngrokapi/services/endpoint_request_headers_module_client.rb,
lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,
lib/ngrokapi/services/endpoint_response_headers_module_client.rb,
lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb
+ lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_stream.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/endpoint_logging.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/ip_whitelist_entry.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/services/ip_whitelist_client.rb,
lib/ngrokapi/models/endpoint_configuration.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/services/event_streams_client.rb,
lib/ngrokapi/models/endpoint_logging_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/endpoint_oidc_module_client.rb,
lib/ngrokapi/services/endpoint_saml_module_client.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/endpoint_o_auth_module_client.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/endpoint_configurations_client.rb,
lib/ngrokapi/services/endpoint_logging_module_client.rb,
lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,
lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,
lib/ngrokapi/services/endpoint_compression_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,
lib/ngrokapi/services/endpoint_request_headers_module_client.rb,
lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,
lib/ngrokapi/services/endpoint_response_headers_module_client.rb,
lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb
@@ -147,7 +147,7 @@ diff --git a/doc/NgrokAPI/Client.html b/doc/NgrokAPI/Client.html index e29dcac..695eb73 100644 --- a/doc/NgrokAPI/Client.html +++ b/doc/NgrokAPI/Client.html @@ -143,7 +143,7 @@
-

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

+

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

@@ -167,7 +167,7 @@
-

API Keys are used to authenticate to the (ngrok.com/docs/api#authentication)ngrok API.

+

API Keys are used to authenticate to the ngrok API.

@@ -191,7 +191,7 @@
-

Certificate Authorities are x509 certificates that are used to sign other x509 certificates.

+

Certificate Authorities are x509 certificates that are used to sign other x509 certificates.

@@ -239,7 +239,7 @@
-

Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.

+

Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.

@@ -377,7 +377,7 @@
-

IP Policies are reusable groups of CIDR ranges with an allow or deny action.

+

IP Policies are reusable groups of CIDR ranges with an allow or deny action.

@@ -401,7 +401,7 @@
-

IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.

+

IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.

@@ -425,7 +425,7 @@
-

An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.

+

An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.

@@ -452,6 +452,28 @@

The IP Whitelist is deprecated and will be removed.

+ + + +
  • + + + #pointcfg_module ⇒ Object + + + + + + + + + + + + + +
    +
  • @@ -521,7 +543,7 @@
    -

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    +

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    @@ -545,7 +567,7 @@
    -

    SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

    +

    SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

    @@ -569,7 +591,7 @@
    -

    SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.

    +

    SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.

    @@ -593,7 +615,7 @@
    -

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.

    +

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.

    @@ -617,7 +639,7 @@
    -

    TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.

    +

    TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.

    @@ -641,7 +663,7 @@
    -

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.

    +

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.

    @@ -665,7 +687,7 @@
    -

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

    +

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

    @@ -703,15 +725,15 @@
     
     
    -8
    -9
     10
     11
     12
    -13
    +13 +14 +15 -
    # File 'lib/ngrokapi/client.rb', line 8
    +      
    # File 'lib/ngrokapi/client.rb', line 10
     
     def initialize(
       api_key:,
    @@ -743,10 +765,7 @@
     
    -

    Abuse Reports allow you to submit take-down requests for URLs hosted by

    - -
    ngrok that violate ngrok's terms of service.
    -
    +

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

    @@ -773,12 +792,12 @@
     
     
    -20
    -21
    -22
    +22 +23 +24
    -
    # File 'lib/ngrokapi/client.rb', line 20
    +      
    # File 'lib/ngrokapi/client.rb', line 22
     
     def abuse_reports
       @_abuse_reports ||= NgrokAPI::Services::AbuseReportsClient.new(client: @client)
    @@ -800,13 +819,7 @@
     
    -

    API Keys are used to authenticate to the (ngrok.com/docs/api#authentication)ngrok

    - -
    API. You may use the API itself
    -to provision and manage API Keys but you'll need to provision your first API
    -key from the  (https://dashboard.ngrok.com/api/keys)API Keys page on your
    -ngrok.com dashboard.
    -
    +

    API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

    @@ -833,12 +846,12 @@ ngrok.com dashboard.
     
     
    -33
     34
    -35
    +35 +36
    -
    # File 'lib/ngrokapi/client.rb', line 33
    +      
    # File 'lib/ngrokapi/client.rb', line 34
     
     def api_keys
       @_api_keys ||= NgrokAPI::Services::APIKeysClient.new(client: @client)
    @@ -860,13 +873,7 @@ ngrok.com dashboard.
     
    -

    Certificate Authorities are x509 certificates that are used to sign other

    - -
    x509 certificates. Attach a Certificate Authority to the Mutual TLS module
    -to verify that the TLS certificate presented by a client has been signed by
    -this CA. Certificate Authorities  are used only for mTLS validation only and
    -thus a private key is not included in the resource.
    -
    +

    Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.

    @@ -893,12 +900,12 @@ thus a private key is not included in the resource.
     
     
    -45
     46
    -47
    +47 +48
    -
    # File 'lib/ngrokapi/client.rb', line 45
    +      
    # File 'lib/ngrokapi/client.rb', line 46
     
     def certificate_authorities
       @_certificate_authorities ||= NgrokAPI::Services::CertificateAuthoritiesClient.new(client: @client)
    @@ -920,12 +927,7 @@ thus a private key is not included in the resource.
     
    -

    Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok

    - -
    agent to connect the ngrok service as your account. They are installed with
    -the ngrok authtoken command or by specifying it in the ngrok.yml
    -configuration file with the authtoken property.
    -
    +

    Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ngrok authtoken command or by specifying it in the ngrok.yml configuration file with the authtoken property.

    @@ -952,12 +954,12 @@ configuration file with the authtoken property.
     
     
    -56
     57
    -58
    +58 +59
    -
    # File 'lib/ngrokapi/client.rb', line 56
    +      
    # File 'lib/ngrokapi/client.rb', line 57
     
     def credentials
       @_credentials ||= NgrokAPI::Services::CredentialsClient.new(client: @client)
    @@ -979,11 +981,7 @@ configuration file with the authtoken property.
     
    -

    Endpoint Configurations are a reusable group of modules that encapsulate how

    - -
    traffic to a domain or address is handled. Endpoint configurations are only
    -applied to Domains and TCP Addresses they have been attached to.
    -
    +

    Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.

    @@ -1010,12 +1008,12 @@ applied to Domains and TCP Addresses they have been attached to.
     
     
    -66
     67
    -68
    +68 +69
    -
    # File 'lib/ngrokapi/client.rb', line 66
    +      
    # File 'lib/ngrokapi/client.rb', line 67
     
     def endpoint_configurations
       @_endpoint_configurations ||= NgrokAPI::Services::EndpointConfigurationsClient.new(client: @client)
    @@ -1040,12 +1038,12 @@ applied to Domains and TCP Addresses they have been attached to.
           
     
     
    -74
     75
    -76
    +76 +77
    -
    # File 'lib/ngrokapi/client.rb', line 74
    +      
    # File 'lib/ngrokapi/client.rb', line 75
     
     def event_destinations
       @_event_destinations ||= NgrokAPI::Services::EventDestinationsClient.new(client: @client)
    @@ -1070,12 +1068,12 @@ applied to Domains and TCP Addresses they have been attached to.
           
     
     
    -82
     83
    -84
    +84 +85
    -
    # File 'lib/ngrokapi/client.rb', line 82
    +      
    # File 'lib/ngrokapi/client.rb', line 83
     
     def event_sources
       @_event_sources ||= NgrokAPI::Services::EventSourcesClient.new(client: @client)
    @@ -1100,12 +1098,12 @@ applied to Domains and TCP Addresses they have been attached to.
           
     
     
    -70
     71
    -72
    +72 +73
    -
    # File 'lib/ngrokapi/client.rb', line 70
    +      
    # File 'lib/ngrokapi/client.rb', line 71
     
     def event_streams
       @_event_streams ||= NgrokAPI::Services::EventStreamsClient.new(client: @client)
    @@ -1130,12 +1128,12 @@ applied to Domains and TCP Addresses they have been attached to.
           
     
     
    -78
     79
    -80
    +80 +81
    -
    # File 'lib/ngrokapi/client.rb', line 78
    +      
    # File 'lib/ngrokapi/client.rb', line 79
     
     def event_subscriptions
       @_event_subscriptions ||= NgrokAPI::Services::EventSubscriptionsClient.new(client: @client)
    @@ -1157,12 +1155,7 @@ applied to Domains and TCP Addresses they have been attached to.
     
    -

    IP Policies are reusable groups of CIDR ranges with an allow or deny

    - -
    action. They can be attached to endpoints via the Endpoint Configuration IP
    -Policy module. They can also be used with IP Restrictions to control source
    -IP ranges that can start tunnel sessions and connect to the API and dashboard.
    -
    +

    IP Policies are reusable groups of CIDR ranges with an allow or deny action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.

    @@ -1189,12 +1182,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
     
     
    -93
     94
    -95
    +95 +96
    -
    # File 'lib/ngrokapi/client.rb', line 93
    +      
    # File 'lib/ngrokapi/client.rb', line 94
     
     def ip_policies
       @_ip_policies ||= NgrokAPI::Services::IPPoliciesClient.new(client: @client)
    @@ -1216,10 +1209,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
     
    -

    IP Policy Rules are the IPv4 or IPv6 CIDRs entries that

    - -
    make up an IP Policy.
    -
    +

    IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.

    @@ -1246,12 +1236,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
     
     
    -102
     103
    -104
    +104 +105
    -
    # File 'lib/ngrokapi/client.rb', line 102
    +      
    # File 'lib/ngrokapi/client.rb', line 103
     
     def ip_policy_rules
       @_ip_policy_rules ||= NgrokAPI::Services::IPPolicyRulesClient.new(client: @client)
    @@ -1273,14 +1263,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
     
    -

    An IP restriction is a restriction placed on the CIDRs that are allowed to

    - -
    initate traffic to a specific aspect of your ngrok account. An IP
    -restriction has a type which defines the ingress it applies to. IP
    -restrictions can be used to enforce the source IPs that can make API
    -requests, log in to the dashboard, start ngrok agents, and connect to your
    -public-facing endpoints.
    -
    +

    An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.

    @@ -1307,12 +1290,12 @@ public-facing endpoints.
     
     
    -115
     116
    -117
    +117 +118
    -
    # File 'lib/ngrokapi/client.rb', line 115
    +      
    # File 'lib/ngrokapi/client.rb', line 116
     
     def ip_restrictions
       @_ip_restrictions ||= NgrokAPI::Services::IPRestrictionsClient.new(client: @client)
    @@ -1334,10 +1317,7 @@ public-facing endpoints.
     
    -

    The IP Whitelist is deprecated and will be removed. Use an IP Restriction

    - -
    with an endpoints type instead.
    -
    +

    The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an endpoints type instead.

    @@ -1364,12 +1344,12 @@ public-facing endpoints.
     
     
    -124
     125
    -126
    +126 +127
    -
    # File 'lib/ngrokapi/client.rb', line 124
    +      
    # File 'lib/ngrokapi/client.rb', line 125
     
     def ip_whitelist
       @_ip_whitelist ||= NgrokAPI::Services::IPWhitelistClient.new(client: @client)
    @@ -1377,6 +1357,64 @@ public-facing endpoints.
         
       
     
    +
    +    
    +      
    +

    + + #pointcfg_moduleObject + + + + + +

    + + + + +
    +
    +
    +
    +219
    +220
    +221
    +222
    +223
    +224
    +225
    +226
    +227
    +228
    +229
    +230
    +231
    +232
    +233
    +234
    +235
    +
    +
    # File 'lib/ngrokapi/client.rb', line 219
    +
    +def pointcfg_module
    +  ns = OpenStruct.new
    +  ns.logging = NgrokAPI::Services::EndpointLoggingModuleClient.new(client: @client)
    +  ns.circuit_breaker = NgrokAPI::Services::EndpointCircuitBreakerModuleClient.new(client: @client)
    +  ns.compression = NgrokAPI::Services::EndpointCompressionModuleClient.new(client: @client)
    +  ns.tls_termination = NgrokAPI::Services::EndpointTLSTerminationModuleClient.new(client: @client)
    +  ns.ip_policy = NgrokAPI::Services::EndpointIPPolicyModuleClient.new(client: @client)
    +  ns.mutual_tls = NgrokAPI::Services::EndpointMutualTLSModuleClient.new(client: @client)
    +  ns.request_headers = NgrokAPI::Services::EndpointRequestHeadersModuleClient.new(client: @client)
    +  ns.response_headers = NgrokAPI::Services::EndpointResponseHeadersModuleClient.new(client: @client)
    +  ns.oauth = NgrokAPI::Services::EndpointOAuthModuleClient.new(client: @client)
    +  ns.webhook_validation = NgrokAPI::Services::EndpointWebhookValidationModuleClient.new(client: @client)
    +  ns.saml = NgrokAPI::Services::EndpointSAMLModuleClient.new(client: @client)
    +  ns.oidc = NgrokAPI::Services::EndpointOIDCModuleClient.new(client: @client)
    +
    +  ns
    +end
    +
    @@ -1391,11 +1429,7 @@ public-facing endpoints.
    -

    Reserved Addresses are TCP addresses that can be used to listen for traffic.

    - -
    TCP address hostnames and ports are assigned by ngrok, they cannot be
    -chosen.
    -
    +

    Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.

    @@ -1422,12 +1456,12 @@ chosen.
     
     
    -134
     135
    -136
    +136 +137
    -
    # File 'lib/ngrokapi/client.rb', line 134
    +      
    # File 'lib/ngrokapi/client.rb', line 135
     
     def reserved_addrs
       @_reserved_addrs ||= NgrokAPI::Services::ReservedAddrsClient.new(client: @client)
    @@ -1449,12 +1483,7 @@ chosen.
     
    -

    Reserved Domains are hostnames that you can listen for traffic on. Domains

    - -
    can be used to listen for http, https or tls traffic. You may use a domain
    -that you own by creating a CNAME record specified in the returned resource.
    -This CNAME record points traffic for that domain to ngrok's edge servers.
    -
    +

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

    @@ -1481,12 +1510,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
     
    -145
     146
    -147
    +147 +148
    -
    # File 'lib/ngrokapi/client.rb', line 145
    +      
    # File 'lib/ngrokapi/client.rb', line 146
     
     def reserved_domains
       @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
    @@ -1508,10 +1537,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
    -

    An SSH Certificate Authority is a pair of an SSH Certificate and its private

    - -
    key that can be used to sign other SSH host and user certificates.
    -
    +

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    @@ -1538,12 +1564,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
     
    -154
     155
    -156
    +156 +157
    -
    # File 'lib/ngrokapi/client.rb', line 154
    +      
    # File 'lib/ngrokapi/client.rb', line 155
     
     def ssh_certificate_authorities
       @_ssh_certificate_authorities ||= NgrokAPI::Services::SSHCertificateAuthoritiesClient.new(client: @client)
    @@ -1565,10 +1591,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
    -

    SSH Credentials are SSH public keys that can be used to start SSH tunnels

    - -
    via the ngrok SSH tunnel gateway.
    -
    +

    SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

    @@ -1595,12 +1618,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
     
    -163
     164
    -165
    +165 +166
    -
    # File 'lib/ngrokapi/client.rb', line 163
    +      
    # File 'lib/ngrokapi/client.rb', line 164
     
     def ssh_credentials
       @_ssh_credentials ||= NgrokAPI::Services::SSHCredentialsClient.new(client: @client)
    @@ -1622,11 +1645,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers.
     
    -

    SSH Host Certificates along with the corresponding private key allows an SSH

    - -
    server to assert its authenticity to connecting SSH clients who trust the
    -SSH Certificate Authority that was used to sign the certificate.
    -
    +

    SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.

    @@ -1653,12 +1672,12 @@ SSH Certificate Authority that was used to sign the certificate.
     
     
    -173
     174
    -175
    +175 +176
    -
    # File 'lib/ngrokapi/client.rb', line 173
    +      
    # File 'lib/ngrokapi/client.rb', line 174
     
     def ssh_host_certificates
       @_ssh_host_certificates ||= NgrokAPI::Services::SSHHostCertificatesClient.new(client: @client)
    @@ -1680,11 +1699,7 @@ SSH Certificate Authority that was used to sign the certificate.
     
    -

    SSH User Certificates are presented by SSH clients when connecting to an SSH

    - -
    server to authenticate their connection. The SSH server must trust the SSH
    -Certificate Authority used to sign the certificate.
    -
    +

    SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.

    @@ -1711,12 +1726,12 @@ Certificate Authority used to sign the certificate.
     
     
    -183
     184
    -185
    +185 +186
    -
    # File 'lib/ngrokapi/client.rb', line 183
    +      
    # File 'lib/ngrokapi/client.rb', line 184
     
     def ssh_user_certificates
       @_ssh_user_certificates ||= NgrokAPI::Services::SSHUserCertificatesClient.new(client: @client)
    @@ -1738,13 +1753,7 @@ Certificate Authority used to sign the certificate.
     
    -

    TLS Certificates are pairs of x509 certificates and their matching private

    - -
    key that can be used to terminate TLS traffic. TLS certificates are unused
    -until they are attached to a Domain. TLS Certificates may also be
    -provisioned by ngrok automatically for domains on which you have enabled
    -automated certificate provisioning.
    -
    +

    TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.

    @@ -1771,12 +1780,12 @@ automated certificate provisioning.
     
     
    -195
     196
    -197
    +197 +198
    -
    # File 'lib/ngrokapi/client.rb', line 195
    +      
    # File 'lib/ngrokapi/client.rb', line 196
     
     def tls_certificates
       @_tls_certificates ||= NgrokAPI::Services::TLSCertificatesClient.new(client: @client)
    @@ -1798,11 +1807,7 @@ automated certificate provisioning.
     
    -

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel

    - -
    sessions that are running and connected to the ngrok service. Each tunnel
    -session can include one or more Tunnels.
    -
    +

    Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.

    @@ -1829,12 +1834,12 @@ session can include one or more Tunnels.
     
     
    -205
     206
    -207
    +207 +208
    -
    # File 'lib/ngrokapi/client.rb', line 205
    +      
    # File 'lib/ngrokapi/client.rb', line 206
     
     def tunnel_sessions
       @_tunnel_sessions ||= NgrokAPI::Services::TunnelSessionsClient.new(client: @client)
    @@ -1856,10 +1861,7 @@ session can include one or more Tunnels.
     
    -

    Tunnels provide endpoints to access services exposed by a running ngrok

    - -
    agent tunnel session or an SSH reverse tunnel session.
    -
    +

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

    @@ -1886,12 +1888,12 @@ session can include one or more Tunnels.
     
     
    -214
     215
    -216
    +216 +217
    -
    # File 'lib/ngrokapi/client.rb', line 214
    +      
    # File 'lib/ngrokapi/client.rb', line 215
     
     def tunnels
       @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
    @@ -1906,7 +1908,7 @@ session can include one or more Tunnels.
     
     
           
    diff --git a/doc/NgrokAPI/Error.html b/doc/NgrokAPI/Error.html
    index 4a054f2..cb2daed 100644
    --- a/doc/NgrokAPI/Error.html
    +++ b/doc/NgrokAPI/Error.html
    @@ -295,7 +295,7 @@
     
     
           
    diff --git a/doc/NgrokAPI/Errors.html b/doc/NgrokAPI/Errors.html
    index da40ae2..bbce45d 100644
    --- a/doc/NgrokAPI/Errors.html
    +++ b/doc/NgrokAPI/Errors.html
    @@ -105,7 +105,7 @@
     
     
           
    diff --git a/doc/NgrokAPI/Errors/NotFoundError.html b/doc/NgrokAPI/Errors/NotFoundError.html
    index 9ae67da..b6cd8da 100644
    --- a/doc/NgrokAPI/Errors/NotFoundError.html
    +++ b/doc/NgrokAPI/Errors/NotFoundError.html
    @@ -299,7 +299,7 @@
     
     
           
    diff --git a/doc/NgrokAPI/HttpClient.html b/doc/NgrokAPI/HttpClient.html
    index ebdf903..4cd7f19 100644
    --- a/doc/NgrokAPI/HttpClient.html
    +++ b/doc/NgrokAPI/HttpClient.html
    @@ -265,7 +265,7 @@
             
  • - #list(before_id: nil, limit: nil, path: nil, url: nil) ⇒ json + #list(danger: false, before_id: nil, limit: nil, path: nil, url: nil) ⇒ json @@ -280,7 +280,7 @@
    -

    Make a GET request.

    +

    Make a GET request to list resources.

  • @@ -705,7 +705,7 @@

    - #list(before_id: nil, limit: nil, path: nil, url: nil) ⇒ json + #list(danger: false, before_id: nil, limit: nil, path: nil, url: nil) ⇒ json @@ -714,7 +714,7 @@

    -

    Make a GET request

    +

    Make a GET request to list resources

    @@ -723,6 +723,24 @@

    Parameters:

      +
    • + + danger + + + (boolean) + + + (defaults to: false) + + + — +
      +

      determine if we should throw an exception on 404 or not

      +
      + +
    • +
    • before_id @@ -788,6 +806,24 @@ (defaults to: nil) + — +
      +

      Full URL of the resource, mutually exclusive with path

      +
      + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + —

      Full URL of the resource, mutually exclusive with path

      @@ -822,8 +858,6 @@
       
       
      -52
      -53
       54
       55
       56
      @@ -831,19 +865,21 @@
       58
       59
       60
      -61
      +61 +62 +63
    -
    # File 'lib/ngrokapi/http_client.rb', line 52
    +      
    # File 'lib/ngrokapi/http_client.rb', line 54
     
    -def list(before_id: nil, limit: nil, path: nil, url: nil)
    +def list(danger: false, before_id: nil, limit: nil, path: nil, url: nil)
       if url
         get(url)
       else
         data = {}
         data[:before_id] = before_id if before_id
         data[:limit] = limit if limit
    -    get(path, data: data)
    +    get(path, danger: danger, data: data)
       end
     end
    @@ -951,14 +987,14 @@
     
     
    -70
    -71
     72
     73
    -74
    +74 +75 +76
    -
    # File 'lib/ngrokapi/http_client.rb', line 70
    +      
    # File 'lib/ngrokapi/http_client.rb', line 72
     
     def patch(path, danger: false, data: {})
       uri = get_uri(path)
    @@ -1070,14 +1106,14 @@
           
     
     
    -83
    -84
     85
     86
    -87
    +87 +88 +89
    -
    # File 'lib/ngrokapi/http_client.rb', line 83
    +      
    # File 'lib/ngrokapi/http_client.rb', line 85
     
     def post(path, danger: false, data: {})
       uri = get_uri(path)
    @@ -1094,7 +1130,7 @@
     
     
           
    diff --git a/doc/NgrokAPI/Models.html b/doc/NgrokAPI/Models.html
    index 0547e73..7e3752c 100644
    --- a/doc/NgrokAPI/Models.html
    +++ b/doc/NgrokAPI/Models.html
    @@ -79,7 +79,7 @@
       
    Defined in:
    lib/ngrokapi/models/ref.rb,
    - lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_stream.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/endpoint_logging.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/ip_whitelist_entry.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/endpoint_configuration.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_logging_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/reserved_domain_cert_ns_target.rb
    + lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_stream.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/endpoint_logging.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/ip_whitelist_entry.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/endpoint_configuration.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_logging_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb
    @@ -91,7 +91,7 @@ - Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, CertificateAuthority, Credential, EndpointCircuitBreaker, EndpointCompression, EndpointConfiguration, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointLogging, EndpointLoggingMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGoogle, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointWebhookValidation, EventDestination, EventSource, EventSourceReplace, EventStream, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetFirehose, EventTargetKinesis, IPPolicy, IPPolicyRule, IPRestriction, IPWhitelistEntry, Listable, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertNSTarget, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, TLSCertificate, TLSCertificateSANs, Tunnel, TunnelSession + Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, CertificateAuthority, Credential, EndpointCircuitBreaker, EndpointCompression, EndpointConfiguration, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointLogging, EndpointLoggingMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGoogle, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointWebhookValidation, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventStream, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetFirehose, EventTargetKinesis, IPPolicy, IPPolicyRule, IPRestriction, IPWhitelistEntry, Listable, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, TLSCertificate, TLSCertificateSANs, Tunnel, TunnelSession

    @@ -107,7 +107,7 @@ diff --git a/doc/NgrokAPI/Models/APIKey.html b/doc/NgrokAPI/Models/APIKey.html index 5a556ef..393429f 100644 --- a/doc/NgrokAPI/Models/APIKey.html +++ b/doc/NgrokAPI/Models/APIKey.html @@ -1059,7 +1059,7 @@ diff --git a/doc/NgrokAPI/Models/AWSAuth.html b/doc/NgrokAPI/Models/AWSAuth.html index 1c60506..6fc4f6b 100644 --- a/doc/NgrokAPI/Models/AWSAuth.html +++ b/doc/NgrokAPI/Models/AWSAuth.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/AWSCredentials.html b/doc/NgrokAPI/Models/AWSCredentials.html index 9ba8ccb..9ba3660 100644 --- a/doc/NgrokAPI/Models/AWSCredentials.html +++ b/doc/NgrokAPI/Models/AWSCredentials.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/AWSRole.html b/doc/NgrokAPI/Models/AWSRole.html index 2735a2c..932daf6 100644 --- a/doc/NgrokAPI/Models/AWSRole.html +++ b/doc/NgrokAPI/Models/AWSRole.html @@ -533,7 +533,7 @@ diff --git a/doc/NgrokAPI/Models/AbuseReport.html b/doc/NgrokAPI/Models/AbuseReport.html index 74f263e..b0d747c 100644 --- a/doc/NgrokAPI/Models/AbuseReport.html +++ b/doc/NgrokAPI/Models/AbuseReport.html @@ -977,7 +977,7 @@ diff --git a/doc/NgrokAPI/Models/AbuseReportHostname.html b/doc/NgrokAPI/Models/AbuseReportHostname.html index 0dcd4e4..676f67f 100644 --- a/doc/NgrokAPI/Models/AbuseReportHostname.html +++ b/doc/NgrokAPI/Models/AbuseReportHostname.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/CertificateAuthority.html b/doc/NgrokAPI/Models/CertificateAuthority.html index ae2f393..8676b71 100644 --- a/doc/NgrokAPI/Models/CertificateAuthority.html +++ b/doc/NgrokAPI/Models/CertificateAuthority.html @@ -1429,7 +1429,7 @@ diff --git a/doc/NgrokAPI/Models/Credential.html b/doc/NgrokAPI/Models/Credential.html index 86f98cc..c2b5ac0 100644 --- a/doc/NgrokAPI/Models/Credential.html +++ b/doc/NgrokAPI/Models/Credential.html @@ -1139,7 +1139,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html index a80fff5..8f68967 100644 --- a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -903,7 +903,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointCompression.html b/doc/NgrokAPI/Models/EndpointCompression.html index c61ab35..88a522d 100644 --- a/doc/NgrokAPI/Models/EndpointCompression.html +++ b/doc/NgrokAPI/Models/EndpointCompression.html @@ -533,7 +533,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointConfiguration.html b/doc/NgrokAPI/Models/EndpointConfiguration.html index e05065c..efc4dfd 100644 --- a/doc/NgrokAPI/Models/EndpointConfiguration.html +++ b/doc/NgrokAPI/Models/EndpointConfiguration.html @@ -2167,7 +2167,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointIPPolicy.html b/doc/NgrokAPI/Models/EndpointIPPolicy.html index 421827d..995574a 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicy.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicy.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html index 1bb2600..b39a331 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointLogging.html b/doc/NgrokAPI/Models/EndpointLogging.html index df8f1d4..cf08dfb 100644 --- a/doc/NgrokAPI/Models/EndpointLogging.html +++ b/doc/NgrokAPI/Models/EndpointLogging.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointLoggingMutate.html b/doc/NgrokAPI/Models/EndpointLoggingMutate.html index 6b79c6c..8e9d708 100644 --- a/doc/NgrokAPI/Models/EndpointLoggingMutate.html +++ b/doc/NgrokAPI/Models/EndpointLoggingMutate.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointMutualTLS.html b/doc/NgrokAPI/Models/EndpointMutualTLS.html index c2d1c4f..5b511e3 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLS.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLS.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html index ab6be7f..f2ca9de 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -607,7 +607,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuth.html b/doc/NgrokAPI/Models/EndpointOAuth.html index c683c15..82e541b 100644 --- a/doc/NgrokAPI/Models/EndpointOAuth.html +++ b/doc/NgrokAPI/Models/EndpointOAuth.html @@ -977,7 +977,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html index e6df671..f0107fa 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -829,7 +829,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html index bb02618..6a605fe 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -977,7 +977,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html index 6d4ad26..b90a400 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -829,7 +829,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 3c43cc9..891d87e 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -829,7 +829,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthProvider.html b/doc/NgrokAPI/Models/EndpointOAuthProvider.html index 04a9ce9..864a353 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/doc/NgrokAPI/Models/EndpointOAuthProvider.html @@ -755,7 +755,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointOIDC.html b/doc/NgrokAPI/Models/EndpointOIDC.html index cdf58d1..e5ea218 100644 --- a/doc/NgrokAPI/Models/EndpointOIDC.html +++ b/doc/NgrokAPI/Models/EndpointOIDC.html @@ -1125,7 +1125,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointRequestHeaders.html b/doc/NgrokAPI/Models/EndpointRequestHeaders.html index e32dbec..eb158a9 100644 --- a/doc/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/doc/NgrokAPI/Models/EndpointRequestHeaders.html @@ -681,7 +681,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointResponseHeaders.html b/doc/NgrokAPI/Models/EndpointResponseHeaders.html index 7cb6b75..a408c03 100644 --- a/doc/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/doc/NgrokAPI/Models/EndpointResponseHeaders.html @@ -681,7 +681,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointSAML.html b/doc/NgrokAPI/Models/EndpointSAML.html index 60e3dad..761a8b4 100644 --- a/doc/NgrokAPI/Models/EndpointSAML.html +++ b/doc/NgrokAPI/Models/EndpointSAML.html @@ -1643,7 +1643,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointSAMLMutate.html b/doc/NgrokAPI/Models/EndpointSAMLMutate.html index 889cca5..154233f 100644 --- a/doc/NgrokAPI/Models/EndpointSAMLMutate.html +++ b/doc/NgrokAPI/Models/EndpointSAMLMutate.html @@ -1273,7 +1273,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointTLSTermination.html b/doc/NgrokAPI/Models/EndpointTLSTermination.html index fc2ad9c..c265cb7 100644 --- a/doc/NgrokAPI/Models/EndpointTLSTermination.html +++ b/doc/NgrokAPI/Models/EndpointTLSTermination.html @@ -681,7 +681,7 @@ diff --git a/doc/NgrokAPI/Models/EndpointWebhookValidation.html b/doc/NgrokAPI/Models/EndpointWebhookValidation.html index e6c0b4a..83faba1 100644 --- a/doc/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/doc/NgrokAPI/Models/EndpointWebhookValidation.html @@ -681,7 +681,7 @@ diff --git a/doc/NgrokAPI/Models/EventDestination.html b/doc/NgrokAPI/Models/EventDestination.html index 38d9c3a..6182c71 100644 --- a/doc/NgrokAPI/Models/EventDestination.html +++ b/doc/NgrokAPI/Models/EventDestination.html @@ -1048,7 +1048,7 @@ diff --git a/doc/NgrokAPI/Models/EventSource.html b/doc/NgrokAPI/Models/EventSource.html index 34ff62e..ee12055 100644 --- a/doc/NgrokAPI/Models/EventSource.html +++ b/doc/NgrokAPI/Models/EventSource.html @@ -755,7 +755,7 @@ diff --git a/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html b/doc/NgrokAPI/Models/EventSourceList.html similarity index 77% rename from doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html rename to doc/NgrokAPI/Models/EventSourceList.html index df2f3a6..088d8aa 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +++ b/doc/NgrokAPI/Models/EventSourceList.html @@ -4,7 +4,7 @@ - Class: NgrokAPI::Models::ReservedDomainCertNSTarget + Class: NgrokAPI::Models::EventSourceList — Documentation by YARD 0.9.26 @@ -15,7 +15,7 @@ <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> - pathId = "NgrokAPI::Models::ReservedDomainCertNSTarget"; + pathId = "NgrokAPI::Models::EventSourceList"; relpath = '../../'; </script> @@ -36,10 +36,10 @@ <div id="header"> <div id="menu"> - <a href="../../_index.html">Index (R)</a> » + <a href="../../_index.html">Index (E)</a> » <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span> » - <span class="title">ReservedDomainCertNSTarget</span> + <span class="title">EventSourceList</span> </div> @@ -59,7 +59,7 @@ <div class="clear"></div> </div> - <div id="content"><h1>Class: NgrokAPI::Models::ReservedDomainCertNSTarget + <div id="content"><h1>Class: NgrokAPI::Models::EventSourceList @@ -74,7 +74,7 @@ <ul class="fullTree"> <li>Object</li> - <li class="next">NgrokAPI::Models::ReservedDomainCertNSTarget</li> + <li class="next">NgrokAPI::Models::EventSourceList</li> </ul> <a href="#" class="inheritanceTree">show all</a> @@ -94,7 +94,7 @@ <dl> <dt>Defined in:</dt> - <dd>lib/ngrokapi/models/reserved_domain_cert_ns_target.rb</dd> + <dd>lib/ngrokapi/models/event_source_list.rb</dd> </dl> </div> @@ -132,35 +132,6 @@ <p>Returns the value of attribute client.</p> </div></span> -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#nameservers-instance_method" title="#nameservers (instance method)">#<strong>nameservers</strong> ⇒ Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute nameservers.</p> -</div></span> - </li> @@ -196,7 +167,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#zone-instance_method" title="#zone (instance method)">#<strong>zone</strong> ⇒ Object </a> + <a href="#sources-instance_method" title="#sources (instance method)">#<strong>sources</strong> ⇒ Object </a> @@ -216,7 +187,36 @@ <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute zone.</p> +<p>Returns the value of attribute sources.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</strong> ⇒ Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute uri.</p> </div></span> </li> @@ -260,7 +260,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ ReservedDomainCertNSTarget </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ EventSourceList </a> @@ -277,7 +277,7 @@ <span class="summary_desc"><div class='inline'> -<p>A new instance of ReservedDomainCertNSTarget.</p> +<p>A new instance of EventSourceList.</p> </div></span> </li> @@ -314,7 +314,7 @@ <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span></tt> + #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></tt> @@ -323,7 +323,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Returns a new instance of ReservedDomainCertNSTarget.</p> +<p>Returns a new instance of EventSourceList.</p> </div> @@ -345,13 +345,13 @@ 16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 11</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 11</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span> - <span class='ivar'>@zone</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>zone</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> - <span class='ivar'>@nameservers</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>nameservers</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@sources</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -396,7 +396,7 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -407,49 +407,6 @@ </div> - <span id=""></span> - <div class="method_details "> - <h3 class="signature " id="nameservers-instance_method"> - - #<strong>nameservers</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Returns the value of attribute nameservers.</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -6 -7 -8</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_nameservers'>nameservers</span> - <span class='ivar'>@nameservers</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <span id=""></span> <div class="method_details "> <h3 class="signature " id="result-instance_method"> @@ -482,7 +439,7 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@result</span> @@ -495,9 +452,9 @@ <span id=""></span> <div class="method_details "> - <h3 class="signature " id="zone-instance_method"> + <h3 class="signature " id="sources-instance_method"> - #<strong>zone</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + #<strong>sources</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> @@ -506,7 +463,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Returns the value of attribute zone.</p> +<p>Returns the value of attribute sources.</p> </div> @@ -525,10 +482,53 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> -<span class='kw'>def</span> <span class='id identifier rubyid_zone'>zone</span> - <span class='ivar'>@zone</span> +<span class='kw'>def</span> <span class='id identifier rubyid_sources'>sources</span> + <span class='ivar'>@sources</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="uri-instance_method"> + + #<strong>uri</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute uri.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span> + <span class='ivar'>@uri</span> <span class='kw'>end</span></pre> </td> </tr> @@ -562,7 +562,7 @@ 20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 18</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 18</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -592,7 +592,7 @@ 24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventSourceReplace.html b/doc/NgrokAPI/Models/EventSourceReplace.html index ec6e3cc..cd165d6 100644 --- a/doc/NgrokAPI/Models/EventSourceReplace.html +++ b/doc/NgrokAPI/Models/EventSourceReplace.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventStream.html b/doc/NgrokAPI/Models/EventStream.html index ebc74c0..91b27c2 100644 --- a/doc/NgrokAPI/Models/EventStream.html +++ b/doc/NgrokAPI/Models/EventStream.html @@ -1299,7 +1299,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventSubscription.html b/doc/NgrokAPI/Models/EventSubscription.html index 64d23d5..579cb27 100644 --- a/doc/NgrokAPI/Models/EventSubscription.html +++ b/doc/NgrokAPI/Models/EventSubscription.html @@ -1048,7 +1048,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventTarget.html b/doc/NgrokAPI/Models/EventTarget.html index c8b9045..652ad9b 100644 --- a/doc/NgrokAPI/Models/EventTarget.html +++ b/doc/NgrokAPI/Models/EventTarget.html @@ -755,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html index 92b017f..dc75ce6 100644 --- a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +++ b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventTargetFirehose.html b/doc/NgrokAPI/Models/EventTargetFirehose.html index 20e93cd..485f325 100644 --- a/doc/NgrokAPI/Models/EventTargetFirehose.html +++ b/doc/NgrokAPI/Models/EventTargetFirehose.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/EventTargetKinesis.html b/doc/NgrokAPI/Models/EventTargetKinesis.html index de07769..4a98b30 100644 --- a/doc/NgrokAPI/Models/EventTargetKinesis.html +++ b/doc/NgrokAPI/Models/EventTargetKinesis.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/IPPolicy.html b/doc/NgrokAPI/Models/IPPolicy.html index d0e900c..eae1ff3 100644 --- a/doc/NgrokAPI/Models/IPPolicy.html +++ b/doc/NgrokAPI/Models/IPPolicy.html @@ -1059,7 +1059,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/IPPolicyRule.html b/doc/NgrokAPI/Models/IPPolicyRule.html index 636eadd..711d4bb 100644 --- a/doc/NgrokAPI/Models/IPPolicyRule.html +++ b/doc/NgrokAPI/Models/IPPolicyRule.html @@ -1139,7 +1139,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/IPRestriction.html b/doc/NgrokAPI/Models/IPRestriction.html index cbcd47e..602961f 100644 --- a/doc/NgrokAPI/Models/IPRestriction.html +++ b/doc/NgrokAPI/Models/IPRestriction.html @@ -1122,7 +1122,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/IPWhitelistEntry.html b/doc/NgrokAPI/Models/IPWhitelistEntry.html index 68cd0fc..9843461 100644 --- a/doc/NgrokAPI/Models/IPWhitelistEntry.html +++ b/doc/NgrokAPI/Models/IPWhitelistEntry.html @@ -1059,7 +1059,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/Listable.html b/doc/NgrokAPI/Models/Listable.html index b2fb75b..5c21270 100644 --- a/doc/NgrokAPI/Models/Listable.html +++ b/doc/NgrokAPI/Models/Listable.html @@ -87,6 +87,11 @@ + <dl> + <dt>Includes:</dt> + <dd>Enumerable</dd> + </dl> + @@ -387,7 +392,29 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:, list_property:, klass:) ⇒ Listable </a> + <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong> ⇒ Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(danger: false, client:, result:, list_property:, klass:) ⇒ Listable </a> @@ -435,13 +462,14 @@ </ul> -<div id="constructor_details" class="method_details_list"> + + <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, result:, list_property:, klass:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::Listable (class)">Listable</a></span></tt> + #<strong>initialize</strong>(danger: false, client:, result:, list_property:, klass:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::Listable (class)">Listable</a></span></tt> @@ -464,8 +492,6 @@ <pre class="lines"> -17 -18 19 20 21 @@ -478,12 +504,15 @@ 28 29 30 -31</pre> +31 +32 +33 +34</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 17</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 19</span> -<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='comma'>,</span> <span class='label'>list_property:</span><span class='comma'>,</span> <span class='label'>klass:</span><span class='rparen'>)</span> +<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='comma'>,</span> <span class='label'>list_property:</span><span class='comma'>,</span> <span class='label'>klass:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span> @@ -495,7 +524,8 @@ <span class='ivar'>@iter</span> <span class='op'>=</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="../PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../PagedIterator.html#initialize-instance_method" title="NgrokAPI::PagedIterator#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='label'>page:</span> <span class='kw'>self</span><span class='comma'>,</span> - <span class='label'>list_property:</span> <span class='id identifier rubyid_list_property'>list_property</span> + <span class='label'>list_property:</span> <span class='id identifier rubyid_list_property'>list_property</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span> <span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -536,12 +566,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -579,12 +609,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span> <span class='ivar'>@items</span> @@ -622,12 +652,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_iter'>iter</span> <span class='ivar'>@iter</span> @@ -665,12 +695,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_klass'>klass</span> <span class='ivar'>@klass</span> @@ -708,12 +738,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_list_property'>list_property</span> <span class='ivar'>@list_property</span> @@ -751,12 +781,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_next_page_uri'>next_page_uri</span> <span class='ivar'>@next_page_uri</span> @@ -794,12 +824,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@result</span> @@ -837,12 +867,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span> <span class='ivar'>@uri</span> @@ -874,12 +904,12 @@ <pre class="lines"> -33 -34 -35</pre> +44 +45 +46</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 33</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 44</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -887,6 +917,44 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="each-instance_method"> + + #<strong>each</strong> ⇒ <tt>Object</tt> + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +36 +37 +38 +39 +40 +41 +42</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 36</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span> + <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@iter</span><span class='period'>.</span><span class='id identifier rubyid_get_next'>get_next</span> + <span class='kw'>while</span> <span class='id identifier rubyid_item'>item</span> + <span class='kw'>yield</span> <span class='id identifier rubyid_item'>item</span> + <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@iter</span><span class='period'>.</span><span class='id identifier rubyid_get_next'>get_next</span> + <span class='kw'>end</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -904,12 +972,12 @@ <pre class="lines"> -37 -38 -39</pre> +48 +49 +50</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 48</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -924,7 +992,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/Ref.html b/doc/NgrokAPI/Models/Ref.html index 3f007aa..34e1725 100644 --- a/doc/NgrokAPI/Models/Ref.html +++ b/doc/NgrokAPI/Models/Ref.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/ReservedAddr.html b/doc/NgrokAPI/Models/ReservedAddr.html index 1fde3a2..7a064d6 100644 --- a/doc/NgrokAPI/Models/ReservedAddr.html +++ b/doc/NgrokAPI/Models/ReservedAddr.html @@ -1122,7 +1122,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/ReservedDomain.html b/doc/NgrokAPI/Models/ReservedDomain.html index 38b795a..eec8769 100644 --- a/doc/NgrokAPI/Models/ReservedDomain.html +++ b/doc/NgrokAPI/Models/ReservedDomain.html @@ -106,6 +106,35 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> + <li class="public "> + <span class="summary_signature"> + + <a href="#acme_challenge_cname_target-instance_method" title="#acme_challenge_cname_target (instance method)">#<strong>acme_challenge_cname_target</strong> ⇒ Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute acme_challenge_cname_target.</p> +</div></span> + +</li> + + <li class="public "> <span class="summary_signature"> @@ -680,7 +709,6 @@ <pre class="lines"> -22 23 24 25 @@ -696,10 +724,12 @@ 35 36 37 -38</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 23</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -717,6 +747,7 @@ <span class='ivar'>@certificate</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate_management_policy</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@certificate_management_status</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate_management_status</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@acme_challenge_cname_target</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>acme_challenge_cname_target</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -731,7 +762,50 @@ <span id=""></span> <div class="method_details first"> - <h3 class="signature first" id="certificate-instance_method"> + <h3 class="signature first" id="acme_challenge_cname_target-instance_method"> + + #<strong>acme_challenge_cname_target</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute acme_challenge_cname_target.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 6</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_acme_challenge_cname_target'>acme_challenge_cname_target</span> + <span class='ivar'>@acme_challenge_cname_target</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="certificate-instance_method"> #<strong>certificate</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> @@ -1395,12 +1469,12 @@ <pre class="lines"> -40 -41 -42</pre> +42 +43 +44</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 40</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 42</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -1438,14 +1512,14 @@ <pre class="lines"> -52 -53 54 55 -56</pre> +56 +57 +58</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 52</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 54</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span> @@ -1472,12 +1546,12 @@ <pre class="lines"> -44 -45 -46</pre> +46 +47 +48</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 44</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 46</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -1492,7 +1566,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/ReservedDomainCertJob.html b/doc/NgrokAPI/Models/ReservedDomainCertJob.html index fc3d47a..be2247a 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertJob.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertJob.html @@ -190,35 +190,6 @@ <p>Returns the value of attribute msg.</p> </div></span> -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ns_targets-instance_method" title="#ns_targets (instance method)">#<strong>ns_targets</strong> ⇒ Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute ns_targets.</p> -</div></span> - </li> @@ -424,18 +395,17 @@ <pre class="lines"> +13 14 15 16 17 18 19 -20 -21 -22</pre> +20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 14</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 13</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -444,7 +414,6 @@ <span class='ivar'>@msg</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>msg</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@started_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>started_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@retries_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>retries_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> - <span class='ivar'>@ns_targets</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ns_targets</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -586,49 +555,6 @@ </div> - <span id=""></span> - <div class="method_details "> - <h3 class="signature " id="ns_targets-instance_method"> - - #<strong>ns_targets</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Returns the value of attribute ns_targets.</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -6 -7 -8</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 6</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_ns_targets'>ns_targets</span> - <span class='ivar'>@ns_targets</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <span id=""></span> <div class="method_details "> <h3 class="signature " id="result-instance_method"> @@ -779,12 +705,12 @@ <pre class="lines"> -24 -25 -26</pre> +22 +23 +24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 24</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 22</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -809,12 +735,12 @@ <pre class="lines"> -28 -29 -30</pre> +26 +27 +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 28</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -829,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html index 9c5bd43..495adb1 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html index 5544b6f..ebcd783 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/SSHCertificateAuthority.html b/doc/NgrokAPI/Models/SSHCertificateAuthority.html index d007b0b..b1d1209 100644 --- a/doc/NgrokAPI/Models/SSHCertificateAuthority.html +++ b/doc/NgrokAPI/Models/SSHCertificateAuthority.html @@ -1133,7 +1133,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/SSHCredential.html b/doc/NgrokAPI/Models/SSHCredential.html index 3cedc7b..af11228 100644 --- a/doc/NgrokAPI/Models/SSHCredential.html +++ b/doc/NgrokAPI/Models/SSHCredential.html @@ -1139,7 +1139,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/SSHHostCertificate.html b/doc/NgrokAPI/Models/SSHHostCertificate.html index b3e56d1..135e535 100644 --- a/doc/NgrokAPI/Models/SSHHostCertificate.html +++ b/doc/NgrokAPI/Models/SSHHostCertificate.html @@ -1503,7 +1503,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/SSHUserCertificate.html b/doc/NgrokAPI/Models/SSHUserCertificate.html index 78b0a3c..fe4a0fb 100644 --- a/doc/NgrokAPI/Models/SSHUserCertificate.html +++ b/doc/NgrokAPI/Models/SSHUserCertificate.html @@ -1651,7 +1651,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/TLSCertificate.html b/doc/NgrokAPI/Models/TLSCertificate.html index 9894192..ca70f08 100644 --- a/doc/NgrokAPI/Models/TLSCertificate.html +++ b/doc/NgrokAPI/Models/TLSCertificate.html @@ -2169,7 +2169,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/TLSCertificateSANs.html b/doc/NgrokAPI/Models/TLSCertificateSANs.html index f178150..a6af59e 100644 --- a/doc/NgrokAPI/Models/TLSCertificateSANs.html +++ b/doc/NgrokAPI/Models/TLSCertificateSANs.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/Tunnel.html b/doc/NgrokAPI/Models/Tunnel.html index 7657a70..94e6017 100644 --- a/doc/NgrokAPI/Models/Tunnel.html +++ b/doc/NgrokAPI/Models/Tunnel.html @@ -977,7 +977,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Models/TunnelSession.html b/doc/NgrokAPI/Models/TunnelSession.html index abb79ff..d1237ae 100644 --- a/doc/NgrokAPI/Models/TunnelSession.html +++ b/doc/NgrokAPI/Models/TunnelSession.html @@ -1199,7 +1199,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/PagedIterator.html b/doc/NgrokAPI/PagedIterator.html index 55fa84b..ae0603e 100644 --- a/doc/NgrokAPI/PagedIterator.html +++ b/doc/NgrokAPI/PagedIterator.html @@ -269,7 +269,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, page:, list_property:) ⇒ PagedIterator </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, page:, list_property:, danger: false) ⇒ PagedIterator </a> @@ -301,7 +301,7 @@ <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, page:, list_property:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt> + #<strong>initialize</strong>(client:, page:, list_property:, danger: false) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt> @@ -333,7 +333,9 @@ 16 17 18 -19</pre> +19 +20 +21</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 10</span> @@ -341,12 +343,14 @@ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='label'>client:</span><span class='comma'>,</span> <span class='label'>page:</span><span class='comma'>,</span> - <span class='label'>list_property:</span> + <span class='label'>list_property:</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>false</span> <span class='rparen'>)</span> <span class='ivar'>@n</span> <span class='op'>=</span> <span class='int'>0</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span> <span class='ivar'>@page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span> + <span class='ivar'>@danger</span> <span class='op'>=</span> <span class='id identifier rubyid_danger'>danger</span> <span class='kw'>end</span></pre> </td> </tr> @@ -581,8 +585,6 @@ <pre class="lines"> -26 -27 28 29 30 @@ -593,10 +595,12 @@ 35 36 37 -38</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 26</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_get_next'>get_next</span> <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='ivar'>@list_property</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='ivar'>@n</span><span class='rbracket'>]</span> @@ -605,7 +609,7 @@ <span class='id identifier rubyid_item'>item</span> <span class='kw'>rescue</span> <span class='kw'>if</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span> - <span class='id identifier rubyid_res'>res</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><span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span> + <span class='id identifier rubyid_res'>res</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><span class='label'>danger:</span> <span class='ivar'>@danger</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='int'>0</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span> <span class='id identifier rubyid_get_next'>get_next</span> @@ -621,7 +625,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services.html b/doc/NgrokAPI/Services.html index 3f67461..4332bd5 100644 --- a/doc/NgrokAPI/Services.html +++ b/doc/NgrokAPI/Services.html @@ -107,7 +107,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/APIKeysClient.html b/doc/NgrokAPI/Services/APIKeysClient.html index f07a6a0..bde9fb7 100644 --- a/doc/NgrokAPI/Services/APIKeysClient.html +++ b/doc/NgrokAPI/Services/APIKeysClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p> - -<pre class="code ruby"><code class="ruby">API. You may use the API itself -to provision and manage API Keys but you'll need to provision your first API -key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your -ngrok.com dashboard. -</code></pre> +<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p> <p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p> @@ -377,6 +371,30 @@ ngrok.com dashboard. <p>List all API keys owned by this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all API keys owned by this account Throws an exception if API error.</p> +</div></span> + </li> @@ -460,12 +478,12 @@ ngrok.com dashboard. <pre class="lines"> +21 22 -23 -24</pre> +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span> <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> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -508,12 +526,12 @@ ngrok.com dashboard. <pre class="lines"> +19 20 -21 -22</pre> +21</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 20</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -616,6 +634,7 @@ ngrok.com dashboard. <pre class="lines"> +34 35 36 37 @@ -627,11 +646,10 @@ ngrok.com dashboard. 43 44 45 -46 -47</pre> +46</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 35</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span> <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> @@ -719,6 +737,7 @@ ngrok.com dashboard. <pre class="lines"> +55 56 57 58 @@ -726,11 +745,10 @@ ngrok.com dashboard. 60 61 62 -63 -64</pre> +63</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 56</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 55</span> <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> @@ -814,6 +832,7 @@ ngrok.com dashboard. <pre class="lines"> +73 74 75 76 @@ -821,11 +840,10 @@ ngrok.com dashboard. 78 79 80 -81 -82</pre> +81</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 74</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 73</span> <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> @@ -909,6 +927,7 @@ ngrok.com dashboard. <pre class="lines"> +90 91 92 93 @@ -918,11 +937,10 @@ ngrok.com dashboard. 97 98 99 -100 -101</pre> +100</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 91</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 90</span> <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> @@ -1008,6 +1026,7 @@ ngrok.com dashboard. <pre class="lines"> +110 111 112 113 @@ -1017,11 +1036,10 @@ ngrok.com dashboard. 117 118 119 -120 -121</pre> +120</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 111</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 110</span> <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> @@ -1133,6 +1151,7 @@ ngrok.com dashboard. <pre class="lines"> +131 132 133 134 @@ -1153,7 +1172,7 @@ ngrok.com dashboard. 149</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 132</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 131</span> <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> @@ -1166,6 +1185,7 @@ ngrok.com dashboard. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1176,6 +1196,151 @@ ngrok.com dashboard. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all API keys owned by this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 161</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1277,24 +1442,24 @@ ngrok.com dashboard. <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174</pre> +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 192</span> <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> @@ -1415,24 +1580,24 @@ ngrok.com dashboard. <pre class="lines"> -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200</pre> +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 186</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 218</span> <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> @@ -1459,7 +1624,7 @@ ngrok.com dashboard. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/AbuseReportsClient.html b/doc/NgrokAPI/Services/AbuseReportsClient.html index 3c78ab7..d05d66a 100644 --- a/doc/NgrokAPI/Services/AbuseReportsClient.html +++ b/doc/NgrokAPI/Services/AbuseReportsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p> - -<pre class="code ruby"><code class="ruby">ngrok that violate ngrok's terms of service. -</code></pre> +<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p> <p><a href="https://ngrok.com/docs/api#api-abuse-reports">ngrok.com/docs/api#api-abuse-reports</a></p> @@ -713,7 +710,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html index c88da70..3d42d86 100644 --- a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Certificate Authorities are x509 certificates that are used to sign other</p> - -<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module -to verify that the TLS certificate presented by a client has been signed by -this CA. Certificate Authorities are used only for mTLS validation only and -thus a private key is not included in the resource. -</code></pre> +<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p> <p><a href="https://ngrok.com/docs/api#api-certificate-authorities">ngrok.com/docs/api#api-certificate-authorities</a></p> @@ -377,6 +371,30 @@ thus a private key is not included in the resource. <p>List all Certificate Authority on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all Certificate Authority on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1170,7 +1188,8 @@ thus a private key is not included in the resource. 147 148 149 -150</pre> +150 +151</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 133</span> @@ -1186,6 +1205,7 @@ thus a private key is not included in the resource. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1196,6 +1216,151 @@ thus a private key is not included in the resource. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Certificate Authority on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-list">ngrok.com/docs/api#api-certificate-authorities-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 163</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1297,24 +1462,24 @@ thus a private key is not included in the resource. <pre class="lines"> -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175</pre> +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 161</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 194</span> <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> @@ -1435,24 +1600,24 @@ thus a private key is not included in the resource. <pre class="lines"> -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201</pre> +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 187</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 220</span> <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> @@ -1479,7 +1644,7 @@ thus a private key is not included in the resource. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/CredentialsClient.html b/doc/NgrokAPI/Services/CredentialsClient.html index 455ee34..4df850d 100644 --- a/doc/NgrokAPI/Services/CredentialsClient.html +++ b/doc/NgrokAPI/Services/CredentialsClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p> - -<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with -the ngrok authtoken command or by specifying it in the ngrok.yml -configuration file with the authtoken property. -</code></pre> +<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p> <p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p> @@ -376,6 +371,30 @@ configuration file with the authtoken property. <p>List all tunnel authtoken credentials on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -601,7 +620,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1171,7 +1190,8 @@ configuration file with the authtoken property. 149 150 151 -152</pre> +152 +153</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span> @@ -1187,6 +1207,7 @@ configuration file with the authtoken property. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1197,6 +1218,151 @@ configuration file with the authtoken property. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-credentials-list">ngrok.com/docs/api#api-credentials-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 165</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1284,7 +1450,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1316,26 +1482,26 @@ configuration file with the authtoken property. <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 197</span> <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> @@ -1444,7 +1610,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1476,26 +1642,26 @@ configuration file with the authtoken property. <pre class="lines"> -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209</pre> +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 193</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 226</span> <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> @@ -1524,7 +1690,7 @@ configuration file with the authtoken property. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html b/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html index 6cc5c4c..6df05f5 100644 --- a/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html b/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html index 1781e2d..7d92fa7 100644 --- a/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointConfigurationsClient.html b/doc/NgrokAPI/Services/EndpointConfigurationsClient.html index 60ad299..0add540 100644 --- a/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +++ b/doc/NgrokAPI/Services/EndpointConfigurationsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p> - -<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only -applied to Domains and TCP Addresses they have been attached to. -</code></pre> +<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p> <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p> @@ -375,6 +371,30 @@ applied to Domains and TCP Addresses they have been attached to. <p>Returns a list of all endpoint configurations on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -564,7 +584,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p> +<p>they type of traffic this endpoint configuration can be applied to. one of: <code>http</code>, <code>https</code>, <code>tcp</code></p> </div> </li> @@ -618,7 +638,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -636,7 +656,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -654,7 +674,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -672,7 +692,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -690,7 +710,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -708,7 +728,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -726,7 +746,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -744,7 +764,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -762,7 +782,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -780,7 +800,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -798,7 +818,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -816,7 +836,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -1438,7 +1458,8 @@ applied to Domains and TCP Addresses they have been attached to. 185 186 187 -188</pre> +188 +189</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 171</span> @@ -1454,6 +1475,7 @@ applied to Domains and TCP Addresses they have been attached to. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1464,6 +1486,151 @@ applied to Domains and TCP Addresses they have been attached to. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 201</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1556,7 +1723,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -1574,7 +1741,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -1592,7 +1759,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -1610,7 +1777,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -1628,7 +1795,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -1646,7 +1813,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -1664,7 +1831,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -1682,7 +1849,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -1700,7 +1867,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -1718,7 +1885,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -1736,7 +1903,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -1754,7 +1921,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -1786,39 +1953,6 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 247 248 249 @@ -1826,10 +1960,43 @@ applied to Domains and TCP Addresses they have been attached to. 251 252 253 -254</pre> +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 214</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 247</span> <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> @@ -1967,7 +2134,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -1985,7 +2152,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -2003,7 +2170,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -2021,7 +2188,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -2039,7 +2206,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -2057,7 +2224,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -2075,7 +2242,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -2093,7 +2260,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -2111,7 +2278,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -2129,7 +2296,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -2147,7 +2314,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -2165,7 +2332,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -2197,39 +2364,6 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -281 -282 -283 -284 -285 -286 -287 -288 -289 -290 -291 -292 -293 -294 -295 -296 -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 314 315 316 @@ -2237,10 +2371,43 @@ applied to Domains and TCP Addresses they have been attached to. 318 319 320 -321</pre> +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 281</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 314</span> <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> @@ -2293,7 +2460,7 @@ applied to Domains and TCP Addresses they have been attached to. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html b/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html index 0db28bd..52db0eb 100644 --- a/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html b/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html index cffac98..596acbb 100644 --- a/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html b/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html index 2f65fa5..0552357 100644 --- a/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html b/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html index d433864..204f1db 100644 --- a/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html b/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html index 7b242bf..cafc1a7 100644 --- a/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html b/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html index ab460b4..8622d3d 100644 --- a/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html b/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html index 5e4bece..e82eb9d 100644 --- a/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html b/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html index 4c8db30..9f493bc 100644 --- a/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html b/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html index 7f904f8..73f8c3c 100644 --- a/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html b/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html index 719f591..7cf65af 100644 --- a/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +++ b/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:27 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EventDestinationsClient.html b/doc/NgrokAPI/Services/EventDestinationsClient.html index 31bf309..0a537d2 100644 --- a/doc/NgrokAPI/Services/EventDestinationsClient.html +++ b/doc/NgrokAPI/Services/EventDestinationsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all Event Destinations on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all Event Destinations on this account.</p> </div></span> @@ -594,7 +618,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -612,7 +636,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1188,7 +1212,8 @@ 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 137</span> @@ -1204,6 +1229,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1214,6 +1240,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Event Destinations on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-destinations-list">ngrok.com/docs/api#api-event-destinations-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventDestinationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1306,7 +1477,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -1324,7 +1495,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1356,29 +1527,29 @@ <pre class="lines"> -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186</pre> +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span> <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> @@ -1495,7 +1666,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -1513,7 +1684,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1545,29 +1716,29 @@ <pre class="lines"> -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219</pre> +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 233</span> <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> @@ -1599,7 +1770,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EventSourcesClient.html b/doc/NgrokAPI/Services/EventSourcesClient.html index 53c5706..d0d1fb6 100644 --- a/doc/NgrokAPI/Services/EventSourcesClient.html +++ b/doc/NgrokAPI/Services/EventSourcesClient.html @@ -329,6 +329,54 @@ <p>A new instance of EventSourcesClient.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List the types for which this event subscription will trigger.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List the types for which this event subscription will trigger Throws an exception if API error.</p> +</div></span> + </li> @@ -1081,6 +1129,204 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list-instance_method"> + + #<strong>list</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List the types for which this event subscription will trigger</p> + +<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>subscription_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'> +<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 134</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span> + <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> +<span class='rparen'>)</span> + <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span> + <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span> + <span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span> + <span class='rbrace'>}</span> + <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> + <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> + <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/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List the types for which this event subscription will trigger Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>subscription_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'> +<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 154</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span> + <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> +<span class='rparen'>)</span> + <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span> + <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span> + <span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span> + <span class='rbrace'>}</span> + <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> + <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> + <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/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1169,24 +1415,24 @@ <pre class="lines"> -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149</pre> +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 135</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 174</span> <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span> <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> @@ -1294,24 +1540,24 @@ <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174</pre> +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 199</span> <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span> <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> @@ -1338,7 +1584,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EventStreamsClient.html b/doc/NgrokAPI/Services/EventStreamsClient.html index 02d2439..4f02c4b 100644 --- a/doc/NgrokAPI/Services/EventStreamsClient.html +++ b/doc/NgrokAPI/Services/EventStreamsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all Event Streams available on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all Event Streams available on this account.</p> </div></span> @@ -612,7 +636,7 @@ — <div class='inline'> -<p>The protocol that determines which events will be collected. Supported values are “tcp_connection_closed“ and “http_request_complete“.</p> +<p>The protocol that determines which events will be collected. Supported values are <code>tcp_connection_closed</code> and <code>http_request_complete</code>.</p> </div> </li> @@ -1230,7 +1254,8 @@ 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 137</span> @@ -1246,6 +1271,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1256,6 +1282,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Event Streams available on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1416,30 +1587,30 @@ <pre class="lines"> -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188</pre> +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 168</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 201</span> <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> @@ -1625,30 +1796,30 @@ <pre class="lines"> -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223</pre> +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 203</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 236</span> <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> @@ -1681,7 +1852,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/EventSubscriptionsClient.html b/doc/NgrokAPI/Services/EventSubscriptionsClient.html index 1e4ca34..2b837be 100644 --- a/doc/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/doc/NgrokAPI/Services/EventSubscriptionsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List this Account's Event Subscriptions.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List this Account's Event Subscriptions.</p> </div></span> @@ -1186,7 +1210,8 @@ 144 145 146 -147</pre> +147 +148</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 130</span> @@ -1202,6 +1227,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1212,6 +1238,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List this Account's Event Subscriptions. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-list">ngrok.com/docs/api#api-event-subscriptions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventSubscriptionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1354,28 +1525,28 @@ <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 193</span> <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> @@ -1541,28 +1712,28 @@ <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 225</span> <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> @@ -1593,7 +1764,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/IPPoliciesClient.html b/doc/NgrokAPI/Services/IPPoliciesClient.html index 421426d..490a453 100644 --- a/doc/NgrokAPI/Services/IPPoliciesClient.html +++ b/doc/NgrokAPI/Services/IPPoliciesClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p> - -<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP -Policy module. They can also be used with IP Restrictions to control source -IP ranges that can start tunnel sessions and connect to the API and dashboard. -</code></pre> +<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p> <p><a href="https://ngrok.com/docs/api#api-ip-policies">ngrok.com/docs/api#api-ip-policies</a></p> @@ -376,6 +371,30 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <p>List all IP policies on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP policies on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +618,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. — <div class='inline'> -<p>the IP policy action. Supported values are “allow“ or “deny“</p> +<p>the IP policy action. Supported values are <code>allow</code> or <code>deny</code></p> </div> </li> @@ -1169,7 +1188,8 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 137</span> @@ -1185,6 +1205,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPoliciesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1195,6 +1216,151 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP policies on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-policies-list">ngrok.com/docs/api#api-ip-policies-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPoliciesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPPoliciesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1296,24 +1462,24 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 165</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 198</span> <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> @@ -1434,24 +1600,24 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205</pre> +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 191</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 224</span> <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> @@ -1478,7 +1644,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/IPPolicyRulesClient.html b/doc/NgrokAPI/Services/IPPolicyRulesClient.html index fc29ea4..5f76991 100644 --- a/doc/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/doc/NgrokAPI/Services/IPPolicyRulesClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p> - -<pre class="code ruby"><code class="ruby">make up an IP Policy. -</code></pre> +<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p> <p><a href="https://ngrok.com/docs/api#api-ip-policy-rules">ngrok.com/docs/api#api-ip-policy-rules</a></p> @@ -374,6 +371,30 @@ <p>List all IP policy rules on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP policy rules on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1187,7 +1208,8 @@ 147 148 149 -150</pre> +150 +151</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 133</span> @@ -1203,6 +1225,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1213,6 +1236,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP policy rules on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-policy-rules-list">ngrok.com/docs/api#api-ip-policy-rules-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 163</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPPolicyRulesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1332,26 +1500,26 @@ <pre class="lines"> -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 162</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 195</span> <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> @@ -1492,26 +1660,26 @@ <pre class="lines"> -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207</pre> +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 191</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 224</span> <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> @@ -1540,7 +1708,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/IPRestrictionsClient.html b/doc/NgrokAPI/Services/IPRestrictionsClient.html index 8751ea9..5192b63 100644 --- a/doc/NgrokAPI/Services/IPRestrictionsClient.html +++ b/doc/NgrokAPI/Services/IPRestrictionsClient.html @@ -102,14 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p> - -<pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP -restriction has a type which defines the ingress it applies to. IP -restrictions can be used to enforce the source IPs that can make API -requests, log in to the dashboard, start ngrok agents, and connect to your -public-facing endpoints. -</code></pre> +<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p> <p><a href="https://ngrok.com/docs/api#api-ip-restrictions">ngrok.com/docs/api#api-ip-restrictions</a></p> @@ -378,6 +371,30 @@ public-facing endpoints. <p>List all IP restrictions on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP restrictions on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -619,7 +636,7 @@ public-facing endpoints. — <div class='inline'> -<p>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“</p> +<p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code>dashboard</code>, <code>api</code>, <code>agent</code>, and <code>endpoints</code></p> </div> </li> @@ -1213,7 +1230,8 @@ public-facing endpoints. 154 155 156 -157</pre> +157 +158</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 140</span> @@ -1229,6 +1247,7 @@ public-facing endpoints. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPRestrictionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1239,6 +1258,151 @@ public-facing endpoints. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP restrictions on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-restrictions-list">ngrok.com/docs/api#api-ip-restrictions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 170</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPRestrictionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPRestrictionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1376,28 +1540,28 @@ public-facing endpoints. <pre class="lines"> -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188</pre> +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 170</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 203</span> <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> @@ -1558,28 +1722,28 @@ public-facing endpoints. <pre class="lines"> -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220</pre> +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 202</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 235</span> <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> @@ -1610,7 +1774,7 @@ public-facing endpoints. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/IPWhitelistClient.html b/doc/NgrokAPI/Services/IPWhitelistClient.html index f863fb1..ea432aa 100644 --- a/doc/NgrokAPI/Services/IPWhitelistClient.html +++ b/doc/NgrokAPI/Services/IPWhitelistClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p> - -<pre class="code ruby"><code class="ruby">with an endpoints type instead. -</code></pre> +<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p> <p><a href="https://ngrok.com/docs/api#api-ip-whitelist">ngrok.com/docs/api#api-ip-whitelist</a></p> @@ -374,6 +371,30 @@ <p>List all IP whitelist entries on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP whitelist entries on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1169,7 +1190,8 @@ 145 146 147 -148</pre> +148 +149</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 131</span> @@ -1185,6 +1207,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1195,6 +1218,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP whitelist entries on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-whitelist-list">ngrok.com/docs/api#api-ip-whitelist-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 161</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPWhitelistClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1296,24 +1464,24 @@ <pre class="lines"> -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173</pre> +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 159</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 192</span> <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> @@ -1434,24 +1602,24 @@ <pre class="lines"> -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199</pre> +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 185</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 218</span> <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> @@ -1478,7 +1646,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/ReservedAddrsClient.html b/doc/NgrokAPI/Services/ReservedAddrsClient.html index eb68285..5eaff4e 100644 --- a/doc/NgrokAPI/Services/ReservedAddrsClient.html +++ b/doc/NgrokAPI/Services/ReservedAddrsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p> - -<pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be -chosen. -</code></pre> +<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p> <p><a href="https://ngrok.com/docs/api#api-reserved-addrs">ngrok.com/docs/api#api-reserved-addrs</a></p> @@ -419,6 +415,30 @@ chosen. + <span class="summary_desc"><div class='inline'> +<p>List all reserved addresses on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all reserved addresses on this account.</p> </div></span> @@ -999,18 +1019,18 @@ chosen. <pre class="lines"> -217 -218 -219 -220 -221 -222 -223 -224 -225</pre> +250 +251 +252 +253 +254 +255 +256 +257 +258</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 217</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 250</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config'>delete_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1094,18 +1114,18 @@ chosen. <pre class="lines"> -235 -236 -237 -238 -239 -240 -241 -242 -243</pre> +268 +269 +270 +271 +272 +273 +274 +275 +276</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 235</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 268</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config!'>delete_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1430,7 +1450,8 @@ chosen. 148 149 150 -151</pre> +151 +152</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 134</span> @@ -1446,6 +1467,7 @@ chosen. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1456,6 +1478,151 @@ chosen. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all reserved addresses on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-list">ngrok.com/docs/api#api-reserved-addrs-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 164</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedAddrsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1575,26 +1742,26 @@ chosen. <pre class="lines"> -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 196</span> <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> @@ -1735,26 +1902,26 @@ chosen. <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 225</span> <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> @@ -1783,7 +1950,7 @@ chosen. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/ReservedDomainsClient.html b/doc/NgrokAPI/Services/ReservedDomainsClient.html index d5f08d8..e11636b 100644 --- a/doc/NgrokAPI/Services/ReservedDomainsClient.html +++ b/doc/NgrokAPI/Services/ReservedDomainsClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p> - -<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain -that you own by creating a CNAME record specified in the returned resource. -This CNAME record points traffic for that domain to ngrok's edge servers. -</code></pre> +<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.</p> <p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p> @@ -564,6 +559,30 @@ This CNAME record points traffic for that domain to ngrok's edge servers. + <span class="summary_desc"><div class='inline'> +<p>List all reserved domains on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all reserved domains on this account.</p> </div></span> @@ -863,7 +882,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -881,7 +900,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -1230,18 +1249,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -283 -284 -285 -286 -287 -288 -289 -290 -291</pre> +316 +317 +318 +319 +320 +321 +322 +323 +324</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 283</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 316</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1325,18 +1344,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -301 -302 -303 -304 -305 -306 -307 -308 -309</pre> +334 +335 +336 +337 +338 +339 +340 +341 +342</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 301</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 334</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1420,18 +1439,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -248 -249 -250 -251 -252 -253 -254 -255 -256</pre> +281 +282 +283 +284 +285 +286 +287 +288 +289</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 248</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 281</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1515,18 +1534,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -266 -267 -268 -269 -270 -271 -272 -273 -274</pre> +299 +300 +301 +302 +303 +304 +305 +306 +307</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 266</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 299</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1610,18 +1629,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -318 -319 -320 -321 -322 -323 -324 -325 -326</pre> +351 +352 +353 +354 +355 +356 +357 +358 +359</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 318</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 351</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1705,18 +1724,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -336 -337 -338 -339 -340 -341 -342 -343 -344</pre> +369 +370 +371 +372 +373 +374 +375 +376 +377</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 336</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 369</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1800,18 +1819,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -353 -354 -355 -356 -357 -358 -359 -360 -361</pre> +386 +387 +388 +389 +390 +391 +392 +393 +394</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 353</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 386</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1895,18 +1914,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -371 -372 -373 -374 -375 -376 -377 -378 -379</pre> +404 +405 +406 +407 +408 +409 +410 +411 +412</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 371</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 404</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -2231,7 +2250,8 @@ This CNAME record points traffic for that domain to ngrok's edge servers. 161 162 163 -164</pre> +164 +165</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 147</span> @@ -2247,6 +2267,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -2257,6 +2278,151 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all reserved domains on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 177</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -2380,7 +2546,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -2398,7 +2564,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -2430,32 +2596,32 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201</pre> +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 179</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 212</span> <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> @@ -2606,7 +2772,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -2624,7 +2790,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -2656,32 +2822,32 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239</pre> +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 217</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 250</span> <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> @@ -2716,7 +2882,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index 6392ca3..31d1817 100644 --- a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates. -</code></pre> +<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities">ngrok.com/docs/api#api-ssh-certificate-authorities</a></p> @@ -374,6 +371,30 @@ <p>List all SSH Certificate Authorities on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +620,7 @@ — <div class='inline'> -<p>the type of private key to generate. one of “rsa“, “ecdsa“, “ed25519“</p> +<p>the type of private key to generate. one of <code>rsa</code>, <code>ecdsa</code>, <code>ed25519</code></p> </div> </li> @@ -635,7 +656,7 @@ — <div class='inline'> -<p>the key size to use when creating an RSA key. one of “2048“ or “4096“</p> +<p>the key size to use when creating an RSA key. one of <code>2048</code> or <code>4096</code></p> </div> </li> @@ -1213,7 +1234,8 @@ 150 151 152 -153</pre> +153 +154</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 136</span> @@ -1229,6 +1251,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1239,6 +1262,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-list">ngrok.com/docs/api#api-ssh-certificate-authorities-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 166</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1340,24 +1508,24 @@ <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 197</span> <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> @@ -1478,24 +1646,24 @@ <pre class="lines"> -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204</pre> +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 190</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 223</span> <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> @@ -1522,7 +1690,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/SSHCredentialsClient.html b/doc/NgrokAPI/Services/SSHCredentialsClient.html index e002ed7..a66a5cc 100644 --- a/doc/NgrokAPI/Services/SSHCredentialsClient.html +++ b/doc/NgrokAPI/Services/SSHCredentialsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p> - -<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway. -</code></pre> +<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-credentials">ngrok.com/docs/api#api-ssh-credentials</a></p> @@ -374,6 +371,30 @@ <p>List all ssh credentials on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all ssh credentials on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +620,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1189,7 +1210,8 @@ 148 149 150 -151</pre> +151 +152</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 134</span> @@ -1205,6 +1227,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1215,6 +1238,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all ssh credentials on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-credentials-list">ngrok.com/docs/api#api-ssh-credentials-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 164</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1302,7 +1470,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1334,26 +1502,26 @@ <pre class="lines"> -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 196</span> <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> @@ -1462,7 +1630,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1494,26 +1662,26 @@ <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 225</span> <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> @@ -1542,7 +1710,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html index 13eb62d..1967908 100644 --- a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH Host Certificates along with the corresponding private key allows an SSH</p> - -<pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the -SSH Certificate Authority that was used to sign the certificate. -</code></pre> +<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates">ngrok.com/docs/api#api-ssh-host-certificates</a></p> @@ -375,6 +371,30 @@ SSH Certificate Authority that was used to sign the certificate. <p>List all SSH Host Certificates issued on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -632,7 +652,7 @@ SSH Certificate Authority that was used to sign the certificate. — <div class='inline'> -<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this “valid_before“.</p> +<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p> </div> </li> @@ -1254,7 +1274,8 @@ SSH Certificate Authority that was used to sign the certificate. 157 158 159 -160</pre> +160 +161</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 143</span> @@ -1270,6 +1291,7 @@ SSH Certificate Authority that was used to sign the certificate. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1280,6 +1302,151 @@ SSH Certificate Authority that was used to sign the certificate. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-list">ngrok.com/docs/api#api-ssh-host-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 173</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1381,24 +1548,24 @@ SSH Certificate Authority that was used to sign the certificate. <pre class="lines"> -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185</pre> +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 171</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 204</span> <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> @@ -1519,24 +1686,24 @@ SSH Certificate Authority that was used to sign the certificate. <pre class="lines"> -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211</pre> +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 197</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 230</span> <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> @@ -1563,7 +1730,7 @@ SSH Certificate Authority that was used to sign the certificate. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html index 23cb556..4c7f2c5 100644 --- a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p> - -<pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH -Certificate Authority used to sign the certificate. -</code></pre> +<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates">ngrok.com/docs/api#api-ssh-user-certificates</a></p> @@ -375,6 +371,30 @@ Certificate Authority used to sign the certificate. <p>List all SSH User Certificates issued on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH User Certificates issued on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -614,7 +634,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: “force-command“ and “source-address“. See `the OpenSSH certificate protocol spec` <<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_“>github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_</a> for additional details.</p> +<p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code>force-command</code> and <code>source-address</code>. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p> </div> </li> @@ -632,7 +652,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ““”, “permit-user-rc”: “”“ OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_“>github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_</a> for additional details.</p> +<p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code>{"permit-pty": "", "permit-user-rc": ""}</code> OpenSSH understands a number of predefined extensions. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p> </div> </li> @@ -668,7 +688,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this “valid_before“.</p> +<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p> </div> </li> @@ -1298,7 +1318,8 @@ Certificate Authority used to sign the certificate. 163 164 165 -166</pre> +166 +167</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 149</span> @@ -1314,6 +1335,7 @@ Certificate Authority used to sign the certificate. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1324,6 +1346,151 @@ Certificate Authority used to sign the certificate. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH User Certificates issued on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">ngrok.com/docs/api#api-ssh-user-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 179</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1425,24 +1592,24 @@ Certificate Authority used to sign the certificate. <pre class="lines"> -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191</pre> +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 177</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 210</span> <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> @@ -1563,24 +1730,24 @@ Certificate Authority used to sign the certificate. <pre class="lines"> -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217</pre> +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 203</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 236</span> <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> @@ -1607,7 +1774,7 @@ Certificate Authority used to sign the certificate. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/TLSCertificatesClient.html b/doc/NgrokAPI/Services/TLSCertificatesClient.html index 538fc9b..e28bc85 100644 --- a/doc/NgrokAPI/Services/TLSCertificatesClient.html +++ b/doc/NgrokAPI/Services/TLSCertificatesClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>TLS Certificates are pairs of x509 certificates and their matching private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused -until they are attached to a Domain. TLS Certificates may also be -provisioned by ngrok automatically for domains on which you have enabled -automated certificate provisioning. -</code></pre> +<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</a></p> @@ -377,6 +371,30 @@ automated certificate provisioning. <p>List all TLS certificates on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all TLS certificates on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -600,7 +618,7 @@ automated certificate provisioning. — <div class='inline'> -<p>chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <<a href="https://ngrok.com/docs/api#tls-certificates-pem>`_“>ngrok.com/docs/api#tls-certificates-pem>`_</a>.</p> +<p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles</code> <a href="https://ngrok.com/docs/api#tls-certificates-pem`_">ngrok.com/docs/api#tls-certificates-pem`_</a>.</p> </div> </li> @@ -616,7 +634,7 @@ automated certificate provisioning. — <div class='inline'> -<p>private key for the TLS certificate, PEM-encoded. See `Private Keys` <<a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_“>ngrok.com/docs/ngrok-link#tls-certificates-key>`_</a>.</p> +<p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys</code> <a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key`_">ngrok.com/docs/ngrok-link#tls-certificates-key`_</a>.</p> </div> </li> @@ -1190,7 +1208,8 @@ automated certificate provisioning. 150 151 152 -153</pre> +153 +154</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 136</span> @@ -1206,6 +1225,7 @@ automated certificate provisioning. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TLSCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1216,6 +1236,151 @@ automated certificate provisioning. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all TLS certificates on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 166</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TLSCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TLSCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1317,24 +1482,24 @@ automated certificate provisioning. <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 197</span> <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> @@ -1455,24 +1620,24 @@ automated certificate provisioning. <pre class="lines"> -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204</pre> +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 190</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 223</span> <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> @@ -1499,7 +1664,7 @@ automated certificate provisioning. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/TunnelSessionsClient.html b/doc/NgrokAPI/Services/TunnelSessionsClient.html index 1ee54ad..d0b2e01 100644 --- a/doc/NgrokAPI/Services/TunnelSessionsClient.html +++ b/doc/NgrokAPI/Services/TunnelSessionsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p> - -<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel -session can include one or more Tunnels. -</code></pre> +<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p> <p><a href="https://ngrok.com/docs/api#api-tunnel-sessions">ngrok.com/docs/api#api-tunnel-sessions</a></p> @@ -299,6 +295,30 @@ session can include one or more Tunnels. + <span class="summary_desc"><div class='inline'> +<p>List all online tunnel sessions running on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all online tunnel sessions running on this account.</p> </div></span> @@ -620,20 +640,20 @@ session can include one or more Tunnels. <pre class="lines"> -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68</pre> +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 58</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 91</span> <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> @@ -719,20 +739,20 @@ session can include one or more Tunnels. <pre class="lines"> -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88</pre> +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 78</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 111</span> <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> @@ -861,7 +881,8 @@ session can include one or more Tunnels. 46 47 48 -49</pre> +49 +50</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 32</span> @@ -877,6 +898,7 @@ session can include one or more Tunnels. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -887,6 +909,151 @@ session can include one or more Tunnels. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all online tunnel sessions running on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 62</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -957,18 +1124,18 @@ session can include one or more Tunnels. <pre class="lines"> -100 -101 -102 -103 -104 -105 -106 -107 -108</pre> +133 +134 +135 +136 +137 +138 +139 +140 +141</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 100</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 133</span> <span class='kw'>def</span> <span class='id identifier rubyid_restart'>restart</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1052,18 +1219,18 @@ session can include one or more Tunnels. <pre class="lines"> -121 -122 -123 -124 -125 -126 -127 -128 -129</pre> +154 +155 +156 +157 +158 +159 +160 +161 +162</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 121</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 154</span> <span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1147,18 +1314,18 @@ session can include one or more Tunnels. <pre class="lines"> -139 -140 -141 -142 -143 -144 -145 -146 -147</pre> +172 +173 +174 +175 +176 +177 +178 +179 +180</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 139</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 172</span> <span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1242,18 +1409,18 @@ session can include one or more Tunnels. <pre class="lines"> -158 -159 -160 -161 -162 -163 -164 -165 -166</pre> +191 +192 +193 +194 +195 +196 +197 +198 +199</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 158</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 191</span> <span class='kw'>def</span> <span class='id identifier rubyid_stop!'>stop!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1332,19 +1499,19 @@ session can include one or more Tunnels. <pre class="lines"> -186 -187 -188 -189 -190 -191 -192 -193 -194 -195</pre> +219 +220 +221 +222 +223 +224 +225 +226 +227 +228</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 186</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 219</span> <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> @@ -1424,19 +1591,19 @@ session can include one or more Tunnels. <pre class="lines"> -216 -217 -218 -219 -220 -221 -222 -223 -224 -225</pre> +249 +250 +251 +252 +253 +254 +255 +256 +257 +258</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 216</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 249</span> <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> @@ -1458,7 +1625,7 @@ session can include one or more Tunnels. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/NgrokAPI/Services/TunnelsClient.html b/doc/NgrokAPI/Services/TunnelsClient.html index 6c54768..d2074c1 100644 --- a/doc/NgrokAPI/Services/TunnelsClient.html +++ b/doc/NgrokAPI/Services/TunnelsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnels provide endpoints to access services exposed by a running ngrok</p> - -<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session. -</code></pre> +<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p> <p><a href="https://ngrok.com/docs/api#api-tunnels">ngrok.com/docs/api#api-tunnels</a></p> @@ -250,6 +247,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all online tunnels currently running on the account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all online tunnels currently running on the account.</p> </div></span> @@ -470,7 +491,8 @@ 45 46 47 -48</pre> +48 +49</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 31</span> @@ -486,6 +508,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -496,6 +519,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all online tunnels currently running on the account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tunnels-list">ngrok.com/docs/api#api-tunnels-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 61</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> </div> @@ -503,7 +671,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..12ac58c --- /dev/null +++ b/doc/README @@ -0,0 +1,94 @@ +# ngrok-api + +This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it +easier to consume in Ruby. + +## Installation + +This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api) + +```ruby +gem install ngrok-api +``` + +## Quickstart + +Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# Get an instance of the api_keys client and list all API keys +keys_client = client.api_keys +keys_client.list +``` + +## Automatic Paging + +The ngrok API pages all list resources but this library abstracts that away +from you. All response objects from any ``list`` or ``list!`` methods return an object that +implements an ``each`` method which will automatically fetch additional +pages for you. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# list all api keys, transparently fetching additional +# pages for you if necessary +keys_client = client.api_keys +keys_client.list.each do |key| + puts(key) +end +``` + +## Instance Methods + +Instance methods like ``update`` and ``delete`` can be invoked on an instance of an +API object itself as well as directly without needing to first fetch the object. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# update the metadata of a credential +cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz') +cred.update(metadata: {server_name: 'giraffe-1'}.to_json) + +# or do it in single call +cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json) +``` + +## Bang Methods +Most methods that interact with the API have a `!` counterpart. It raises an error when +one is returned by the API. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# no error raised, even though it's a bad identifier +# the error is simply returned +cred = client.credentials.get(id: 'invalid') + +# this raises an NgrokAPI::Error +cred = client.credentials.get!(id: 'invalid') +``` + +## Error Handling + +The ngrok API returns detailed information when an API call fails. Consult the +section on errors for additional details. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +begin + client.ip_policies.get!(id: 'invalid') +rescue NgrokAPI::Error => e + puts(e) + puts(e.response.to_s) +end +``` diff --git a/doc/_index.html b/doc/_index.html index 0f5f21e..714ea7c 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -467,6 +467,13 @@ </li> + <li> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> + + <small>(NgrokAPI::Models)</small> + + </li> + <li> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> @@ -727,13 +734,6 @@ </li> - <li> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span> - - <small>(NgrokAPI::Models)</small> - - </li> - <li> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> @@ -895,7 +895,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/class_list.html b/doc/class_list.html index f520d89..c3b6097 100644 --- a/doc/class_list.html +++ b/doc/class_list.html @@ -43,7 +43,7 @@ <ul id="full_list" class="class"> <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li> -<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> < StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> < Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertNSTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li> +<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> < StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> < Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceList' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li> </ul> </div> diff --git a/doc/file.README.html b/doc/file.README.html index 250e81f..3467f58 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -58,7 +58,7 @@ </div> <div id="content"><div id='filecontents'> -<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1> +<h1 id="label-ngrok-api">ngrok-api</h1> <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p> @@ -69,54 +69,81 @@ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span> </code></pre> -<h2 id="label-Documentation">Documentation</h2> - -<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p> - <h2 id="label-Quickstart">Quickstart</h2> <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>'</span></span> -<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - -<span class='comment'># Get an instance of the api_keys client and list all API keys -</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># Get an instance of the api_keys client and list all API keys +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span> </code></pre> -<h2 id="label-Local+Documentation">Local Documentation</h2> +<h2 id="label-Automatic+Paging">Automatic Paging</h2> -<p>Documentation can be generated with the command:</p> +<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>'</span></span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># list all api keys, transparently fetching additional +</span><span class='comment'># pages for you if necessary +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> -<p>This will generate documentation which can be viewed within the doc folder.</p> +<h2 id="label-Instance+Methods">Instance Methods</h2> -<h2 id="label-Specs">Specs</h2> +<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p> -<p>Specs can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> +<span class='comment'># update the metadata of a credential +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> + +<span class='comment'># or do it in single call +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> </code></pre> -<p>This will generate a coverage report which can be viewed within the coverage folder.</p> +<h2 id="label-Bang+Methods">Bang Methods</h2> -<h2 id="label-Rubocop">Rubocop</h2> +<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p> -<p>Rubocop can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span> - -<span class='comment'># Run rubcop on all files -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> +<span class='comment'># no error raised, even though it's a bad identifier +</span><span class='comment'># the error is simply returned +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># this raises an NgrokAPI::Error +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +</code></pre> + +<h2 id="label-Error+Handling">Error Handling</h2> + +<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='kw'>begin</span> + <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> </div></div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/index.html b/doc/index.html index 2e93085..34a342a 100644 --- a/doc/index.html +++ b/doc/index.html @@ -58,7 +58,7 @@ </div> <div id="content"><div id='filecontents'> -<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1> +<h1 id="label-ngrok-api">ngrok-api</h1> <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p> @@ -69,54 +69,81 @@ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span> </code></pre> -<h2 id="label-Documentation">Documentation</h2> - -<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p> - <h2 id="label-Quickstart">Quickstart</h2> <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>'</span></span> -<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - -<span class='comment'># Get an instance of the api_keys client and list all API keys -</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># Get an instance of the api_keys client and list all API keys +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span> </code></pre> -<h2 id="label-Local+Documentation">Local Documentation</h2> +<h2 id="label-Automatic+Paging">Automatic Paging</h2> -<p>Documentation can be generated with the command:</p> +<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>'</span></span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># list all api keys, transparently fetching additional +</span><span class='comment'># pages for you if necessary +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> -<p>This will generate documentation which can be viewed within the doc folder.</p> +<h2 id="label-Instance+Methods">Instance Methods</h2> -<h2 id="label-Specs">Specs</h2> +<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p> -<p>Specs can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> +<span class='comment'># update the metadata of a credential +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> + +<span class='comment'># or do it in single call +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> </code></pre> -<p>This will generate a coverage report which can be viewed within the coverage folder.</p> +<h2 id="label-Bang+Methods">Bang Methods</h2> -<h2 id="label-Rubocop">Rubocop</h2> +<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p> -<p>Rubocop can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span> - -<span class='comment'># Run rubcop on all files -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> +<span class='comment'># no error raised, even though it's a bad identifier +</span><span class='comment'># the error is simply returned +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># this raises an NgrokAPI::Error +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +</code></pre> + +<h2 id="label-Error+Handling">Error Handling</h2> + +<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='kw'>begin</span> + <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> </div></div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/doc/method_list.html b/doc/method_list.html index 34bae34..6ec334c 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -245,6 +245,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#==-instance_method" title="NgrokAPI::Models::EventSourceList#== (method)">#==</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#==-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -252,7 +260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#==-instance_method" title="NgrokAPI::Models::EventSubscription#== (method)">#==</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -260,7 +268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#==-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#== (method)">#==</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -268,7 +276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#==-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -276,7 +284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#==-instance_method" title="NgrokAPI::Models::EndpointCompression#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -284,7 +292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -292,7 +300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#==-instance_method" title="NgrokAPI::Models::EventSourceReplace#== (method)">#==</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -300,7 +308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#==-instance_method" title="NgrokAPI::Models::EventTargetKinesis#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -308,7 +316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#==-instance_method" title="NgrokAPI::Models::SSHHostCertificate#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -316,7 +324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#==-instance_method" title="NgrokAPI::Models::SSHUserCertificate#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -324,7 +332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#==-instance_method" title="NgrokAPI::Models::AbuseReportHostname#== (method)">#==</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -332,7 +340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#==-instance_method" title="NgrokAPI::Models::CertificateAuthority#== (method)">#==</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -340,7 +348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#==-instance_method" title="NgrokAPI::Models::EventTargetFirehose#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -348,7 +356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#==-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#== (method)">#==</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -356,7 +364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#==-instance_method" title="NgrokAPI::Models::EndpointConfiguration#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -364,7 +372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -372,7 +380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -380,7 +388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -388,7 +396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#==-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -396,7 +404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -404,7 +412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -412,7 +420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#==-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -420,7 +428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#==-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -428,7 +436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -436,7 +444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -444,7 +452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -452,7 +460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#==-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -460,7 +468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#==-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -468,7 +476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -476,7 +484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#==-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -484,7 +492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -492,7 +500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -500,7 +508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#==-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -508,14 +516,6 @@ </li> - <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#== (method)">#==</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#abuse_reports-instance_method" title="NgrokAPI::Client#abuse_reports (method)">#abuse_reports</a></span> @@ -541,6 +541,14 @@ <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#acme_challenge_cname_target-instance_method" title="NgrokAPI::Models::ReservedDomain#acme_challenge_cname_target (method)">#acme_challenge_cname_target</a></span> + <small>NgrokAPI::Models::ReservedDomain</small> + </div> + </li> + + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#action-instance_method" title="NgrokAPI::Models::IPPolicy#action (method)">#action</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -548,7 +556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#add-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#add (method)">#add</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -556,7 +564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#add-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#add (method)">#add</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -564,7 +572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#addr-instance_method" title="NgrokAPI::Models::ReservedAddr#addr (method)">#addr</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -572,7 +580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#agent_version-instance_method" title="NgrokAPI::Models::TunnelSession#agent_version (method)">#agent_version</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -580,7 +588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#allow_idp_initiated-instance_method" title="NgrokAPI::Models::EndpointSAML#allow_idp_initiated (method)">#allow_idp_initiated</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -588,7 +596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#allow_idp_initiated-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#allow_idp_initiated (method)">#allow_idp_initiated</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -596,7 +604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#api_key-instance_method" title="NgrokAPI::HttpClient#api_key (method)">#api_key</a></span> <small>NgrokAPI::HttpClient</small> @@ -604,7 +612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#api_keys-instance_method" title="NgrokAPI::Client#api_keys (method)">#api_keys</a></span> <small>NgrokAPI::Client</small> @@ -612,7 +620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#assertion_consumer_service_url-instance_method" title="NgrokAPI::Models::EndpointSAML#assertion_consumer_service_url (method)">#assertion_consumer_service_url</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -620,7 +628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#auth-instance_method" title="NgrokAPI::Models::EventTargetKinesis#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -628,7 +636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#auth-instance_method" title="NgrokAPI::Models::EventTargetFirehose#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -636,7 +644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#auth-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -644,7 +652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#auth_check_interval-instance_method" title="NgrokAPI::Models::EndpointOAuth#auth_check_interval (method)">#auth_check_interval</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -652,7 +660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#authority-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#authority (method)">#authority</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -660,7 +668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#authorized_groups-instance_method" title="NgrokAPI::Models::EndpointSAML#authorized_groups (method)">#authorized_groups</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -668,7 +676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#authorized_groups-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#authorized_groups (method)">#authorized_groups</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -676,7 +684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#aws_access_key_id-instance_method" title="NgrokAPI::Models::AWSCredentials#aws_access_key_id (method)">#aws_access_key_id</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -684,7 +692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#aws_secret_access_key-instance_method" title="NgrokAPI::Models::AWSCredentials#aws_secret_access_key (method)">#aws_secret_access_key</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -692,7 +700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#backend-instance_method" title="NgrokAPI::Models::EndpointConfiguration#backend (method)">#backend</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -700,7 +708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#base_url-instance_method" title="NgrokAPI::HttpClient#base_url (method)">#base_url</a></span> <small>NgrokAPI::HttpClient</small> @@ -708,7 +716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#basic_auth-instance_method" title="NgrokAPI::Models::EndpointConfiguration#basic_auth (method)">#basic_auth</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -716,7 +724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#ca_pem-instance_method" title="NgrokAPI::Models::CertificateAuthority#ca_pem (method)">#ca_pem</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -724,7 +732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -732,7 +740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#certificate-instance_method" title="NgrokAPI::Models::SSHHostCertificate#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -740,7 +748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#certificate-instance_method" title="NgrokAPI::Models::SSHUserCertificate#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -748,7 +756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#certificate_authorities-instance_method" title="NgrokAPI::Client#certificate_authorities (method)">#certificate_authorities</a></span> <small>NgrokAPI::Client</small> @@ -756,7 +764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#certificate_authorities-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#certificate_authorities (method)">#certificate_authorities</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -764,7 +772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#certificate_authority_ids-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#certificate_authority_ids (method)">#certificate_authority_ids</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -772,7 +780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate_management_policy-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate_management_policy (method)">#certificate_management_policy</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -780,7 +788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate_management_status-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate_management_status (method)">#certificate_management_status</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -788,7 +796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#certificate_pem-instance_method" title="NgrokAPI::Models::TLSCertificate#certificate_pem (method)">#certificate_pem</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -796,7 +804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#cidr-instance_method" title="NgrokAPI::Models::IPPolicyRule#cidr (method)">#cidr</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -804,7 +812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#circuit_breaker-instance_method" title="NgrokAPI::Models::EndpointConfiguration#circuit_breaker (method)">#circuit_breaker</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -812,7 +820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Ref.html#client-instance_method" title="NgrokAPI::Models::Ref#client (method)">#client</a></span> <small>NgrokAPI::Models::Ref</small> @@ -820,7 +828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#client-instance_method" title="NgrokAPI::Models::Tunnel#client (method)">#client</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -828,7 +836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#client-instance_method" title="NgrokAPI::Models::APIKey#client (method)">#client</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -836,7 +844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/PagedIterator.html#client-instance_method" title="NgrokAPI::PagedIterator#client (method)">#client</a></span> <small>NgrokAPI::PagedIterator</small> @@ -844,7 +852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#client-instance_method" title="NgrokAPI::Models::AWSAuth#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -852,7 +860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#client-instance_method" title="NgrokAPI::Models::AWSRole#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -860,7 +868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#client-instance_method" title="NgrokAPI::Models::Listable#client (method)">#client</a></span> <small>NgrokAPI::Models::Listable</small> @@ -868,7 +876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#client-instance_method" title="NgrokAPI::Models::IPPolicy#client (method)">#client</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -876,7 +884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#client-instance_method" title="NgrokAPI::Models::Credential#client (method)">#client</a></span> <small>NgrokAPI::Models::Credential</small> @@ -884,7 +892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#client-instance_method" title="NgrokAPI::Models::AbuseReport#client (method)">#client</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -892,7 +900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSource.html#client-instance_method" title="NgrokAPI::Models::EventSource#client (method)">#client</a></span> <small>NgrokAPI::Models::EventSource</small> @@ -900,7 +908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#client-instance_method" title="NgrokAPI::Models::EventStream#client (method)">#client</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -908,7 +916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#client-instance_method" title="NgrokAPI::Models::EventTarget#client (method)">#client</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -916,7 +924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client-instance_method" title="NgrokAPI::Models::EndpointOIDC#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -924,7 +932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#client-instance_method" title="NgrokAPI::Models::EndpointSAML#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -932,7 +940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#client-instance_method" title="NgrokAPI::Models::ReservedAddr#client (method)">#client</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -940,7 +948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#client-instance_method" title="NgrokAPI::Models::IPPolicyRule#client (method)">#client</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -948,7 +956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#client-instance_method" title="NgrokAPI::Models::IPRestriction#client (method)">#client</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -956,7 +964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#client-instance_method" title="NgrokAPI::Models::SSHCredential#client (method)">#client</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -964,7 +972,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#client-instance_method" title="NgrokAPI::Models::TunnelSession#client (method)">#client</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -972,7 +980,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#client-instance_method" title="NgrokAPI::Models::AWSCredentials#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -980,7 +988,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#client-instance_method" title="NgrokAPI::Models::EndpointOAuth#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -988,7 +996,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#client-instance_method" title="NgrokAPI::Models::ReservedDomain#client (method)">#client</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -996,7 +1004,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#client-instance_method" title="NgrokAPI::Models::TLSCertificate#client (method)">#client</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -1004,7 +1012,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html#client-instance_method" title="NgrokAPI::Models::EndpointLogging#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointLogging</small> @@ -1012,7 +1020,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html#client-instance_method" title="NgrokAPI::Services::TunnelsClient#client (method)">#client</a></span> <small>NgrokAPI::Services::TunnelsClient</small> @@ -1020,7 +1028,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#client-instance_method" title="NgrokAPI::Models::EventDestination#client (method)">#client</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -1028,6 +1036,14 @@ </li> + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#client-instance_method" title="NgrokAPI::Models::EventSourceList#client (method)">#client</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#client-instance_method" title="NgrokAPI::Services::APIKeysClient#client (method)">#client</a></span> @@ -1437,14 +1453,6 @@ <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#client-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#client (method)">#client</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#client-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -1452,7 +1460,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#client-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -1460,7 +1468,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -1468,7 +1476,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#client-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -1476,7 +1484,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#client-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -1484,7 +1492,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -1492,7 +1500,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -1500,7 +1508,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -1508,7 +1516,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -1516,7 +1524,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#client-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -1524,7 +1532,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -1532,7 +1540,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -1540,7 +1548,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -1548,7 +1556,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -1556,7 +1564,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -1564,7 +1572,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOIDC#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1572,7 +1580,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -1580,7 +1588,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -1588,7 +1596,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -1596,7 +1604,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -1604,7 +1612,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOIDC#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1612,7 +1620,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -1620,7 +1628,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -1628,7 +1636,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -1636,7 +1644,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -1644,7 +1652,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#cloudwatch_logs-instance_method" title="NgrokAPI::Models::EventTarget#cloudwatch_logs (method)">#cloudwatch_logs</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -1652,7 +1660,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#cname_target-instance_method" title="NgrokAPI::Models::ReservedDomain#cname_target (method)">#cname_target</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -1660,7 +1668,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#compression-instance_method" title="NgrokAPI::Models::EndpointConfiguration#compression (method)">#compression</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -1668,7 +1676,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointOIDC#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1676,7 +1684,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointSAML#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -1684,7 +1692,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointOAuth#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -1692,7 +1700,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -1700,7 +1708,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#create-instance_method" title="NgrokAPI::Services::APIKeysClient#create (method)">#create</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -1708,7 +1716,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#create-instance_method" title="NgrokAPI::Services::CredentialsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -1716,7 +1724,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#create-instance_method" title="NgrokAPI::Services::IPPoliciesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -1724,7 +1732,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#create-instance_method" title="NgrokAPI::Services::IPWhitelistClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -1732,7 +1740,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html#create-instance_method" title="NgrokAPI::Services::AbuseReportsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::AbuseReportsClient</small> @@ -1740,7 +1748,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#create-instance_method" title="NgrokAPI::Services::EventSourcesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -1748,7 +1756,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#create-instance_method" title="NgrokAPI::Services::EventStreamsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -1756,7 +1764,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#create-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -1764,7 +1772,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#create-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -1772,7 +1780,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#create-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -1780,7 +1788,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#create-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -1788,7 +1796,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#create-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -1796,7 +1804,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -1804,7 +1812,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#create-instance_method" title="NgrokAPI::Services::EventDestinationsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -1812,7 +1820,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#create-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -1820,7 +1828,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -1828,7 +1836,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -1836,7 +1844,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#create-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -1844,7 +1852,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#create-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -1852,7 +1860,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#create-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -1860,7 +1868,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#created_at-instance_method" title="NgrokAPI::Models::APIKey#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -1868,7 +1876,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#created_at-instance_method" title="NgrokAPI::Models::IPPolicy#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -1876,7 +1884,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#created_at-instance_method" title="NgrokAPI::Models::Credential#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::Credential</small> @@ -1884,7 +1892,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#created_at-instance_method" title="NgrokAPI::Models::AbuseReport#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -1892,7 +1900,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#created_at-instance_method" title="NgrokAPI::Models::EventStream#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -1900,7 +1908,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#created_at-instance_method" title="NgrokAPI::Models::ReservedAddr#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -1908,7 +1916,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#created_at-instance_method" title="NgrokAPI::Models::IPPolicyRule#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -1916,7 +1924,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#created_at-instance_method" title="NgrokAPI::Models::IPRestriction#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -1924,7 +1932,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#created_at-instance_method" title="NgrokAPI::Models::SSHCredential#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -1932,7 +1940,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#created_at-instance_method" title="NgrokAPI::Models::ReservedDomain#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -1940,7 +1948,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#created_at-instance_method" title="NgrokAPI::Models::TLSCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -1948,7 +1956,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#created_at-instance_method" title="NgrokAPI::Models::EventDestination#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -1956,7 +1964,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#created_at-instance_method" title="NgrokAPI::Models::EventSubscription#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -1964,7 +1972,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#created_at-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -1972,7 +1980,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#created_at-instance_method" title="NgrokAPI::Models::SSHHostCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -1980,7 +1988,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#created_at-instance_method" title="NgrokAPI::Models::SSHUserCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -1988,7 +1996,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#created_at-instance_method" title="NgrokAPI::Models::CertificateAuthority#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -1996,7 +2004,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#created_at-instance_method" title="NgrokAPI::Models::EndpointConfiguration#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2004,7 +2012,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#created_at-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2012,7 +2020,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#credential-instance_method" title="NgrokAPI::Models::TunnelSession#credential (method)">#credential</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -2020,7 +2028,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#credentials-instance_method" title="NgrokAPI::Client#credentials (method)">#credentials</a></span> <small>NgrokAPI::Client</small> @@ -2028,7 +2036,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#creds-instance_method" title="NgrokAPI::Models::AWSAuth#creds (method)">#creds</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -2036,7 +2044,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#critical_options-instance_method" title="NgrokAPI::Models::SSHUserCertificate#critical_options (method)">#critical_options</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2044,7 +2052,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#debug-instance_method" title="NgrokAPI::Models::EventTarget#debug (method)">#debug</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -2052,7 +2060,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#delete-instance_method" title="NgrokAPI::HttpClient#delete (method)">#delete</a></span> <small>NgrokAPI::HttpClient</small> @@ -2060,7 +2068,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#delete-instance_method" title="NgrokAPI::Models::APIKey#delete (method)">#delete</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -2068,7 +2076,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#delete-instance_method" title="NgrokAPI::Models::IPPolicy#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -2076,7 +2084,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#delete-instance_method" title="NgrokAPI::Models::Credential#delete (method)">#delete</a></span> <small>NgrokAPI::Models::Credential</small> @@ -2084,7 +2092,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#delete-instance_method" title="NgrokAPI::Models::EventStream#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2092,7 +2100,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#delete-instance_method" title="NgrokAPI::Models::ReservedAddr#delete (method)">#delete</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -2100,7 +2108,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#delete-instance_method" title="NgrokAPI::Models::IPPolicyRule#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -2108,7 +2116,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#delete-instance_method" title="NgrokAPI::Models::IPRestriction#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -2116,7 +2124,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#delete-instance_method" title="NgrokAPI::Models::SSHCredential#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -2124,7 +2132,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#delete-instance_method" title="NgrokAPI::Models::ReservedDomain#delete (method)">#delete</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2132,7 +2140,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#delete-instance_method" title="NgrokAPI::Models::TLSCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -2140,7 +2148,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#delete-instance_method" title="NgrokAPI::Models::EventDestination#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -2148,7 +2156,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#delete-instance_method" title="NgrokAPI::Services::APIKeysClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -2156,7 +2164,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#delete-instance_method" title="NgrokAPI::Models::EventSubscription#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2164,7 +2172,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#delete-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -2172,7 +2180,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#delete-instance_method" title="NgrokAPI::Models::SSHHostCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -2180,7 +2188,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#delete-instance_method" title="NgrokAPI::Models::SSHUserCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2188,7 +2196,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#delete-instance_method" title="NgrokAPI::Services::CredentialsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -2196,7 +2204,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#delete-instance_method" title="NgrokAPI::Services::IPPoliciesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -2204,7 +2212,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#delete-instance_method" title="NgrokAPI::Models::CertificateAuthority#delete (method)">#delete</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -2212,7 +2220,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#delete-instance_method" title="NgrokAPI::Services::IPWhitelistClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -2220,7 +2228,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#delete-instance_method" title="NgrokAPI::Models::EndpointConfiguration#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2228,7 +2236,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#delete-instance_method" title="NgrokAPI::Services::EventSourcesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -2236,7 +2244,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#delete-instance_method" title="NgrokAPI::Services::EventStreamsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -2244,7 +2252,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2252,7 +2260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#delete-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -2260,7 +2268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#delete-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -2268,7 +2276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#delete-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -2276,7 +2284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#delete-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2284,7 +2292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2292,7 +2300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -2300,7 +2308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#delete-instance_method" title="NgrokAPI::Services::EventDestinationsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -2308,7 +2316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#delete-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -2316,7 +2324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -2324,7 +2332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -2332,7 +2340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -2340,7 +2348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -2348,7 +2356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -2356,7 +2364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#delete-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -2364,7 +2372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -2372,7 +2380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -2380,7 +2388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -2388,7 +2396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -2396,7 +2404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -2404,7 +2412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -2412,7 +2420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -2420,7 +2428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -2428,7 +2436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -2436,7 +2444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -2444,7 +2452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -2452,7 +2460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#delete!-instance_method" title="NgrokAPI::Services::APIKeysClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -2460,7 +2468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#delete!-instance_method" title="NgrokAPI::Services::CredentialsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -2468,7 +2476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#delete!-instance_method" title="NgrokAPI::Services::IPPoliciesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -2476,7 +2484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#delete!-instance_method" title="NgrokAPI::Services::IPWhitelistClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -2484,7 +2492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#delete!-instance_method" title="NgrokAPI::Services::EventSourcesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -2492,7 +2500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventStreamsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -2500,7 +2508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2508,7 +2516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#delete!-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -2516,7 +2524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#delete!-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -2524,7 +2532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -2532,7 +2540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2540,7 +2548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -2548,7 +2556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventDestinationsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -2556,7 +2564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -2564,7 +2572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -2572,7 +2580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -2580,7 +2588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -2588,7 +2596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -2596,7 +2604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -2604,7 +2612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#delete!-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -2612,7 +2620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -2620,7 +2628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -2628,7 +2636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -2636,7 +2644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -2644,7 +2652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -2652,7 +2660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -2660,7 +2668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -2668,7 +2676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -2676,7 +2684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -2684,7 +2692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -2692,7 +2700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -2700,7 +2708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate (method)">#delete_certificate</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2708,7 +2716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate! (method)">#delete_certificate!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2716,7 +2724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate_management_policy-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate_management_policy (method)">#delete_certificate_management_policy</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2724,7 +2732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate_management_policy!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate_management_policy! (method)">#delete_certificate_management_policy!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2732,7 +2740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete_endpoint_config (method)">#delete_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2740,7 +2748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete_endpoint_config! (method)">#delete_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2748,7 +2756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_http_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_http_endpoint_config (method)">#delete_http_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2756,7 +2764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_http_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_http_endpoint_config! (method)">#delete_http_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2764,7 +2772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_https_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_https_endpoint_config (method)">#delete_https_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2772,7 +2780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_https_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_https_endpoint_config! (method)">#delete_https_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2780,7 +2788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#delivery_stream_arn-instance_method" title="NgrokAPI::Models::EventTargetFirehose#delivery_stream_arn (method)">#delivery_stream_arn</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -2788,7 +2796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#description-instance_method" title="NgrokAPI::Models::APIKey#description (method)">#description</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -2796,7 +2804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#description-instance_method" title="NgrokAPI::Models::IPPolicy#description (method)">#description</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -2804,7 +2812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#description-instance_method" title="NgrokAPI::Models::Credential#description (method)">#description</a></span> <small>NgrokAPI::Models::Credential</small> @@ -2812,7 +2820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#description-instance_method" title="NgrokAPI::Models::EventStream#description (method)">#description</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2820,7 +2828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#description-instance_method" title="NgrokAPI::Models::ReservedAddr#description (method)">#description</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -2828,7 +2836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#description-instance_method" title="NgrokAPI::Models::IPPolicyRule#description (method)">#description</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -2836,7 +2844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#description-instance_method" title="NgrokAPI::Models::IPRestriction#description (method)">#description</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -2844,7 +2852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#description-instance_method" title="NgrokAPI::Models::SSHCredential#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -2852,7 +2860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#description-instance_method" title="NgrokAPI::Models::ReservedDomain#description (method)">#description</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2860,7 +2868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#description-instance_method" title="NgrokAPI::Models::TLSCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -2868,7 +2876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#description-instance_method" title="NgrokAPI::Models::EventDestination#description (method)">#description</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -2876,7 +2884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#description-instance_method" title="NgrokAPI::Models::EventSubscription#description (method)">#description</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2884,7 +2892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#description-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#description (method)">#description</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -2892,7 +2900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#description-instance_method" title="NgrokAPI::Models::SSHHostCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -2900,7 +2908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#description-instance_method" title="NgrokAPI::Models::SSHUserCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2908,7 +2916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#description-instance_method" title="NgrokAPI::Models::CertificateAuthority#description (method)">#description</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -2916,7 +2924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#description-instance_method" title="NgrokAPI::Models::EndpointConfiguration#description (method)">#description</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2924,7 +2932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#description-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2932,7 +2940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#destination_ids-instance_method" title="NgrokAPI::Models::EventStream#destination_ids (method)">#destination_ids</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2940,7 +2948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#destinations-instance_method" title="NgrokAPI::Models::EventSubscription#destinations (method)">#destinations</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2948,7 +2956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#dns_names-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#dns_names (method)">#dns_names</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -2956,7 +2964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#domain-instance_method" title="NgrokAPI::Models::ReservedDomain#domain (method)">#domain</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2964,6 +2972,14 @@ </li> + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/Listable.html#each-instance_method" title="NgrokAPI::Models::Listable#each (method)">#each</a></span> + <small>NgrokAPI::Models::Listable</small> + </div> + </li> + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#email_addresses-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#email_addresses (method)">#email_addresses</a></span> @@ -4445,6 +4461,14 @@ <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#initialize (method)">#initialize</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -4452,7 +4476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -4460,7 +4484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -4468,7 +4492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -4476,7 +4500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#initialize-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -4484,7 +4508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -4492,7 +4516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -4500,7 +4524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceReplace#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -4508,7 +4532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetKinesis#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -4516,7 +4540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -4524,7 +4548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -4532,7 +4556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -4540,7 +4564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -4548,7 +4572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#initialize-instance_method" title="NgrokAPI::Models::AbuseReportHostname#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -4556,7 +4580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -4564,7 +4588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetFirehose#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -4572,7 +4596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -4580,7 +4604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -4588,7 +4612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -4596,7 +4620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -4604,7 +4628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::AbuseReportsClient</small> @@ -4612,7 +4636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -4620,7 +4644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -4628,7 +4652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -4636,7 +4660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -4644,7 +4668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -4652,7 +4676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -4660,7 +4684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -4668,7 +4692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -4676,7 +4700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#initialize-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -4684,7 +4708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#initialize-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -4692,7 +4716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -4700,7 +4724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -4708,7 +4732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -4716,7 +4740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -4724,7 +4748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -4732,7 +4756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -4740,7 +4764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -4748,7 +4772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#initialize-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -4756,7 +4780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -4764,7 +4788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -4772,7 +4796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -4780,7 +4804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -4788,7 +4812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -4796,7 +4820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -4804,7 +4828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -4812,7 +4836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -4820,7 +4844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -4828,7 +4852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -4836,7 +4860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -4844,7 +4868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -4852,14 +4876,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#initialize (method)">#initialize</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">#initialize</a></span> @@ -5221,6 +5237,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#list-instance_method" title="NgrokAPI::Services::EventSourcesClient#list (method)">#list</a></span> + <small>NgrokAPI::Services::EventSourcesClient</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#list-instance_method" title="NgrokAPI::Services::EventStreamsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -5228,7 +5252,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#list-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -5236,7 +5260,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#list-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -5244,7 +5268,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#list-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -5252,7 +5276,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#list-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -5260,7 +5284,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#list-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -5268,7 +5292,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#list-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -5276,7 +5300,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -5284,7 +5308,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#list-instance_method" title="NgrokAPI::Services::EventDestinationsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -5292,7 +5316,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#list-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -5300,7 +5324,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -5308,7 +5332,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -5316,7 +5340,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#list-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -5324,7 +5348,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#list-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -5332,7 +5356,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#list-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -5340,6 +5364,174 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html#list!-instance_method" title="NgrokAPI::Services::TunnelsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TunnelsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#list!-instance_method" title="NgrokAPI::Services::APIKeysClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::APIKeysClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#list!-instance_method" title="NgrokAPI::Services::CredentialsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::CredentialsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#list!-instance_method" title="NgrokAPI::Services::IPPoliciesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPPoliciesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#list!-instance_method" title="NgrokAPI::Services::IPWhitelistClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPWhitelistClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#list!-instance_method" title="NgrokAPI::Services::EventSourcesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventSourcesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#list!-instance_method" title="NgrokAPI::Services::EventStreamsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventStreamsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#list!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::ReservedAddrsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#list!-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPPolicyRulesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#list!-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPRestrictionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#list!-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHCredentialsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#list!-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TunnelSessionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#list!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::ReservedDomainsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TLSCertificatesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#list!-instance_method" title="NgrokAPI::Services::EventDestinationsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventDestinationsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#list!-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventSubscriptionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHHostCertificatesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHUserCertificatesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#list!-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#list!-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EndpointConfigurationsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/PagedIterator.html#list_property-instance_method" title="NgrokAPI::PagedIterator#list_property (method)">#list_property</a></span> @@ -5637,14 +5829,6 @@ <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#nameservers-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#nameservers (method)">#nameservers</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#next_page_uri-instance_method" title="NgrokAPI::Models::Listable#next_page_uri (method)">#next_page_uri</a></span> <small>NgrokAPI::Models::Listable</small> @@ -5652,7 +5836,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#not_after-instance_method" title="NgrokAPI::Models::TLSCertificate#not_after (method)">#not_after</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5660,7 +5844,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#not_after-instance_method" title="NgrokAPI::Models::CertificateAuthority#not_after (method)">#not_after</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -5668,7 +5852,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#not_before-instance_method" title="NgrokAPI::Models::TLSCertificate#not_before (method)">#not_before</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5676,7 +5860,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#not_before-instance_method" title="NgrokAPI::Models::CertificateAuthority#not_before (method)">#not_before</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -5684,14 +5868,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#ns_targets-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#ns_targets (method)">#ns_targets</a></span> - <small>NgrokAPI::Models::ReservedDomainCertJob</small> - </div> - </li> - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#num_buckets-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#num_buckets (method)">#num_buckets</a></span> @@ -5781,6 +5957,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Client.html#pointcfg_module-instance_method" title="NgrokAPI::Client#pointcfg_module (method)">#pointcfg_module</a></span> + <small>NgrokAPI::Client</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#post-instance_method" title="NgrokAPI::HttpClient#post (method)">#post</a></span> <small>NgrokAPI::HttpClient</small> @@ -5788,7 +5972,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#principals-instance_method" title="NgrokAPI::Models::SSHHostCertificate#principals (method)">#principals</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -5796,7 +5980,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#principals-instance_method" title="NgrokAPI::Models::SSHUserCertificate#principals (method)">#principals</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -5804,7 +5988,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#private_key_type-instance_method" title="NgrokAPI::Models::TLSCertificate#private_key_type (method)">#private_key_type</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5812,7 +5996,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#private_key_type-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#private_key_type (method)">#private_key_type</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -5820,7 +6004,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#proto-instance_method" title="NgrokAPI::Models::Tunnel#proto (method)">#proto</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5828,7 +6012,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#provider-instance_method" title="NgrokAPI::Models::EndpointOAuth#provider (method)">#provider</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -5836,7 +6020,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#provider-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#provider (method)">#provider</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -5844,7 +6028,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#provisioning_job-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#provisioning_job (method)">#provisioning_job</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -5852,7 +6036,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#public_key-instance_method" title="NgrokAPI::Models::SSHCredential#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -5860,7 +6044,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#public_key-instance_method" title="NgrokAPI::Models::SSHHostCertificate#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -5868,7 +6052,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#public_key-instance_method" title="NgrokAPI::Models::SSHUserCertificate#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -5876,7 +6060,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#public_key-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -5884,7 +6068,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#public_url-instance_method" title="NgrokAPI::Models::Tunnel#public_url (method)">#public_url</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5892,7 +6076,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#region-instance_method" title="NgrokAPI::Models::Tunnel#region (method)">#region</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5900,7 +6084,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#region-instance_method" title="NgrokAPI::Models::ReservedAddr#region (method)">#region</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -5908,7 +6092,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#region-instance_method" title="NgrokAPI::Models::TunnelSession#region (method)">#region</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -5916,7 +6100,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#region-instance_method" title="NgrokAPI::Models::ReservedDomain#region (method)">#region</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -5924,7 +6108,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#remove-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#remove (method)">#remove</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -5932,7 +6116,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#remove-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#remove (method)">#remove</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -5940,7 +6124,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#renews_at-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#renews_at (method)">#renews_at</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -5948,7 +6132,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -5956,7 +6140,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -5964,7 +6148,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -5972,7 +6156,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -5980,7 +6164,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -5988,7 +6172,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -5996,7 +6180,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -6004,7 +6188,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -6012,7 +6196,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -6020,7 +6204,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -6028,7 +6212,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -6036,7 +6220,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -6044,7 +6228,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -6052,7 +6236,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -6060,7 +6244,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -6068,7 +6252,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -6076,7 +6260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -6084,7 +6268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -6092,7 +6276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -6100,7 +6284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -6108,7 +6292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -6116,7 +6300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -6124,7 +6308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -6132,7 +6316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -6140,7 +6324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#request_headers-instance_method" title="NgrokAPI::Models::EndpointConfiguration#request_headers (method)">#request_headers</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6148,7 +6332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#request_signing_certificate_pem-instance_method" title="NgrokAPI::Models::EndpointSAML#request_signing_certificate_pem (method)">#request_signing_certificate_pem</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6156,7 +6340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#reserved_addrs-instance_method" title="NgrokAPI::Client#reserved_addrs (method)">#reserved_addrs</a></span> <small>NgrokAPI::Client</small> @@ -6164,7 +6348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#reserved_domains-instance_method" title="NgrokAPI::Client#reserved_domains (method)">#reserved_domains</a></span> <small>NgrokAPI::Client</small> @@ -6172,7 +6356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Error.html#response-instance_method" title="NgrokAPI::Error#response (method)">#response</a></span> <small>NgrokAPI::Error</small> @@ -6180,7 +6364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html#response-instance_method" title="NgrokAPI::Errors::NotFoundError#response (method)">#response</a></span> <small>NgrokAPI::Errors::NotFoundError</small> @@ -6188,7 +6372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#response_headers-instance_method" title="NgrokAPI::Models::EndpointConfiguration#response_headers (method)">#response_headers</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6196,7 +6380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#restart-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#restart (method)">#restart</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -6204,7 +6388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#restart!-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#restart! (method)">#restart!</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -6212,7 +6396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Ref.html#result-instance_method" title="NgrokAPI::Models::Ref#result (method)">#result</a></span> <small>NgrokAPI::Models::Ref</small> @@ -6220,7 +6404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#result-instance_method" title="NgrokAPI::Models::Tunnel#result (method)">#result</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -6228,7 +6412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#result-instance_method" title="NgrokAPI::Models::APIKey#result (method)">#result</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -6236,7 +6420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#result-instance_method" title="NgrokAPI::Models::AWSAuth#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -6244,7 +6428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#result-instance_method" title="NgrokAPI::Models::AWSRole#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -6252,7 +6436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#result-instance_method" title="NgrokAPI::Models::Listable#result (method)">#result</a></span> <small>NgrokAPI::Models::Listable</small> @@ -6260,7 +6444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#result-instance_method" title="NgrokAPI::Models::IPPolicy#result (method)">#result</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -6268,7 +6452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#result-instance_method" title="NgrokAPI::Models::Credential#result (method)">#result</a></span> <small>NgrokAPI::Models::Credential</small> @@ -6276,7 +6460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#result-instance_method" title="NgrokAPI::Models::AbuseReport#result (method)">#result</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -6284,7 +6468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSource.html#result-instance_method" title="NgrokAPI::Models::EventSource#result (method)">#result</a></span> <small>NgrokAPI::Models::EventSource</small> @@ -6292,7 +6476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#result-instance_method" title="NgrokAPI::Models::EventStream#result (method)">#result</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -6300,7 +6484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#result-instance_method" title="NgrokAPI::Models::EventTarget#result (method)">#result</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -6308,7 +6492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#result-instance_method" title="NgrokAPI::Models::EndpointOIDC#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -6316,7 +6500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#result-instance_method" title="NgrokAPI::Models::EndpointSAML#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6324,7 +6508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#result-instance_method" title="NgrokAPI::Models::ReservedAddr#result (method)">#result</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -6332,7 +6516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#result-instance_method" title="NgrokAPI::Models::IPPolicyRule#result (method)">#result</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -6340,7 +6524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#result-instance_method" title="NgrokAPI::Models::IPRestriction#result (method)">#result</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -6348,7 +6532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#result-instance_method" title="NgrokAPI::Models::SSHCredential#result (method)">#result</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -6356,7 +6540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#result-instance_method" title="NgrokAPI::Models::TunnelSession#result (method)">#result</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -6364,7 +6548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#result-instance_method" title="NgrokAPI::Models::AWSCredentials#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -6372,7 +6556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#result-instance_method" title="NgrokAPI::Models::EndpointOAuth#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -6380,7 +6564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#result-instance_method" title="NgrokAPI::Models::ReservedDomain#result (method)">#result</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -6388,7 +6572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#result-instance_method" title="NgrokAPI::Models::TLSCertificate#result (method)">#result</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -6396,7 +6580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html#result-instance_method" title="NgrokAPI::Models::EndpointLogging#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointLogging</small> @@ -6404,7 +6588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#result-instance_method" title="NgrokAPI::Models::EventDestination#result (method)">#result</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -6412,6 +6596,14 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#result-instance_method" title="NgrokAPI::Models::EventSourceList#result (method)">#result</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#result-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#result (method)">#result</a></span> @@ -6677,14 +6869,6 @@ <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#result-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#result (method)">#result</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#retries_at-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#retries_at (method)">#retries_at</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -6692,7 +6876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#role-instance_method" title="NgrokAPI::Models::AWSAuth#role (method)">#role</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -6700,7 +6884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#role_arn-instance_method" title="NgrokAPI::Models::AWSRole#role_arn (method)">#role_arn</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -6708,7 +6892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#rolling_window-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#rolling_window (method)">#rolling_window</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -6716,7 +6900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#saml-instance_method" title="NgrokAPI::Models::EndpointConfiguration#saml (method)">#saml</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6724,7 +6908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#sampling_rate-instance_method" title="NgrokAPI::Models::EventStream#sampling_rate (method)">#sampling_rate</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -6732,7 +6916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOIDC#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -6740,7 +6924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -6748,7 +6932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -6756,7 +6940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -6764,7 +6948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -6772,7 +6956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#secret-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#secret (method)">#secret</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -6780,7 +6964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#serial_number-instance_method" title="NgrokAPI::Models::TLSCertificate#serial_number (method)">#serial_number</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -6788,7 +6972,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#single_logout_url-instance_method" title="NgrokAPI::Models::EndpointSAML#single_logout_url (method)">#single_logout_url</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6796,6 +6980,14 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#sources-instance_method" title="NgrokAPI::Models::EventSourceList#sources (method)">#sources</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#sources-instance_method" title="NgrokAPI::Models::EventSubscription#sources (method)">#sources</a></span> @@ -7221,6 +7413,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#to_s-instance_method" title="NgrokAPI::Models::EventSourceList#to_s (method)">#to_s</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#to_s-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -7228,7 +7428,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#to_s-instance_method" title="NgrokAPI::Models::EventSubscription#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -7236,7 +7436,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#to_s-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -7244,7 +7444,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#to_s-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -7252,7 +7452,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#to_s-instance_method" title="NgrokAPI::Models::EndpointCompression#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -7260,7 +7460,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -7268,7 +7468,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#to_s-instance_method" title="NgrokAPI::Models::EventSourceReplace#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -7276,7 +7476,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetKinesis#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -7284,7 +7484,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#to_s-instance_method" title="NgrokAPI::Models::SSHHostCertificate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -7292,7 +7492,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#to_s-instance_method" title="NgrokAPI::Models::SSHUserCertificate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -7300,7 +7500,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#to_s-instance_method" title="NgrokAPI::Models::AbuseReportHostname#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -7308,7 +7508,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#to_s-instance_method" title="NgrokAPI::Models::CertificateAuthority#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -7316,7 +7516,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetFirehose#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -7324,7 +7524,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#to_s-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -7332,7 +7532,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#to_s-instance_method" title="NgrokAPI::Models::EndpointConfiguration#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -7340,7 +7540,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -7348,7 +7548,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -7356,7 +7556,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -7364,7 +7564,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#to_s-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -7372,7 +7572,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -7380,7 +7580,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -7388,7 +7588,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#to_s-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -7396,7 +7596,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#to_s-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -7404,7 +7604,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -7412,7 +7612,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -7420,7 +7620,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -7428,7 +7628,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#to_s-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -7436,7 +7636,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#to_s-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -7444,7 +7644,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -7452,7 +7652,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#to_s-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -7460,7 +7660,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -7468,7 +7668,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -7476,7 +7676,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -7484,14 +7684,6 @@ </li> - <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#to_s (method)">#to_s</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#token-instance_method" title="NgrokAPI::Models::APIKey#token (method)">#token</a></span> @@ -8133,6 +8325,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#uri-instance_method" title="NgrokAPI::Models::EventSourceList#uri (method)">#uri</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#uri-instance_method" title="NgrokAPI::Models::EventSubscription#uri (method)">#uri</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -8140,7 +8340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#uri-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#uri (method)">#uri</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -8148,7 +8348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#uri-instance_method" title="NgrokAPI::Models::SSHHostCertificate#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8156,7 +8356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#uri-instance_method" title="NgrokAPI::Models::SSHUserCertificate#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8164,7 +8364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#uri-instance_method" title="NgrokAPI::Models::CertificateAuthority#uri (method)">#uri</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -8172,7 +8372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#uri-instance_method" title="NgrokAPI::Models::EndpointConfiguration#uri (method)">#uri</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -8180,7 +8380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#uri-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -8188,7 +8388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#urls-instance_method" title="NgrokAPI::Models::AbuseReport#urls (method)">#urls</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -8196,7 +8396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#valid_after-instance_method" title="NgrokAPI::Models::SSHHostCertificate#valid_after (method)">#valid_after</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8204,7 +8404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#valid_after-instance_method" title="NgrokAPI::Models::SSHUserCertificate#valid_after (method)">#valid_after</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8212,7 +8412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#valid_until-instance_method" title="NgrokAPI::Models::SSHHostCertificate#valid_until (method)">#valid_until</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8220,7 +8420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#valid_until-instance_method" title="NgrokAPI::Models::SSHUserCertificate#valid_until (method)">#valid_until</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8228,7 +8428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#volume_threshold-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#volume_threshold (method)">#volume_threshold</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -8236,7 +8436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#webhook_validation-instance_method" title="NgrokAPI::Models::EndpointConfiguration#webhook_validation (method)">#webhook_validation</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -8244,14 +8444,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#zone-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#zone (method)">#zone</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - </ul> </div> diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 8743aa2..dd4a689 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -100,7 +100,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index b381bf5..0000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -ruby-api.docs.ngrok.com \ No newline at end of file diff --git a/docs/NgrokAPI.html b/docs/NgrokAPI.html index d1b1a63..2545e7d 100644 --- a/docs/NgrokAPI.html +++ b/docs/NgrokAPI.html @@ -79,7 +79,7 @@ <dl> <dt>Defined in:</dt> <dd>lib/ngrokapi.rb<span class="defines">,<br /> - lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_ns_target.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span> + lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span> </dd> </dl> @@ -147,7 +147,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Client.html b/docs/NgrokAPI/Client.html index e29dcac..695eb73 100644 --- a/docs/NgrokAPI/Client.html +++ b/docs/NgrokAPI/Client.html @@ -143,7 +143,7 @@ <span class="summary_desc"><div class='inline'> -<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p> +<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p> </div></span> </li> @@ -167,7 +167,7 @@ <span class="summary_desc"><div class='inline'> -<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a> API.</p> +<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>.</p> </div></span> </li> @@ -191,7 +191,7 @@ <span class="summary_desc"><div class='inline'> -<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p> +<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p> </div></span> </li> @@ -239,7 +239,7 @@ <span class="summary_desc"><div class='inline'> -<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p> +<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p> </div></span> </li> @@ -377,7 +377,7 @@ <span class="summary_desc"><div class='inline'> -<p>IP Policies are reusable groups of CIDR ranges with an allow or deny action.</p> +<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action.</p> </div></span> </li> @@ -401,7 +401,7 @@ <span class="summary_desc"><div class='inline'> -<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p> +<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p> </div></span> </li> @@ -425,7 +425,7 @@ <span class="summary_desc"><div class='inline'> -<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p> +<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p> </div></span> </li> @@ -452,6 +452,28 @@ <p>The IP Whitelist is deprecated and will be removed.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#pointcfg_module-instance_method" title="#pointcfg_module (instance method)">#<strong>pointcfg_module</strong> ⇒ Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + </li> @@ -521,7 +543,7 @@ <span class="summary_desc"><div class='inline'> -<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p> +<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p> </div></span> </li> @@ -545,7 +567,7 @@ <span class="summary_desc"><div class='inline'> -<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p> +<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p> </div></span> </li> @@ -569,7 +591,7 @@ <span class="summary_desc"><div class='inline'> -<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p> +<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p> </div></span> </li> @@ -593,7 +615,7 @@ <span class="summary_desc"><div class='inline'> -<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p> +<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p> </div></span> </li> @@ -617,7 +639,7 @@ <span class="summary_desc"><div class='inline'> -<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p> +<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p> </div></span> </li> @@ -641,7 +663,7 @@ <span class="summary_desc"><div class='inline'> -<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p> +<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p> </div></span> </li> @@ -665,7 +687,7 @@ <span class="summary_desc"><div class='inline'> -<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p> +<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p> </div></span> </li> @@ -703,15 +725,15 @@ <pre class="lines"> -8 -9 10 11 12 -13</pre> +13 +14 +15</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='label'>api_key:</span><span class='comma'>,</span> @@ -743,10 +765,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p> - -<pre class="code ruby"><code class="ruby">ngrok that violate ngrok's terms of service. -</code></pre> +<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p> </div> @@ -773,12 +792,12 @@ <pre class="lines"> -20 -21 -22</pre> +22 +23 +24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 20</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_abuse_reports'>abuse_reports</span> <span class='ivar'>@_abuse_reports</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -800,13 +819,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p> - -<pre class="code ruby"><code class="ruby">API. You may use the API itself -to provision and manage API Keys but you'll need to provision your first API -key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your -ngrok.com dashboard. -</code></pre> +<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p> </div> @@ -833,12 +846,12 @@ ngrok.com dashboard. <pre class="lines"> -33 34 -35</pre> +35 +36</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 33</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 34</span> <span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span> <span class='ivar'>@_api_keys</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -860,13 +873,7 @@ ngrok.com dashboard. </h3><div class="docstring"> <div class="discussion"> -<p>Certificate Authorities are x509 certificates that are used to sign other</p> - -<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module -to verify that the TLS certificate presented by a client has been signed by -this CA. Certificate Authorities are used only for mTLS validation only and -thus a private key is not included in the resource. -</code></pre> +<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p> </div> @@ -893,12 +900,12 @@ thus a private key is not included in the resource. <pre class="lines"> -45 46 -47</pre> +47 +48</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 46</span> <span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span> <span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -920,12 +927,7 @@ thus a private key is not included in the resource. </h3><div class="docstring"> <div class="discussion"> -<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p> - -<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with -the ngrok authtoken command or by specifying it in the ngrok.yml -configuration file with the authtoken property. -</code></pre> +<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p> </div> @@ -952,12 +954,12 @@ configuration file with the authtoken property. <pre class="lines"> -56 57 -58</pre> +58 +59</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 56</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 57</span> <span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span> <span class='ivar'>@_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -979,11 +981,7 @@ configuration file with the authtoken property. </h3><div class="docstring"> <div class="discussion"> -<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p> - -<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only -applied to Domains and TCP Addresses they have been attached to. -</code></pre> +<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p> </div> @@ -1010,12 +1008,12 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -66 67 -68</pre> +68 +69</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 66</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 67</span> <span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span> <span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1040,12 +1038,12 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -74 75 -76</pre> +76 +77</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 74</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 75</span> <span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span> <span class='ivar'>@_event_destinations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1070,12 +1068,12 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -82 83 -84</pre> +84 +85</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 82</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 83</span> <span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span> <span class='ivar'>@_event_sources</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1100,12 +1098,12 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -70 71 -72</pre> +72 +73</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 70</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 71</span> <span class='kw'>def</span> <span class='id identifier rubyid_event_streams'>event_streams</span> <span class='ivar'>@_event_streams</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1130,12 +1128,12 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -78 79 -80</pre> +80 +81</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 78</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 79</span> <span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span> <span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1157,12 +1155,7 @@ applied to Domains and TCP Addresses they have been attached to. </h3><div class="docstring"> <div class="discussion"> -<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p> - -<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP -Policy module. They can also be used with IP Restrictions to control source -IP ranges that can start tunnel sessions and connect to the API and dashboard. -</code></pre> +<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p> </div> @@ -1189,12 +1182,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -93 94 -95</pre> +95 +96</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 93</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 94</span> <span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span> <span class='ivar'>@_ip_policies</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1216,10 +1209,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </h3><div class="docstring"> <div class="discussion"> -<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p> - -<pre class="code ruby"><code class="ruby">make up an IP Policy. -</code></pre> +<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p> </div> @@ -1246,12 +1236,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -102 103 -104</pre> +104 +105</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 102</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 103</span> <span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span> <span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1273,14 +1263,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </h3><div class="docstring"> <div class="discussion"> -<p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p> - -<pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP -restriction has a type which defines the ingress it applies to. IP -restrictions can be used to enforce the source IPs that can make API -requests, log in to the dashboard, start ngrok agents, and connect to your -public-facing endpoints. -</code></pre> +<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p> </div> @@ -1307,12 +1290,12 @@ public-facing endpoints. <pre class="lines"> -115 116 -117</pre> +117 +118</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 115</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 116</span> <span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span> <span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1334,10 +1317,7 @@ public-facing endpoints. </h3><div class="docstring"> <div class="discussion"> -<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p> - -<pre class="code ruby"><code class="ruby">with an endpoints type instead. -</code></pre> +<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p> </div> @@ -1364,12 +1344,12 @@ public-facing endpoints. <pre class="lines"> -124 125 -126</pre> +126 +127</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 124</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 125</span> <span class='kw'>def</span> <span class='id identifier rubyid_ip_whitelist'>ip_whitelist</span> <span class='ivar'>@_ip_whitelist</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1377,6 +1357,64 @@ public-facing endpoints. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="pointcfg_module-instance_method"> + + #<strong>pointcfg_module</strong> ⇒ <tt>Object</tt> + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 219</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_pointcfg_module'>pointcfg_module</span> + <span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_logging'>logging</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_compression'>compression</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_response_headers'>response_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oauth'>oauth</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_saml'>saml</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oidc'>oidc</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> + + <span class='id identifier rubyid_ns'>ns</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1391,11 +1429,7 @@ public-facing endpoints. </h3><div class="docstring"> <div class="discussion"> -<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p> - -<pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be -chosen. -</code></pre> +<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p> </div> @@ -1422,12 +1456,12 @@ chosen. <pre class="lines"> -134 135 -136</pre> +136 +137</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 134</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 135</span> <span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span> <span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1449,12 +1483,7 @@ chosen. </h3><div class="docstring"> <div class="discussion"> -<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p> - -<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain -that you own by creating a CNAME record specified in the returned resource. -This CNAME record points traffic for that domain to ngrok's edge servers. -</code></pre> +<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.</p> </div> @@ -1481,12 +1510,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -145 146 -147</pre> +147 +148</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 145</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 146</span> <span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span> <span class='ivar'>@_reserved_domains</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1508,10 +1537,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </h3><div class="docstring"> <div class="discussion"> -<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates. -</code></pre> +<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p> </div> @@ -1538,12 +1564,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -154 155 -156</pre> +156 +157</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 154</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 155</span> <span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span> <span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1565,10 +1591,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </h3><div class="docstring"> <div class="discussion"> -<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p> - -<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway. -</code></pre> +<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p> </div> @@ -1595,12 +1618,12 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -163 164 -165</pre> +165 +166</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 164</span> <span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span> <span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1622,11 +1645,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </h3><div class="docstring"> <div class="discussion"> -<p>SSH Host Certificates along with the corresponding private key allows an SSH</p> - -<pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the -SSH Certificate Authority that was used to sign the certificate. -</code></pre> +<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p> </div> @@ -1653,12 +1672,12 @@ SSH Certificate Authority that was used to sign the certificate. <pre class="lines"> -173 174 -175</pre> +175 +176</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 173</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 174</span> <span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span> <span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1680,11 +1699,7 @@ SSH Certificate Authority that was used to sign the certificate. </h3><div class="docstring"> <div class="discussion"> -<p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p> - -<pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH -Certificate Authority used to sign the certificate. -</code></pre> +<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p> </div> @@ -1711,12 +1726,12 @@ Certificate Authority used to sign the certificate. <pre class="lines"> -183 184 -185</pre> +185 +186</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 183</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 184</span> <span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span> <span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1738,13 +1753,7 @@ Certificate Authority used to sign the certificate. </h3><div class="docstring"> <div class="discussion"> -<p>TLS Certificates are pairs of x509 certificates and their matching private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused -until they are attached to a Domain. TLS Certificates may also be -provisioned by ngrok automatically for domains on which you have enabled -automated certificate provisioning. -</code></pre> +<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p> </div> @@ -1771,12 +1780,12 @@ automated certificate provisioning. <pre class="lines"> -195 196 -197</pre> +197 +198</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 195</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 196</span> <span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span> <span class='ivar'>@_tls_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1798,11 +1807,7 @@ automated certificate provisioning. </h3><div class="docstring"> <div class="discussion"> -<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p> - -<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel -session can include one or more Tunnels. -</code></pre> +<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p> </div> @@ -1829,12 +1834,12 @@ session can include one or more Tunnels. <pre class="lines"> -205 206 -207</pre> +207 +208</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 205</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 206</span> <span class='kw'>def</span> <span class='id identifier rubyid_tunnel_sessions'>tunnel_sessions</span> <span class='ivar'>@_tunnel_sessions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1856,10 +1861,7 @@ session can include one or more Tunnels. </h3><div class="docstring"> <div class="discussion"> -<p>Tunnels provide endpoints to access services exposed by a running ngrok</p> - -<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session. -</code></pre> +<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p> </div> @@ -1886,12 +1888,12 @@ session can include one or more Tunnels. <pre class="lines"> -214 215 -216</pre> +216 +217</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 214</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 215</span> <span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span> <span class='ivar'>@_tunnels</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span> @@ -1906,7 +1908,7 @@ session can include one or more Tunnels. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Error.html b/docs/NgrokAPI/Error.html index 4a054f2..cb2daed 100644 --- a/docs/NgrokAPI/Error.html +++ b/docs/NgrokAPI/Error.html @@ -295,7 +295,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Errors.html b/docs/NgrokAPI/Errors.html index da40ae2..bbce45d 100644 --- a/docs/NgrokAPI/Errors.html +++ b/docs/NgrokAPI/Errors.html @@ -105,7 +105,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Errors/NotFoundError.html b/docs/NgrokAPI/Errors/NotFoundError.html index 9ae67da..b6cd8da 100644 --- a/docs/NgrokAPI/Errors/NotFoundError.html +++ b/docs/NgrokAPI/Errors/NotFoundError.html @@ -299,7 +299,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/HttpClient.html b/docs/NgrokAPI/HttpClient.html index ebdf903..4cd7f19 100644 --- a/docs/NgrokAPI/HttpClient.html +++ b/docs/NgrokAPI/HttpClient.html @@ -265,7 +265,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, path: nil, url: nil) ⇒ json </a> + <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(danger: false, before_id: nil, limit: nil, path: nil, url: nil) ⇒ json </a> @@ -280,7 +280,7 @@ <span class="summary_desc"><div class='inline'> -<p>Make a GET request.</p> +<p>Make a GET request to list resources.</p> </div></span> </li> @@ -705,7 +705,7 @@ <div class="method_details "> <h3 class="signature " id="list-instance_method"> - #<strong>list</strong>(before_id: nil, limit: nil, path: nil, url: nil) ⇒ <tt>json</tt> + #<strong>list</strong>(danger: false, before_id: nil, limit: nil, path: nil, url: nil) ⇒ <tt>json</tt> @@ -714,7 +714,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Make a GET request</p> +<p>Make a GET request to list resources</p> </div> @@ -723,6 +723,24 @@ <p class="tag_title">Parameters:</p> <ul class="param"> + <li> + + <span class='name'>danger</span> + + + <span class='type'>(<tt>boolean</tt>)</span> + + + <em class="default">(defaults to: <tt>false</tt>)</em> + + + — + <div class='inline'> +<p>determine if we should throw an exception on 404 or not</p> +</div> + + </li> + <li> <span class='name'>before_id</span> @@ -788,6 +806,24 @@ <em class="default">(defaults to: <tt>nil</tt>)</em> + — + <div class='inline'> +<p>Full URL of the resource, mutually exclusive with path</p> +</div> + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + — <div class='inline'> <p>Full URL of the resource, mutually exclusive with path</p> @@ -822,8 +858,6 @@ <pre class="lines"> -52 -53 54 55 56 @@ -831,19 +865,21 @@ 58 59 60 -61</pre> +61 +62 +63</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 52</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 54</span> -<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'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span> +<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span> <span class='kw'>else</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:before_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_before_id'>before_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_before_id'>before_id</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_limit'>limit</span> <span class='kw'>if</span> <span class='id identifier rubyid_limit'>limit</span> - <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> + <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> @@ -951,14 +987,14 @@ <pre class="lines"> -70 -71 72 73 -74</pre> +74 +75 +76</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 70</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 72</span> <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> @@ -1070,14 +1106,14 @@ <pre class="lines"> -83 -84 85 86 -87</pre> +87 +88 +89</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 83</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 85</span> <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> @@ -1094,7 +1130,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models.html b/docs/NgrokAPI/Models.html index 0547e73..7e3752c 100644 --- a/docs/NgrokAPI/Models.html +++ b/docs/NgrokAPI/Models.html @@ -79,7 +79,7 @@ <dl> <dt>Defined in:</dt> <dd>lib/ngrokapi/models/ref.rb<span class="defines">,<br /> - lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_ns_target.rb</span> + lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb</span> </dd> </dl> @@ -91,7 +91,7 @@ - <strong class="classes">Classes:</strong> <span class='object_link'><a href="Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span>, <span class='object_link'><a href="Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span>, <span class='object_link'><a href="Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span>, <span class='object_link'><a href="Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span>, <span class='object_link'><a href="Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span>, <span class='object_link'><a href="Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span>, <span class='object_link'><a href="Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span>, <span class='object_link'><a href="Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span>, <span class='object_link'><a href="Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span>, <span class='object_link'><a href="Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span>, <span class='object_link'><a href="Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span>, <span class='object_link'><a href="Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span>, <span class='object_link'><a href="Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span>, <span class='object_link'><a href="Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span>, <span class='object_link'><a href="Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span>, <span class='object_link'><a href="Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span>, <span class='object_link'><a href="Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span>, <span class='object_link'><a href="Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span>, <span class='object_link'><a href="Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span>, <span class='object_link'><a href="Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span>, <span class='object_link'><a href="Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span>, <span class='object_link'><a href="Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span>, <span class='object_link'><a href="Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span>, <span class='object_link'><a href="Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span>, <span class='object_link'><a href="Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span>, <span class='object_link'><a href="Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span>, <span class='object_link'><a href="Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span>, <span class='object_link'><a href="Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span>, <span class='object_link'><a href="Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span>, <span class='object_link'><a href="Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span>, <span class='object_link'><a href="Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span>, <span class='object_link'><a href="Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span>, <span class='object_link'><a href="Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span>, <span class='object_link'><a href="Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span>, <span class='object_link'><a href="Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span>, <span class='object_link'><a href="Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span>, <span class='object_link'><a href="Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span>, <span class='object_link'><a href="Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span>, <span class='object_link'><a href="Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span>, <span class='object_link'><a href="Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span>, <span class='object_link'><a href="Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span>, <span class='object_link'><a href="Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span>, <span class='object_link'><a href="Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span>, <span class='object_link'><a href="Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span>, <span class='object_link'><a href="Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span>, <span class='object_link'><a href="Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span>, <span class='object_link'><a href="Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span>, <span class='object_link'><a href="Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span>, <span class='object_link'><a href="Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> + <strong class="classes">Classes:</strong> <span class='object_link'><a href="Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span>, <span class='object_link'><a href="Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span>, <span class='object_link'><a href="Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span>, <span class='object_link'><a href="Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span>, <span class='object_link'><a href="Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span>, <span class='object_link'><a href="Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span>, <span class='object_link'><a href="Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span>, <span class='object_link'><a href="Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span>, <span class='object_link'><a href="Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span>, <span class='object_link'><a href="Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span>, <span class='object_link'><a href="Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span>, <span class='object_link'><a href="Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span>, <span class='object_link'><a href="Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span>, <span class='object_link'><a href="Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span>, <span class='object_link'><a href="Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span>, <span class='object_link'><a href="Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span>, <span class='object_link'><a href="Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span>, <span class='object_link'><a href="Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span>, <span class='object_link'><a href="Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span>, <span class='object_link'><a href="Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span>, <span class='object_link'><a href="Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span>, <span class='object_link'><a href="Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span>, <span class='object_link'><a href="Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span>, <span class='object_link'><a href="Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span>, <span class='object_link'><a href="Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span>, <span class='object_link'><a href="Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span>, <span class='object_link'><a href="Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span>, <span class='object_link'><a href="Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span>, <span class='object_link'><a href="Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span>, <span class='object_link'><a href="Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span>, <span class='object_link'><a href="Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span>, <span class='object_link'><a href="Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span>, <span class='object_link'><a href="Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span>, <span class='object_link'><a href="Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span>, <span class='object_link'><a href="Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span>, <span class='object_link'><a href="Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span>, <span class='object_link'><a href="Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span>, <span class='object_link'><a href="Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span>, <span class='object_link'><a href="Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span>, <span class='object_link'><a href="Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span>, <span class='object_link'><a href="Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span>, <span class='object_link'><a href="Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span>, <span class='object_link'><a href="Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span>, <span class='object_link'><a href="Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span>, <span class='object_link'><a href="Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span>, <span class='object_link'><a href="Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span>, <span class='object_link'><a href="Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span>, <span class='object_link'><a href="Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span>, <span class='object_link'><a href="Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span>, <span class='object_link'><a href="Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> </p> @@ -107,7 +107,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/APIKey.html b/docs/NgrokAPI/Models/APIKey.html index 5a556ef..393429f 100644 --- a/docs/NgrokAPI/Models/APIKey.html +++ b/docs/NgrokAPI/Models/APIKey.html @@ -1059,7 +1059,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/AWSAuth.html b/docs/NgrokAPI/Models/AWSAuth.html index 1c60506..6fc4f6b 100644 --- a/docs/NgrokAPI/Models/AWSAuth.html +++ b/docs/NgrokAPI/Models/AWSAuth.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/AWSCredentials.html b/docs/NgrokAPI/Models/AWSCredentials.html index 9ba8ccb..9ba3660 100644 --- a/docs/NgrokAPI/Models/AWSCredentials.html +++ b/docs/NgrokAPI/Models/AWSCredentials.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/AWSRole.html b/docs/NgrokAPI/Models/AWSRole.html index 2735a2c..932daf6 100644 --- a/docs/NgrokAPI/Models/AWSRole.html +++ b/docs/NgrokAPI/Models/AWSRole.html @@ -533,7 +533,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/AbuseReport.html b/docs/NgrokAPI/Models/AbuseReport.html index 74f263e..b0d747c 100644 --- a/docs/NgrokAPI/Models/AbuseReport.html +++ b/docs/NgrokAPI/Models/AbuseReport.html @@ -977,7 +977,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/AbuseReportHostname.html b/docs/NgrokAPI/Models/AbuseReportHostname.html index 0dcd4e4..676f67f 100644 --- a/docs/NgrokAPI/Models/AbuseReportHostname.html +++ b/docs/NgrokAPI/Models/AbuseReportHostname.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/CertificateAuthority.html b/docs/NgrokAPI/Models/CertificateAuthority.html index ae2f393..8676b71 100644 --- a/docs/NgrokAPI/Models/CertificateAuthority.html +++ b/docs/NgrokAPI/Models/CertificateAuthority.html @@ -1429,7 +1429,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/Credential.html b/docs/NgrokAPI/Models/Credential.html index 86f98cc..c2b5ac0 100644 --- a/docs/NgrokAPI/Models/Credential.html +++ b/docs/NgrokAPI/Models/Credential.html @@ -1139,7 +1139,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html index a80fff5..8f68967 100644 --- a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -903,7 +903,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointCompression.html b/docs/NgrokAPI/Models/EndpointCompression.html index c61ab35..88a522d 100644 --- a/docs/NgrokAPI/Models/EndpointCompression.html +++ b/docs/NgrokAPI/Models/EndpointCompression.html @@ -533,7 +533,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointConfiguration.html b/docs/NgrokAPI/Models/EndpointConfiguration.html index e05065c..efc4dfd 100644 --- a/docs/NgrokAPI/Models/EndpointConfiguration.html +++ b/docs/NgrokAPI/Models/EndpointConfiguration.html @@ -2167,7 +2167,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointIPPolicy.html b/docs/NgrokAPI/Models/EndpointIPPolicy.html index 421827d..995574a 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicy.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicy.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html index 1bb2600..b39a331 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointLogging.html b/docs/NgrokAPI/Models/EndpointLogging.html index df8f1d4..cf08dfb 100644 --- a/docs/NgrokAPI/Models/EndpointLogging.html +++ b/docs/NgrokAPI/Models/EndpointLogging.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointLoggingMutate.html b/docs/NgrokAPI/Models/EndpointLoggingMutate.html index 6b79c6c..8e9d708 100644 --- a/docs/NgrokAPI/Models/EndpointLoggingMutate.html +++ b/docs/NgrokAPI/Models/EndpointLoggingMutate.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointMutualTLS.html b/docs/NgrokAPI/Models/EndpointMutualTLS.html index c2d1c4f..5b511e3 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLS.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLS.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html index ab6be7f..f2ca9de 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuth.html b/docs/NgrokAPI/Models/EndpointOAuth.html index c683c15..82e541b 100644 --- a/docs/NgrokAPI/Models/EndpointOAuth.html +++ b/docs/NgrokAPI/Models/EndpointOAuth.html @@ -977,7 +977,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html index e6df671..f0107fa 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -829,7 +829,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html index bb02618..6a605fe 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -977,7 +977,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html index 6d4ad26..b90a400 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -829,7 +829,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 3c43cc9..891d87e 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -829,7 +829,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOAuthProvider.html b/docs/NgrokAPI/Models/EndpointOAuthProvider.html index 04a9ce9..864a353 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/docs/NgrokAPI/Models/EndpointOAuthProvider.html @@ -755,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointOIDC.html b/docs/NgrokAPI/Models/EndpointOIDC.html index cdf58d1..e5ea218 100644 --- a/docs/NgrokAPI/Models/EndpointOIDC.html +++ b/docs/NgrokAPI/Models/EndpointOIDC.html @@ -1125,7 +1125,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointRequestHeaders.html b/docs/NgrokAPI/Models/EndpointRequestHeaders.html index e32dbec..eb158a9 100644 --- a/docs/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/docs/NgrokAPI/Models/EndpointRequestHeaders.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointResponseHeaders.html b/docs/NgrokAPI/Models/EndpointResponseHeaders.html index 7cb6b75..a408c03 100644 --- a/docs/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/docs/NgrokAPI/Models/EndpointResponseHeaders.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointSAML.html b/docs/NgrokAPI/Models/EndpointSAML.html index 60e3dad..761a8b4 100644 --- a/docs/NgrokAPI/Models/EndpointSAML.html +++ b/docs/NgrokAPI/Models/EndpointSAML.html @@ -1643,7 +1643,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointSAMLMutate.html b/docs/NgrokAPI/Models/EndpointSAMLMutate.html index 889cca5..154233f 100644 --- a/docs/NgrokAPI/Models/EndpointSAMLMutate.html +++ b/docs/NgrokAPI/Models/EndpointSAMLMutate.html @@ -1273,7 +1273,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointTLSTermination.html b/docs/NgrokAPI/Models/EndpointTLSTermination.html index fc2ad9c..c265cb7 100644 --- a/docs/NgrokAPI/Models/EndpointTLSTermination.html +++ b/docs/NgrokAPI/Models/EndpointTLSTermination.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EndpointWebhookValidation.html b/docs/NgrokAPI/Models/EndpointWebhookValidation.html index e6c0b4a..83faba1 100644 --- a/docs/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/docs/NgrokAPI/Models/EndpointWebhookValidation.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventDestination.html b/docs/NgrokAPI/Models/EventDestination.html index 38d9c3a..6182c71 100644 --- a/docs/NgrokAPI/Models/EventDestination.html +++ b/docs/NgrokAPI/Models/EventDestination.html @@ -1048,7 +1048,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventSource.html b/docs/NgrokAPI/Models/EventSource.html index 34ff62e..ee12055 100644 --- a/docs/NgrokAPI/Models/EventSource.html +++ b/docs/NgrokAPI/Models/EventSource.html @@ -755,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html b/docs/NgrokAPI/Models/EventSourceList.html similarity index 77% rename from docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html rename to docs/NgrokAPI/Models/EventSourceList.html index df2f3a6..088d8aa 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +++ b/docs/NgrokAPI/Models/EventSourceList.html @@ -4,7 +4,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> - Class: NgrokAPI::Models::ReservedDomainCertNSTarget + Class: NgrokAPI::Models::EventSourceList — Documentation by YARD 0.9.26 @@ -15,7 +15,7 @@ <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> - pathId = "NgrokAPI::Models::ReservedDomainCertNSTarget"; + pathId = "NgrokAPI::Models::EventSourceList"; relpath = '../../'; </script> @@ -36,10 +36,10 @@ <div id="header"> <div id="menu"> - <a href="../../_index.html">Index (R)</a> » + <a href="../../_index.html">Index (E)</a> » <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span> » - <span class="title">ReservedDomainCertNSTarget</span> + <span class="title">EventSourceList</span> </div> @@ -59,7 +59,7 @@ <div class="clear"></div> </div> - <div id="content"><h1>Class: NgrokAPI::Models::ReservedDomainCertNSTarget + <div id="content"><h1>Class: NgrokAPI::Models::EventSourceList @@ -74,7 +74,7 @@ <ul class="fullTree"> <li>Object</li> - <li class="next">NgrokAPI::Models::ReservedDomainCertNSTarget</li> + <li class="next">NgrokAPI::Models::EventSourceList</li> </ul> <a href="#" class="inheritanceTree">show all</a> @@ -94,7 +94,7 @@ <dl> <dt>Defined in:</dt> - <dd>lib/ngrokapi/models/reserved_domain_cert_ns_target.rb</dd> + <dd>lib/ngrokapi/models/event_source_list.rb</dd> </dl> </div> @@ -132,35 +132,6 @@ <p>Returns the value of attribute client.</p> </div></span> -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#nameservers-instance_method" title="#nameservers (instance method)">#<strong>nameservers</strong> ⇒ Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute nameservers.</p> -</div></span> - </li> @@ -196,7 +167,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#zone-instance_method" title="#zone (instance method)">#<strong>zone</strong> ⇒ Object </a> + <a href="#sources-instance_method" title="#sources (instance method)">#<strong>sources</strong> ⇒ Object </a> @@ -216,7 +187,36 @@ <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute zone.</p> +<p>Returns the value of attribute sources.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</strong> ⇒ Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute uri.</p> </div></span> </li> @@ -260,7 +260,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ ReservedDomainCertNSTarget </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ EventSourceList </a> @@ -277,7 +277,7 @@ <span class="summary_desc"><div class='inline'> -<p>A new instance of ReservedDomainCertNSTarget.</p> +<p>A new instance of EventSourceList.</p> </div></span> </li> @@ -314,7 +314,7 @@ <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span></tt> + #<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></tt> @@ -323,7 +323,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Returns a new instance of ReservedDomainCertNSTarget.</p> +<p>Returns a new instance of EventSourceList.</p> </div> @@ -345,13 +345,13 @@ 16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 11</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 11</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span> - <span class='ivar'>@zone</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>zone</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> - <span class='ivar'>@nameservers</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>nameservers</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@sources</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -396,7 +396,7 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -407,49 +407,6 @@ </div> - <span id=""></span> - <div class="method_details "> - <h3 class="signature " id="nameservers-instance_method"> - - #<strong>nameservers</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Returns the value of attribute nameservers.</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -6 -7 -8</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_nameservers'>nameservers</span> - <span class='ivar'>@nameservers</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <span id=""></span> <div class="method_details "> <h3 class="signature " id="result-instance_method"> @@ -482,7 +439,7 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@result</span> @@ -495,9 +452,9 @@ <span id=""></span> <div class="method_details "> - <h3 class="signature " id="zone-instance_method"> + <h3 class="signature " id="sources-instance_method"> - #<strong>zone</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + #<strong>sources</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> @@ -506,7 +463,7 @@ </h3><div class="docstring"> <div class="discussion"> -<p>Returns the value of attribute zone.</p> +<p>Returns the value of attribute sources.</p> </div> @@ -525,10 +482,53 @@ 8</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 6</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> -<span class='kw'>def</span> <span class='id identifier rubyid_zone'>zone</span> - <span class='ivar'>@zone</span> +<span class='kw'>def</span> <span class='id identifier rubyid_sources'>sources</span> + <span class='ivar'>@sources</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="uri-instance_method"> + + #<strong>uri</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute uri.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 6</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span> + <span class='ivar'>@uri</span> <span class='kw'>end</span></pre> </td> </tr> @@ -562,7 +562,7 @@ 20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 18</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 18</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -592,7 +592,7 @@ 24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_ns_target.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/event_source_list.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventSourceReplace.html b/docs/NgrokAPI/Models/EventSourceReplace.html index ec6e3cc..cd165d6 100644 --- a/docs/NgrokAPI/Models/EventSourceReplace.html +++ b/docs/NgrokAPI/Models/EventSourceReplace.html @@ -681,7 +681,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventStream.html b/docs/NgrokAPI/Models/EventStream.html index ebc74c0..91b27c2 100644 --- a/docs/NgrokAPI/Models/EventStream.html +++ b/docs/NgrokAPI/Models/EventStream.html @@ -1299,7 +1299,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventSubscription.html b/docs/NgrokAPI/Models/EventSubscription.html index 64d23d5..579cb27 100644 --- a/docs/NgrokAPI/Models/EventSubscription.html +++ b/docs/NgrokAPI/Models/EventSubscription.html @@ -1048,7 +1048,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventTarget.html b/docs/NgrokAPI/Models/EventTarget.html index c8b9045..652ad9b 100644 --- a/docs/NgrokAPI/Models/EventTarget.html +++ b/docs/NgrokAPI/Models/EventTarget.html @@ -755,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html index 92b017f..dc75ce6 100644 --- a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +++ b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventTargetFirehose.html b/docs/NgrokAPI/Models/EventTargetFirehose.html index 20e93cd..485f325 100644 --- a/docs/NgrokAPI/Models/EventTargetFirehose.html +++ b/docs/NgrokAPI/Models/EventTargetFirehose.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/EventTargetKinesis.html b/docs/NgrokAPI/Models/EventTargetKinesis.html index de07769..4a98b30 100644 --- a/docs/NgrokAPI/Models/EventTargetKinesis.html +++ b/docs/NgrokAPI/Models/EventTargetKinesis.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/IPPolicy.html b/docs/NgrokAPI/Models/IPPolicy.html index d0e900c..eae1ff3 100644 --- a/docs/NgrokAPI/Models/IPPolicy.html +++ b/docs/NgrokAPI/Models/IPPolicy.html @@ -1059,7 +1059,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/IPPolicyRule.html b/docs/NgrokAPI/Models/IPPolicyRule.html index 636eadd..711d4bb 100644 --- a/docs/NgrokAPI/Models/IPPolicyRule.html +++ b/docs/NgrokAPI/Models/IPPolicyRule.html @@ -1139,7 +1139,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/IPRestriction.html b/docs/NgrokAPI/Models/IPRestriction.html index cbcd47e..602961f 100644 --- a/docs/NgrokAPI/Models/IPRestriction.html +++ b/docs/NgrokAPI/Models/IPRestriction.html @@ -1122,7 +1122,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/IPWhitelistEntry.html b/docs/NgrokAPI/Models/IPWhitelistEntry.html index 68cd0fc..9843461 100644 --- a/docs/NgrokAPI/Models/IPWhitelistEntry.html +++ b/docs/NgrokAPI/Models/IPWhitelistEntry.html @@ -1059,7 +1059,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/Listable.html b/docs/NgrokAPI/Models/Listable.html index b2fb75b..5c21270 100644 --- a/docs/NgrokAPI/Models/Listable.html +++ b/docs/NgrokAPI/Models/Listable.html @@ -87,6 +87,11 @@ + <dl> + <dt>Includes:</dt> + <dd>Enumerable</dd> + </dl> + @@ -387,7 +392,29 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:, list_property:, klass:) ⇒ Listable </a> + <a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong> ⇒ Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(danger: false, client:, result:, list_property:, klass:) ⇒ Listable </a> @@ -435,13 +462,14 @@ </ul> -<div id="constructor_details" class="method_details_list"> + + <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, result:, list_property:, klass:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::Listable (class)">Listable</a></span></tt> + #<strong>initialize</strong>(danger: false, client:, result:, list_property:, klass:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::Listable (class)">Listable</a></span></tt> @@ -464,8 +492,6 @@ <pre class="lines"> -17 -18 19 20 21 @@ -478,12 +504,15 @@ 28 29 30 -31</pre> +31 +32 +33 +34</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 17</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 19</span> -<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='comma'>,</span> <span class='label'>list_property:</span><span class='comma'>,</span> <span class='label'>klass:</span><span class='rparen'>)</span> +<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='comma'>,</span> <span class='label'>list_property:</span><span class='comma'>,</span> <span class='label'>klass:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span> @@ -495,7 +524,8 @@ <span class='ivar'>@iter</span> <span class='op'>=</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="../PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../PagedIterator.html#initialize-instance_method" title="NgrokAPI::PagedIterator#initialize (method)">new</a></span></span><span class='lparen'>(</span> <span class='label'>client:</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='label'>page:</span> <span class='kw'>self</span><span class='comma'>,</span> - <span class='label'>list_property:</span> <span class='id identifier rubyid_list_property'>list_property</span> + <span class='label'>list_property:</span> <span class='id identifier rubyid_list_property'>list_property</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span> <span class='rparen'>)</span> <span class='kw'>end</span></pre> </td> @@ -536,12 +566,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -579,12 +609,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span> <span class='ivar'>@items</span> @@ -622,12 +652,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_iter'>iter</span> <span class='ivar'>@iter</span> @@ -665,12 +695,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_klass'>klass</span> <span class='ivar'>@klass</span> @@ -708,12 +738,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_list_property'>list_property</span> <span class='ivar'>@list_property</span> @@ -751,12 +781,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_next_page_uri'>next_page_uri</span> <span class='ivar'>@next_page_uri</span> @@ -794,12 +824,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span> <span class='ivar'>@result</span> @@ -837,12 +867,12 @@ <pre class="lines"> -8 -9 -10</pre> +10 +11 +12</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span> <span class='ivar'>@uri</span> @@ -874,12 +904,12 @@ <pre class="lines"> -33 -34 -35</pre> +44 +45 +46</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 33</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 44</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -887,6 +917,44 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="each-instance_method"> + + #<strong>each</strong> ⇒ <tt>Object</tt> + + + + + +</h3><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +36 +37 +38 +39 +40 +41 +42</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 36</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span> + <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@iter</span><span class='period'>.</span><span class='id identifier rubyid_get_next'>get_next</span> + <span class='kw'>while</span> <span class='id identifier rubyid_item'>item</span> + <span class='kw'>yield</span> <span class='id identifier rubyid_item'>item</span> + <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@iter</span><span class='period'>.</span><span class='id identifier rubyid_get_next'>get_next</span> + <span class='kw'>end</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -904,12 +972,12 @@ <pre class="lines"> -37 -38 -39</pre> +48 +49 +50</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/listable.rb', line 48</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -924,7 +992,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/Ref.html b/docs/NgrokAPI/Models/Ref.html index 3f007aa..34e1725 100644 --- a/docs/NgrokAPI/Models/Ref.html +++ b/docs/NgrokAPI/Models/Ref.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedAddr.html b/docs/NgrokAPI/Models/ReservedAddr.html index 1fde3a2..7a064d6 100644 --- a/docs/NgrokAPI/Models/ReservedAddr.html +++ b/docs/NgrokAPI/Models/ReservedAddr.html @@ -1122,7 +1122,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedDomain.html b/docs/NgrokAPI/Models/ReservedDomain.html index 38b795a..eec8769 100644 --- a/docs/NgrokAPI/Models/ReservedDomain.html +++ b/docs/NgrokAPI/Models/ReservedDomain.html @@ -106,6 +106,35 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> + <li class="public "> + <span class="summary_signature"> + + <a href="#acme_challenge_cname_target-instance_method" title="#acme_challenge_cname_target (instance method)">#<strong>acme_challenge_cname_target</strong> ⇒ Object </a> + + + + </span> + + + + + <span class="note title readonly">readonly</span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns the value of attribute acme_challenge_cname_target.</p> +</div></span> + +</li> + + <li class="public "> <span class="summary_signature"> @@ -680,7 +709,6 @@ <pre class="lines"> -22 23 24 25 @@ -696,10 +724,12 @@ 35 36 37 -38</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 23</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -717,6 +747,7 @@ <span class='ivar'>@certificate</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@certificate_management_policy</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate_management_policy</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@certificate_management_status</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate_management_status</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> + <span class='ivar'>@acme_challenge_cname_target</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>acme_challenge_cname_target</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -731,7 +762,50 @@ <span id=""></span> <div class="method_details first"> - <h3 class="signature first" id="certificate-instance_method"> + <h3 class="signature first" id="acme_challenge_cname_target-instance_method"> + + #<strong>acme_challenge_cname_target</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns the value of attribute acme_challenge_cname_target.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 6</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_acme_challenge_cname_target'>acme_challenge_cname_target</span> + <span class='ivar'>@acme_challenge_cname_target</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <div class="method_details "> + <h3 class="signature " id="certificate-instance_method"> #<strong>certificate</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> @@ -1395,12 +1469,12 @@ <pre class="lines"> -40 -41 -42</pre> +42 +43 +44</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 40</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 42</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -1438,14 +1512,14 @@ <pre class="lines"> -52 -53 54 55 -56</pre> +56 +57 +58</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 52</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 54</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span> @@ -1472,12 +1546,12 @@ <pre class="lines"> -44 -45 -46</pre> +46 +47 +48</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 44</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain.rb', line 46</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -1492,7 +1566,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedDomainCertJob.html b/docs/NgrokAPI/Models/ReservedDomainCertJob.html index fc3d47a..be2247a 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertJob.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertJob.html @@ -190,35 +190,6 @@ <p>Returns the value of attribute msg.</p> </div></span> -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ns_targets-instance_method" title="#ns_targets (instance method)">#<strong>ns_targets</strong> ⇒ Object </a> - - - - </span> - - - - - <span class="note title readonly">readonly</span> - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Returns the value of attribute ns_targets.</p> -</div></span> - </li> @@ -424,18 +395,17 @@ <pre class="lines"> +13 14 15 16 17 18 19 -20 -21 -22</pre> +20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 14</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 13</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -444,7 +414,6 @@ <span class='ivar'>@msg</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>msg</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@started_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>started_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@retries_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>retries_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> - <span class='ivar'>@ns_targets</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ns_targets</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> @@ -586,49 +555,6 @@ </div> - <span id=""></span> - <div class="method_details "> - <h3 class="signature " id="ns_targets-instance_method"> - - #<strong>ns_targets</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> - - - - - -</h3><div class="docstring"> - <div class="discussion"> - -<p>Returns the value of attribute ns_targets.</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -6 -7 -8</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 6</span> - -<span class='kw'>def</span> <span class='id identifier rubyid_ns_targets'>ns_targets</span> - <span class='ivar'>@ns_targets</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - <span id=""></span> <div class="method_details "> <h3 class="signature " id="result-instance_method"> @@ -779,12 +705,12 @@ <pre class="lines"> -24 -25 -26</pre> +22 +23 +24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 24</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 22</span> <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> @@ -809,12 +735,12 @@ <pre class="lines"> -28 -29 -30</pre> +26 +27 +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 28</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/reserved_domain_cert_job.rb', line 26</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> @@ -829,7 +755,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html index 9c5bd43..495adb1 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html index 5544b6f..ebcd783 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/SSHCertificateAuthority.html b/docs/NgrokAPI/Models/SSHCertificateAuthority.html index d007b0b..b1d1209 100644 --- a/docs/NgrokAPI/Models/SSHCertificateAuthority.html +++ b/docs/NgrokAPI/Models/SSHCertificateAuthority.html @@ -1133,7 +1133,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/SSHCredential.html b/docs/NgrokAPI/Models/SSHCredential.html index 3cedc7b..af11228 100644 --- a/docs/NgrokAPI/Models/SSHCredential.html +++ b/docs/NgrokAPI/Models/SSHCredential.html @@ -1139,7 +1139,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/SSHHostCertificate.html b/docs/NgrokAPI/Models/SSHHostCertificate.html index b3e56d1..135e535 100644 --- a/docs/NgrokAPI/Models/SSHHostCertificate.html +++ b/docs/NgrokAPI/Models/SSHHostCertificate.html @@ -1503,7 +1503,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/SSHUserCertificate.html b/docs/NgrokAPI/Models/SSHUserCertificate.html index 78b0a3c..fe4a0fb 100644 --- a/docs/NgrokAPI/Models/SSHUserCertificate.html +++ b/docs/NgrokAPI/Models/SSHUserCertificate.html @@ -1651,7 +1651,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/TLSCertificate.html b/docs/NgrokAPI/Models/TLSCertificate.html index 9894192..ca70f08 100644 --- a/docs/NgrokAPI/Models/TLSCertificate.html +++ b/docs/NgrokAPI/Models/TLSCertificate.html @@ -2169,7 +2169,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/TLSCertificateSANs.html b/docs/NgrokAPI/Models/TLSCertificateSANs.html index f178150..a6af59e 100644 --- a/docs/NgrokAPI/Models/TLSCertificateSANs.html +++ b/docs/NgrokAPI/Models/TLSCertificateSANs.html @@ -607,7 +607,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/Tunnel.html b/docs/NgrokAPI/Models/Tunnel.html index 7657a70..94e6017 100644 --- a/docs/NgrokAPI/Models/Tunnel.html +++ b/docs/NgrokAPI/Models/Tunnel.html @@ -977,7 +977,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Models/TunnelSession.html b/docs/NgrokAPI/Models/TunnelSession.html index abb79ff..d1237ae 100644 --- a/docs/NgrokAPI/Models/TunnelSession.html +++ b/docs/NgrokAPI/Models/TunnelSession.html @@ -1199,7 +1199,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/PagedIterator.html b/docs/NgrokAPI/PagedIterator.html index 55fa84b..ae0603e 100644 --- a/docs/NgrokAPI/PagedIterator.html +++ b/docs/NgrokAPI/PagedIterator.html @@ -269,7 +269,7 @@ <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, page:, list_property:) ⇒ PagedIterator </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, page:, list_property:, danger: false) ⇒ PagedIterator </a> @@ -301,7 +301,7 @@ <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - #<strong>initialize</strong>(client:, page:, list_property:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt> + #<strong>initialize</strong>(client:, page:, list_property:, danger: false) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span></tt> @@ -333,7 +333,9 @@ 16 17 18 -19</pre> +19 +20 +21</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 10</span> @@ -341,12 +343,14 @@ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='label'>client:</span><span class='comma'>,</span> <span class='label'>page:</span><span class='comma'>,</span> - <span class='label'>list_property:</span> + <span class='label'>list_property:</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>false</span> <span class='rparen'>)</span> <span class='ivar'>@n</span> <span class='op'>=</span> <span class='int'>0</span> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@list_property</span> <span class='op'>=</span> <span class='id identifier rubyid_list_property'>list_property</span> <span class='ivar'>@page</span> <span class='op'>=</span> <span class='id identifier rubyid_page'>page</span> + <span class='ivar'>@danger</span> <span class='op'>=</span> <span class='id identifier rubyid_danger'>danger</span> <span class='kw'>end</span></pre> </td> </tr> @@ -581,8 +585,6 @@ <pre class="lines"> -26 -27 28 29 30 @@ -593,10 +595,12 @@ 35 36 37 -38</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 26</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/paged_iterator.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_get_next'>get_next</span> <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='ivar'>@list_property</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='ivar'>@n</span><span class='rbracket'>]</span> @@ -605,7 +609,7 @@ <span class='id identifier rubyid_item'>item</span> <span class='kw'>rescue</span> <span class='kw'>if</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span> - <span class='id identifier rubyid_res'>res</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><span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span> + <span class='id identifier rubyid_res'>res</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><span class='label'>danger:</span> <span class='ivar'>@danger</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='ivar'>@page</span><span class='period'>.</span><span class='id identifier rubyid_next_page_uri'>next_page_uri</span><span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='int'>0</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='id identifier rubyid_res'>res</span> <span class='id identifier rubyid_get_next'>get_next</span> @@ -621,7 +625,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:18 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services.html b/docs/NgrokAPI/Services.html index 3f67461..4332bd5 100644 --- a/docs/NgrokAPI/Services.html +++ b/docs/NgrokAPI/Services.html @@ -107,7 +107,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/APIKeysClient.html b/docs/NgrokAPI/Services/APIKeysClient.html index f07a6a0..bde9fb7 100644 --- a/docs/NgrokAPI/Services/APIKeysClient.html +++ b/docs/NgrokAPI/Services/APIKeysClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p> - -<pre class="code ruby"><code class="ruby">API. You may use the API itself -to provision and manage API Keys but you'll need to provision your first API -key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your -ngrok.com dashboard. -</code></pre> +<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p> <p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p> @@ -377,6 +371,30 @@ ngrok.com dashboard. <p>List all API keys owned by this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all API keys owned by this account Throws an exception if API error.</p> +</div></span> + </li> @@ -460,12 +478,12 @@ ngrok.com dashboard. <pre class="lines"> +21 22 -23 -24</pre> +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 22</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span> <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> <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> @@ -508,12 +526,12 @@ ngrok.com dashboard. <pre class="lines"> +19 20 -21 -22</pre> +21</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 20</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> @@ -616,6 +634,7 @@ ngrok.com dashboard. <pre class="lines"> +34 35 36 37 @@ -627,11 +646,10 @@ ngrok.com dashboard. 43 44 45 -46 -47</pre> +46</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 35</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span> <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> @@ -719,6 +737,7 @@ ngrok.com dashboard. <pre class="lines"> +55 56 57 58 @@ -726,11 +745,10 @@ ngrok.com dashboard. 60 61 62 -63 -64</pre> +63</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 56</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 55</span> <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> @@ -814,6 +832,7 @@ ngrok.com dashboard. <pre class="lines"> +73 74 75 76 @@ -821,11 +840,10 @@ ngrok.com dashboard. 78 79 80 -81 -82</pre> +81</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 74</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 73</span> <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> @@ -909,6 +927,7 @@ ngrok.com dashboard. <pre class="lines"> +90 91 92 93 @@ -918,11 +937,10 @@ ngrok.com dashboard. 97 98 99 -100 -101</pre> +100</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 91</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 90</span> <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> @@ -1008,6 +1026,7 @@ ngrok.com dashboard. <pre class="lines"> +110 111 112 113 @@ -1017,11 +1036,10 @@ ngrok.com dashboard. 117 118 119 -120 -121</pre> +120</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 111</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 110</span> <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> @@ -1133,6 +1151,7 @@ ngrok.com dashboard. <pre class="lines"> +131 132 133 134 @@ -1153,7 +1172,7 @@ ngrok.com dashboard. 149</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 132</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 131</span> <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> @@ -1166,6 +1185,7 @@ ngrok.com dashboard. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1176,6 +1196,151 @@ ngrok.com dashboard. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all API keys owned by this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 161</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1277,24 +1442,24 @@ ngrok.com dashboard. <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174</pre> +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 192</span> <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> @@ -1415,24 +1580,24 @@ ngrok.com dashboard. <pre class="lines"> -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200</pre> +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 186</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 218</span> <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> @@ -1459,7 +1624,7 @@ ngrok.com dashboard. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/AbuseReportsClient.html b/docs/NgrokAPI/Services/AbuseReportsClient.html index 3c78ab7..d05d66a 100644 --- a/docs/NgrokAPI/Services/AbuseReportsClient.html +++ b/docs/NgrokAPI/Services/AbuseReportsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p> - -<pre class="code ruby"><code class="ruby">ngrok that violate ngrok's terms of service. -</code></pre> +<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p> <p><a href="https://ngrok.com/docs/api#api-abuse-reports">ngrok.com/docs/api#api-abuse-reports</a></p> @@ -713,7 +710,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html index c88da70..3d42d86 100644 --- a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Certificate Authorities are x509 certificates that are used to sign other</p> - -<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module -to verify that the TLS certificate presented by a client has been signed by -this CA. Certificate Authorities are used only for mTLS validation only and -thus a private key is not included in the resource. -</code></pre> +<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p> <p><a href="https://ngrok.com/docs/api#api-certificate-authorities">ngrok.com/docs/api#api-certificate-authorities</a></p> @@ -377,6 +371,30 @@ thus a private key is not included in the resource. <p>List all Certificate Authority on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all Certificate Authority on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1170,7 +1188,8 @@ thus a private key is not included in the resource. 147 148 149 -150</pre> +150 +151</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 133</span> @@ -1186,6 +1205,7 @@ thus a private key is not included in the resource. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1196,6 +1216,151 @@ thus a private key is not included in the resource. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Certificate Authority on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-list">ngrok.com/docs/api#api-certificate-authorities-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 163</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1297,24 +1462,24 @@ thus a private key is not included in the resource. <pre class="lines"> -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175</pre> +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 161</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 194</span> <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> @@ -1435,24 +1600,24 @@ thus a private key is not included in the resource. <pre class="lines"> -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201</pre> +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 187</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 220</span> <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> @@ -1479,7 +1644,7 @@ thus a private key is not included in the resource. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/CredentialsClient.html b/docs/NgrokAPI/Services/CredentialsClient.html index 455ee34..4df850d 100644 --- a/docs/NgrokAPI/Services/CredentialsClient.html +++ b/docs/NgrokAPI/Services/CredentialsClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p> - -<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with -the ngrok authtoken command or by specifying it in the ngrok.yml -configuration file with the authtoken property. -</code></pre> +<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p> <p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p> @@ -376,6 +371,30 @@ configuration file with the authtoken property. <p>List all tunnel authtoken credentials on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -601,7 +620,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1171,7 +1190,8 @@ configuration file with the authtoken property. 149 150 151 -152</pre> +152 +153</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span> @@ -1187,6 +1207,7 @@ configuration file with the authtoken property. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1197,6 +1218,151 @@ configuration file with the authtoken property. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-credentials-list">ngrok.com/docs/api#api-credentials-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 165</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1284,7 +1450,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1316,26 +1482,26 @@ configuration file with the authtoken property. <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 197</span> <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> @@ -1444,7 +1610,7 @@ configuration file with the authtoken property. — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1476,26 +1642,26 @@ configuration file with the authtoken property. <pre class="lines"> -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209</pre> +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 193</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 226</span> <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> @@ -1524,7 +1690,7 @@ configuration file with the authtoken property. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html b/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html index 6cc5c4c..6df05f5 100644 --- a/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html b/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html index 1781e2d..7d92fa7 100644 --- a/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointConfigurationsClient.html b/docs/NgrokAPI/Services/EndpointConfigurationsClient.html index 60ad299..0add540 100644 --- a/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +++ b/docs/NgrokAPI/Services/EndpointConfigurationsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p> - -<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only -applied to Domains and TCP Addresses they have been attached to. -</code></pre> +<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p> <p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p> @@ -375,6 +371,30 @@ applied to Domains and TCP Addresses they have been attached to. <p>Returns a list of all endpoint configurations on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -564,7 +584,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p> +<p>they type of traffic this endpoint configuration can be applied to. one of: <code>http</code>, <code>https</code>, <code>tcp</code></p> </div> </li> @@ -618,7 +638,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -636,7 +656,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -654,7 +674,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -672,7 +692,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -690,7 +710,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -708,7 +728,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -726,7 +746,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -744,7 +764,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -762,7 +782,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -780,7 +800,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -798,7 +818,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -816,7 +836,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -1438,7 +1458,8 @@ applied to Domains and TCP Addresses they have been attached to. 185 186 187 -188</pre> +188 +189</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 171</span> @@ -1454,6 +1475,7 @@ applied to Domains and TCP Addresses they have been attached to. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1464,6 +1486,151 @@ applied to Domains and TCP Addresses they have been attached to. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 201</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1556,7 +1723,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -1574,7 +1741,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -1592,7 +1759,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -1610,7 +1777,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -1628,7 +1795,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -1646,7 +1813,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -1664,7 +1831,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -1682,7 +1849,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -1700,7 +1867,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -1718,7 +1885,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -1736,7 +1903,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -1754,7 +1921,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -1786,39 +1953,6 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 247 248 249 @@ -1826,10 +1960,43 @@ applied to Domains and TCP Addresses they have been attached to. 251 252 253 -254</pre> +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 214</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 247</span> <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> @@ -1967,7 +2134,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>circuit breaker module configuration or “null“</p> +<p>circuit breaker module configuration or <code>null</code></p> </div> </li> @@ -1985,7 +2152,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>compression module configuration or “null“</p> +<p>compression module configuration or <code>null</code></p> </div> </li> @@ -2003,7 +2170,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>request headers module configuration or “null“</p> +<p>request headers module configuration or <code>null</code></p> </div> </li> @@ -2021,7 +2188,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>response headers module configuration or “null“</p> +<p>response headers module configuration or <code>null</code></p> </div> </li> @@ -2039,7 +2206,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>ip policy module configuration or “null“</p> +<p>ip policy module configuration or <code>null</code></p> </div> </li> @@ -2057,7 +2224,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>mutual TLS module configuration or “null“</p> +<p>mutual TLS module configuration or <code>null</code></p> </div> </li> @@ -2075,7 +2242,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>TLS termination module configuration or “null“</p> +<p>TLS termination module configuration or <code>null</code></p> </div> </li> @@ -2093,7 +2260,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>webhook validation module configuration or “null“</p> +<p>webhook validation module configuration or <code>null</code></p> </div> </li> @@ -2111,7 +2278,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oauth module configuration or “null“</p> +<p>oauth module configuration or <code>null</code></p> </div> </li> @@ -2129,7 +2296,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>logging module configuration or “null“</p> +<p>logging module configuration or <code>null</code></p> </div> </li> @@ -2147,7 +2314,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>saml module configuration or “null“</p> +<p>saml module configuration or <code>null</code></p> </div> </li> @@ -2165,7 +2332,7 @@ applied to Domains and TCP Addresses they have been attached to. — <div class='inline'> -<p>oidc module configuration or “null“</p> +<p>oidc module configuration or <code>null</code></p> </div> </li> @@ -2197,39 +2364,6 @@ applied to Domains and TCP Addresses they have been attached to. <pre class="lines"> -281 -282 -283 -284 -285 -286 -287 -288 -289 -290 -291 -292 -293 -294 -295 -296 -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 314 315 316 @@ -2237,10 +2371,43 @@ applied to Domains and TCP Addresses they have been attached to. 318 319 320 -321</pre> +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 281</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 314</span> <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> @@ -2293,7 +2460,7 @@ applied to Domains and TCP Addresses they have been attached to. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html b/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html index 0db28bd..52db0eb 100644 --- a/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html b/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html index cffac98..596acbb 100644 --- a/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html b/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html index 2f65fa5..0552357 100644 --- a/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html b/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html index d433864..204f1db 100644 --- a/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html b/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html index 7b242bf..cafc1a7 100644 --- a/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html b/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html index ab460b4..8622d3d 100644 --- a/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html b/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html index 5e4bece..e82eb9d 100644 --- a/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html b/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html index 4c8db30..9f493bc 100644 --- a/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html b/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html index 7f904f8..73f8c3c 100644 --- a/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html b/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html index 719f591..7cf65af 100644 --- a/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +++ b/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html @@ -1061,7 +1061,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:19 2021 by + Generated on Tue Oct 19 15:48:27 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EventDestinationsClient.html b/docs/NgrokAPI/Services/EventDestinationsClient.html index 31bf309..0a537d2 100644 --- a/docs/NgrokAPI/Services/EventDestinationsClient.html +++ b/docs/NgrokAPI/Services/EventDestinationsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all Event Destinations on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all Event Destinations on this account.</p> </div></span> @@ -594,7 +618,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -612,7 +636,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1188,7 +1212,8 @@ 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 137</span> @@ -1204,6 +1229,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1214,6 +1240,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Event Destinations on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-destinations-list">ngrok.com/docs/api#api-event-destinations-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventDestinationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1306,7 +1477,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -1324,7 +1495,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1356,29 +1527,29 @@ <pre class="lines"> -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186</pre> +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span> <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> @@ -1495,7 +1666,7 @@ — <div class='inline'> -<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p> +<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p> </div> </li> @@ -1513,7 +1684,7 @@ — <div class='inline'> -<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p> +<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p> </div> </li> @@ -1545,29 +1716,29 @@ <pre class="lines"> -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219</pre> +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 233</span> <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> @@ -1599,7 +1770,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EventSourcesClient.html b/docs/NgrokAPI/Services/EventSourcesClient.html index 53c5706..d0d1fb6 100644 --- a/docs/NgrokAPI/Services/EventSourcesClient.html +++ b/docs/NgrokAPI/Services/EventSourcesClient.html @@ -329,6 +329,54 @@ <p>A new instance of EventSourcesClient.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List the types for which this event subscription will trigger.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List the types for which this event subscription will trigger Throws an exception if API error.</p> +</div></span> + </li> @@ -1081,6 +1129,204 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list-instance_method"> + + #<strong>list</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List the types for which this event subscription will trigger</p> + +<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>subscription_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'> +<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 134</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span> + <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> +<span class='rparen'>)</span> + <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span> + <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span> + <span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span> + <span class='rbrace'>}</span> + <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> + <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> + <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/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List the types for which this event subscription will trigger Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>subscription_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'> +<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 154</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span> + <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> +<span class='rparen'>)</span> + <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span> + <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span> + <span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span> + <span class='rbrace'>}</span> + <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> + <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> + <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/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1169,24 +1415,24 @@ <pre class="lines"> -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149</pre> +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 135</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 174</span> <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span> <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> @@ -1294,24 +1540,24 @@ <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174</pre> +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 199</span> <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span> <span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> @@ -1338,7 +1584,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EventStreamsClient.html b/docs/NgrokAPI/Services/EventStreamsClient.html index 02d2439..4f02c4b 100644 --- a/docs/NgrokAPI/Services/EventStreamsClient.html +++ b/docs/NgrokAPI/Services/EventStreamsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all Event Streams available on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all Event Streams available on this account.</p> </div></span> @@ -612,7 +636,7 @@ — <div class='inline'> -<p>The protocol that determines which events will be collected. Supported values are “tcp_connection_closed“ and “http_request_complete“.</p> +<p>The protocol that determines which events will be collected. Supported values are <code>tcp_connection_closed</code> and <code>http_request_complete</code>.</p> </div> </li> @@ -1230,7 +1254,8 @@ 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 137</span> @@ -1246,6 +1271,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1256,6 +1282,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all Event Streams available on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1416,30 +1587,30 @@ <pre class="lines"> -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188</pre> +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 168</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 201</span> <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> @@ -1625,30 +1796,30 @@ <pre class="lines"> -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223</pre> +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 203</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 236</span> <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> @@ -1681,7 +1852,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/EventSubscriptionsClient.html b/docs/NgrokAPI/Services/EventSubscriptionsClient.html index 1e4ca34..2b837be 100644 --- a/docs/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/docs/NgrokAPI/Services/EventSubscriptionsClient.html @@ -365,6 +365,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List this Account's Event Subscriptions.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List this Account's Event Subscriptions.</p> </div></span> @@ -1186,7 +1210,8 @@ 144 145 146 -147</pre> +147 +148</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 130</span> @@ -1202,6 +1227,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1212,6 +1238,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List this Account's Event Subscriptions. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-list">ngrok.com/docs/api#api-event-subscriptions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventSubscriptionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1354,28 +1525,28 @@ <pre class="lines"> -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 160</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 193</span> <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> @@ -1541,28 +1712,28 @@ <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 225</span> <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> @@ -1593,7 +1764,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/IPPoliciesClient.html b/docs/NgrokAPI/Services/IPPoliciesClient.html index 421426d..490a453 100644 --- a/docs/NgrokAPI/Services/IPPoliciesClient.html +++ b/docs/NgrokAPI/Services/IPPoliciesClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p> - -<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP -Policy module. They can also be used with IP Restrictions to control source -IP ranges that can start tunnel sessions and connect to the API and dashboard. -</code></pre> +<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p> <p><a href="https://ngrok.com/docs/api#api-ip-policies">ngrok.com/docs/api#api-ip-policies</a></p> @@ -376,6 +371,30 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <p>List all IP policies on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP policies on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +618,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. — <div class='inline'> -<p>the IP policy action. Supported values are “allow“ or “deny“</p> +<p>the IP policy action. Supported values are <code>allow</code> or <code>deny</code></p> </div> </li> @@ -1169,7 +1188,8 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. 151 152 153 -154</pre> +154 +155</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 137</span> @@ -1185,6 +1205,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPoliciesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1195,6 +1216,151 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP policies on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-policies-list">ngrok.com/docs/api#api-ip-policies-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 167</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPoliciesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPPoliciesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1296,24 +1462,24 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 165</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 198</span> <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> @@ -1434,24 +1600,24 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. <pre class="lines"> -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205</pre> +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 191</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 224</span> <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> @@ -1478,7 +1644,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/IPPolicyRulesClient.html b/docs/NgrokAPI/Services/IPPolicyRulesClient.html index fc29ea4..5f76991 100644 --- a/docs/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/docs/NgrokAPI/Services/IPPolicyRulesClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p> - -<pre class="code ruby"><code class="ruby">make up an IP Policy. -</code></pre> +<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p> <p><a href="https://ngrok.com/docs/api#api-ip-policy-rules">ngrok.com/docs/api#api-ip-policy-rules</a></p> @@ -374,6 +371,30 @@ <p>List all IP policy rules on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP policy rules on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1187,7 +1208,8 @@ 147 148 149 -150</pre> +150 +151</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 133</span> @@ -1203,6 +1225,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1213,6 +1236,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP policy rules on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-policy-rules-list">ngrok.com/docs/api#api-ip-policy-rules-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 163</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPolicyRulesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPPolicyRulesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1332,26 +1500,26 @@ <pre class="lines"> -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 162</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 195</span> <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> @@ -1492,26 +1660,26 @@ <pre class="lines"> -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207</pre> +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 191</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 224</span> <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> @@ -1540,7 +1708,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/IPRestrictionsClient.html b/docs/NgrokAPI/Services/IPRestrictionsClient.html index 8751ea9..5192b63 100644 --- a/docs/NgrokAPI/Services/IPRestrictionsClient.html +++ b/docs/NgrokAPI/Services/IPRestrictionsClient.html @@ -102,14 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p> - -<pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP -restriction has a type which defines the ingress it applies to. IP -restrictions can be used to enforce the source IPs that can make API -requests, log in to the dashboard, start ngrok agents, and connect to your -public-facing endpoints. -</code></pre> +<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p> <p><a href="https://ngrok.com/docs/api#api-ip-restrictions">ngrok.com/docs/api#api-ip-restrictions</a></p> @@ -378,6 +371,30 @@ public-facing endpoints. <p>List all IP restrictions on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP restrictions on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -619,7 +636,7 @@ public-facing endpoints. — <div class='inline'> -<p>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“</p> +<p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code>dashboard</code>, <code>api</code>, <code>agent</code>, and <code>endpoints</code></p> </div> </li> @@ -1213,7 +1230,8 @@ public-facing endpoints. 154 155 156 -157</pre> +157 +158</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 140</span> @@ -1229,6 +1247,7 @@ public-facing endpoints. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPRestrictionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1239,6 +1258,151 @@ public-facing endpoints. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP restrictions on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-restrictions-list">ngrok.com/docs/api#api-ip-restrictions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 170</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPRestrictionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPRestrictionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1376,28 +1540,28 @@ public-facing endpoints. <pre class="lines"> -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188</pre> +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 170</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 203</span> <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> @@ -1558,28 +1722,28 @@ public-facing endpoints. <pre class="lines"> -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220</pre> +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 202</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_restrictions_client.rb', line 235</span> <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> @@ -1610,7 +1774,7 @@ public-facing endpoints. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/IPWhitelistClient.html b/docs/NgrokAPI/Services/IPWhitelistClient.html index f863fb1..ea432aa 100644 --- a/docs/NgrokAPI/Services/IPWhitelistClient.html +++ b/docs/NgrokAPI/Services/IPWhitelistClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p> - -<pre class="code ruby"><code class="ruby">with an endpoints type instead. -</code></pre> +<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p> <p><a href="https://ngrok.com/docs/api#api-ip-whitelist">ngrok.com/docs/api#api-ip-whitelist</a></p> @@ -374,6 +371,30 @@ <p>List all IP whitelist entries on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all IP whitelist entries on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -1169,7 +1190,8 @@ 145 146 147 -148</pre> +148 +149</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 131</span> @@ -1185,6 +1207,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1195,6 +1218,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all IP whitelist entries on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ip-whitelist-list">ngrok.com/docs/api#api-ip-whitelist-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 161</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPWhitelistClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1296,24 +1464,24 @@ <pre class="lines"> -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173</pre> +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 159</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 192</span> <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> @@ -1434,24 +1602,24 @@ <pre class="lines"> -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199</pre> +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 185</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 218</span> <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> @@ -1478,7 +1646,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:21 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/ReservedAddrsClient.html b/docs/NgrokAPI/Services/ReservedAddrsClient.html index eb68285..5eaff4e 100644 --- a/docs/NgrokAPI/Services/ReservedAddrsClient.html +++ b/docs/NgrokAPI/Services/ReservedAddrsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p> - -<pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be -chosen. -</code></pre> +<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p> <p><a href="https://ngrok.com/docs/api#api-reserved-addrs">ngrok.com/docs/api#api-reserved-addrs</a></p> @@ -419,6 +415,30 @@ chosen. + <span class="summary_desc"><div class='inline'> +<p>List all reserved addresses on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all reserved addresses on this account.</p> </div></span> @@ -999,18 +1019,18 @@ chosen. <pre class="lines"> -217 -218 -219 -220 -221 -222 -223 -224 -225</pre> +250 +251 +252 +253 +254 +255 +256 +257 +258</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 217</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 250</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config'>delete_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1094,18 +1114,18 @@ chosen. <pre class="lines"> -235 -236 -237 -238 -239 -240 -241 -242 -243</pre> +268 +269 +270 +271 +272 +273 +274 +275 +276</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 235</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 268</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config!'>delete_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1430,7 +1450,8 @@ chosen. 148 149 150 -151</pre> +151 +152</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 134</span> @@ -1446,6 +1467,7 @@ chosen. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1456,6 +1478,151 @@ chosen. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all reserved addresses on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-list">ngrok.com/docs/api#api-reserved-addrs-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 164</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedAddrsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1575,26 +1742,26 @@ chosen. <pre class="lines"> -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 196</span> <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> @@ -1735,26 +1902,26 @@ chosen. <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 225</span> <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> @@ -1783,7 +1950,7 @@ chosen. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:22 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/ReservedDomainsClient.html b/docs/NgrokAPI/Services/ReservedDomainsClient.html index d5f08d8..e11636b 100644 --- a/docs/NgrokAPI/Services/ReservedDomainsClient.html +++ b/docs/NgrokAPI/Services/ReservedDomainsClient.html @@ -102,12 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p> - -<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain -that you own by creating a CNAME record specified in the returned resource. -This CNAME record points traffic for that domain to ngrok's edge servers. -</code></pre> +<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.</p> <p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p> @@ -564,6 +559,30 @@ This CNAME record points traffic for that domain to ngrok's edge servers. + <span class="summary_desc"><div class='inline'> +<p>List all reserved domains on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all reserved domains on this account.</p> </div></span> @@ -863,7 +882,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -881,7 +900,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -1230,18 +1249,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -283 -284 -285 -286 -287 -288 -289 -290 -291</pre> +316 +317 +318 +319 +320 +321 +322 +323 +324</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 283</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 316</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1325,18 +1344,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -301 -302 -303 -304 -305 -306 -307 -308 -309</pre> +334 +335 +336 +337 +338 +339 +340 +341 +342</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 301</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 334</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1420,18 +1439,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -248 -249 -250 -251 -252 -253 -254 -255 -256</pre> +281 +282 +283 +284 +285 +286 +287 +288 +289</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 248</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 281</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1515,18 +1534,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -266 -267 -268 -269 -270 -271 -272 -273 -274</pre> +299 +300 +301 +302 +303 +304 +305 +306 +307</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 266</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 299</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1610,18 +1629,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -318 -319 -320 -321 -322 -323 -324 -325 -326</pre> +351 +352 +353 +354 +355 +356 +357 +358 +359</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 318</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 351</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1705,18 +1724,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -336 -337 -338 -339 -340 -341 -342 -343 -344</pre> +369 +370 +371 +372 +373 +374 +375 +376 +377</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 336</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 369</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1800,18 +1819,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -353 -354 -355 -356 -357 -358 -359 -360 -361</pre> +386 +387 +388 +389 +390 +391 +392 +393 +394</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 353</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 386</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1895,18 +1914,18 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -371 -372 -373 -374 -375 -376 -377 -378 -379</pre> +404 +405 +406 +407 +408 +409 +410 +411 +412</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 371</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 404</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -2231,7 +2250,8 @@ This CNAME record points traffic for that domain to ngrok's edge servers. 161 162 163 -164</pre> +164 +165</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 147</span> @@ -2247,6 +2267,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -2257,6 +2278,151 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all reserved domains on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 177</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -2380,7 +2546,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -2398,7 +2564,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -2430,32 +2596,32 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201</pre> +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 179</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 212</span> <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> @@ -2606,7 +2772,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.</p> +<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p> </div> </li> @@ -2624,7 +2790,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. — <div class='inline'> -<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.</p> +<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p> </div> </li> @@ -2656,32 +2822,32 @@ This CNAME record points traffic for that domain to ngrok's edge servers. <pre class="lines"> -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239</pre> +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 217</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 250</span> <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> @@ -2716,7 +2882,7 @@ This CNAME record points traffic for that domain to ngrok's edge servers. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index 6392ca3..31d1817 100644 --- a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates. -</code></pre> +<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities">ngrok.com/docs/api#api-ssh-certificate-authorities</a></p> @@ -374,6 +371,30 @@ <p>List all SSH Certificate Authorities on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +620,7 @@ — <div class='inline'> -<p>the type of private key to generate. one of “rsa“, “ecdsa“, “ed25519“</p> +<p>the type of private key to generate. one of <code>rsa</code>, <code>ecdsa</code>, <code>ed25519</code></p> </div> </li> @@ -635,7 +656,7 @@ — <div class='inline'> -<p>the key size to use when creating an RSA key. one of “2048“ or “4096“</p> +<p>the key size to use when creating an RSA key. one of <code>2048</code> or <code>4096</code></p> </div> </li> @@ -1213,7 +1234,8 @@ 150 151 152 -153</pre> +153 +154</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 136</span> @@ -1229,6 +1251,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1239,6 +1262,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-list">ngrok.com/docs/api#api-ssh-certificate-authorities-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 166</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1340,24 +1508,24 @@ <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 197</span> <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> @@ -1478,24 +1646,24 @@ <pre class="lines"> -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204</pre> +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 190</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 223</span> <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> @@ -1522,7 +1690,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:26 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/SSHCredentialsClient.html b/docs/NgrokAPI/Services/SSHCredentialsClient.html index e002ed7..a66a5cc 100644 --- a/docs/NgrokAPI/Services/SSHCredentialsClient.html +++ b/docs/NgrokAPI/Services/SSHCredentialsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p> - -<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway. -</code></pre> +<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-credentials">ngrok.com/docs/api#api-ssh-credentials</a></p> @@ -374,6 +371,30 @@ <p>List all ssh credentials on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all ssh credentials on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -599,7 +620,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1189,7 +1210,8 @@ 148 149 150 -151</pre> +151 +152</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 134</span> @@ -1205,6 +1227,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1215,6 +1238,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all ssh credentials on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-credentials-list">ngrok.com/docs/api#api-ssh-credentials-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 164</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1302,7 +1470,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1334,26 +1502,26 @@ <pre class="lines"> -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179</pre> +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 163</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 196</span> <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> @@ -1462,7 +1630,7 @@ — <div class='inline'> -<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the “bind“ rule. The “bind“ rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p> +<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p> </div> </li> @@ -1494,26 +1662,26 @@ <pre class="lines"> -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208</pre> +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 192</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 225</span> <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> @@ -1542,7 +1710,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html index 13eb62d..1967908 100644 --- a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH Host Certificates along with the corresponding private key allows an SSH</p> - -<pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the -SSH Certificate Authority that was used to sign the certificate. -</code></pre> +<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates">ngrok.com/docs/api#api-ssh-host-certificates</a></p> @@ -375,6 +371,30 @@ SSH Certificate Authority that was used to sign the certificate. <p>List all SSH Host Certificates issued on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -632,7 +652,7 @@ SSH Certificate Authority that was used to sign the certificate. — <div class='inline'> -<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this “valid_before“.</p> +<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p> </div> </li> @@ -1254,7 +1274,8 @@ SSH Certificate Authority that was used to sign the certificate. 157 158 159 -160</pre> +160 +161</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 143</span> @@ -1270,6 +1291,7 @@ SSH Certificate Authority that was used to sign the certificate. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1280,6 +1302,151 @@ SSH Certificate Authority that was used to sign the certificate. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-list">ngrok.com/docs/api#api-ssh-host-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 173</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1381,24 +1548,24 @@ SSH Certificate Authority that was used to sign the certificate. <pre class="lines"> -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185</pre> +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 171</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 204</span> <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> @@ -1519,24 +1686,24 @@ SSH Certificate Authority that was used to sign the certificate. <pre class="lines"> -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211</pre> +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 197</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 230</span> <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> @@ -1563,7 +1730,7 @@ SSH Certificate Authority that was used to sign the certificate. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html index 23cb556..4c7f2c5 100644 --- a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p> - -<pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH -Certificate Authority used to sign the certificate. -</code></pre> +<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p> <p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates">ngrok.com/docs/api#api-ssh-user-certificates</a></p> @@ -375,6 +371,30 @@ Certificate Authority used to sign the certificate. <p>List all SSH User Certificates issued on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all SSH User Certificates issued on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -614,7 +634,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: “force-command“ and “source-address“. See `the OpenSSH certificate protocol spec` <<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_“>github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_</a> for additional details.</p> +<p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code>force-command</code> and <code>source-address</code>. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p> </div> </li> @@ -632,7 +652,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: ““”, “permit-user-rc”: “”“ OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_“>github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_</a> for additional details.</p> +<p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code>{"permit-pty": "", "permit-user-rc": ""}</code> OpenSSH understands a number of predefined extensions. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p> </div> </li> @@ -668,7 +688,7 @@ Certificate Authority used to sign the certificate. — <div class='inline'> -<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this “valid_before“.</p> +<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p> </div> </li> @@ -1298,7 +1318,8 @@ Certificate Authority used to sign the certificate. 163 164 165 -166</pre> +166 +167</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 149</span> @@ -1314,6 +1335,7 @@ Certificate Authority used to sign the certificate. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1324,6 +1346,151 @@ Certificate Authority used to sign the certificate. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all SSH User Certificates issued on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">ngrok.com/docs/api#api-ssh-user-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 179</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1425,24 +1592,24 @@ Certificate Authority used to sign the certificate. <pre class="lines"> -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191</pre> +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 177</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 210</span> <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> @@ -1563,24 +1730,24 @@ Certificate Authority used to sign the certificate. <pre class="lines"> -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217</pre> +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 203</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 236</span> <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> @@ -1607,7 +1774,7 @@ Certificate Authority used to sign the certificate. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:25 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/TLSCertificatesClient.html b/docs/NgrokAPI/Services/TLSCertificatesClient.html index 538fc9b..e28bc85 100644 --- a/docs/NgrokAPI/Services/TLSCertificatesClient.html +++ b/docs/NgrokAPI/Services/TLSCertificatesClient.html @@ -102,13 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>TLS Certificates are pairs of x509 certificates and their matching private</p> - -<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused -until they are attached to a Domain. TLS Certificates may also be -provisioned by ngrok automatically for domains on which you have enabled -automated certificate provisioning. -</code></pre> +<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p> <p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</a></p> @@ -377,6 +371,30 @@ automated certificate provisioning. <p>List all TLS certificates on this account.</p> </div></span> +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>List all TLS certificates on this account Throws an exception if API error.</p> +</div></span> + </li> @@ -600,7 +618,7 @@ automated certificate provisioning. — <div class='inline'> -<p>chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <<a href="https://ngrok.com/docs/api#tls-certificates-pem>`_“>ngrok.com/docs/api#tls-certificates-pem>`_</a>.</p> +<p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles</code> <a href="https://ngrok.com/docs/api#tls-certificates-pem`_">ngrok.com/docs/api#tls-certificates-pem`_</a>.</p> </div> </li> @@ -616,7 +634,7 @@ automated certificate provisioning. — <div class='inline'> -<p>private key for the TLS certificate, PEM-encoded. See `Private Keys` <<a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_“>ngrok.com/docs/ngrok-link#tls-certificates-key>`_</a>.</p> +<p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys</code> <a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key`_">ngrok.com/docs/ngrok-link#tls-certificates-key`_</a>.</p> </div> </li> @@ -1190,7 +1208,8 @@ automated certificate provisioning. 150 151 152 -153</pre> +153 +154</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 136</span> @@ -1206,6 +1225,7 @@ automated certificate provisioning. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TLSCertificatesClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -1216,6 +1236,151 @@ automated certificate provisioning. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all TLS certificates on this account Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 166</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TLSCertificatesClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TLSCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -1317,24 +1482,24 @@ automated certificate provisioning. <pre class="lines"> -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178</pre> +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 164</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 197</span> <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> @@ -1455,24 +1620,24 @@ automated certificate provisioning. <pre class="lines"> -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204</pre> +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 190</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 223</span> <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> @@ -1499,7 +1664,7 @@ automated certificate provisioning. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:18 2021 by + Generated on Tue Oct 19 15:48:24 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/TunnelSessionsClient.html b/docs/NgrokAPI/Services/TunnelSessionsClient.html index 1ee54ad..d0b2e01 100644 --- a/docs/NgrokAPI/Services/TunnelSessionsClient.html +++ b/docs/NgrokAPI/Services/TunnelSessionsClient.html @@ -102,11 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p> - -<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel -session can include one or more Tunnels. -</code></pre> +<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p> <p><a href="https://ngrok.com/docs/api#api-tunnel-sessions">ngrok.com/docs/api#api-tunnel-sessions</a></p> @@ -299,6 +295,30 @@ session can include one or more Tunnels. + <span class="summary_desc"><div class='inline'> +<p>List all online tunnel sessions running on this account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all online tunnel sessions running on this account.</p> </div></span> @@ -620,20 +640,20 @@ session can include one or more Tunnels. <pre class="lines"> -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68</pre> +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 58</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 91</span> <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> @@ -719,20 +739,20 @@ session can include one or more Tunnels. <pre class="lines"> -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88</pre> +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 78</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 111</span> <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> @@ -861,7 +881,8 @@ session can include one or more Tunnels. 46 47 48 -49</pre> +49 +50</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 32</span> @@ -877,6 +898,7 @@ session can include one or more Tunnels. <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -887,6 +909,151 @@ session can include one or more Tunnels. </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all online tunnel sessions running on this account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 62</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> <div class="method_details "> @@ -957,18 +1124,18 @@ session can include one or more Tunnels. <pre class="lines"> -100 -101 -102 -103 -104 -105 -106 -107 -108</pre> +133 +134 +135 +136 +137 +138 +139 +140 +141</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 100</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 133</span> <span class='kw'>def</span> <span class='id identifier rubyid_restart'>restart</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1052,18 +1219,18 @@ session can include one or more Tunnels. <pre class="lines"> -121 -122 -123 -124 -125 -126 -127 -128 -129</pre> +154 +155 +156 +157 +158 +159 +160 +161 +162</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 121</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 154</span> <span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1147,18 +1314,18 @@ session can include one or more Tunnels. <pre class="lines"> -139 -140 -141 -142 -143 -144 -145 -146 -147</pre> +172 +173 +174 +175 +176 +177 +178 +179 +180</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 139</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 172</span> <span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1242,18 +1409,18 @@ session can include one or more Tunnels. <pre class="lines"> -158 -159 -160 -161 -162 -163 -164 -165 -166</pre> +191 +192 +193 +194 +195 +196 +197 +198 +199</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 158</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 191</span> <span class='kw'>def</span> <span class='id identifier rubyid_stop!'>stop!</span><span class='lparen'>(</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> @@ -1332,19 +1499,19 @@ session can include one or more Tunnels. <pre class="lines"> -186 -187 -188 -189 -190 -191 -192 -193 -194 -195</pre> +219 +220 +221 +222 +223 +224 +225 +226 +227 +228</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 186</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 219</span> <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> @@ -1424,19 +1591,19 @@ session can include one or more Tunnels. <pre class="lines"> -216 -217 -218 -219 -220 -221 -222 -223 -224 -225</pre> +249 +250 +251 +252 +253 +254 +255 +256 +257 +258</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 216</span> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 249</span> <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> @@ -1458,7 +1625,7 @@ session can include one or more Tunnels. </div> <div id="footer"> - Generated on Mon Oct 4 23:24:17 2021 by + Generated on Tue Oct 19 15:48:23 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/NgrokAPI/Services/TunnelsClient.html b/docs/NgrokAPI/Services/TunnelsClient.html index 6c54768..d2074c1 100644 --- a/docs/NgrokAPI/Services/TunnelsClient.html +++ b/docs/NgrokAPI/Services/TunnelsClient.html @@ -102,10 +102,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> -<p>Tunnels provide endpoints to access services exposed by a running ngrok</p> - -<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session. -</code></pre> +<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p> <p><a href="https://ngrok.com/docs/api#api-tunnels">ngrok.com/docs/api#api-tunnels</a></p> @@ -250,6 +247,30 @@ + <span class="summary_desc"><div class='inline'> +<p>List all online tunnels currently running on the account.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'> <p>List all online tunnels currently running on the account.</p> </div></span> @@ -470,7 +491,8 @@ 45 46 47 -48</pre> +48 +49</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 31</span> @@ -486,6 +508,7 @@ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span> <span class='rparen'>)</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/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> <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> @@ -496,6 +519,151 @@ </td> </tr> </table> +</div> + + <div class="method_details "> + <h3 class="signature " id="list!-instance_method"> + + #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>List all online tunnels currently running on the account. Throws an exception if API error.</p> + +<p><a href="https://ngrok.com/docs/api#api-tunnels-list">ngrok.com/docs/api#api-tunnels-list</a></p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + + <span class='name'>before_id</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>limit</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + </li> + + <li> + + <span class='name'>url</span> + + + <span class='type'>(<tt>string</tt>)</span> + + + <em class="default">(defaults to: <tt>nil</tt>)</em> + + + — + <div class='inline'> +<p>optional and mutually exclusive from before_id and limit</p> +</div> + + </li> + +</ul> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span> + + + + — + <div class='inline'> +<p>result from the API request</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 61</span> + +<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> + <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> + <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span> + <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> + <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> + <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span> + <span class='rparen'>)</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/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> + <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> + <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> + <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span> + <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/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span></span><span class='comma'>,</span> + <span class='label'>danger:</span> <span class='kw'>true</span> + <span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> </div> </div> @@ -503,7 +671,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:16 2021 by + Generated on Tue Oct 19 15:48:19 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/README b/docs/README new file mode 100644 index 0000000..12ac58c --- /dev/null +++ b/docs/README @@ -0,0 +1,94 @@ +# ngrok-api + +This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it +easier to consume in Ruby. + +## Installation + +This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api) + +```ruby +gem install ngrok-api +``` + +## Quickstart + +Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# Get an instance of the api_keys client and list all API keys +keys_client = client.api_keys +keys_client.list +``` + +## Automatic Paging + +The ngrok API pages all list resources but this library abstracts that away +from you. All response objects from any ``list`` or ``list!`` methods return an object that +implements an ``each`` method which will automatically fetch additional +pages for you. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# list all api keys, transparently fetching additional +# pages for you if necessary +keys_client = client.api_keys +keys_client.list.each do |key| + puts(key) +end +``` + +## Instance Methods + +Instance methods like ``update`` and ``delete`` can be invoked on an instance of an +API object itself as well as directly without needing to first fetch the object. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# update the metadata of a credential +cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz') +cred.update(metadata: {server_name: 'giraffe-1'}.to_json) + +# or do it in single call +cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json) +``` + +## Bang Methods +Most methods that interact with the API have a `!` counterpart. It raises an error when +one is returned by the API. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +# no error raised, even though it's a bad identifier +# the error is simply returned +cred = client.credentials.get(id: 'invalid') + +# this raises an NgrokAPI::Error +cred = client.credentials.get!(id: 'invalid') +``` + +## Error Handling + +The ngrok API returns detailed information when an API call fails. Consult the +section on errors for additional details. + +```ruby +require 'ngrokapi' +client = NgrokAPI::Client.new(api_key: '<API KEY>') + +begin + client.ip_policies.get!(id: 'invalid') +rescue NgrokAPI::Error => e + puts(e) + puts(e.response.to_s) +end +``` diff --git a/docs/_index.html b/docs/_index.html index 0f5f21e..714ea7c 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -467,6 +467,13 @@ </li> + <li> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> + + <small>(NgrokAPI::Models)</small> + + </li> + <li> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> @@ -727,13 +734,6 @@ </li> - <li> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span> - - <small>(NgrokAPI::Models)</small> - - </li> - <li> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> @@ -895,7 +895,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/class_list.html b/docs/class_list.html index f520d89..c3b6097 100644 --- a/docs/class_list.html +++ b/docs/class_list.html @@ -43,7 +43,7 @@ <ul id="full_list" class="class"> <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li> -<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> < StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> < Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertNSTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li> +<li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> < StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> < Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceList' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> < Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> < Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> < Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li> </ul> </div> diff --git a/docs/file.README.html b/docs/file.README.html index 250e81f..3467f58 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -58,7 +58,7 @@ </div> <div id="content"><div id='filecontents'> -<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1> +<h1 id="label-ngrok-api">ngrok-api</h1> <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p> @@ -69,54 +69,81 @@ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span> </code></pre> -<h2 id="label-Documentation">Documentation</h2> - -<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p> - <h2 id="label-Quickstart">Quickstart</h2> <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>'</span></span> -<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - -<span class='comment'># Get an instance of the api_keys client and list all API keys -</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># Get an instance of the api_keys client and list all API keys +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span> </code></pre> -<h2 id="label-Local+Documentation">Local Documentation</h2> +<h2 id="label-Automatic+Paging">Automatic Paging</h2> -<p>Documentation can be generated with the command:</p> +<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>'</span></span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># list all api keys, transparently fetching additional +</span><span class='comment'># pages for you if necessary +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> -<p>This will generate documentation which can be viewed within the doc folder.</p> +<h2 id="label-Instance+Methods">Instance Methods</h2> -<h2 id="label-Specs">Specs</h2> +<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p> -<p>Specs can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> +<span class='comment'># update the metadata of a credential +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> + +<span class='comment'># or do it in single call +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> </code></pre> -<p>This will generate a coverage report which can be viewed within the coverage folder.</p> +<h2 id="label-Bang+Methods">Bang Methods</h2> -<h2 id="label-Rubocop">Rubocop</h2> +<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p> -<p>Rubocop can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span> - -<span class='comment'># Run rubcop on all files -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> +<span class='comment'># no error raised, even though it's a bad identifier +</span><span class='comment'># the error is simply returned +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># this raises an NgrokAPI::Error +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +</code></pre> + +<h2 id="label-Error+Handling">Error Handling</h2> + +<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='kw'>begin</span> + <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> </div></div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/index.html b/docs/index.html index 2e93085..34a342a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -58,7 +58,7 @@ </div> <div id="content"><div id='filecontents'> -<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1> +<h1 id="label-ngrok-api">ngrok-api</h1> <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p> @@ -69,54 +69,81 @@ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span> </code></pre> -<h2 id="label-Documentation">Documentation</h2> - -<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p> - <h2 id="label-Quickstart">Quickstart</h2> <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>'</span></span> -<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - -<span class='comment'># Get an instance of the api_keys client and list all API keys -</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># Get an instance of the api_keys client and list all API keys +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span> </code></pre> -<h2 id="label-Local+Documentation">Local Documentation</h2> +<h2 id="label-Automatic+Paging">Automatic Paging</h2> -<p>Documentation can be generated with the command:</p> +<p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>'</span></span> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># list all api keys, transparently fetching additional +</span><span class='comment'># pages for you if necessary +</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span> +<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> -<p>This will generate documentation which can be viewed within the doc folder.</p> +<h2 id="label-Instance+Methods">Instance Methods</h2> -<h2 id="label-Specs">Specs</h2> +<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p> -<p>Specs can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span> +<span class='comment'># update the metadata of a credential +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> + +<span class='comment'># or do it in single call +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span> </code></pre> -<p>This will generate a coverage report which can be viewed within the coverage folder.</p> +<h2 id="label-Bang+Methods">Bang Methods</h2> -<h2 id="label-Rubocop">Rubocop</h2> +<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p> -<p>Rubocop can be run with the command:</p> +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span> - -<span class='comment'># Run rubcop on all files -</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> +<span class='comment'># no error raised, even though it's a bad identifier +</span><span class='comment'># the error is simply returned +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='comment'># this raises an NgrokAPI::Error +</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +</code></pre> + +<h2 id="label-Error+Handling">Error Handling</h2> + +<p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span> +<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + +<span class='kw'>begin</span> + <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> +<span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span> + <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span> +<span class='kw'>end</span> </code></pre> </div></div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/docs/method_list.html b/docs/method_list.html index 34bae34..6ec334c 100644 --- a/docs/method_list.html +++ b/docs/method_list.html @@ -245,6 +245,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#==-instance_method" title="NgrokAPI::Models::EventSourceList#== (method)">#==</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#==-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -252,7 +260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#==-instance_method" title="NgrokAPI::Models::EventSubscription#== (method)">#==</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -260,7 +268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#==-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#== (method)">#==</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -268,7 +276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#==-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -276,7 +284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#==-instance_method" title="NgrokAPI::Models::EndpointCompression#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -284,7 +292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -292,7 +300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#==-instance_method" title="NgrokAPI::Models::EventSourceReplace#== (method)">#==</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -300,7 +308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#==-instance_method" title="NgrokAPI::Models::EventTargetKinesis#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -308,7 +316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#==-instance_method" title="NgrokAPI::Models::SSHHostCertificate#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -316,7 +324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#==-instance_method" title="NgrokAPI::Models::SSHUserCertificate#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -324,7 +332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#==-instance_method" title="NgrokAPI::Models::AbuseReportHostname#== (method)">#==</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -332,7 +340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#==-instance_method" title="NgrokAPI::Models::CertificateAuthority#== (method)">#==</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -340,7 +348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#==-instance_method" title="NgrokAPI::Models::EventTargetFirehose#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -348,7 +356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#==-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#== (method)">#==</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -356,7 +364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#==-instance_method" title="NgrokAPI::Models::EndpointConfiguration#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -364,7 +372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -372,7 +380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -380,7 +388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -388,7 +396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#==-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -396,7 +404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -404,7 +412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -412,7 +420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#==-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -420,7 +428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#==-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -428,7 +436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -436,7 +444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -444,7 +452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#==-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -452,7 +460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#==-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -460,7 +468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#==-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#== (method)">#==</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -468,7 +476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#==-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -476,7 +484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#==-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#== (method)">#==</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -484,7 +492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -492,7 +500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#== (method)">#==</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -500,7 +508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#==-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#== (method)">#==</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -508,14 +516,6 @@ </li> - <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#==-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#== (method)">#==</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#abuse_reports-instance_method" title="NgrokAPI::Client#abuse_reports (method)">#abuse_reports</a></span> @@ -541,6 +541,14 @@ <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#acme_challenge_cname_target-instance_method" title="NgrokAPI::Models::ReservedDomain#acme_challenge_cname_target (method)">#acme_challenge_cname_target</a></span> + <small>NgrokAPI::Models::ReservedDomain</small> + </div> + </li> + + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#action-instance_method" title="NgrokAPI::Models::IPPolicy#action (method)">#action</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -548,7 +556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#add-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#add (method)">#add</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -556,7 +564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#add-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#add (method)">#add</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -564,7 +572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#addr-instance_method" title="NgrokAPI::Models::ReservedAddr#addr (method)">#addr</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -572,7 +580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#agent_version-instance_method" title="NgrokAPI::Models::TunnelSession#agent_version (method)">#agent_version</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -580,7 +588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#allow_idp_initiated-instance_method" title="NgrokAPI::Models::EndpointSAML#allow_idp_initiated (method)">#allow_idp_initiated</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -588,7 +596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#allow_idp_initiated-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#allow_idp_initiated (method)">#allow_idp_initiated</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -596,7 +604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#api_key-instance_method" title="NgrokAPI::HttpClient#api_key (method)">#api_key</a></span> <small>NgrokAPI::HttpClient</small> @@ -604,7 +612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#api_keys-instance_method" title="NgrokAPI::Client#api_keys (method)">#api_keys</a></span> <small>NgrokAPI::Client</small> @@ -612,7 +620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#assertion_consumer_service_url-instance_method" title="NgrokAPI::Models::EndpointSAML#assertion_consumer_service_url (method)">#assertion_consumer_service_url</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -620,7 +628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#auth-instance_method" title="NgrokAPI::Models::EventTargetKinesis#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -628,7 +636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#auth-instance_method" title="NgrokAPI::Models::EventTargetFirehose#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -636,7 +644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#auth-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#auth (method)">#auth</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -644,7 +652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#auth_check_interval-instance_method" title="NgrokAPI::Models::EndpointOAuth#auth_check_interval (method)">#auth_check_interval</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -652,7 +660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#authority-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#authority (method)">#authority</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -660,7 +668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#authorized_groups-instance_method" title="NgrokAPI::Models::EndpointSAML#authorized_groups (method)">#authorized_groups</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -668,7 +676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#authorized_groups-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#authorized_groups (method)">#authorized_groups</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -676,7 +684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#aws_access_key_id-instance_method" title="NgrokAPI::Models::AWSCredentials#aws_access_key_id (method)">#aws_access_key_id</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -684,7 +692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#aws_secret_access_key-instance_method" title="NgrokAPI::Models::AWSCredentials#aws_secret_access_key (method)">#aws_secret_access_key</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -692,7 +700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#backend-instance_method" title="NgrokAPI::Models::EndpointConfiguration#backend (method)">#backend</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -700,7 +708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#base_url-instance_method" title="NgrokAPI::HttpClient#base_url (method)">#base_url</a></span> <small>NgrokAPI::HttpClient</small> @@ -708,7 +716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#basic_auth-instance_method" title="NgrokAPI::Models::EndpointConfiguration#basic_auth (method)">#basic_auth</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -716,7 +724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#ca_pem-instance_method" title="NgrokAPI::Models::CertificateAuthority#ca_pem (method)">#ca_pem</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -724,7 +732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -732,7 +740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#certificate-instance_method" title="NgrokAPI::Models::SSHHostCertificate#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -740,7 +748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#certificate-instance_method" title="NgrokAPI::Models::SSHUserCertificate#certificate (method)">#certificate</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -748,7 +756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#certificate_authorities-instance_method" title="NgrokAPI::Client#certificate_authorities (method)">#certificate_authorities</a></span> <small>NgrokAPI::Client</small> @@ -756,7 +764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#certificate_authorities-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#certificate_authorities (method)">#certificate_authorities</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -764,7 +772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#certificate_authority_ids-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#certificate_authority_ids (method)">#certificate_authority_ids</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -772,7 +780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate_management_policy-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate_management_policy (method)">#certificate_management_policy</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -780,7 +788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#certificate_management_status-instance_method" title="NgrokAPI::Models::ReservedDomain#certificate_management_status (method)">#certificate_management_status</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -788,7 +796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#certificate_pem-instance_method" title="NgrokAPI::Models::TLSCertificate#certificate_pem (method)">#certificate_pem</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -796,7 +804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#cidr-instance_method" title="NgrokAPI::Models::IPPolicyRule#cidr (method)">#cidr</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -804,7 +812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#circuit_breaker-instance_method" title="NgrokAPI::Models::EndpointConfiguration#circuit_breaker (method)">#circuit_breaker</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -812,7 +820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Ref.html#client-instance_method" title="NgrokAPI::Models::Ref#client (method)">#client</a></span> <small>NgrokAPI::Models::Ref</small> @@ -820,7 +828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#client-instance_method" title="NgrokAPI::Models::Tunnel#client (method)">#client</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -828,7 +836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#client-instance_method" title="NgrokAPI::Models::APIKey#client (method)">#client</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -836,7 +844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/PagedIterator.html#client-instance_method" title="NgrokAPI::PagedIterator#client (method)">#client</a></span> <small>NgrokAPI::PagedIterator</small> @@ -844,7 +852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#client-instance_method" title="NgrokAPI::Models::AWSAuth#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -852,7 +860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#client-instance_method" title="NgrokAPI::Models::AWSRole#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -860,7 +868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#client-instance_method" title="NgrokAPI::Models::Listable#client (method)">#client</a></span> <small>NgrokAPI::Models::Listable</small> @@ -868,7 +876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#client-instance_method" title="NgrokAPI::Models::IPPolicy#client (method)">#client</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -876,7 +884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#client-instance_method" title="NgrokAPI::Models::Credential#client (method)">#client</a></span> <small>NgrokAPI::Models::Credential</small> @@ -884,7 +892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#client-instance_method" title="NgrokAPI::Models::AbuseReport#client (method)">#client</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -892,7 +900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSource.html#client-instance_method" title="NgrokAPI::Models::EventSource#client (method)">#client</a></span> <small>NgrokAPI::Models::EventSource</small> @@ -900,7 +908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#client-instance_method" title="NgrokAPI::Models::EventStream#client (method)">#client</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -908,7 +916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#client-instance_method" title="NgrokAPI::Models::EventTarget#client (method)">#client</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -916,7 +924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client-instance_method" title="NgrokAPI::Models::EndpointOIDC#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -924,7 +932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#client-instance_method" title="NgrokAPI::Models::EndpointSAML#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -932,7 +940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#client-instance_method" title="NgrokAPI::Models::ReservedAddr#client (method)">#client</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -940,7 +948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#client-instance_method" title="NgrokAPI::Models::IPPolicyRule#client (method)">#client</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -948,7 +956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#client-instance_method" title="NgrokAPI::Models::IPRestriction#client (method)">#client</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -956,7 +964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#client-instance_method" title="NgrokAPI::Models::SSHCredential#client (method)">#client</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -964,7 +972,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#client-instance_method" title="NgrokAPI::Models::TunnelSession#client (method)">#client</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -972,7 +980,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#client-instance_method" title="NgrokAPI::Models::AWSCredentials#client (method)">#client</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -980,7 +988,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#client-instance_method" title="NgrokAPI::Models::EndpointOAuth#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -988,7 +996,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#client-instance_method" title="NgrokAPI::Models::ReservedDomain#client (method)">#client</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -996,7 +1004,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#client-instance_method" title="NgrokAPI::Models::TLSCertificate#client (method)">#client</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -1004,7 +1012,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html#client-instance_method" title="NgrokAPI::Models::EndpointLogging#client (method)">#client</a></span> <small>NgrokAPI::Models::EndpointLogging</small> @@ -1012,7 +1020,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html#client-instance_method" title="NgrokAPI::Services::TunnelsClient#client (method)">#client</a></span> <small>NgrokAPI::Services::TunnelsClient</small> @@ -1020,7 +1028,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#client-instance_method" title="NgrokAPI::Models::EventDestination#client (method)">#client</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -1028,6 +1036,14 @@ </li> + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#client-instance_method" title="NgrokAPI::Models::EventSourceList#client (method)">#client</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#client-instance_method" title="NgrokAPI::Services::APIKeysClient#client (method)">#client</a></span> @@ -1437,14 +1453,6 @@ <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#client-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#client (method)">#client</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#client-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -1452,7 +1460,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#client-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -1460,7 +1468,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -1468,7 +1476,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#client-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -1476,7 +1484,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#client-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -1484,7 +1492,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -1492,7 +1500,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -1500,7 +1508,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -1508,7 +1516,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -1516,7 +1524,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#client-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#client (method)">#client</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -1524,7 +1532,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -1532,7 +1540,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -1540,7 +1548,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -1548,7 +1556,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -1556,7 +1564,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#client-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#client (method)">#client</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -1564,7 +1572,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOIDC#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1572,7 +1580,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -1580,7 +1588,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -1588,7 +1596,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -1596,7 +1604,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#client_id-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#client_id (method)">#client_id</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -1604,7 +1612,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOIDC#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1612,7 +1620,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -1620,7 +1628,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -1628,7 +1636,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -1636,7 +1644,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#client_secret-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#client_secret (method)">#client_secret</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -1644,7 +1652,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#cloudwatch_logs-instance_method" title="NgrokAPI::Models::EventTarget#cloudwatch_logs (method)">#cloudwatch_logs</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -1652,7 +1660,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#cname_target-instance_method" title="NgrokAPI::Models::ReservedDomain#cname_target (method)">#cname_target</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -1660,7 +1668,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#compression-instance_method" title="NgrokAPI::Models::EndpointConfiguration#compression (method)">#compression</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -1668,7 +1676,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointOIDC#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -1676,7 +1684,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointSAML#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -1684,7 +1692,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointOAuth#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -1692,7 +1700,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#cookie_prefix-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#cookie_prefix (method)">#cookie_prefix</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -1700,7 +1708,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#create-instance_method" title="NgrokAPI::Services::APIKeysClient#create (method)">#create</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -1708,7 +1716,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#create-instance_method" title="NgrokAPI::Services::CredentialsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -1716,7 +1724,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#create-instance_method" title="NgrokAPI::Services::IPPoliciesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -1724,7 +1732,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#create-instance_method" title="NgrokAPI::Services::IPWhitelistClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -1732,7 +1740,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html#create-instance_method" title="NgrokAPI::Services::AbuseReportsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::AbuseReportsClient</small> @@ -1740,7 +1748,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#create-instance_method" title="NgrokAPI::Services::EventSourcesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -1748,7 +1756,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#create-instance_method" title="NgrokAPI::Services::EventStreamsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -1756,7 +1764,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#create-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -1764,7 +1772,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#create-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -1772,7 +1780,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#create-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -1780,7 +1788,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#create-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -1788,7 +1796,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#create-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -1796,7 +1804,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -1804,7 +1812,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#create-instance_method" title="NgrokAPI::Services::EventDestinationsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -1812,7 +1820,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#create-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -1820,7 +1828,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -1828,7 +1836,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#create-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -1836,7 +1844,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#create-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -1844,7 +1852,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#create-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#create (method)">#create</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -1852,7 +1860,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#create-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#create (method)">#create</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -1860,7 +1868,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#created_at-instance_method" title="NgrokAPI::Models::APIKey#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -1868,7 +1876,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#created_at-instance_method" title="NgrokAPI::Models::IPPolicy#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -1876,7 +1884,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#created_at-instance_method" title="NgrokAPI::Models::Credential#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::Credential</small> @@ -1884,7 +1892,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#created_at-instance_method" title="NgrokAPI::Models::AbuseReport#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -1892,7 +1900,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#created_at-instance_method" title="NgrokAPI::Models::EventStream#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -1900,7 +1908,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#created_at-instance_method" title="NgrokAPI::Models::ReservedAddr#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -1908,7 +1916,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#created_at-instance_method" title="NgrokAPI::Models::IPPolicyRule#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -1916,7 +1924,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#created_at-instance_method" title="NgrokAPI::Models::IPRestriction#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -1924,7 +1932,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#created_at-instance_method" title="NgrokAPI::Models::SSHCredential#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -1932,7 +1940,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#created_at-instance_method" title="NgrokAPI::Models::ReservedDomain#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -1940,7 +1948,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#created_at-instance_method" title="NgrokAPI::Models::TLSCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -1948,7 +1956,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#created_at-instance_method" title="NgrokAPI::Models::EventDestination#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -1956,7 +1964,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#created_at-instance_method" title="NgrokAPI::Models::EventSubscription#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -1964,7 +1972,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#created_at-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -1972,7 +1980,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#created_at-instance_method" title="NgrokAPI::Models::SSHHostCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -1980,7 +1988,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#created_at-instance_method" title="NgrokAPI::Models::SSHUserCertificate#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -1988,7 +1996,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#created_at-instance_method" title="NgrokAPI::Models::CertificateAuthority#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -1996,7 +2004,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#created_at-instance_method" title="NgrokAPI::Models::EndpointConfiguration#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2004,7 +2012,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#created_at-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#created_at (method)">#created_at</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2012,7 +2020,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#credential-instance_method" title="NgrokAPI::Models::TunnelSession#credential (method)">#credential</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -2020,7 +2028,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#credentials-instance_method" title="NgrokAPI::Client#credentials (method)">#credentials</a></span> <small>NgrokAPI::Client</small> @@ -2028,7 +2036,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#creds-instance_method" title="NgrokAPI::Models::AWSAuth#creds (method)">#creds</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -2036,7 +2044,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#critical_options-instance_method" title="NgrokAPI::Models::SSHUserCertificate#critical_options (method)">#critical_options</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2044,7 +2052,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#debug-instance_method" title="NgrokAPI::Models::EventTarget#debug (method)">#debug</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -2052,7 +2060,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#delete-instance_method" title="NgrokAPI::HttpClient#delete (method)">#delete</a></span> <small>NgrokAPI::HttpClient</small> @@ -2060,7 +2068,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#delete-instance_method" title="NgrokAPI::Models::APIKey#delete (method)">#delete</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -2068,7 +2076,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#delete-instance_method" title="NgrokAPI::Models::IPPolicy#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -2076,7 +2084,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#delete-instance_method" title="NgrokAPI::Models::Credential#delete (method)">#delete</a></span> <small>NgrokAPI::Models::Credential</small> @@ -2084,7 +2092,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#delete-instance_method" title="NgrokAPI::Models::EventStream#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2092,7 +2100,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#delete-instance_method" title="NgrokAPI::Models::ReservedAddr#delete (method)">#delete</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -2100,7 +2108,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#delete-instance_method" title="NgrokAPI::Models::IPPolicyRule#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -2108,7 +2116,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#delete-instance_method" title="NgrokAPI::Models::IPRestriction#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -2116,7 +2124,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#delete-instance_method" title="NgrokAPI::Models::SSHCredential#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -2124,7 +2132,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#delete-instance_method" title="NgrokAPI::Models::ReservedDomain#delete (method)">#delete</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2132,7 +2140,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#delete-instance_method" title="NgrokAPI::Models::TLSCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -2140,7 +2148,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#delete-instance_method" title="NgrokAPI::Models::EventDestination#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -2148,7 +2156,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#delete-instance_method" title="NgrokAPI::Services::APIKeysClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -2156,7 +2164,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#delete-instance_method" title="NgrokAPI::Models::EventSubscription#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2164,7 +2172,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#delete-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#delete (method)">#delete</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -2172,7 +2180,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#delete-instance_method" title="NgrokAPI::Models::SSHHostCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -2180,7 +2188,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#delete-instance_method" title="NgrokAPI::Models::SSHUserCertificate#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2188,7 +2196,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#delete-instance_method" title="NgrokAPI::Services::CredentialsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -2196,7 +2204,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#delete-instance_method" title="NgrokAPI::Services::IPPoliciesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -2204,7 +2212,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#delete-instance_method" title="NgrokAPI::Models::CertificateAuthority#delete (method)">#delete</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -2212,7 +2220,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#delete-instance_method" title="NgrokAPI::Services::IPWhitelistClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -2220,7 +2228,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#delete-instance_method" title="NgrokAPI::Models::EndpointConfiguration#delete (method)">#delete</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2228,7 +2236,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#delete-instance_method" title="NgrokAPI::Services::EventSourcesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -2236,7 +2244,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#delete-instance_method" title="NgrokAPI::Services::EventStreamsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -2244,7 +2252,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2252,7 +2260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#delete-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -2260,7 +2268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#delete-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -2268,7 +2276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#delete-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -2276,7 +2284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#delete-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#delete (method)">#delete</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2284,7 +2292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2292,7 +2300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -2300,7 +2308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#delete-instance_method" title="NgrokAPI::Services::EventDestinationsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -2308,7 +2316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#delete-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -2316,7 +2324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -2324,7 +2332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -2332,7 +2340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -2340,7 +2348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -2348,7 +2356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -2356,7 +2364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#delete-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -2364,7 +2372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -2372,7 +2380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -2380,7 +2388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -2388,7 +2396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -2396,7 +2404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -2404,7 +2412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#delete-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -2412,7 +2420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -2420,7 +2428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -2428,7 +2436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -2436,7 +2444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -2444,7 +2452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#delete-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#delete (method)">#delete</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -2452,7 +2460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#delete!-instance_method" title="NgrokAPI::Services::APIKeysClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -2460,7 +2468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#delete!-instance_method" title="NgrokAPI::Services::CredentialsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -2468,7 +2476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#delete!-instance_method" title="NgrokAPI::Services::IPPoliciesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -2476,7 +2484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#delete!-instance_method" title="NgrokAPI::Services::IPWhitelistClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -2484,7 +2492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#delete!-instance_method" title="NgrokAPI::Services::EventSourcesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -2492,7 +2500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventStreamsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -2500,7 +2508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2508,7 +2516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#delete!-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -2516,7 +2524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#delete!-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -2524,7 +2532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -2532,7 +2540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2540,7 +2548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -2548,7 +2556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventDestinationsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -2556,7 +2564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#delete!-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -2564,7 +2572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -2572,7 +2580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -2580,7 +2588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -2588,7 +2596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -2596,7 +2604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -2604,7 +2612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#delete!-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -2612,7 +2620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -2620,7 +2628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -2628,7 +2636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -2636,7 +2644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -2644,7 +2652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -2652,7 +2660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#delete!-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -2660,7 +2668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -2668,7 +2676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -2676,7 +2684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -2684,7 +2692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -2692,7 +2700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#delete!-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#delete! (method)">#delete!</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -2700,7 +2708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate (method)">#delete_certificate</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2708,7 +2716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate! (method)">#delete_certificate!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2716,7 +2724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate_management_policy-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate_management_policy (method)">#delete_certificate_management_policy</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2724,7 +2732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_certificate_management_policy!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_certificate_management_policy! (method)">#delete_certificate_management_policy!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2732,7 +2740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete_endpoint_config (method)">#delete_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2740,7 +2748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#delete_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#delete_endpoint_config! (method)">#delete_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -2748,7 +2756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_http_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_http_endpoint_config (method)">#delete_http_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2756,7 +2764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_http_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_http_endpoint_config! (method)">#delete_http_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2764,7 +2772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_https_endpoint_config-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_https_endpoint_config (method)">#delete_https_endpoint_config</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2772,7 +2780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#delete_https_endpoint_config!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#delete_https_endpoint_config! (method)">#delete_https_endpoint_config!</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -2780,7 +2788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#delivery_stream_arn-instance_method" title="NgrokAPI::Models::EventTargetFirehose#delivery_stream_arn (method)">#delivery_stream_arn</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -2788,7 +2796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#description-instance_method" title="NgrokAPI::Models::APIKey#description (method)">#description</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -2796,7 +2804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#description-instance_method" title="NgrokAPI::Models::IPPolicy#description (method)">#description</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -2804,7 +2812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#description-instance_method" title="NgrokAPI::Models::Credential#description (method)">#description</a></span> <small>NgrokAPI::Models::Credential</small> @@ -2812,7 +2820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#description-instance_method" title="NgrokAPI::Models::EventStream#description (method)">#description</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2820,7 +2828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#description-instance_method" title="NgrokAPI::Models::ReservedAddr#description (method)">#description</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -2828,7 +2836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#description-instance_method" title="NgrokAPI::Models::IPPolicyRule#description (method)">#description</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -2836,7 +2844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#description-instance_method" title="NgrokAPI::Models::IPRestriction#description (method)">#description</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -2844,7 +2852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#description-instance_method" title="NgrokAPI::Models::SSHCredential#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -2852,7 +2860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#description-instance_method" title="NgrokAPI::Models::ReservedDomain#description (method)">#description</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2860,7 +2868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#description-instance_method" title="NgrokAPI::Models::TLSCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -2868,7 +2876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#description-instance_method" title="NgrokAPI::Models::EventDestination#description (method)">#description</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -2876,7 +2884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#description-instance_method" title="NgrokAPI::Models::EventSubscription#description (method)">#description</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2884,7 +2892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#description-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#description (method)">#description</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -2892,7 +2900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#description-instance_method" title="NgrokAPI::Models::SSHHostCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -2900,7 +2908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#description-instance_method" title="NgrokAPI::Models::SSHUserCertificate#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -2908,7 +2916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#description-instance_method" title="NgrokAPI::Models::CertificateAuthority#description (method)">#description</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -2916,7 +2924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#description-instance_method" title="NgrokAPI::Models::EndpointConfiguration#description (method)">#description</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -2924,7 +2932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#description-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#description (method)">#description</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -2932,7 +2940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#destination_ids-instance_method" title="NgrokAPI::Models::EventStream#destination_ids (method)">#destination_ids</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -2940,7 +2948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#destinations-instance_method" title="NgrokAPI::Models::EventSubscription#destinations (method)">#destinations</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -2948,7 +2956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#dns_names-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#dns_names (method)">#dns_names</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -2956,7 +2964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#domain-instance_method" title="NgrokAPI::Models::ReservedDomain#domain (method)">#domain</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -2964,6 +2972,14 @@ </li> + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/Listable.html#each-instance_method" title="NgrokAPI::Models::Listable#each (method)">#each</a></span> + <small>NgrokAPI::Models::Listable</small> + </div> + </li> + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#email_addresses-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#email_addresses (method)">#email_addresses</a></span> @@ -4445,6 +4461,14 @@ <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#initialize (method)">#initialize</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::APIKeysClient</small> @@ -4452,7 +4476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -4460,7 +4484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -4468,7 +4492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -4476,7 +4500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#initialize-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -4484,7 +4508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -4492,7 +4516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -4500,7 +4524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceReplace#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -4508,7 +4532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetKinesis#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -4516,7 +4540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -4524,7 +4548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -4532,7 +4556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::CredentialsClient</small> @@ -4540,7 +4564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPPoliciesClient</small> @@ -4548,7 +4572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#initialize-instance_method" title="NgrokAPI::Models::AbuseReportHostname#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -4556,7 +4580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -4564,7 +4588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetFirehose#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -4572,7 +4596,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -4580,7 +4604,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPWhitelistClient</small> @@ -4588,7 +4612,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -4596,7 +4620,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -4604,7 +4628,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::AbuseReportsClient</small> @@ -4612,7 +4636,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventSourcesClient</small> @@ -4620,7 +4644,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -4628,7 +4652,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -4636,7 +4660,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -4644,7 +4668,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -4652,7 +4676,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -4660,7 +4684,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -4668,7 +4692,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -4676,7 +4700,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#initialize-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -4684,7 +4708,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#initialize-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -4692,7 +4716,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -4700,7 +4724,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -4708,7 +4732,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -4716,7 +4740,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -4724,7 +4748,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -4732,7 +4756,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -4740,7 +4764,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#initialize-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -4748,7 +4772,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#initialize-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -4756,7 +4780,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -4764,7 +4788,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -4772,7 +4796,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -4780,7 +4804,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -4788,7 +4812,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#initialize-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -4796,7 +4820,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -4804,7 +4828,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -4812,7 +4836,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -4820,7 +4844,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#initialize-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#initialize (method)">#initialize</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -4828,7 +4852,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -4836,7 +4860,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -4844,7 +4868,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">#initialize</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -4852,14 +4876,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#initialize (method)">#initialize</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">#initialize</a></span> @@ -5221,6 +5237,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#list-instance_method" title="NgrokAPI::Services::EventSourcesClient#list (method)">#list</a></span> + <small>NgrokAPI::Services::EventSourcesClient</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#list-instance_method" title="NgrokAPI::Services::EventStreamsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventStreamsClient</small> @@ -5228,7 +5252,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#list-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::ReservedAddrsClient</small> @@ -5236,7 +5260,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#list-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::IPPolicyRulesClient</small> @@ -5244,7 +5268,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#list-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::IPRestrictionsClient</small> @@ -5252,7 +5276,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#list-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHCredentialsClient</small> @@ -5260,7 +5284,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#list-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -5268,7 +5292,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#list-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::ReservedDomainsClient</small> @@ -5276,7 +5300,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::TLSCertificatesClient</small> @@ -5284,7 +5308,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#list-instance_method" title="NgrokAPI::Services::EventDestinationsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventDestinationsClient</small> @@ -5292,7 +5316,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#list-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EventSubscriptionsClient</small> @@ -5300,7 +5324,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHHostCertificatesClient</small> @@ -5308,7 +5332,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#list-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHUserCertificatesClient</small> @@ -5316,7 +5340,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#list-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> @@ -5324,7 +5348,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#list-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#list (method)">#list</a></span> <small>NgrokAPI::Services::EndpointConfigurationsClient</small> @@ -5332,7 +5356,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#list-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#list (method)">#list</a></span> <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> @@ -5340,6 +5364,174 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html#list!-instance_method" title="NgrokAPI::Services::TunnelsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TunnelsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html#list!-instance_method" title="NgrokAPI::Services::APIKeysClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::APIKeysClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html#list!-instance_method" title="NgrokAPI::Services::CredentialsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::CredentialsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html#list!-instance_method" title="NgrokAPI::Services::IPPoliciesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPPoliciesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html#list!-instance_method" title="NgrokAPI::Services::IPWhitelistClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPWhitelistClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html#list!-instance_method" title="NgrokAPI::Services::EventSourcesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventSourcesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html#list!-instance_method" title="NgrokAPI::Services::EventStreamsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventStreamsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html#list!-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::ReservedAddrsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html#list!-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPPolicyRulesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html#list!-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::IPRestrictionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html#list!-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHCredentialsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#list!-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TunnelSessionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html#list!-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::ReservedDomainsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::TLSCertificatesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html#list!-instance_method" title="NgrokAPI::Services::EventDestinationsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventDestinationsClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html#list!-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EventSubscriptionsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHHostCertificatesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHUserCertificatesClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html#list!-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::CertificateAuthoritiesClient</small> + </div> + </li> + + + <li class="odd "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html#list!-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::EndpointConfigurationsClient</small> + </div> + </li> + + + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html#list!-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#list! (method)">#list!</a></span> + <small>NgrokAPI::Services::SSHCertificateAuthoritiesClient</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/PagedIterator.html#list_property-instance_method" title="NgrokAPI::PagedIterator#list_property (method)">#list_property</a></span> @@ -5637,14 +5829,6 @@ <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#nameservers-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#nameservers (method)">#nameservers</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#next_page_uri-instance_method" title="NgrokAPI::Models::Listable#next_page_uri (method)">#next_page_uri</a></span> <small>NgrokAPI::Models::Listable</small> @@ -5652,7 +5836,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#not_after-instance_method" title="NgrokAPI::Models::TLSCertificate#not_after (method)">#not_after</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5660,7 +5844,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#not_after-instance_method" title="NgrokAPI::Models::CertificateAuthority#not_after (method)">#not_after</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -5668,7 +5852,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#not_before-instance_method" title="NgrokAPI::Models::TLSCertificate#not_before (method)">#not_before</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5676,7 +5860,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#not_before-instance_method" title="NgrokAPI::Models::CertificateAuthority#not_before (method)">#not_before</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -5684,14 +5868,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#ns_targets-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#ns_targets (method)">#ns_targets</a></span> - <small>NgrokAPI::Models::ReservedDomainCertJob</small> - </div> - </li> - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#num_buckets-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#num_buckets (method)">#num_buckets</a></span> @@ -5781,6 +5957,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Client.html#pointcfg_module-instance_method" title="NgrokAPI::Client#pointcfg_module (method)">#pointcfg_module</a></span> + <small>NgrokAPI::Client</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/HttpClient.html#post-instance_method" title="NgrokAPI::HttpClient#post (method)">#post</a></span> <small>NgrokAPI::HttpClient</small> @@ -5788,7 +5972,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#principals-instance_method" title="NgrokAPI::Models::SSHHostCertificate#principals (method)">#principals</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -5796,7 +5980,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#principals-instance_method" title="NgrokAPI::Models::SSHUserCertificate#principals (method)">#principals</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -5804,7 +5988,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#private_key_type-instance_method" title="NgrokAPI::Models::TLSCertificate#private_key_type (method)">#private_key_type</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -5812,7 +5996,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#private_key_type-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#private_key_type (method)">#private_key_type</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -5820,7 +6004,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#proto-instance_method" title="NgrokAPI::Models::Tunnel#proto (method)">#proto</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5828,7 +6012,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#provider-instance_method" title="NgrokAPI::Models::EndpointOAuth#provider (method)">#provider</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -5836,7 +6020,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#provider-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#provider (method)">#provider</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -5844,7 +6028,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#provisioning_job-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#provisioning_job (method)">#provisioning_job</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -5852,7 +6036,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#public_key-instance_method" title="NgrokAPI::Models::SSHCredential#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -5860,7 +6044,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#public_key-instance_method" title="NgrokAPI::Models::SSHHostCertificate#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -5868,7 +6052,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#public_key-instance_method" title="NgrokAPI::Models::SSHUserCertificate#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -5876,7 +6060,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#public_key-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#public_key (method)">#public_key</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -5884,7 +6068,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#public_url-instance_method" title="NgrokAPI::Models::Tunnel#public_url (method)">#public_url</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5892,7 +6076,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#region-instance_method" title="NgrokAPI::Models::Tunnel#region (method)">#region</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -5900,7 +6084,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#region-instance_method" title="NgrokAPI::Models::ReservedAddr#region (method)">#region</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -5908,7 +6092,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#region-instance_method" title="NgrokAPI::Models::TunnelSession#region (method)">#region</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -5916,7 +6100,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#region-instance_method" title="NgrokAPI::Models::ReservedDomain#region (method)">#region</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -5924,7 +6108,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#remove-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#remove (method)">#remove</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -5932,7 +6116,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#remove-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#remove (method)">#remove</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -5940,7 +6124,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#renews_at-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#renews_at (method)">#renews_at</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -5948,7 +6132,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -5956,7 +6140,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -5964,7 +6148,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -5972,7 +6156,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -5980,7 +6164,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -5988,7 +6172,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -5996,7 +6180,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -6004,7 +6188,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -6012,7 +6196,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -6020,7 +6204,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -6028,7 +6212,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -6036,7 +6220,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#replace-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#replace (method)">#replace</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -6044,7 +6228,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointOIDCModuleClient</small> @@ -6052,7 +6236,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointSAMLModuleClient</small> @@ -6060,7 +6244,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointOAuthModuleClient</small> @@ -6068,7 +6252,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointLoggingModuleClient</small> @@ -6076,7 +6260,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointIPPolicyModuleClient</small> @@ -6084,7 +6268,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointMutualTLSModuleClient</small> @@ -6092,7 +6276,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointCompressionModuleClient</small> @@ -6100,7 +6284,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointCircuitBreakerModuleClient</small> @@ -6108,7 +6292,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointRequestHeadersModuleClient</small> @@ -6116,7 +6300,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointTLSTerminationModuleClient</small> @@ -6124,7 +6308,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointResponseHeadersModuleClient</small> @@ -6132,7 +6316,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html#replace!-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#replace! (method)">#replace!</a></span> <small>NgrokAPI::Services::EndpointWebhookValidationModuleClient</small> @@ -6140,7 +6324,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#request_headers-instance_method" title="NgrokAPI::Models::EndpointConfiguration#request_headers (method)">#request_headers</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6148,7 +6332,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#request_signing_certificate_pem-instance_method" title="NgrokAPI::Models::EndpointSAML#request_signing_certificate_pem (method)">#request_signing_certificate_pem</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6156,7 +6340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#reserved_addrs-instance_method" title="NgrokAPI::Client#reserved_addrs (method)">#reserved_addrs</a></span> <small>NgrokAPI::Client</small> @@ -6164,7 +6348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Client.html#reserved_domains-instance_method" title="NgrokAPI::Client#reserved_domains (method)">#reserved_domains</a></span> <small>NgrokAPI::Client</small> @@ -6172,7 +6356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Error.html#response-instance_method" title="NgrokAPI::Error#response (method)">#response</a></span> <small>NgrokAPI::Error</small> @@ -6180,7 +6364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html#response-instance_method" title="NgrokAPI::Errors::NotFoundError#response (method)">#response</a></span> <small>NgrokAPI::Errors::NotFoundError</small> @@ -6188,7 +6372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#response_headers-instance_method" title="NgrokAPI::Models::EndpointConfiguration#response_headers (method)">#response_headers</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6196,7 +6380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#restart-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#restart (method)">#restart</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -6204,7 +6388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html#restart!-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#restart! (method)">#restart!</a></span> <small>NgrokAPI::Services::TunnelSessionsClient</small> @@ -6212,7 +6396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Ref.html#result-instance_method" title="NgrokAPI::Models::Ref#result (method)">#result</a></span> <small>NgrokAPI::Models::Ref</small> @@ -6220,7 +6404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Tunnel.html#result-instance_method" title="NgrokAPI::Models::Tunnel#result (method)">#result</a></span> <small>NgrokAPI::Models::Tunnel</small> @@ -6228,7 +6412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#result-instance_method" title="NgrokAPI::Models::APIKey#result (method)">#result</a></span> <small>NgrokAPI::Models::APIKey</small> @@ -6236,7 +6420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#result-instance_method" title="NgrokAPI::Models::AWSAuth#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -6244,7 +6428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#result-instance_method" title="NgrokAPI::Models::AWSRole#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -6252,7 +6436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Listable.html#result-instance_method" title="NgrokAPI::Models::Listable#result (method)">#result</a></span> <small>NgrokAPI::Models::Listable</small> @@ -6260,7 +6444,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html#result-instance_method" title="NgrokAPI::Models::IPPolicy#result (method)">#result</a></span> <small>NgrokAPI::Models::IPPolicy</small> @@ -6268,7 +6452,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/Credential.html#result-instance_method" title="NgrokAPI::Models::Credential#result (method)">#result</a></span> <small>NgrokAPI::Models::Credential</small> @@ -6276,7 +6460,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#result-instance_method" title="NgrokAPI::Models::AbuseReport#result (method)">#result</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -6284,7 +6468,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSource.html#result-instance_method" title="NgrokAPI::Models::EventSource#result (method)">#result</a></span> <small>NgrokAPI::Models::EventSource</small> @@ -6292,7 +6476,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#result-instance_method" title="NgrokAPI::Models::EventStream#result (method)">#result</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -6300,7 +6484,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTarget.html#result-instance_method" title="NgrokAPI::Models::EventTarget#result (method)">#result</a></span> <small>NgrokAPI::Models::EventTarget</small> @@ -6308,7 +6492,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#result-instance_method" title="NgrokAPI::Models::EndpointOIDC#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -6316,7 +6500,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#result-instance_method" title="NgrokAPI::Models::EndpointSAML#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6324,7 +6508,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html#result-instance_method" title="NgrokAPI::Models::ReservedAddr#result (method)">#result</a></span> <small>NgrokAPI::Models::ReservedAddr</small> @@ -6332,7 +6516,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html#result-instance_method" title="NgrokAPI::Models::IPPolicyRule#result (method)">#result</a></span> <small>NgrokAPI::Models::IPPolicyRule</small> @@ -6340,7 +6524,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html#result-instance_method" title="NgrokAPI::Models::IPRestriction#result (method)">#result</a></span> <small>NgrokAPI::Models::IPRestriction</small> @@ -6348,7 +6532,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html#result-instance_method" title="NgrokAPI::Models::SSHCredential#result (method)">#result</a></span> <small>NgrokAPI::Models::SSHCredential</small> @@ -6356,7 +6540,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html#result-instance_method" title="NgrokAPI::Models::TunnelSession#result (method)">#result</a></span> <small>NgrokAPI::Models::TunnelSession</small> @@ -6364,7 +6548,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html#result-instance_method" title="NgrokAPI::Models::AWSCredentials#result (method)">#result</a></span> <small>NgrokAPI::Models::AWSCredentials</small> @@ -6372,7 +6556,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html#result-instance_method" title="NgrokAPI::Models::EndpointOAuth#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointOAuth</small> @@ -6380,7 +6564,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html#result-instance_method" title="NgrokAPI::Models::ReservedDomain#result (method)">#result</a></span> <small>NgrokAPI::Models::ReservedDomain</small> @@ -6388,7 +6572,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#result-instance_method" title="NgrokAPI::Models::TLSCertificate#result (method)">#result</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -6396,7 +6580,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html#result-instance_method" title="NgrokAPI::Models::EndpointLogging#result (method)">#result</a></span> <small>NgrokAPI::Models::EndpointLogging</small> @@ -6404,7 +6588,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventDestination.html#result-instance_method" title="NgrokAPI::Models::EventDestination#result (method)">#result</a></span> <small>NgrokAPI::Models::EventDestination</small> @@ -6412,6 +6596,14 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#result-instance_method" title="NgrokAPI::Models::EventSourceList#result (method)">#result</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#result-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#result (method)">#result</a></span> @@ -6677,14 +6869,6 @@ <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#result-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#result (method)">#result</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - - <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#retries_at-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#retries_at (method)">#retries_at</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -6692,7 +6876,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html#role-instance_method" title="NgrokAPI::Models::AWSAuth#role (method)">#role</a></span> <small>NgrokAPI::Models::AWSAuth</small> @@ -6700,7 +6884,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AWSRole.html#role_arn-instance_method" title="NgrokAPI::Models::AWSRole#role_arn (method)">#role_arn</a></span> <small>NgrokAPI::Models::AWSRole</small> @@ -6708,7 +6892,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#rolling_window-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#rolling_window (method)">#rolling_window</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -6716,7 +6900,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#saml-instance_method" title="NgrokAPI::Models::EndpointConfiguration#saml (method)">#saml</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -6724,7 +6908,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventStream.html#sampling_rate-instance_method" title="NgrokAPI::Models::EventStream#sampling_rate (method)">#sampling_rate</a></span> <small>NgrokAPI::Models::EventStream</small> @@ -6732,7 +6916,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOIDC#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOIDC</small> @@ -6740,7 +6924,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -6748,7 +6932,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -6756,7 +6940,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -6764,7 +6948,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#scopes-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#scopes (method)">#scopes</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -6772,7 +6956,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#secret-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#secret (method)">#secret</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -6780,7 +6964,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html#serial_number-instance_method" title="NgrokAPI::Models::TLSCertificate#serial_number (method)">#serial_number</a></span> <small>NgrokAPI::Models::TLSCertificate</small> @@ -6788,7 +6972,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html#single_logout_url-instance_method" title="NgrokAPI::Models::EndpointSAML#single_logout_url (method)">#single_logout_url</a></span> <small>NgrokAPI::Models::EndpointSAML</small> @@ -6796,6 +6980,14 @@ </li> + <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#sources-instance_method" title="NgrokAPI::Models::EventSourceList#sources (method)">#sources</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#sources-instance_method" title="NgrokAPI::Models::EventSubscription#sources (method)">#sources</a></span> @@ -7221,6 +7413,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#to_s-instance_method" title="NgrokAPI::Models::EventSourceList#to_s (method)">#to_s</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html#to_s-instance_method" title="NgrokAPI::Models::EndpointIPPolicy#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointIPPolicy</small> @@ -7228,7 +7428,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#to_s-instance_method" title="NgrokAPI::Models::EventSubscription#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -7236,7 +7436,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#to_s-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -7244,7 +7444,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html#to_s-instance_method" title="NgrokAPI::Models::EndpointMutualTLS#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointMutualTLS</small> @@ -7252,7 +7452,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#to_s-instance_method" title="NgrokAPI::Models::EndpointCompression#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointCompression</small> @@ -7260,7 +7460,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointSAMLMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointSAMLMutate</small> @@ -7268,7 +7468,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html#to_s-instance_method" title="NgrokAPI::Models::EventSourceReplace#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventSourceReplace</small> @@ -7276,7 +7476,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetKinesis#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetKinesis</small> @@ -7284,7 +7484,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#to_s-instance_method" title="NgrokAPI::Models::SSHHostCertificate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -7292,7 +7492,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#to_s-instance_method" title="NgrokAPI::Models::SSHUserCertificate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -7300,7 +7500,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html#to_s-instance_method" title="NgrokAPI::Models::AbuseReportHostname#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::AbuseReportHostname</small> @@ -7308,7 +7508,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#to_s-instance_method" title="NgrokAPI::Models::CertificateAuthority#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -7316,7 +7516,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetFirehose#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetFirehose</small> @@ -7324,7 +7524,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html#to_s-instance_method" title="NgrokAPI::Models::TLSCertificateSANs#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::TLSCertificateSANs</small> @@ -7332,7 +7532,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#to_s-instance_method" title="NgrokAPI::Models::EndpointConfiguration#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -7340,7 +7540,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthGoogle#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthGoogle</small> @@ -7348,7 +7548,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointLoggingMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointLoggingMutate</small> @@ -7356,7 +7556,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthGitHub#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthGitHub</small> @@ -7364,7 +7564,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#to_s-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -7372,7 +7572,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthFacebook#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthFacebook</small> @@ -7380,7 +7580,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthProvider#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthProvider</small> @@ -7388,7 +7588,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html#to_s-instance_method" title="NgrokAPI::Models::EndpointRequestHeaders#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointRequestHeaders</small> @@ -7396,7 +7596,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html#to_s-instance_method" title="NgrokAPI::Models::EndpointTLSTermination#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointTLSTermination</small> @@ -7404,7 +7604,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertJob#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertJob</small> @@ -7412,7 +7612,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointIPPolicyMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointIPPolicyMutate</small> @@ -7420,7 +7620,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html#to_s-instance_method" title="NgrokAPI::Models::EndpointOAuthMicrosoft#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointOAuthMicrosoft</small> @@ -7428,7 +7628,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html#to_s-instance_method" title="NgrokAPI::Models::EndpointResponseHeaders#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointResponseHeaders</small> @@ -7436,7 +7636,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#to_s-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -7444,7 +7644,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html#to_s-instance_method" title="NgrokAPI::Models::EndpointMutualTLSMutate#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointMutualTLSMutate</small> @@ -7452,7 +7652,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html#to_s-instance_method" title="NgrokAPI::Models::EndpointWebhookValidation#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EndpointWebhookValidation</small> @@ -7460,7 +7660,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertPolicy#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertPolicy</small> @@ -7468,7 +7668,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertStatus#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::ReservedDomainCertStatus</small> @@ -7476,7 +7676,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html#to_s-instance_method" title="NgrokAPI::Models::EventTargetCloudwatchLogs#to_s (method)">#to_s</a></span> <small>NgrokAPI::Models::EventTargetCloudwatchLogs</small> @@ -7484,14 +7684,6 @@ </li> - <li class="odd "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#to_s-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#to_s (method)">#to_s</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/APIKey.html#token-instance_method" title="NgrokAPI::Models::APIKey#token (method)">#token</a></span> @@ -8133,6 +8325,14 @@ <li class="even "> + <div class="item"> + <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html#uri-instance_method" title="NgrokAPI::Models::EventSourceList#uri (method)">#uri</a></span> + <small>NgrokAPI::Models::EventSourceList</small> + </div> + </li> + + + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html#uri-instance_method" title="NgrokAPI::Models::EventSubscription#uri (method)">#uri</a></span> <small>NgrokAPI::Models::EventSubscription</small> @@ -8140,7 +8340,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html#uri-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#uri (method)">#uri</a></span> <small>NgrokAPI::Models::IPWhitelistEntry</small> @@ -8148,7 +8348,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#uri-instance_method" title="NgrokAPI::Models::SSHHostCertificate#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8156,7 +8356,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#uri-instance_method" title="NgrokAPI::Models::SSHUserCertificate#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8164,7 +8364,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html#uri-instance_method" title="NgrokAPI::Models::CertificateAuthority#uri (method)">#uri</a></span> <small>NgrokAPI::Models::CertificateAuthority</small> @@ -8172,7 +8372,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#uri-instance_method" title="NgrokAPI::Models::EndpointConfiguration#uri (method)">#uri</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -8180,7 +8380,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html#uri-instance_method" title="NgrokAPI::Models::SSHCertificateAuthority#uri (method)">#uri</a></span> <small>NgrokAPI::Models::SSHCertificateAuthority</small> @@ -8188,7 +8388,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html#urls-instance_method" title="NgrokAPI::Models::AbuseReport#urls (method)">#urls</a></span> <small>NgrokAPI::Models::AbuseReport</small> @@ -8196,7 +8396,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#valid_after-instance_method" title="NgrokAPI::Models::SSHHostCertificate#valid_after (method)">#valid_after</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8204,7 +8404,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#valid_after-instance_method" title="NgrokAPI::Models::SSHUserCertificate#valid_after (method)">#valid_after</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8212,7 +8412,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html#valid_until-instance_method" title="NgrokAPI::Models::SSHHostCertificate#valid_until (method)">#valid_until</a></span> <small>NgrokAPI::Models::SSHHostCertificate</small> @@ -8220,7 +8420,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html#valid_until-instance_method" title="NgrokAPI::Models::SSHUserCertificate#valid_until (method)">#valid_until</a></span> <small>NgrokAPI::Models::SSHUserCertificate</small> @@ -8228,7 +8428,7 @@ </li> - <li class="even "> + <li class="odd "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html#volume_threshold-instance_method" title="NgrokAPI::Models::EndpointCircuitBreaker#volume_threshold (method)">#volume_threshold</a></span> <small>NgrokAPI::Models::EndpointCircuitBreaker</small> @@ -8236,7 +8436,7 @@ </li> - <li class="odd "> + <li class="even "> <div class="item"> <span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html#webhook_validation-instance_method" title="NgrokAPI::Models::EndpointConfiguration#webhook_validation (method)">#webhook_validation</a></span> <small>NgrokAPI::Models::EndpointConfiguration</small> @@ -8244,14 +8444,6 @@ </li> - <li class="even "> - <div class="item"> - <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html#zone-instance_method" title="NgrokAPI::Models::ReservedDomainCertNSTarget#zone (method)">#zone</a></span> - <small>NgrokAPI::Models::ReservedDomainCertNSTarget</small> - </div> - </li> - - </ul> </div> diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html index 8743aa2..dd4a689 100644 --- a/docs/top-level-namespace.html +++ b/docs/top-level-namespace.html @@ -100,7 +100,7 @@ </div> <div id="footer"> - Generated on Mon Oct 4 23:24:15 2021 by + Generated on Tue Oct 19 15:48:17 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> diff --git a/lib/ngrokapi/client.rb b/lib/ngrokapi/client.rb index 930ad9c..5b5aa85 100644 --- a/lib/ngrokapi/client.rb +++ b/lib/ngrokapi/client.rb @@ -1,5 +1,7 @@ # frozen_string_literal: true +require 'ostruct' + module NgrokAPI ## # Low-level api client for communicating with Ngrok's HTTP API. @@ -22,11 +24,10 @@ module NgrokAPI end ## - # API Keys are used to authenticate to the - # (https://ngrok.com/docs/api#authentication)ngrok - # API. You may use the API itself + # API Keys are used to authenticate to the [ngrok + # API](https://ngrok.com/docs/api#authentication). You may use the API itself # to provision and manage API Keys but you'll need to provision your first API - # key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your + # key from the [API Keys page](https://dashboard.ngrok.com/api/keys) on your # ngrok.com dashboard. # # @return [NgrokAPI::Services::APIKeysClient] @@ -49,8 +50,8 @@ module NgrokAPI ## # Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok # agent to connect the ngrok service as your account. They are installed with - # the ngrok authtoken command or by specifying it in the ngrok.yml - # configuration file with the authtoken property. + # the `ngrok authtoken` command or by specifying it in the `ngrok.yml` + # configuration file with the `authtoken` property. # # @return [NgrokAPI::Services::CredentialsClient] def credentials @@ -84,7 +85,7 @@ module NgrokAPI end ## - # IP Policies are reusable groups of CIDR ranges with an allow or deny + # IP Policies are reusable groups of CIDR ranges with an `allow` or `deny` # action. They can be attached to endpoints via the Endpoint Configuration IP # Policy module. They can also be used with IP Restrictions to control source # IP ranges that can start tunnel sessions and connect to the API and dashboard. @@ -118,7 +119,7 @@ module NgrokAPI ## # The IP Whitelist is deprecated and will be removed. Use an IP Restriction - # with an endpoints type instead. + # with an `endpoints` type instead. # # @return [NgrokAPI::Services::IPWhitelistClient] def ip_whitelist @@ -214,5 +215,23 @@ module NgrokAPI def tunnels @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client) end + + def pointcfg_module + ns = OpenStruct.new + ns.logging = NgrokAPI::Services::EndpointLoggingModuleClient.new(client: @client) + ns.circuit_breaker = NgrokAPI::Services::EndpointCircuitBreakerModuleClient.new(client: @client) + ns.compression = NgrokAPI::Services::EndpointCompressionModuleClient.new(client: @client) + ns.tls_termination = NgrokAPI::Services::EndpointTLSTerminationModuleClient.new(client: @client) + ns.ip_policy = NgrokAPI::Services::EndpointIPPolicyModuleClient.new(client: @client) + ns.mutual_tls = NgrokAPI::Services::EndpointMutualTLSModuleClient.new(client: @client) + ns.request_headers = NgrokAPI::Services::EndpointRequestHeadersModuleClient.new(client: @client) + ns.response_headers = NgrokAPI::Services::EndpointResponseHeadersModuleClient.new(client: @client) + ns.oauth = NgrokAPI::Services::EndpointOAuthModuleClient.new(client: @client) + ns.webhook_validation = NgrokAPI::Services::EndpointWebhookValidationModuleClient.new(client: @client) + ns.saml = NgrokAPI::Services::EndpointSAMLModuleClient.new(client: @client) + ns.oidc = NgrokAPI::Services::EndpointOIDCModuleClient.new(client: @client) + + ns + end end end diff --git a/lib/ngrokapi/http_client.rb b/lib/ngrokapi/http_client.rb index b30cf4c..8594a83 100644 --- a/lib/ngrokapi/http_client.rb +++ b/lib/ngrokapi/http_client.rb @@ -42,21 +42,23 @@ module NgrokAPI end ## - # Make a GET request + # Make a GET request to list resources # + # @param [boolean] danger determine if we should throw an exception on 404 or not # @param [string] before_id URL resource path # @param [integer] limit URL resource path # @param [string] path resource path, mutually exclusive with url # @param [string] url Full URL of the resource, mutually exclusive with path + # @param [string] url Full URL of the resource, mutually exclusive with path # @return [json] response body - def list(before_id: nil, limit: nil, path: nil, url: nil) + def list(danger: false, before_id: nil, limit: nil, path: nil, url: nil) if url get(url) else data = {} data[:before_id] = before_id if before_id data[:limit] = limit if limit - get(path, data: data) + get(path, danger: danger, data: data) end end diff --git a/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb b/lib/ngrokapi/models/event_source_list.rb similarity index 68% rename from lib/ngrokapi/models/reserved_domain_cert_ns_target.rb rename to lib/ngrokapi/models/event_source_list.rb index 7be1ba4..24e7364 100644 --- a/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +++ b/lib/ngrokapi/models/event_source_list.rb @@ -2,17 +2,17 @@ module NgrokAPI module Models - class ReservedDomainCertNSTarget + class EventSourceList attr_reader :client, :result, - :zone, - :nameservers + :sources, + :uri def initialize(client:, result:) @client = client @result = result - @zone = @result['zone'] - @nameservers = @result['nameservers'] + @sources = @result['sources'] + @uri = @result['uri'] end def ==(other) diff --git a/lib/ngrokapi/models/listable.rb b/lib/ngrokapi/models/listable.rb index 7fab8e6..9a51a8a 100644 --- a/lib/ngrokapi/models/listable.rb +++ b/lib/ngrokapi/models/listable.rb @@ -5,6 +5,8 @@ module NgrokAPI ## # A resource representing multiple instances from a given "list" API call class Listable + include Enumerable + attr_reader :client, :klass, :iter, @@ -14,7 +16,7 @@ module NgrokAPI :result, :uri - def initialize(client:, result:, list_property:, klass:) + def initialize(danger: false, client:, result:, list_property:, klass:) @client = client @result = result @list_property = list_property @@ -26,10 +28,19 @@ module NgrokAPI @iter = NgrokAPI::PagedIterator.new( client: client, page: self, - list_property: list_property + list_property: list_property, + danger: danger ) end + def each + item = @iter.get_next + while item + yield item + item = @iter.get_next + end + end + def ==(other) @result == other.result end diff --git a/lib/ngrokapi/models/reserved_domain.rb b/lib/ngrokapi/models/reserved_domain.rb index 6d8c2fc..66422a9 100644 --- a/lib/ngrokapi/models/reserved_domain.rb +++ b/lib/ngrokapi/models/reserved_domain.rb @@ -17,7 +17,8 @@ module NgrokAPI :https_endpoint_configuration, :certificate, :certificate_management_policy, - :certificate_management_status + :certificate_management_status, + :acme_challenge_cname_target def initialize(client:, result:) @client = client @@ -35,6 +36,7 @@ module NgrokAPI @certificate = @result['certificate'] @certificate_management_policy = @result['certificate_management_policy'] @certificate_management_status = @result['certificate_management_status'] + @acme_challenge_cname_target = @result['acme_challenge_cname_target'] end def ==(other) diff --git a/lib/ngrokapi/models/reserved_domain_cert_job.rb b/lib/ngrokapi/models/reserved_domain_cert_job.rb index 255dd3c..a80f9c0 100644 --- a/lib/ngrokapi/models/reserved_domain_cert_job.rb +++ b/lib/ngrokapi/models/reserved_domain_cert_job.rb @@ -8,8 +8,7 @@ module NgrokAPI :error_code, :msg, :started_at, - :retries_at, - :ns_targets + :retries_at def initialize(client:, result:) @client = client @@ -18,7 +17,6 @@ module NgrokAPI @msg = @result['msg'] @started_at = @result['started_at'] @retries_at = @result['retries_at'] - @ns_targets = @result['ns_targets'] end def ==(other) diff --git a/lib/ngrokapi/paged_iterator.rb b/lib/ngrokapi/paged_iterator.rb index d19a174..960e428 100644 --- a/lib/ngrokapi/paged_iterator.rb +++ b/lib/ngrokapi/paged_iterator.rb @@ -10,12 +10,14 @@ module NgrokAPI def initialize( client:, page:, - list_property: + list_property:, + danger: false ) @n = 0 @client = client @list_property = list_property @page = page + @danger = danger end ## @@ -30,7 +32,7 @@ module NgrokAPI item rescue if @page.next_page_uri - res = @client.list(url: @page.next_page_uri) + res = @client.list(danger: @danger, url: @page.next_page_uri) self.n = 0 self.page = res get_next diff --git a/lib/ngrokapi/services/api_keys_client.rb b/lib/ngrokapi/services/api_keys_client.rb index 90bbb73..5f7b1cb 100644 --- a/lib/ngrokapi/services/api_keys_client.rb +++ b/lib/ngrokapi/services/api_keys_client.rb @@ -3,11 +3,10 @@ module NgrokAPI module Services ## - # API Keys are used to authenticate to the - # (https://ngrok.com/docs/api#authentication)ngrok - # API. You may use the API itself + # API Keys are used to authenticate to the [ngrok + # API](https://ngrok.com/docs/api#authentication). You may use the API itself # to provision and manage API Keys but you'll need to provision your first API - # key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your + # key from the [API Keys page](https://dashboard.ngrok.com/api/keys) on your # ngrok.com dashboard. # # https://ngrok.com/docs/api#api-api-keys @@ -140,6 +139,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -148,6 +148,38 @@ module NgrokAPI ) end + ## + # List all API keys owned by this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-api-keys-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::APIKey, + danger: true + ) + end + ## # Update attributes of an API key by ID. # diff --git a/lib/ngrokapi/services/certificate_authorities_client.rb b/lib/ngrokapi/services/certificate_authorities_client.rb index 5d4760e..ca8c480 100644 --- a/lib/ngrokapi/services/certificate_authorities_client.rb +++ b/lib/ngrokapi/services/certificate_authorities_client.rb @@ -141,6 +141,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -149,6 +150,38 @@ module NgrokAPI ) end + ## + # List all Certificate Authority on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-certificate-authorities-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::CertificateAuthority, + danger: true + ) + end + ## # Update attributes of a Certificate Authority by ID # diff --git a/lib/ngrokapi/services/credentials_client.rb b/lib/ngrokapi/services/credentials_client.rb index 705dbb7..b7a34bd 100644 --- a/lib/ngrokapi/services/credentials_client.rb +++ b/lib/ngrokapi/services/credentials_client.rb @@ -5,8 +5,8 @@ module NgrokAPI ## # Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok # agent to connect the ngrok service as your account. They are installed with - # the ngrok authtoken command or by specifying it in the ngrok.yml - # configuration file with the authtoken property. + # the `ngrok authtoken` command or by specifying it in the `ngrok.yml` + # configuration file with the `authtoken` property. # # https://ngrok.com/docs/api#api-credentials class CredentialsClient @@ -143,6 +143,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -151,6 +152,38 @@ module NgrokAPI ) end + ## + # List all tunnel authtoken credentials on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-credentials-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Credential, + danger: true + ) + end + ## # Update attributes of an tunnel authtoken credential by ID # diff --git a/lib/ngrokapi/services/endpoint_configurations_client.rb b/lib/ngrokapi/services/endpoint_configurations_client.rb index be40ca3..745768f 100644 --- a/lib/ngrokapi/services/endpoint_configurations_client.rb +++ b/lib/ngrokapi/services/endpoint_configurations_client.rb @@ -179,6 +179,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -187,6 +188,38 @@ module NgrokAPI ) end + ## + # Returns a list of all endpoint configurations on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-endpoint-configurations-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::EndpointConfiguration, + danger: true + ) + end + ## # Updates an endpoint configuration. If a module is not specified in the update, # it will not be modified. However, each module configuration that is specified diff --git a/lib/ngrokapi/services/event_destinations_client.rb b/lib/ngrokapi/services/event_destinations_client.rb index 4ee97ad..414fca7 100644 --- a/lib/ngrokapi/services/event_destinations_client.rb +++ b/lib/ngrokapi/services/event_destinations_client.rb @@ -145,6 +145,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -153,6 +154,38 @@ module NgrokAPI ) end + ## + # List all Event Destinations on this account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-event-destinations-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::EventDestination, + danger: true + ) + end + ## # Update attributes of an Event Destination. # diff --git a/lib/ngrokapi/services/event_sources_client.rb b/lib/ngrokapi/services/event_sources_client.rb index d8b8593..8938219 100644 --- a/lib/ngrokapi/services/event_sources_client.rb +++ b/lib/ngrokapi/services/event_sources_client.rb @@ -124,6 +124,45 @@ module NgrokAPI NgrokAPI::Models::EventSource.new(client: self, result: result) end + ## + # List the types for which this event subscription will trigger + # + # @param [string] subscription_id The unique identifier for the Event Subscription that this Event Source is attached to. + # @return [NgrokAPI::Models::EventSourceList] result from the API request + # + # https://ngrok.com/docs/api#api-event-sources-list + def list( + subscription_id: "" + ) + path = '/event_subscriptions/%{subscription_id}/sources' + replacements = { + subscription_id: subscription_id, + } + data = {} + result = @client.get(path % replacements, data: data) + NgrokAPI::Models::EventSourceList.new(client: self, result: result) + end + + ## + # List the types for which this event subscription will trigger + # Throws an exception if API error. + # + # @param [string] subscription_id The unique identifier for the Event Subscription that this Event Source is attached to. + # @return [NgrokAPI::Models::EventSourceList] result from the API request + # + # https://ngrok.com/docs/api#api-event-sources-list + def list!( + subscription_id: "" + ) + path = '/event_subscriptions/%{subscription_id}/sources' + replacements = { + subscription_id: subscription_id, + } + data = {} + result = @client.get(path % replacements, data: data, danger: true) + NgrokAPI::Models::EventSourceList.new(client: self, result: result) + end + ## # Update the type for which this event subscription will trigger # diff --git a/lib/ngrokapi/services/event_streams_client.rb b/lib/ngrokapi/services/event_streams_client.rb index 70d5df6..df8f96e 100644 --- a/lib/ngrokapi/services/event_streams_client.rb +++ b/lib/ngrokapi/services/event_streams_client.rb @@ -145,6 +145,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -153,6 +154,38 @@ module NgrokAPI ) end + ## + # List all Event Streams available on this account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-event-streams-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::EventStream, + danger: true + ) + end + ## # Update attributes of an Event Stream by ID. # diff --git a/lib/ngrokapi/services/event_subscriptions_client.rb b/lib/ngrokapi/services/event_subscriptions_client.rb index c614594..8961774 100644 --- a/lib/ngrokapi/services/event_subscriptions_client.rb +++ b/lib/ngrokapi/services/event_subscriptions_client.rb @@ -138,6 +138,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -146,6 +147,38 @@ module NgrokAPI ) end + ## + # List this Account's Event Subscriptions. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-event-subscriptions-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::EventSubscription, + danger: true + ) + end + ## # Update an Event Subscription. # diff --git a/lib/ngrokapi/services/ip_policies_client.rb b/lib/ngrokapi/services/ip_policies_client.rb index 35d3f65..b358d7d 100644 --- a/lib/ngrokapi/services/ip_policies_client.rb +++ b/lib/ngrokapi/services/ip_policies_client.rb @@ -3,7 +3,7 @@ module NgrokAPI module Services ## - # IP Policies are reusable groups of CIDR ranges with an allow or deny + # IP Policies are reusable groups of CIDR ranges with an `allow` or `deny` # action. They can be attached to endpoints via the Endpoint Configuration IP # Policy module. They can also be used with IP Restrictions to control source # IP ranges that can start tunnel sessions and connect to the API and dashboard. @@ -145,6 +145,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -153,6 +154,38 @@ module NgrokAPI ) end + ## + # List all IP policies on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ip-policies-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::IPPolicy, + danger: true + ) + end + ## # Update attributes of an IP policy by ID # diff --git a/lib/ngrokapi/services/ip_policy_rules_client.rb b/lib/ngrokapi/services/ip_policy_rules_client.rb index 22a1665..dd0e7ad 100644 --- a/lib/ngrokapi/services/ip_policy_rules_client.rb +++ b/lib/ngrokapi/services/ip_policy_rules_client.rb @@ -141,6 +141,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -149,6 +150,38 @@ module NgrokAPI ) end + ## + # List all IP policy rules on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ip-policy-rules-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::IPPolicyRule, + danger: true + ) + end + ## # Update attributes of an IP policy rule by ID # diff --git a/lib/ngrokapi/services/ip_restrictions_client.rb b/lib/ngrokapi/services/ip_restrictions_client.rb index a8c3bad..315c3b9 100644 --- a/lib/ngrokapi/services/ip_restrictions_client.rb +++ b/lib/ngrokapi/services/ip_restrictions_client.rb @@ -148,6 +148,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -156,6 +157,38 @@ module NgrokAPI ) end + ## + # List all IP restrictions on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ip-restrictions-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::IPRestriction, + danger: true + ) + end + ## # Update attributes of an IP restriction by ID # diff --git a/lib/ngrokapi/services/ip_whitelist_client.rb b/lib/ngrokapi/services/ip_whitelist_client.rb index f19ab77..d3f44d0 100644 --- a/lib/ngrokapi/services/ip_whitelist_client.rb +++ b/lib/ngrokapi/services/ip_whitelist_client.rb @@ -4,7 +4,7 @@ module NgrokAPI module Services ## # The IP Whitelist is deprecated and will be removed. Use an IP Restriction - # with an endpoints type instead. + # with an `endpoints` type instead. # # https://ngrok.com/docs/api#api-ip-whitelist class IPWhitelistClient @@ -139,6 +139,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -147,6 +148,38 @@ module NgrokAPI ) end + ## + # List all IP whitelist entries on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ip-whitelist-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::IPWhitelistEntry, + danger: true + ) + end + ## # Update attributes of an IP whitelist entry by ID # diff --git a/lib/ngrokapi/services/reserved_addrs_client.rb b/lib/ngrokapi/services/reserved_addrs_client.rb index 7e1bbb9..51a7b11 100644 --- a/lib/ngrokapi/services/reserved_addrs_client.rb +++ b/lib/ngrokapi/services/reserved_addrs_client.rb @@ -142,6 +142,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -150,6 +151,38 @@ module NgrokAPI ) end + ## + # List all reserved addresses on this account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-reserved-addrs-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::ReservedAddr, + danger: true + ) + end + ## # Update the attributes of a reserved address. # diff --git a/lib/ngrokapi/services/reserved_domains_client.rb b/lib/ngrokapi/services/reserved_domains_client.rb index a6b767c..467d4d3 100644 --- a/lib/ngrokapi/services/reserved_domains_client.rb +++ b/lib/ngrokapi/services/reserved_domains_client.rb @@ -155,6 +155,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -163,6 +164,38 @@ module NgrokAPI ) end + ## + # List all reserved domains on this account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-reserved-domains-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::ReservedDomain, + danger: true + ) + end + ## # Update the attributes of a reserved domain. # diff --git a/lib/ngrokapi/services/ssh_certificate_authorities_client.rb b/lib/ngrokapi/services/ssh_certificate_authorities_client.rb index 0579d36..abbd698 100644 --- a/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +++ b/lib/ngrokapi/services/ssh_certificate_authorities_client.rb @@ -144,6 +144,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -152,6 +153,38 @@ module NgrokAPI ) end + ## + # List all SSH Certificate Authorities on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ssh-certificate-authorities-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::SSHCertificateAuthority, + danger: true + ) + end + ## # Update an SSH Certificate Authority # diff --git a/lib/ngrokapi/services/ssh_credentials_client.rb b/lib/ngrokapi/services/ssh_credentials_client.rb index 9612d67..b9ad633 100644 --- a/lib/ngrokapi/services/ssh_credentials_client.rb +++ b/lib/ngrokapi/services/ssh_credentials_client.rb @@ -142,6 +142,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -150,6 +151,38 @@ module NgrokAPI ) end + ## + # List all ssh credentials on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ssh-credentials-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::SSHCredential, + danger: true + ) + end + ## # Update attributes of an ssh_credential by ID # diff --git a/lib/ngrokapi/services/ssh_host_certificates_client.rb b/lib/ngrokapi/services/ssh_host_certificates_client.rb index 9eadc3a..97341cb 100644 --- a/lib/ngrokapi/services/ssh_host_certificates_client.rb +++ b/lib/ngrokapi/services/ssh_host_certificates_client.rb @@ -151,6 +151,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -159,6 +160,38 @@ module NgrokAPI ) end + ## + # List all SSH Host Certificates issued on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ssh-host-certificates-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::SSHHostCertificate, + danger: true + ) + end + ## # Update an SSH Host Certificate # diff --git a/lib/ngrokapi/services/ssh_user_certificates_client.rb b/lib/ngrokapi/services/ssh_user_certificates_client.rb index f46056a..909b170 100644 --- a/lib/ngrokapi/services/ssh_user_certificates_client.rb +++ b/lib/ngrokapi/services/ssh_user_certificates_client.rb @@ -157,6 +157,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -165,6 +166,38 @@ module NgrokAPI ) end + ## + # List all SSH User Certificates issued on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-ssh-user-certificates-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::SSHUserCertificate, + danger: true + ) + end + ## # Update an SSH User Certificate # diff --git a/lib/ngrokapi/services/tls_certificates_client.rb b/lib/ngrokapi/services/tls_certificates_client.rb index 42603c9..cdfb2ee 100644 --- a/lib/ngrokapi/services/tls_certificates_client.rb +++ b/lib/ngrokapi/services/tls_certificates_client.rb @@ -144,6 +144,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -152,6 +153,38 @@ module NgrokAPI ) end + ## + # List all TLS certificates on this account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-tls-certificates-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::TLSCertificate, + danger: true + ) + end + ## # Update attributes of a TLS Certificate by ID # diff --git a/lib/ngrokapi/services/tunnel_sessions_client.rb b/lib/ngrokapi/services/tunnel_sessions_client.rb index b8fa493..0a48d57 100644 --- a/lib/ngrokapi/services/tunnel_sessions_client.rb +++ b/lib/ngrokapi/services/tunnel_sessions_client.rb @@ -40,6 +40,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -48,6 +49,38 @@ module NgrokAPI ) end + ## + # List all online tunnel sessions running on this account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-tunnel-sessions-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::TunnelSession, + danger: true + ) + end + ## # Get the detailed status of a tunnel session by ID # diff --git a/lib/ngrokapi/services/tunnels_client.rb b/lib/ngrokapi/services/tunnels_client.rb index a647adf..36b2cf9 100644 --- a/lib/ngrokapi/services/tunnels_client.rb +++ b/lib/ngrokapi/services/tunnels_client.rb @@ -39,6 +39,7 @@ module NgrokAPI url: url, path: PATH ) + NgrokAPI::Models::Listable.new( client: self, result: result, @@ -46,6 +47,38 @@ module NgrokAPI klass: NgrokAPI::Models::Tunnel ) end + + ## + # List all online tunnels currently running on the account. + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-tunnels-list + def list!( + before_id: nil, + limit: nil, + url: nil + ) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + result: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Tunnel, + danger: true + ) + end end end end diff --git a/lib/ngrokapi/version.rb b/lib/ngrokapi/version.rb index e8573a9..15acac8 100644 --- a/lib/ngrokapi/version.rb +++ b/lib/ngrokapi/version.rb @@ -2,6 +2,6 @@ module NgrokAPI # rubocop:disable Layout/SpaceAroundOperators # The current version of the gem - VERSION="0.12.0".freeze + VERSION="0.14.0".freeze # rubocop:enable Layout/SpaceAroundOperators end diff --git a/spec/ngrokapi/client_spec.rb b/spec/ngrokapi/client_spec.rb index 0ea4ae3..a8ab33f 100644 --- a/spec/ngrokapi/client_spec.rb +++ b/spec/ngrokapi/client_spec.rb @@ -1,4 +1,5 @@ require 'spec_helper' +require 'ostruct' RSpec.describe NgrokAPI::Client do before(:each) do @@ -136,4 +137,22 @@ RSpec.describe NgrokAPI::Client do expect(@client.tunnels.class).to eq(NgrokAPI::Services::TunnelsClient) end end + + describe "#pointcfg_module" do + it "returns an instance of OpenStruct covering namespaces" do + ns = @client.pointcfg_module + expect(ns.logging.class).to eq(NgrokAPI::Services::EndpointLoggingModuleClient) + expect(ns.circuit_breaker.class).to eq(NgrokAPI::Services::EndpointCircuitBreakerModuleClient) + expect(ns.compression.class).to eq(NgrokAPI::Services::EndpointCompressionModuleClient) + expect(ns.tls_termination.class).to eq(NgrokAPI::Services::EndpointTLSTerminationModuleClient) + expect(ns.ip_policy.class).to eq(NgrokAPI::Services::EndpointIPPolicyModuleClient) + expect(ns.mutual_tls.class).to eq(NgrokAPI::Services::EndpointMutualTLSModuleClient) + expect(ns.request_headers.class).to eq(NgrokAPI::Services::EndpointRequestHeadersModuleClient) + expect(ns.response_headers.class).to eq(NgrokAPI::Services::EndpointResponseHeadersModuleClient) + expect(ns.oauth.class).to eq(NgrokAPI::Services::EndpointOAuthModuleClient) + expect(ns.webhook_validation.class).to eq(NgrokAPI::Services::EndpointWebhookValidationModuleClient) + expect(ns.saml.class).to eq(NgrokAPI::Services::EndpointSAMLModuleClient) + expect(ns.oidc.class).to eq(NgrokAPI::Services::EndpointOIDCModuleClient) + end + end end diff --git a/spec/ngrokapi/models/event_source_list_spec.rb b/spec/ngrokapi/models/event_source_list_spec.rb new file mode 100644 index 0000000..ad6630c --- /dev/null +++ b/spec/ngrokapi/models/event_source_list_spec.rb @@ -0,0 +1,21 @@ +require 'spec_helper' + +RSpec.describe NgrokAPI::Models::EventSourceList do + before(:each) do + @client = class_double("EventSourceListsClient") + @event_source_list = NgrokAPI::Models::EventSourceList.new(client: @client, result: event_source_list_result) + end + + describe "#==" do + it "is equal if the results are the same" do + other = NgrokAPI::Models::EventSourceList.new(client: @client, result: event_source_list_result) + expect(@event_source_list == other).to eq true + end + end + + describe "#to_s" do + it "stringifies as result.to_s" do + expect(@event_source_list.to_s).to eq event_source_list_result.to_s + end + end +end diff --git a/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb b/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb deleted file mode 100644 index cf2325a..0000000 --- a/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +++ /dev/null @@ -1,21 +0,0 @@ -require 'spec_helper' - -RSpec.describe NgrokAPI::Models::ReservedDomainCertNSTarget do - before(:each) do - @client = class_double("ReservedDomainCertNSTargetsClient") - @reserved_domain_cert_ns_target = NgrokAPI::Models::ReservedDomainCertNSTarget.new(client: @client, result: reserved_domain_cert_ns_target_result) - end - - describe "#==" do - it "is equal if the results are the same" do - other = NgrokAPI::Models::ReservedDomainCertNSTarget.new(client: @client, result: reserved_domain_cert_ns_target_result) - expect(@reserved_domain_cert_ns_target == other).to eq true - end - end - - describe "#to_s" do - it "stringifies as result.to_s" do - expect(@reserved_domain_cert_ns_target.to_s).to eq reserved_domain_cert_ns_target_result.to_s - end - end -end diff --git a/spec/ngrokapi/paged_iterator_spec.rb b/spec/ngrokapi/paged_iterator_spec.rb index 68670e9..3aff846 100644 --- a/spec/ngrokapi/paged_iterator_spec.rb +++ b/spec/ngrokapi/paged_iterator_spec.rb @@ -67,7 +67,7 @@ RSpec.describe NgrokAPI::PagedIterator do page: empty_page, list_property: 'keys' ) - expect(client).to receive(:list).with({ url: next_page_uri }).and_return(page) + expect(client).to receive(:list).with({ danger: false, url: next_page_uri }).and_return(page) expect(paged_iterator.get_next).to eq(api_key_result) end @@ -77,7 +77,7 @@ RSpec.describe NgrokAPI::PagedIterator do page: empty_page, list_property: 'keys' ) - expect(client).to receive(:list).with({ url: next_page_uri }).and_return(empty_last_page) + expect(client).to receive(:list).with({ danger: false, url: next_page_uri }).and_return(empty_last_page) expect(paged_iterator.get_next).to eq(nil) end end diff --git a/spec/ngrokapi/services/abuse_reports_client_spec.rb b/spec/ngrokapi/services/abuse_reports_client_spec.rb index 24b3a8b..8bdf212 100644 --- a/spec/ngrokapi/services/abuse_reports_client_spec.rb +++ b/spec/ngrokapi/services/abuse_reports_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::AbuseReportsClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::AbuseReport) - # expect(result.id).to eq(abuse_report_result["id"]) end end @@ -44,7 +43,6 @@ RSpec.describe NgrokAPI::Services::AbuseReportsClient do id: abuse_report_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::AbuseReport) - # expect(result.id).to eq(abuse_report_result["id"]) end end diff --git a/spec/ngrokapi/services/api_keys_client_spec.rb b/spec/ngrokapi/services/api_keys_client_spec.rb index f29f544..b316163 100644 --- a/spec/ngrokapi/services/api_keys_client_spec.rb +++ b/spec/ngrokapi/services/api_keys_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::APIKeysClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::APIKey) - # expect(result.id).to eq(api_key_result["id"]) end end @@ -85,7 +84,6 @@ RSpec.describe NgrokAPI::Services::APIKeysClient do id: api_key_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::APIKey) - # expect(result.id).to eq(api_key_result["id"]) end end @@ -133,7 +131,6 @@ RSpec.describe NgrokAPI::Services::APIKeysClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::APIKey) - # expect(result.id).to eq(api_key_result["id"]) end end diff --git a/spec/ngrokapi/services/certificate_authorities_client_spec.rb b/spec/ngrokapi/services/certificate_authorities_client_spec.rb index 2a8408c..c25d8b7 100644 --- a/spec/ngrokapi/services/certificate_authorities_client_spec.rb +++ b/spec/ngrokapi/services/certificate_authorities_client_spec.rb @@ -29,7 +29,6 @@ RSpec.describe NgrokAPI::Services::CertificateAuthoritiesClient do ca_pem: "New ca_pem" ) expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority) - # expect(result.id).to eq(certificate_authority_result["id"]) end end @@ -87,7 +86,6 @@ RSpec.describe NgrokAPI::Services::CertificateAuthoritiesClient do id: certificate_authority_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority) - # expect(result.id).to eq(certificate_authority_result["id"]) end end @@ -135,7 +133,6 @@ RSpec.describe NgrokAPI::Services::CertificateAuthoritiesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::CertificateAuthority) - # expect(result.id).to eq(certificate_authority_result["id"]) end end diff --git a/spec/ngrokapi/services/credentials_client_spec.rb b/spec/ngrokapi/services/credentials_client_spec.rb index 3ba7723..425c050 100644 --- a/spec/ngrokapi/services/credentials_client_spec.rb +++ b/spec/ngrokapi/services/credentials_client_spec.rb @@ -29,7 +29,6 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do acl: "New acl" ) expect(result.class).to eq(NgrokAPI::Models::Credential) - # expect(result.id).to eq(credential_result["id"]) end end @@ -87,7 +86,6 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do id: credential_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::Credential) - # expect(result.id).to eq(credential_result["id"]) end end @@ -137,7 +135,6 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do acl: "New acl" ) expect(result.class).to eq(NgrokAPI::Models::Credential) - # expect(result.id).to eq(credential_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb b/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb index 52dcabc..0d832e1 100644 --- a/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointCircuitBreakerModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointCircuitBreaker) - # expect(result.id).to eq(endpoint_circuit_breaker_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointCircuitBreakerModuleClient do id: endpoint_circuit_breaker_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointCircuitBreaker) - # expect(result.id).to eq(endpoint_circuit_breaker_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb b/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb index 150746e..0f91196 100644 --- a/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointCompressionModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointCompression) - # expect(result.id).to eq(endpoint_compression_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointCompressionModuleClient do id: endpoint_compression_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointCompression) - # expect(result.id).to eq(endpoint_compression_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_configurations_client_spec.rb b/spec/ngrokapi/services/endpoint_configurations_client_spec.rb index 40bb9ab..a2cbb1f 100644 --- a/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_configurations_client_spec.rb @@ -55,7 +55,6 @@ RSpec.describe NgrokAPI::Services::EndpointConfigurationsClient do backend: "New backend" ) expect(result.class).to eq(NgrokAPI::Models::EndpointConfiguration) - # expect(result.id).to eq(endpoint_configuration_result["id"]) end end @@ -113,7 +112,6 @@ RSpec.describe NgrokAPI::Services::EndpointConfigurationsClient do id: endpoint_configuration_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointConfiguration) - # expect(result.id).to eq(endpoint_configuration_result["id"]) end end @@ -187,7 +185,6 @@ RSpec.describe NgrokAPI::Services::EndpointConfigurationsClient do backend: "New backend" ) expect(result.class).to eq(NgrokAPI::Models::EndpointConfiguration) - # expect(result.id).to eq(endpoint_configuration_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb b/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb index 64ca862..74b3dad 100644 --- a/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointIPPolicyModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointIPPolicy) - # expect(result.id).to eq(endpoint_ip_policy_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointIPPolicyModuleClient do id: endpoint_ip_policy_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointIPPolicy) - # expect(result.id).to eq(endpoint_ip_policy_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb b/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb index 0e3ad7f..6f8e40f 100644 --- a/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointLoggingModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointLogging) - # expect(result.id).to eq(endpoint_logging_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointLoggingModuleClient do id: endpoint_logging_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointLogging) - # expect(result.id).to eq(endpoint_logging_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb b/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb index ce05119..5a01d11 100644 --- a/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointMutualTLSModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointMutualTLS) - # expect(result.id).to eq(endpoint_mutual_tls_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointMutualTLSModuleClient do id: endpoint_mutual_tls_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointMutualTLS) - # expect(result.id).to eq(endpoint_mutual_tls_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb b/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb index aa38487..e6ea529 100644 --- a/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointOAuthModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointOAuth) - # expect(result.id).to eq(endpoint_o_auth_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointOAuthModuleClient do id: endpoint_o_auth_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointOAuth) - # expect(result.id).to eq(endpoint_o_auth_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb b/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb index 9dc1aee..d9745c1 100644 --- a/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointOIDCModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointOIDC) - # expect(result.id).to eq(endpoint_oidc_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointOIDCModuleClient do id: endpoint_oidc_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointOIDC) - # expect(result.id).to eq(endpoint_oidc_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb b/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb index a6eef21..2c9b141 100644 --- a/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointRequestHeadersModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointRequestHeaders) - # expect(result.id).to eq(endpoint_request_headers_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointRequestHeadersModuleClient do id: endpoint_request_headers_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointRequestHeaders) - # expect(result.id).to eq(endpoint_request_headers_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb b/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb index 5f365b6..fb78f02 100644 --- a/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointResponseHeadersModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointResponseHeaders) - # expect(result.id).to eq(endpoint_response_headers_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointResponseHeadersModuleClient do id: endpoint_response_headers_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointResponseHeaders) - # expect(result.id).to eq(endpoint_response_headers_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb b/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb index 327c838..0f91afe 100644 --- a/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointSAMLModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointSAML) - # expect(result.id).to eq(endpoint_saml_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointSAMLModuleClient do id: endpoint_saml_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointSAML) - # expect(result.id).to eq(endpoint_saml_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb b/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb index 73238dd..c934307 100644 --- a/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointTLSTerminationModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointTLSTermination) - # expect(result.id).to eq(endpoint_tls_termination_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointTLSTerminationModuleClient do id: endpoint_tls_termination_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointTLSTermination) - # expect(result.id).to eq(endpoint_tls_termination_result["id"]) end end diff --git a/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb b/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb index 207de3b..c56e93f 100644 --- a/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +++ b/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb @@ -27,7 +27,6 @@ RSpec.describe NgrokAPI::Services::EndpointWebhookValidationModuleClient do a_module: "New a_module" ) expect(result.class).to eq(NgrokAPI::Models::EndpointWebhookValidation) - # expect(result.id).to eq(endpoint_webhook_validation_result["id"]) end end @@ -63,7 +62,6 @@ RSpec.describe NgrokAPI::Services::EndpointWebhookValidationModuleClient do id: endpoint_webhook_validation_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EndpointWebhookValidation) - # expect(result.id).to eq(endpoint_webhook_validation_result["id"]) end end diff --git a/spec/ngrokapi/services/event_destinations_client_spec.rb b/spec/ngrokapi/services/event_destinations_client_spec.rb index 7829a64..6b85f2d 100644 --- a/spec/ngrokapi/services/event_destinations_client_spec.rb +++ b/spec/ngrokapi/services/event_destinations_client_spec.rb @@ -32,7 +32,6 @@ RSpec.describe NgrokAPI::Services::EventDestinationsClient do verify_with_test_event: "New verify_with_test_event" ) expect(result.class).to eq(NgrokAPI::Models::EventDestination) - # expect(result.id).to eq(event_destination_result["id"]) end end @@ -90,7 +89,6 @@ RSpec.describe NgrokAPI::Services::EventDestinationsClient do id: event_destination_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EventDestination) - # expect(result.id).to eq(event_destination_result["id"]) end end @@ -143,7 +141,6 @@ RSpec.describe NgrokAPI::Services::EventDestinationsClient do verify_with_test_event: "New verify_with_test_event" ) expect(result.class).to eq(NgrokAPI::Models::EventDestination) - # expect(result.id).to eq(event_destination_result["id"]) end end diff --git a/spec/ngrokapi/services/event_sources_client_spec.rb b/spec/ngrokapi/services/event_sources_client_spec.rb index b8733e7..bde5a12 100644 --- a/spec/ngrokapi/services/event_sources_client_spec.rb +++ b/spec/ngrokapi/services/event_sources_client_spec.rb @@ -29,7 +29,6 @@ RSpec.describe NgrokAPI::Services::EventSourcesClient do fields: "New fields" ) expect(result.class).to eq(NgrokAPI::Models::EventSource) - # expect(result.id).to eq(event_source_result["id"]) end end @@ -95,7 +94,6 @@ RSpec.describe NgrokAPI::Services::EventSourcesClient do type: event_source_result["type"] ) expect(result.class).to eq(NgrokAPI::Models::EventSource) - # expect(result.id).to eq(event_source_result["id"]) end end @@ -118,6 +116,39 @@ RSpec.describe NgrokAPI::Services::EventSourcesClient do end end + describe "#list" do + it "will make a get request and return an instance of NgrokAPI::Models::EventSourceList" do + path = '/event_subscriptions/%{subscription_id}/sources' + replacements = { + subscription_id: event_source_list_result["subscription_id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(event_source_list_result) + result = @event_sources_client.list( + subscription_id: event_source_list_result["subscription_id"] + ) + expect(result.class).to eq(NgrokAPI::Models::EventSourceList) + end + end + + describe "#list!" do + it "will make a get request and return an instance of NgrokAPI::Models::EventSourceList" do + path = '/event_subscriptions/%{subscription_id}/sources' + replacements = { + subscription_id: event_source_list_result["subscription_id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(event_source_list_result) + result = @event_sources_client.list( + subscription_id: event_source_list_result["subscription_id"] + ) + expect(result.class).to eq(NgrokAPI::Models::EventSourceList) + # expect(result.id).to eq(event_source_list_result["id"]) + end + end + describe "#update" do it "will make a patch request and return an instance of NgrokAPI::Models::EventSource" do path = '/event_subscriptions/%{subscription_id}/sources/%{type}' @@ -135,7 +166,6 @@ RSpec.describe NgrokAPI::Services::EventSourcesClient do fields: "New fields" ) expect(result.class).to eq(NgrokAPI::Models::EventSource) - # expect(result.id).to eq(event_source_result["id"]) end end diff --git a/spec/ngrokapi/services/event_streams_client_spec.rb b/spec/ngrokapi/services/event_streams_client_spec.rb index dd7b37c..c6d2ad5 100644 --- a/spec/ngrokapi/services/event_streams_client_spec.rb +++ b/spec/ngrokapi/services/event_streams_client_spec.rb @@ -35,7 +35,6 @@ RSpec.describe NgrokAPI::Services::EventStreamsClient do sampling_rate: "New sampling_rate" ) expect(result.class).to eq(NgrokAPI::Models::EventStream) - # expect(result.id).to eq(event_stream_result["id"]) end end @@ -93,7 +92,6 @@ RSpec.describe NgrokAPI::Services::EventStreamsClient do id: event_stream_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EventStream) - # expect(result.id).to eq(event_stream_result["id"]) end end @@ -147,7 +145,6 @@ RSpec.describe NgrokAPI::Services::EventStreamsClient do sampling_rate: "New sampling_rate" ) expect(result.class).to eq(NgrokAPI::Models::EventStream) - # expect(result.id).to eq(event_stream_result["id"]) end end diff --git a/spec/ngrokapi/services/event_subscriptions_client_spec.rb b/spec/ngrokapi/services/event_subscriptions_client_spec.rb index 7502630..5c2d06d 100644 --- a/spec/ngrokapi/services/event_subscriptions_client_spec.rb +++ b/spec/ngrokapi/services/event_subscriptions_client_spec.rb @@ -31,7 +31,6 @@ RSpec.describe NgrokAPI::Services::EventSubscriptionsClient do destination_ids: "New destination_ids" ) expect(result.class).to eq(NgrokAPI::Models::EventSubscription) - # expect(result.id).to eq(event_subscription_result["id"]) end end @@ -89,7 +88,6 @@ RSpec.describe NgrokAPI::Services::EventSubscriptionsClient do id: event_subscription_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::EventSubscription) - # expect(result.id).to eq(event_subscription_result["id"]) end end @@ -141,7 +139,6 @@ RSpec.describe NgrokAPI::Services::EventSubscriptionsClient do destination_ids: "New destination_ids" ) expect(result.class).to eq(NgrokAPI::Models::EventSubscription) - # expect(result.id).to eq(event_subscription_result["id"]) end end diff --git a/spec/ngrokapi/services/ip_policies_client_spec.rb b/spec/ngrokapi/services/ip_policies_client_spec.rb index f9f785a..7ac0777 100644 --- a/spec/ngrokapi/services/ip_policies_client_spec.rb +++ b/spec/ngrokapi/services/ip_policies_client_spec.rb @@ -29,7 +29,6 @@ RSpec.describe NgrokAPI::Services::IPPoliciesClient do action: "New action" ) expect(result.class).to eq(NgrokAPI::Models::IPPolicy) - # expect(result.id).to eq(ip_policy_result["id"]) end end @@ -87,7 +86,6 @@ RSpec.describe NgrokAPI::Services::IPPoliciesClient do id: ip_policy_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::IPPolicy) - # expect(result.id).to eq(ip_policy_result["id"]) end end @@ -135,7 +133,6 @@ RSpec.describe NgrokAPI::Services::IPPoliciesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::IPPolicy) - # expect(result.id).to eq(ip_policy_result["id"]) end end diff --git a/spec/ngrokapi/services/ip_policy_rules_client_spec.rb b/spec/ngrokapi/services/ip_policy_rules_client_spec.rb index 4504916..b22e0b1 100644 --- a/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +++ b/spec/ngrokapi/services/ip_policy_rules_client_spec.rb @@ -31,7 +31,6 @@ RSpec.describe NgrokAPI::Services::IPPolicyRulesClient do ip_policy_id: "New ip_policy_id" ) expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule) - # expect(result.id).to eq(ip_policy_rule_result["id"]) end end @@ -89,7 +88,6 @@ RSpec.describe NgrokAPI::Services::IPPolicyRulesClient do id: ip_policy_rule_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule) - # expect(result.id).to eq(ip_policy_rule_result["id"]) end end @@ -139,7 +137,6 @@ RSpec.describe NgrokAPI::Services::IPPolicyRulesClient do cidr: "New cidr" ) expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule) - # expect(result.id).to eq(ip_policy_rule_result["id"]) end end diff --git a/spec/ngrokapi/services/ip_restrictions_client_spec.rb b/spec/ngrokapi/services/ip_restrictions_client_spec.rb index b1518e7..8a2da4c 100644 --- a/spec/ngrokapi/services/ip_restrictions_client_spec.rb +++ b/spec/ngrokapi/services/ip_restrictions_client_spec.rb @@ -33,7 +33,6 @@ RSpec.describe NgrokAPI::Services::IPRestrictionsClient do ip_policy_ids: "New ip_policy_ids" ) expect(result.class).to eq(NgrokAPI::Models::IPRestriction) - # expect(result.id).to eq(ip_restriction_result["id"]) end end @@ -91,7 +90,6 @@ RSpec.describe NgrokAPI::Services::IPRestrictionsClient do id: ip_restriction_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::IPRestriction) - # expect(result.id).to eq(ip_restriction_result["id"]) end end @@ -143,7 +141,6 @@ RSpec.describe NgrokAPI::Services::IPRestrictionsClient do ip_policy_ids: "New ip_policy_ids" ) expect(result.class).to eq(NgrokAPI::Models::IPRestriction) - # expect(result.id).to eq(ip_restriction_result["id"]) end end diff --git a/spec/ngrokapi/services/ip_whitelist_client_spec.rb b/spec/ngrokapi/services/ip_whitelist_client_spec.rb index 2f524f6..b224716 100644 --- a/spec/ngrokapi/services/ip_whitelist_client_spec.rb +++ b/spec/ngrokapi/services/ip_whitelist_client_spec.rb @@ -29,7 +29,6 @@ RSpec.describe NgrokAPI::Services::IPWhitelistClient do ip_net: "New ip_net" ) expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry) - # expect(result.id).to eq(ip_whitelist_entry_result["id"]) end end @@ -87,7 +86,6 @@ RSpec.describe NgrokAPI::Services::IPWhitelistClient do id: ip_whitelist_entry_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry) - # expect(result.id).to eq(ip_whitelist_entry_result["id"]) end end @@ -135,7 +133,6 @@ RSpec.describe NgrokAPI::Services::IPWhitelistClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::IPWhitelistEntry) - # expect(result.id).to eq(ip_whitelist_entry_result["id"]) end end diff --git a/spec/ngrokapi/services/reserved_addrs_client_spec.rb b/spec/ngrokapi/services/reserved_addrs_client_spec.rb index 9e51bed..bec50c4 100644 --- a/spec/ngrokapi/services/reserved_addrs_client_spec.rb +++ b/spec/ngrokapi/services/reserved_addrs_client_spec.rb @@ -31,7 +31,6 @@ RSpec.describe NgrokAPI::Services::ReservedAddrsClient do endpoint_configuration_id: "New endpoint_configuration_id" ) expect(result.class).to eq(NgrokAPI::Models::ReservedAddr) - # expect(result.id).to eq(reserved_addr_result["id"]) end end @@ -89,7 +88,6 @@ RSpec.describe NgrokAPI::Services::ReservedAddrsClient do id: reserved_addr_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::ReservedAddr) - # expect(result.id).to eq(reserved_addr_result["id"]) end end @@ -139,7 +137,6 @@ RSpec.describe NgrokAPI::Services::ReservedAddrsClient do endpoint_configuration_id: "New endpoint_configuration_id" ) expect(result.class).to eq(NgrokAPI::Models::ReservedAddr) - # expect(result.id).to eq(reserved_addr_result["id"]) end end diff --git a/spec/ngrokapi/services/reserved_domains_client_spec.rb b/spec/ngrokapi/services/reserved_domains_client_spec.rb index fdc7266..552f22f 100644 --- a/spec/ngrokapi/services/reserved_domains_client_spec.rb +++ b/spec/ngrokapi/services/reserved_domains_client_spec.rb @@ -39,7 +39,6 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do certificate_management_policy: "New certificate_management_policy" ) expect(result.class).to eq(NgrokAPI::Models::ReservedDomain) - # expect(result.id).to eq(reserved_domain_result["id"]) end end @@ -97,7 +96,6 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do id: reserved_domain_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::ReservedDomain) - # expect(result.id).to eq(reserved_domain_result["id"]) end end @@ -153,7 +151,6 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do certificate_management_policy: "New certificate_management_policy" ) expect(result.class).to eq(NgrokAPI::Models::ReservedDomain) - # expect(result.id).to eq(reserved_domain_result["id"]) end end diff --git a/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb b/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb index 9c2f069..31347ef 100644 --- a/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +++ b/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb @@ -33,7 +33,6 @@ RSpec.describe NgrokAPI::Services::SSHCertificateAuthoritiesClient do key_size: "New key_size" ) expect(result.class).to eq(NgrokAPI::Models::SSHCertificateAuthority) - # expect(result.id).to eq(ssh_certificate_authority_result["id"]) end end @@ -91,7 +90,6 @@ RSpec.describe NgrokAPI::Services::SSHCertificateAuthoritiesClient do id: ssh_certificate_authority_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::SSHCertificateAuthority) - # expect(result.id).to eq(ssh_certificate_authority_result["id"]) end end @@ -139,7 +137,6 @@ RSpec.describe NgrokAPI::Services::SSHCertificateAuthoritiesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::SSHCertificateAuthority) - # expect(result.id).to eq(ssh_certificate_authority_result["id"]) end end diff --git a/spec/ngrokapi/services/ssh_credentials_client_spec.rb b/spec/ngrokapi/services/ssh_credentials_client_spec.rb index bae093c..31431d8 100644 --- a/spec/ngrokapi/services/ssh_credentials_client_spec.rb +++ b/spec/ngrokapi/services/ssh_credentials_client_spec.rb @@ -31,7 +31,6 @@ RSpec.describe NgrokAPI::Services::SSHCredentialsClient do public_key: "New public_key" ) expect(result.class).to eq(NgrokAPI::Models::SSHCredential) - # expect(result.id).to eq(ssh_credential_result["id"]) end end @@ -89,7 +88,6 @@ RSpec.describe NgrokAPI::Services::SSHCredentialsClient do id: ssh_credential_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::SSHCredential) - # expect(result.id).to eq(ssh_credential_result["id"]) end end @@ -139,7 +137,6 @@ RSpec.describe NgrokAPI::Services::SSHCredentialsClient do acl: "New acl" ) expect(result.class).to eq(NgrokAPI::Models::SSHCredential) - # expect(result.id).to eq(ssh_credential_result["id"]) end end diff --git a/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb b/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb index ae6aec3..d94be73 100644 --- a/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +++ b/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb @@ -37,7 +37,6 @@ RSpec.describe NgrokAPI::Services::SSHHostCertificatesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::SSHHostCertificate) - # expect(result.id).to eq(ssh_host_certificate_result["id"]) end end @@ -95,7 +94,6 @@ RSpec.describe NgrokAPI::Services::SSHHostCertificatesClient do id: ssh_host_certificate_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::SSHHostCertificate) - # expect(result.id).to eq(ssh_host_certificate_result["id"]) end end @@ -143,7 +141,6 @@ RSpec.describe NgrokAPI::Services::SSHHostCertificatesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::SSHHostCertificate) - # expect(result.id).to eq(ssh_host_certificate_result["id"]) end end diff --git a/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb b/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb index 654aa0a..c639c1f 100644 --- a/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +++ b/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb @@ -41,7 +41,6 @@ RSpec.describe NgrokAPI::Services::SSHUserCertificatesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::SSHUserCertificate) - # expect(result.id).to eq(ssh_user_certificate_result["id"]) end end @@ -99,7 +98,6 @@ RSpec.describe NgrokAPI::Services::SSHUserCertificatesClient do id: ssh_user_certificate_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::SSHUserCertificate) - # expect(result.id).to eq(ssh_user_certificate_result["id"]) end end @@ -147,7 +145,6 @@ RSpec.describe NgrokAPI::Services::SSHUserCertificatesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::SSHUserCertificate) - # expect(result.id).to eq(ssh_user_certificate_result["id"]) end end diff --git a/spec/ngrokapi/services/tls_certificates_client_spec.rb b/spec/ngrokapi/services/tls_certificates_client_spec.rb index ec14c21..40a61f2 100644 --- a/spec/ngrokapi/services/tls_certificates_client_spec.rb +++ b/spec/ngrokapi/services/tls_certificates_client_spec.rb @@ -31,7 +31,6 @@ RSpec.describe NgrokAPI::Services::TLSCertificatesClient do private_key_pem: "New private_key_pem" ) expect(result.class).to eq(NgrokAPI::Models::TLSCertificate) - # expect(result.id).to eq(tls_certificate_result["id"]) end end @@ -89,7 +88,6 @@ RSpec.describe NgrokAPI::Services::TLSCertificatesClient do id: tls_certificate_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::TLSCertificate) - # expect(result.id).to eq(tls_certificate_result["id"]) end end @@ -137,7 +135,6 @@ RSpec.describe NgrokAPI::Services::TLSCertificatesClient do metadata: "New metadata" ) expect(result.class).to eq(NgrokAPI::Models::TLSCertificate) - # expect(result.id).to eq(tls_certificate_result["id"]) end end diff --git a/spec/ngrokapi/services/tunnel_sessions_client_spec.rb b/spec/ngrokapi/services/tunnel_sessions_client_spec.rb index 5322855..c14ae2c 100644 --- a/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +++ b/spec/ngrokapi/services/tunnel_sessions_client_spec.rb @@ -35,7 +35,6 @@ RSpec.describe NgrokAPI::Services::TunnelSessionsClient do id: tunnel_session_result["id"] ) expect(result.class).to eq(NgrokAPI::Models::TunnelSession) - # expect(result.id).to eq(tunnel_session_result["id"]) end end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 50ff16d..3069d92 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -497,6 +497,13 @@ def event_source_result } end +def event_source_list_result + { + "sources" => [], + "uri" => "https://api.ngrok.com/event_sources", + } +end + def event_subscription_result { "id" => "esb_1ro7av77nFHjRVO7GwDxRE7TElG",