Merge pull request #32 from ngrok/pr/generated-654f4c2c2d

Update generated files

.tox/log/GLOB-0.log

@@ -1,6 +1,6 @@
 action: GLOB, msg: packaging
-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
+cwd: /var/lib/buildkite-agent-9/builds/ip-172-31-29-111-us-west-2-compute-internal-9-1/ngrok/api-client-prs/.cache/ngrok-api-python
+cmd: /var/lib/buildkite-agent-9/builds/ip-172-31-29-111-us-west-2-compute-internal-9-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
@@ -37,27 +37,27 @@ copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests
 Writing ngrok-api-0.0.0/setup.cfg
 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/README.md'
-adding 'ngrok-api-0.0.0/pyproject.toml'
-adding 'ngrok-api-0.0.0/setup.py'
+adding 'ngrok-api-0.0.0/ngrok'
+adding 'ngrok-api-0.0.0/tests'
 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/pyproject.toml'
+adding 'ngrok-api-0.0.0/README.md'
+adding 'ngrok-api-0.0.0/LICENSE'
+adding 'ngrok-api-0.0.0/setup.py'
+adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.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/requires.txt'
+adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
 adding 'ngrok-api-0.0.0/ngrok/client.py'
-adding 'ngrok-api-0.0.0/ngrok/http_client.py'
+adding 'ngrok-api-0.0.0/ngrok/utils.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/http_client.py'
 adding 'ngrok-api-0.0.0/ngrok/services.py'
+adding 'ngrok-api-0.0.0/ngrok/__init__.py'
+adding 'ngrok-api-0.0.0/ngrok/iterator.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/dependency_links.txt'
-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'
+adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
 removing 'ngrok-api-0.0.0' (and everything under it)

CHANGELOG.md

@@ -1,9 +1,12 @@
 <!-- Code generated for API Clients. DO NOT EDIT. -->
 
+## 0.11.0
+
+* Added support for the Bot User API. The Bot User API allows you to manage the bots that are registered to your ngrok account. You can automate the creation, management, and deletion of bot users in your account.
+
 ## 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.
-

doc/source/bot_users.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+Bot Users
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.bot_users` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: BotUsersClient
+   :undoc-members: BotUsersClient

doc/source/edge_route_policy_module.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+HTTPS Edge Route Policies Module
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.edge_route_policy_module` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: EdgeRoutePolicyModuleClient
+   :undoc-members: EdgeRoutePolicyModuleClient

doc/source/edge_route_user_agent_filter_module.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+HTTPS Edge Route User Agent Filter Module
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.edge_route_user_agent_filter_module` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: EdgeRouteUserAgentFilterModuleClient
+   :undoc-members: EdgeRouteUserAgentFilterModuleClient

doc/source/index.rst

@@ -131,8 +131,10 @@ API Reference
   tunnel_sessions
   failover_backends
   http_response_backends
+  static_backends
   tunnel_group_backends
   weighted_backends
+  bot_users
   certificate_authorities
   credentials
   edges_https_routes
@@ -150,14 +152,18 @@ API Reference
   edge_route_saml_module
   edge_route_oidc_module
   edge_route_websocket_tcp_converter_module
+  edge_route_user_agent_filter_module
+  edge_route_policy_module
   edges_tcp
   tcp_edge_backend_module
   tcp_edge_ip_restriction_module
+  tcp_edge_policy_module
   edges_tls
   tls_edge_backend_module
   tls_edge_ip_restriction_module
   tls_edge_mutual_tls_module
   tls_edge_tls_termination_module
+  tls_edge_policy_module
   endpoints
   event_destinations
   event_subscriptions

doc/source/static_backends.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+Static Backends
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.static_backends` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: StaticBackendsClient
+   :undoc-members: StaticBackendsClient

