ngrok/ngrok-api-python
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-python.git synced 2026-05-17 16:50:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #27 from ngrok/pr/generated-c4f53b246e

Browse Source 
Update generated files
This commit is contained in:
bobzilla
2023-08-31 11:03:12 -04:00
committed by GitHub
parent 73b96ac4e8 c076db5c3f
commit a5b22f995e
195 changed files with 1624 additions and 619 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+2
View File
@@ -1,3 +1,5 @@
# Code generated for API Clients. DO NOT EDIT.
doc/build
.pyc
.swp
.tox/dist/ngrok-api-0.0.0.zip
Vendored
BIN
View File
Binary file not shown.
.tox/log/GLOB-0.log
+14 -15
View File
@@ -1,6 +1,6 @@
action: GLOB, msg: packaging
cwd: /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python
cmd: /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist
cwd: /var/lib/buildkite-agent-4/builds/ip-172-31-53-232-us-west-2-compute-internal-4-1/ngrok/api-client-prs/.cache/ngrok-api-python
cmd: /var/lib/buildkite-agent-4/builds/ip-172-31-53-232-us-west-2-compute-internal-4-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist
running sdist
running egg_info
writing ngrok_api.egg-info/PKG-INFO
@@ -35,30 +35,29 @@ copying ngrok_api.egg-info/requires.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/top_level.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests
Writing ngrok-api-0.0.0/setup.cfg
creating /var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist
creating '/var/lib/buildkite-agent-2/builds/ip-172-31-8-201-us-west-2-compute-internal-2-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it
creating '.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it
adding 'ngrok-api-0.0.0'
adding 'ngrok-api-0.0.0/tests'
adding 'ngrok-api-0.0.0/ngrok'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info'
adding 'ngrok-api-0.0.0/tests'
adding 'ngrok-api-0.0.0/PKG-INFO'
adding 'ngrok-api-0.0.0/setup.py'
adding 'ngrok-api-0.0.0/pyproject.toml'
adding 'ngrok-api-0.0.0/README.md'
adding 'ngrok-api-0.0.0/LICENSE'
adding 'ngrok-api-0.0.0/pyproject.toml'
adding 'ngrok-api-0.0.0/setup.py'
adding 'ngrok-api-0.0.0/setup.cfg'
adding 'ngrok-api-0.0.0/LICENSE'
adding 'ngrok-api-0.0.0/PKG-INFO'
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
adding 'ngrok-api-0.0.0/ngrok/utils.py'
adding 'ngrok-api-0.0.0/ngrok/error.py'
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
adding 'ngrok-api-0.0.0/ngrok/client.py'
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
adding 'ngrok-api-0.0.0/ngrok/http_client.py'
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
adding 'ngrok-api-0.0.0/ngrok/iterator.py'
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
adding 'ngrok-api-0.0.0/ngrok/services.py'
adding 'ngrok-api-0.0.0/ngrok/error.py'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt'
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO'
removing 'ngrok-api-0.0.0' (and everything under it)
CHANGELOG.md
+9
View File
@@ -0,0 +1,9 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->
## 0.10.0
ENHANCEMENTS:
* Added `owner_id` field to the `api_key`, `credential`, and `ssh_credential` resources. If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
* Added `failover_backend`, `http_response_backend`, and `tunnel_group_backend` resources. A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
README.md
+2
View File
@@ -1,3 +1,5 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->
# ngrok API client library for Python
This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
doc/Makefile
+2
View File
@@ -1,3 +1,5 @@
# Code generated for API Clients. DO NOT EDIT.
# Minimal makefile for Sphinx documentation
#
doc/make.bat
+37 -35
View File
@@ -1,35 +1,37 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
REM Code generated for API Clients. DO NOT EDIT.
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
doc/source/abuse_reports.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Abuse Reports
=====================================
doc/source/agent_ingresses.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Agent Ingresses
=====================================
doc/source/api_keys.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
API Keys
=====================================
doc/source/application_sessions.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Application Sessions
=====================================
doc/source/application_users.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Application Users
=====================================
doc/source/certificate_authorities.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Certificate Authorities
=====================================
doc/source/client.rst
+4 -1
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Client
=====================================
@@ -15,7 +18,7 @@ Client object:
# list all ip policies
for policy in client.ip_policies.list():
print(policy)
# create an ngrok agent authtoken
cred = client.credentials.create()
print(cred)
doc/source/conf.py
+2
View File
@@ -1,3 +1,5 @@
# Code generated for API Clients. DO NOT EDIT.
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
doc/source/credentials.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Tunnel Credentials
=====================================
doc/source/datatypes.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Datatypes
=====================================
doc/source/edge_route_backend_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Backend Module
=====================================
doc/source/edge_route_circuit_breaker_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Circuit Breaker Module
=====================================
doc/source/edge_route_compression_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Compression Module
=====================================
doc/source/edge_route_ip_restriction_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route IP Restriction Module
=====================================
doc/source/edge_route_o_auth_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route OAuth Module
=====================================
doc/source/edge_route_oidc_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route OIDC Module
=====================================
doc/source/edge_route_request_headers_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Request Headers Module
=====================================
doc/source/edge_route_response_headers_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Response Headers Module
=====================================
doc/source/edge_route_saml_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route SAML Module
=====================================
doc/source/edge_route_webhook_verification_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Webhook Verification Module
=====================================
doc/source/edge_route_websocket_tcp_converter_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Websocket TCP Converter Module
=====================================
doc/source/edges_https.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edges
=====================================
doc/source/edges_https_routes.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Routes
=====================================
doc/source/edges_tcp.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TCP Edges
=====================================
doc/source/edges_tls.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edges
=====================================
doc/source/endpoints.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Endpoints
=====================================
doc/source/errors.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
.. _errors:
Errors
doc/source/event_destinations.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Destinations
=====================================
doc/source/event_sources.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Sources
=====================================
doc/source/event_subscriptions.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Subscriptions
=====================================
doc/source/failover_backends.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Failover Backends
=====================================
doc/source/http_response_backends.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTP Response Backends
=====================================
doc/source/https_edge_mutual_tls_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Mutual TLS Module
=====================================
doc/source/https_edge_tls_termination_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge TLS Termination Module
=====================================
doc/source/index.rst
+4 -1
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
ngrok-api
#########
@@ -125,6 +128,7 @@ API Reference
api_keys
application_sessions
application_users
tunnel_sessions
failover_backends
http_response_backends
tunnel_group_backends
@@ -168,5 +172,4 @@ API Reference
ssh_host_certificates
ssh_user_certificates
tls_certificates
tunnel_sessions
tunnels
doc/source/ip_policies.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
IP Policies
=====================================
doc/source/ip_policy_rules.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
IP Policy Rules
=====================================
doc/source/ip_restrictions.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
IP Restrictions
=====================================
doc/source/reserved_addrs.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Reserved Addresses
=====================================
doc/source/reserved_domains.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Reserved Domains
=====================================
doc/source/ssh_certificate_authorities.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
SSH Certificate Authorities
=====================================
doc/source/ssh_credentials.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
SSH Credentials
=====================================
doc/source/ssh_host_certificates.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
SSH Host Certificates
=====================================
doc/source/ssh_user_certificates.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
SSH User Certificates
=====================================
doc/source/tcp_edge_backend_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TCP Edge Backend Module
=====================================
doc/source/tcp_edge_ip_restriction_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TCP Edge IP Restriction Module
=====================================
doc/source/tls_certificates.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Certificates
=====================================
doc/source/tls_edge_backend_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edge Backend Module
=====================================
doc/source/tls_edge_ip_restriction_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edge IP Restriction Module
=====================================
doc/source/tls_edge_mutual_tls_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edge Mutual TLS Module
=====================================
doc/source/tls_edge_tls_termination_module.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edge TLS Termination Module
=====================================
doc/source/tunnel_group_backends.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Tunnel Group Backends
=====================================
doc/source/tunnel_sessions.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Tunnel Sessions
=====================================
doc/source/tunnels.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Tunnels
=====================================
doc/source/weighted_backends.rst
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Weighted Backends
=====================================
docs/_modules/index.html
+1 -1
View File
@@ -166,6 +166,7 @@
<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="../tunnel_sessions.html">Tunnel Sessions</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>
@@ -209,7 +210,6 @@
<li class="toctree-l1"><a class="reference internal" href="../ssh_host_certificates.html">SSH Host Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ssh_user_certificates.html">SSH User Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tls_certificates.html">TLS Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tunnel_sessions.html">Tunnel Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tunnels.html">Tunnels</a></li>
</ul>
docs/_modules/ngrok/client.html
+12 -9
View File
@@ -166,6 +166,7 @@
<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="../../tunnel_sessions.html">Tunnel Sessions</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>
@@ -209,7 +210,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
</ul>
@@ -245,7 +245,10 @@
</div>
<article role="main">
<h1>Source code for ngrok.client</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span></span><span class="c1"># Code generated for API Clients. DO NOT EDIT.</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">.services</span> <span class="kn">import</span> <span class="o">*</span>
@@ -282,6 +285,13 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;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.&quot;&quot;&quot;</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">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="w"> </span><span class="sd">&quot;&quot;&quot;Certificate Authorities are x509 certificates that are used to sign other</span>
@@ -392,13 +402,6 @@
<span class="sd"> automated certificate provisioning.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">TLSCertificatesClient</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">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="w"> </span><span class="sd">&quot;&quot;&quot;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.&quot;&quot;&quot;</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="w"> </span><span class="sd">&quot;&quot;&quot;Tunnels provide endpoints to access services exposed by a running ngrok</span>
docs/_modules/ngrok/datatypes.html
+274 -114
View File
@@ -166,6 +166,7 @@
<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="../../tunnel_sessions.html">Tunnel Sessions</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>
@@ -209,7 +210,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
</ul>
@@ -245,7 +245,10 @@
</div>
<article role="main">
<h1>Source code for ngrok.datatypes</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span></span><span class="c1"># Code generated for API Clients. DO NOT EDIT.</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
<span class="kn">from</span> <span class="nn">.iterator</span> <span class="kn">import</span> <span class="n">PagedIterator</span>
@@ -360,6 +363,16 @@
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;certificate_management_policy&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">AgentIngressCertPolicy</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;certificate_management_policy&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;certificate_management_policy&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;certificate_management_status&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">AgentIngressCertStatus</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;certificate_management_status&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;certificate_management_status&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
@@ -381,11 +394,13 @@
<span class="bp">self</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="p">:</span> <span class="n">AgentIngressCertPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">agent_ingresses</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="o">=</span><span class="n">certificate_management_policy</span><span class="p">,</span>
<span class="p">)</span></div>
<span class="nd">@property</span>
@@ -426,7 +441,17 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">created_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;timestamp when the Agent Ingress was created, RFC 3339 format&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;created_at&quot;</span><span class="p">]</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;created_at&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">certificate_management_policy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentIngressCertPolicy</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;certificate_management_policy&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">certificate_management_status</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentIngressCertStatus</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;status of the automatic certificate management for this domain, or null if automatic management is disabled&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;certificate_management_status&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="AgentIngressList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.AgentIngressList">[docs]</a><span class="k">class</span> <span class="nc">AgentIngressList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
@@ -467,6 +492,96 @@
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;next_page_uri&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="AgentIngressCertPolicy"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.AgentIngressCertPolicy">[docs]</a><span class="k">class</span> <span class="nc">AgentIngressCertPolicy</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertPolicy </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertPolicy </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">authority</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;certificate authority to request certificates from. The only supported value is letsencrypt.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;authority&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">private_key_type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;private_key_type&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="AgentIngressCertStatus"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.AgentIngressCertStatus">[docs]</a><span class="k">class</span> <span class="nc">AgentIngressCertStatus</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;provisioning_job&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">AgentIngressCertJob</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;provisioning_job&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;provisioning_job&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertStatus </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertStatus </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">renews_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;timestamp when the next renewal will be requested, RFC 3339 format&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;renews_at&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">provisioning_job</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentIngressCertJob</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;status of the certificate provisioning job, or null if the certificiate isn&#39;t being provisioned or renewed&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;provisioning_job&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="AgentIngressCertJob"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.AgentIngressCertJob">[docs]</a><span class="k">class</span> <span class="nc">AgentIngressCertJob</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertJob </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;AgentIngressCertJob </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">error_code</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;error_code&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">msg</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;a message describing the current status or error&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;msg&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">started_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;timestamp when the provisioning job started, RFC 3339 format&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;started_at&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">retries_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;timestamp when the provisioning job will be retried&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;retries_at&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="APIKey"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.APIKey">[docs]</a><span class="k">class</span> <span class="nc">APIKey</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
@@ -969,6 +1084,114 @@
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="TunnelSession"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TunnelSession">[docs]</a><span class="k">class</span> <span class="nc">TunnelSession</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;credential&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSession </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSession </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">agent_version</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;version of the ngrok agent that started this ngrok tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;agent_version&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">credential</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;unique tunnel session resource identifier&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ip</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;source ip address of the tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;ip&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;metadata&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">os</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;operating system of the host the ngrok agent is running on&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;os&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">region</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the ngrok region identifier in which this tunnel session was started&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;region&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">started_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;time when the tunnel session first connected to the ngrok servers&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;started_at&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">transport</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;transport&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI to the API resource of the tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;uri&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="TunnelSessionList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TunnelSessionList">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">[</span><span class="n">TunnelSession</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]]</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="p">[]</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSessionList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSessionList </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">)</span>
<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">Sequence</span><span class="p">[</span><span class="n">TunnelSession</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;list of all tunnel sessions on this account&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI to the API resource of the tunnel session list&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;uri&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI of the next page, or null if there is no next page&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;next_page_uri&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="FailoverBackend"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.FailoverBackend">[docs]</a><span class="k">class</span> <span class="nc">FailoverBackend</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
@@ -3586,6 +3809,11 @@
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;cloudwatch_logs&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;datadog&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">EventTargetDatadog</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;datadog&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;datadog&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
@@ -3609,7 +3837,12 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">cloudwatch_logs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EventTargetCloudwatchLogs</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Configuration used to send events to Amazon CloudWatch Logs.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;cloudwatch_logs&quot;</span><span class="p">]</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;cloudwatch_logs&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">datadog</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EventTargetDatadog</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Configuration used to send events to Datadog.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;datadog&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="EventTargetFirehose"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EventTargetFirehose">[docs]</a><span class="k">class</span> <span class="nc">EventTargetFirehose</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
@@ -3698,6 +3931,41 @@
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;log_group_arn&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="EventTargetDatadog"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EventTargetDatadog">[docs]</a><span class="k">class</span> <span class="nc">EventTargetDatadog</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;EventTargetDatadog </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;EventTargetDatadog </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">api_key</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Datadog API key to use.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;api_key&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ddtags</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Tags to send with the event.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;ddtags&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">service</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Service name to send with the event.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;service&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ddsite</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Datadog site to send event to.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;ddsite&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="AWSAuth"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.AWSAuth">[docs]</a><span class="k">class</span> <span class="nc">AWSAuth</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
@@ -5155,7 +5423,7 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">certificate_pem</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;chain of PEM-encoded certificates, leaf first. See `Certificate Bundles &lt;/cloud-edge/endpoints#certificate-chains&gt;`_.&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;chain of PEM-encoded certificates, leaf first. See `Certificate Bundles &lt;https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains&gt;`_.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;certificate_pem&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
@@ -5297,114 +5565,6 @@
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;ips&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="TunnelSession"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TunnelSession">[docs]</a><span class="k">class</span> <span class="nc">TunnelSession</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;credential&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSession </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSession </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">agent_version</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;version of the ngrok agent that started this ngrok tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;agent_version&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">credential</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;credential&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;unique tunnel session resource identifier&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;id&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ip</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;source ip address of the tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;ip&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;metadata&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">os</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;operating system of the host the ngrok agent is running on&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;os&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">region</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the ngrok region identifier in which this tunnel session was started&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;region&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">started_at</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">datetime</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;time when the tunnel session first connected to the ngrok servers&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;started_at&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">transport</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the transport protocol used to start the tunnel session. Either ``ngrok/v2`` or ``ssh``&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;transport&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI to the API resource of the tunnel session&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;uri&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="TunnelSessionList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.TunnelSessionList">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">=</span> <span class="n">props</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">[</span><span class="n">TunnelSession</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]]</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="p">[]</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="s2">&quot;id&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSessionList </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;TunnelSessionList </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">PagedIterator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">)</span>
<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">Sequence</span><span class="p">[</span><span class="n">TunnelSession</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;list of all tunnel sessions on this account&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_sessions&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI to the API resource of the tunnel session list&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;uri&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">next_page_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI of the next page, or null if there is no next page&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;next_page_uri&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="Tunnel"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Tunnel">[docs]</a><span class="k">class</span> <span class="nc">Tunnel</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
@@ -5451,7 +5611,7 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option &lt;/ngrok-agent/config#common-tunnel-configuration-properties&gt;`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option &lt;/ngrok-agent/config#metadata&gt;`_.&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option &lt;https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#common-tunnel-configuration-properties&gt;`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option &lt;https://ngrok.com/docs/secure-tunnels/ngrok-agent/reference/config#metadata&gt;`_.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;metadata&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
docs/_modules/ngrok/error.html
+4 -2
View File
@@ -166,6 +166,7 @@
<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="../../tunnel_sessions.html">Tunnel Sessions</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>
@@ -209,7 +210,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
</ul>
@@ -245,7 +245,9 @@
</div>
<article role="main">
<h1>Source code for ngrok.error</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
<span></span><span class="c1"># Code generated for API Clients. DO NOT EDIT.</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
<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>
docs/_modules/ngrok/services.html
+111 -105
View File
@@ -166,6 +166,7 @@
<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="../../tunnel_sessions.html">Tunnel Sessions</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>
@@ -209,7 +210,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../ssh_host_certificates.html">SSH Host Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ssh_user_certificates.html">SSH User Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tls_certificates.html">TLS Certificates</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_sessions.html">Tunnel Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tunnels.html">Tunnels</a></li>
</ul>
@@ -245,7 +245,10 @@
</div>
<article role="main">
<h1>Source code for ngrok.services</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span></span><span class="c1"># Code generated for API Clients. DO NOT EDIT.</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Iterator</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
@@ -310,12 +313,14 @@
<span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="p">:</span> <span class="n">AgentIngressCertPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentIngress</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.</span>
<span class="sd"> :param description: human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</span>
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</span>
<span class="sd"> :param domain: the domain that you own to be used as the base domain name to generate regional agent ingress domains.</span>
<span class="sd"> :param certificate_management_policy: configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</span>
<span class="sd"> https://ngrok.com/docs/api#api-agent-ingresses-create</span>
<span class="sd"> &quot;&quot;&quot;</span>
@@ -324,6 +329,7 @@
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">certificate_management_policy</span><span class="p">),</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">AgentIngress</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
@@ -388,12 +394,14 @@
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="p">:</span> <span class="n">AgentIngressCertPolicy</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AgentIngress</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Update attributes of an Agent Ingress by ID.</span>
<span class="sd"> :param id:</span>
<span class="sd"> :param description: human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</span>
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</span>
<span class="sd"> :param certificate_management_policy: configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</span>
<span class="sd"> https://ngrok.com/docs/api#api-agent-ingresses-update</span>
<span class="sd"> &quot;&quot;&quot;</span>
@@ -404,6 +412,7 @@
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">certificate_management_policy</span><span class="o">=</span><span class="n">extract_props</span><span class="p">(</span><span class="n">certificate_management_policy</span><span class="p">),</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">AgentIngress</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
@@ -643,6 +652,104 @@
<span class="k">return</span> <span class="n">ApplicationUserList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="TunnelSessionsClient"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;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.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<div class="viewcode-block" id="TunnelSessionsClient.list"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelSessionList</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;List all online tunnel sessions running on this account.</span>
<span class="sd"> :param before_id:</span>
<span class="sd"> :param limit:</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-list</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions&quot;</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">TunnelSessionList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.get"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelSession</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the detailed status of a tunnel session by ID</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-get</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">TunnelSession</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.restart"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.restart">[docs]</a> <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-restart</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/restart&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.stop"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent that started this tunnel session to exit.</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-stop</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/stop&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.update"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent&#39;s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</span>
<span class="sd"> :param id:</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-update</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/update&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="FailoverBackendsClient"><a class="viewcode-back" href="../../failover_backends.html#ngrok.services.FailoverBackendsClient">[docs]</a><span class="k">class</span> <span class="nc">FailoverBackendsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A Failover backend defines failover behavior within a list of referenced</span>
<span class="sd"> backends. Traffic is sent to the first backend in the list. If that backend</span>
@@ -4010,7 +4117,6 @@
<div class="viewcode-block" id="ReservedDomainsClient.create"><a class="viewcode-back" href="../../reserved_domains.html#ngrok.services.ReservedDomainsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">domain</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">region</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
@@ -4020,7 +4126,6 @@
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ReservedDomain</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a new reserved domain.</span>
<span class="sd"> :param name: the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a &#39;.&#39; it will reserve that subdomain on ngrok.io.</span>
<span class="sd"> :param domain: hostname of the reserved domain</span>
<span class="sd"> :param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</span>
<span class="sd"> :param description: human-readable description of what this reserved domain will be used for</span>
@@ -4032,7 +4137,6 @@
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/reserved_domains&quot;</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">region</span><span class="o">=</span><span class="n">region</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
@@ -4676,8 +4780,8 @@
<span class="sd"> :param description: human-readable description of this TLS certificate. optional, max 255 bytes.</span>
<span class="sd"> :param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</span>
<span class="sd"> :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles &lt;/cloud-edge/endpoints#certificate-chains&gt;`_.</span>
<span class="sd"> :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys &lt;/cloud-edge/endpoints#private-keys&gt;`_.</span>
<span class="sd"> :param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles &lt;https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains&gt;`_.</span>
<span class="sd"> :param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys &lt;https://ngrok.com/docs/cloud-edge/endpoints#private-keys&gt;`_.</span>
<span class="sd"> https://ngrok.com/docs/api#api-tls-certificates-create</span>
<span class="sd"> &quot;&quot;&quot;</span>
@@ -4772,104 +4876,6 @@
<span class="k">return</span> <span class="n">TLSCertificate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="TunnelSessionsClient"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelSessionsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;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.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<div class="viewcode-block" id="TunnelSessionsClient.list"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">limit</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelSessionList</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;List all online tunnel sessions running on this account.</span>
<span class="sd"> :param before_id:</span>
<span class="sd"> :param limit:</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-list</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions&quot;</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">before_id</span><span class="o">=</span><span class="n">before_id</span><span class="p">,</span>
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">TunnelSessionList</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.get"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TunnelSession</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the detailed status of a tunnel session by ID</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-get</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">TunnelSession</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.restart"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.restart">[docs]</a> <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-restart</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/restart&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.stop"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent that started this tunnel session to exit.</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-stop</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/stop&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="TunnelSessionsClient.update"><a class="viewcode-back" href="../../tunnel_sessions.html#ngrok.services.TunnelSessionsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent&#39;s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</span>
<span class="sd"> :param id:</span>
<span class="sd"> https://ngrok.com/docs/api#api-tunnel-sessions-update</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/tunnel_sessions/</span><span class="si">{id}</span><span class="s2">/update&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="TunnelsClient"><a class="viewcode-back" href="../../tunnels.html#ngrok.services.TunnelsClient">[docs]</a><span class="k">class</span> <span class="nc">TunnelsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Tunnels provide endpoints to access services exposed by a running ngrok</span>
<span class="sd"> agent tunnel session or an SSH reverse tunnel session.&quot;&quot;&quot;</span>
docs/_sources/abuse_reports.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Abuse Reports
=====================================
docs/_sources/agent_ingresses.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Agent Ingresses
=====================================
docs/_sources/api_keys.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
API Keys
=====================================
docs/_sources/application_sessions.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Application Sessions
=====================================
docs/_sources/application_users.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Application Users
=====================================
docs/_sources/certificate_authorities.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Certificate Authorities
=====================================
docs/_sources/client.rst.txt
+4 -1
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Client
=====================================
@@ -15,7 +18,7 @@ Client object:
# list all ip policies
for policy in client.ip_policies.list():
print(policy)
# create an ngrok agent authtoken
cred = client.credentials.create()
print(cred)
docs/_sources/credentials.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Tunnel Credentials
=====================================
docs/_sources/datatypes.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Datatypes
=====================================
docs/_sources/edge_route_backend_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Backend Module
=====================================
docs/_sources/edge_route_circuit_breaker_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Circuit Breaker Module
=====================================
docs/_sources/edge_route_compression_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Compression Module
=====================================
docs/_sources/edge_route_ip_restriction_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route IP Restriction Module
=====================================
docs/_sources/edge_route_o_auth_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route OAuth Module
=====================================
docs/_sources/edge_route_oidc_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route OIDC Module
=====================================
docs/_sources/edge_route_request_headers_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Request Headers Module
=====================================
docs/_sources/edge_route_response_headers_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Response Headers Module
=====================================
docs/_sources/edge_route_saml_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route SAML Module
=====================================
docs/_sources/edge_route_webhook_verification_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Webhook Verification Module
=====================================
docs/_sources/edge_route_websocket_tcp_converter_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Route Websocket TCP Converter Module
=====================================
docs/_sources/edges_https.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edges
=====================================
docs/_sources/edges_https_routes.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Routes
=====================================
docs/_sources/edges_tcp.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TCP Edges
=====================================
docs/_sources/edges_tls.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
TLS Edges
=====================================
docs/_sources/endpoints.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Endpoints
=====================================
docs/_sources/errors.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
.. _errors:
Errors
docs/_sources/event_destinations.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Destinations
=====================================
docs/_sources/event_sources.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Sources
=====================================
docs/_sources/event_subscriptions.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Event Subscriptions
=====================================
docs/_sources/failover_backends.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
Failover Backends
=====================================
docs/_sources/http_response_backends.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTP Response Backends
=====================================
docs/_sources/https_edge_mutual_tls_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge Mutual TLS Module
=====================================
docs/_sources/https_edge_tls_termination_module.rst.txt
+3
View File
@@ -1,3 +1,6 @@
..
Code generated for API Clients. DO NOT EDIT.
HTTPS Edge TLS Termination Module
=====================================

Some files were not shown because too many files have changed in this diff Show More