Update generated files

2026-06-16 16:54:33 +00:00 · 2023-03-13 23:06:28 +00:00
parent 73479addb9
commit cdf67b49df
82 changed files with 4069 additions and 839 deletions
@@ -118,6 +118,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../abuse_reports.html">Abuse Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../agent_ingresses.html">Agent Ingresses</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../api_keys.html">API Keys</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../application_sessions.html">Application Sessions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../application_users.html">Application Users</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../failover_backends.html">Failover Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../http_response_backends.html">HTTP Response Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tunnel_group_backends.html">Tunnel Group Backends</a></li>
@@ -118,6 +118,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../application_sessions.html">Application Sessions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../application_users.html">Application Users</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
@@ -190,7 +192,7 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">abuse_reports</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AbuseReportsClient</span><span class="p">:</span>
-        <span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
+<span class="w">        </span><span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
 <span class="sd">        ngrok that violate ngrok's terms of service."""</span>
        <span class="k">return</span> <span class="n">AbuseReportsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

@@ -200,16 +202,24 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">api_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">APIKeysClient</span><span class="p">:</span>
-        <span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
-<span class="sd">        API` &lt;https://ngrok.com/docs/api#authentication&gt;`_. You may use the API itself</span>
+<span class="w">        </span><span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
+<span class="sd">        API &lt;https://ngrok.com/docs/api#authentication&gt;`_. You may use the API itself</span>
 <span class="sd">        to provision and manage API Keys but you'll need to provision your first API</span>
-<span class="sd">        key from the `API Keys page` &lt;https://dashboard.ngrok.com/api/keys&gt;`_ on your</span>
+<span class="sd">        key from the `API Keys page &lt;https://dashboard.ngrok.com/api/keys&gt;`_ on your</span>
 <span class="sd">        ngrok.com dashboard."""</span>
        <span class="k">return</span> <span class="n">APIKeysClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">application_sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ApplicationSessionsClient</span><span class="p">:</span>
+        <span class="k">return</span> <span class="n">ApplicationSessionsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">application_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ApplicationUsersClient</span><span class="p">:</span>
+        <span class="k">return</span> <span class="n">ApplicationUsersClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+
    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">CertificateAuthoritiesClient</span><span class="p">:</span>
-        <span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
+<span class="w">        </span><span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
 <span class="sd">        x509 certificates. Attach a Certificate Authority to the Mutual TLS module</span>
 <span class="sd">        to verify that the TLS certificate presented by a client has been signed by</span>
 <span class="sd">        this CA. Certificate Authorities  are used only for mTLS validation only and</span>
@@ -218,7 +228,7 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">CredentialsClient</span><span class="p">:</span>
-        <span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
+<span class="w">        </span><span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
 <span class="sd">        agent to connect the ngrok service as your account. They are installed with</span>
 <span class="sd">        the ``ngrok config add-authtoken`` command or by specifying it in the ``ngrok.yml``</span>
 <span class="sd">        configuration file with the ``authtoken`` property."""</span>
@@ -226,7 +236,7 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EndpointsClient</span><span class="p">:</span>
-        <span class="sd">"""Endpoints provides an API for querying the endpoint objects</span>
+<span class="w">        </span><span class="sd">"""Endpoints provides an API for querying the endpoint objects</span>
 <span class="sd">        which define what tunnel or edge is used to serve a hostport.</span>
 <span class="sd">        Only active endpoints associated with a tunnel or backend are returned."""</span>
        <span class="k">return</span> <span class="n">EndpointsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
@@ -245,7 +255,7 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ip_policies</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">IPPoliciesClient</span><span class="p">:</span>
-        <span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
+<span class="w">        </span><span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
 <span class="sd">        action. They can be attached to endpoints via the Endpoint Configuration IP</span>
 <span class="sd">        Policy module. They can also be used with IP Restrictions to control source</span>
 <span class="sd">        IP ranges that can start tunnel sessions and connect to the API and dashboard."""</span>
@@ -253,13 +263,13 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ip_policy_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">IPPolicyRulesClient</span><span class="p">:</span>
-        <span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
+<span class="w">        </span><span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
 <span class="sd">        make up an IP Policy."""</span>
        <span class="k">return</span> <span class="n">IPPolicyRulesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ip_restrictions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">IPRestrictionsClient</span><span class="p">:</span>
-        <span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
+<span class="w">        </span><span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
 <span class="sd">        initiate traffic to a specific aspect of your ngrok account. An IP</span>
 <span class="sd">        restriction has a type which defines the ingress it applies to. IP</span>
 <span class="sd">        restrictions can be used to enforce the source IPs that can make API</span>
@@ -269,14 +279,14 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">reserved_addrs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ReservedAddrsClient</span><span class="p">:</span>
-        <span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
+<span class="w">        </span><span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
 <span class="sd">        TCP address hostnames and ports are assigned by ngrok, they cannot be</span>
 <span class="sd">        chosen."""</span>
        <span class="k">return</span> <span class="n">ReservedAddrsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">reserved_domains</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ReservedDomainsClient</span><span class="p">:</span>