doc/source/tcp_edge_policy_module.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+TCP Edge Policy Module
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.tcp_edge_policy_module` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: TCPEdgePolicyModuleClient
+   :undoc-members: TCPEdgePolicyModuleClient

doc/source/tls_edge_policy_module.rst

@@ -0,0 +1,12 @@
+..
+  Code generated for API Clients. DO NOT EDIT.
+
+TLS Edge Policy Module
+=====================================
+
+Do not construct this object directly, instead access the
+:attr:`~ngrok.Client.tls_edge_policy_module` property of an :class:`ngrok.Client` object.
+
+.. automodule:: ngrok.services
+   :members: TLSEdgePolicyModuleClient
+   :undoc-members: TLSEdgePolicyModuleClient

docs/_modules/index.html

@@ -169,8 +169,10 @@
 <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="../static_backends.html">Static Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tunnel_group_backends.html">Tunnel Group Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../weighted_backends.html">Weighted Backends</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../bot_users.html">Bot Users</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../certificate_authorities.html">Certificate Authorities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../credentials.html">Tunnel Credentials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../edges_https_routes.html">HTTPS Edge Routes</a></li>
@@ -188,14 +190,18 @@
 <li class="toctree-l1"><a class="reference internal" href="../edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../edge_route_policy_module.html">HTTPS Edge Route Policies Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../edges_tcp.html">TCP Edges</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tcp_edge_policy_module.html">TCP Edge Policy Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../edges_tls.html">TLS Edges</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tls_edge_policy_module.html">TLS Edge Policy Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../endpoints.html">Endpoints</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../event_destinations.html">Event Destinations</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../event_subscriptions.html">Event Subscriptions</a></li>

docs/_modules/ngrok/client.html

@@ -169,8 +169,10 @@
 <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="../../static_backends.html">Static Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../weighted_backends.html">Weighted Backends</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../bot_users.html">Bot Users</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../certificate_authorities.html">Certificate Authorities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../credentials.html">Tunnel Credentials</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../edges_https_routes.html">HTTPS Edge Routes</a></li>
@@ -188,14 +190,18 @@
 <li class="toctree-l1"><a class="reference internal" href="../../edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../edge_route_user_agent_filter_module.html">HTTPS Edge Route User Agent Filter Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../edge_route_policy_module.html">HTTPS Edge Route Policies Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../edges_tcp.html">TCP Edges</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tcp_edge_policy_module.html">TCP Edge Policy Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../edges_tls.html">TLS Edges</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../tls_edge_policy_module.html">TLS Edge Policy Module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../endpoints.html">Endpoints</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../event_destinations.html">Event Destinations</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../event_subscriptions.html">Event Subscriptions</a></li>
@@ -292,6 +298,10 @@ <h1>Source code for ngrok.client</h1><div class="highlight"><pre>
 <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">bot_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BotUsersClient</span><span class="p">:</span>
+        <span class="k">return</span> <span class="n">BotUsersClient</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>
@@ -415,13 +425,15 @@ <h1>Source code for ngrok.client</h1><div class="highlight"><pre>
             <span class="p">[</span>
                 <span class="s2">&quot;failover&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;http_response&quot;</span><span class="p">,</span>
+                <span class="s2">&quot;static_address&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;tunnel_group&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;weighted&quot;</span><span class="p">,</span>
             <span class="p">],</span>
         <span class="p">)</span>
         <span class="k">return</span> <span class="n">ns</span><span class="p">(</span>
             <span class="n">failover</span><span class="o">=</span><span class="n">FailoverBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
             <span class="n">http_response</span><span class="o">=</span><span class="n">HTTPResponseBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
+            <span class="n">static_address</span><span class="o">=</span><span class="n">StaticBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
             <span class="n">tunnel_group</span><span class="o">=</span><span class="n">TunnelGroupBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
             <span class="n">weighted</span><span class="o">=</span><span class="n">WeightedBackendsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
         <span class="p">)</span>
@@ -462,6 +474,7 @@ <h1>Source code for ngrok.client</h1><div class="highlight"><pre>
                 <span class="s2">&quot;https_edge_route_saml&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;https_edge_route_oidc&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;https_edge_route_websocket_tcp_converter&quot;</span><span class="p">,</span>
+                <span class="s2">&quot;https_edge_route_user_agent_filter&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;tcp_edge_backend&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;tcp_edge_ip_restriction&quot;</span><span class="p">,</span>
                 <span class="s2">&quot;tls_edge_backend&quot;</span><span class="p">,</span>
@@ -490,6 +503,9 @@ <h1>Source code for ngrok.client</h1><div class="highlight"><pre>
             <span class="n">https_edge_route_websocket_tcp_converter</span><span class="o">=</span><span class="n">EdgeRouteWebsocketTCPConverterModuleClient</span><span class="p">(</span>
                 <span class="bp">self</span>
             <span class="p">),</span>
+            <span class="n">https_edge_route_user_agent_filter</span><span class="o">=</span><span class="n">EdgeRouteUserAgentFilterModuleClient</span><span class="p">(</span>
+                <span class="bp">self</span>
+            <span class="p">),</span>
             <span class="n">tcp_edge_backend</span><span class="o">=</span><span class="n">TCPEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
             <span class="n">tcp_edge_ip_restriction</span><span class="o">=</span><span class="n">TCPEdgeIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
             <span class="n">tls_edge_backend</span><span class="o">=</span><span class="n">TLSEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>