-        <span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
+<span class="w">        </span><span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
 <span class="sd">        can be used to listen for http, https or tls traffic. You may use a domain</span>
 <span class="sd">        that you own by creating a CNAME record specified in the returned resource.</span>
 <span class="sd">        This CNAME record points traffic for that domain to ngrok's edge servers."""</span>
@@ -284,33 +294,33 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ssh_certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">:</span>
-        <span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
+<span class="w">        </span><span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
 <span class="sd">        key that can be used to sign other SSH host and user certificates."""</span>
        <span class="k">return</span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ssh_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SSHCredentialsClient</span><span class="p">:</span>
-        <span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
+<span class="w">        </span><span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
 <span class="sd">        via the ngrok SSH tunnel gateway."""</span>
        <span class="k">return</span> <span class="n">SSHCredentialsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ssh_host_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SSHHostCertificatesClient</span><span class="p">:</span>
-        <span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
+<span class="w">        </span><span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
 <span class="sd">        server to assert its authenticity to connecting SSH clients who trust the</span>
 <span class="sd">        SSH Certificate Authority that was used to sign the certificate."""</span>
        <span class="k">return</span> <span class="n">SSHHostCertificatesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">ssh_user_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SSHUserCertificatesClient</span><span class="p">:</span>
-        <span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
+<span class="w">        </span><span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
 <span class="sd">        server to authenticate their connection. The SSH server must trust the SSH</span>
 <span class="sd">        Certificate Authority used to sign the certificate."""</span>
        <span class="k">return</span> <span class="n">SSHUserCertificatesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">tls_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TLSCertificatesClient</span><span class="p">:</span>
-        <span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
+<span class="w">        </span><span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
 <span class="sd">        key that can be used to terminate TLS traffic. TLS certificates are unused</span>
 <span class="sd">        until they are attached to a Domain. TLS Certificates may also be</span>
 <span class="sd">        provisioned by ngrok automatically for domains on which you have enabled</span>
@@ -319,14 +329,14 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">tunnel_sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelSessionsClient</span><span class="p">:</span>
-        <span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
+<span class="w">        </span><span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
 <span class="sd">        sessions that are running and connected to the ngrok service. Each tunnel</span>
 <span class="sd">        session can include one or more Tunnels."""</span>
        <span class="k">return</span> <span class="n">TunnelSessionsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">tunnels</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelsClient</span><span class="p">:</span>
-        <span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
+<span class="w">        </span><span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
 <span class="sd">        agent tunnel session or an SSH reverse tunnel session."""</span>
        <span class="k">return</span> <span class="n">TunnelsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

@@ -118,6 +118,8 @@
 <li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../application_sessions.html">Application Sessions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../application_users.html">Application Users</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
@@ -182,7 +184,7 @@


 <div class="viewcode-block" id="Error"><a class="viewcode-back" href="../../errors.html#ngrok.Error">[docs]</a><span class="k">class</span> <span class="nc">Error</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
-    <span class="sd">"""Raised by failed ngrok API operations.</span>
+<span class="w">    </span><span class="sd">"""Raised by failed ngrok API operations.</span>

 <span class="sd">    This class encapsulates details about the error to make it simple for callers</span>
 <span class="sd">    to introspect the error and take action on it.</span>
@@ -207,7 +209,7 @@

    <span class="nd">@property</span>
    <span class="k">def</span> <span class="nf">operation_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-        <span class="sd">"""</span>
+<span class="w">        </span><span class="sd">"""</span>
 <span class="sd">        OperationID returns the unique trace ID assigned by ngrok to this API</span>
 <span class="sd">        request.</span>
 <span class="sd">        """</span>
@@ -215,7 +217,7 @@


 <div class="viewcode-block" id="NotFoundError"><a class="viewcode-back" href="../../errors.html#ngrok.NotFoundError">[docs]</a><span class="k">class</span> <span class="nc">NotFoundError</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
-    <span class="sd">"""Raised if the http_status_code of an API operation is 404.</span>
+<span class="w">    </span><span class="sd">"""Raised if the http_status_code of an API operation is 404.</span>
 <span class="sd">    This is a separate class to make this common condition easier to handle.</span>
 <span class="sd">    """</span>