mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-11-18 21:23:39 +00:00
Merge pull request #49 from ngrok/pr/generated-32797567ac
Update generated files
This commit is contained in:
9 files changed
+26
-6
No files matched your search
@@ -1,4 +1,10 @@
|
||||
<!-- Code generated for API Clients. DO NOT EDIT. -->
|
||||
## 0.16.0
|
||||
* Add support for `ids` and `urls` query parameters when listing endpoint resources.
|
||||
|
||||
## 0.15.1
|
||||
* Un-pin specific version of `requests`
|
||||
|
||||
## 0.15.0
|
||||
* Add support for `vaults`
|
||||
* Add support for `secrets`
|
||||
|
||||
@@ -4079,7 +4079,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the clep API resource"""</span>
|
||||
<span class="w"> </span><span class="sd">"""URI of the Cloud Endpoint API resource"""</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">"uri"</span><span class="p">]</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
|
||||
@@ -3811,11 +3811,15 @@
|
||||
<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="n">ids</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
||||
<span class="n">urls</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">EndpointList</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""List all active endpoints on the account</span>
|
||||
|
||||
<span class="sd"> :param before_id:</span>
|
||||
<span class="sd"> :param limit:</span>
|
||||
<span class="sd"> :param ids:</span>
|
||||
<span class="sd"> :param urls:</span>
|
||||
|
||||
<span class="sd"> https://ngrok.com/docs/api#api-endpoints-list</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -3823,6 +3827,8 @@
|
||||
<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="n">ids</span><span class="o">=</span><span class="n">ids</span><span class="p">,</span>
|
||||
<span class="n">urls</span><span class="o">=</span><span class="n">urls</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">EndpointList</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>
|
||||
|
||||
+1
-1
@@ -1908,7 +1908,7 @@
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.uri">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.uri" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>URI of the clep API resource</p>
|
||||
<dd><p>URI of the Cloud Endpoint API resource</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
|
||||
+3
-1
@@ -320,13 +320,15 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.list">
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">urls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.list" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>List all active endpoints on the account</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
<li><p><strong>urls</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+1
-1
@@ -1 +1 @@
|
||||
Search.setIndex({"docnames": ["abuse_reports", "agent_ingresses", "api_keys", "application_sessions", "application_users", "bot_users", "certificate_authorities", "client", "credentials", "datatypes", "edge_route_backend_module", "edge_route_circuit_breaker_module", "edge_route_compression_module", "edge_route_ip_restriction_module", "edge_route_o_auth_module", "edge_route_oidc_module", "edge_route_policy_module", "edge_route_request_headers_module", "edge_route_response_headers_module", "edge_route_saml_module", "edge_route_traffic_policy_module", "edge_route_user_agent_filter_module", "edge_route_webhook_verification_module", "edge_route_websocket_tcp_converter_module", "edges_https", "edges_https_routes", "edges_tcp", "edges_tls", "endpoints", "errors", "event_destinations", "event_sources", "event_subscriptions", "failover_backends", "http_response_backends", "https_edge_mutual_tls_module", "https_edge_tls_termination_module", "index", "ip_policies", "ip_policy_rules", "ip_restrictions", "reserved_addrs", "reserved_domains", "secrets", "ssh_certificate_authorities", "ssh_credentials", "ssh_host_certificates", "ssh_user_certificates", "static_backends", "tcp_edge_backend_module", "tcp_edge_ip_restriction_module", "tcp_edge_policy_module", "tcp_edge_traffic_policy_module", "tls_certificates", "tls_edge_backend_module", "tls_edge_ip_restriction_module", "tls_edge_mutual_tls_module", "tls_edge_policy_module", "tls_edge_tls_termination_module", "tls_edge_traffic_policy_module", "tunnel_group_backends", "tunnel_sessions", "tunnels", "vaults", "weighted_backends"], "filenames": ["abuse_reports.rst", "agent_ingresses.rst", "api_keys.rst", "application_sessions.rst", "application_users.rst", "bot_users.rst", "certificate_authorities.rst", "client.rst", "credentials.rst", "datatypes.rst", "edge_route_backend_module.rst", "edge_route_circuit_breaker_module.rst", "edge_route_compression_module.rst", "edge_route_ip_restriction_module.rst", "edge_route_o_auth_module.rst", "edge_route_oidc_module.rst", "edge_route_policy_module.rst", "edge_route_request_headers_module.rst", "edge_route_response_headers_module.rst", "edge_route_saml_module.rst", "edge_route_traffic_policy_module.rst", "edge_route_user_agent_filter_module.rst", "edge_route_webhook_verification_module.rst", "edge_route_websocket_tcp_converter_module.rst", "edges_https.rst", "edges_https_routes.rst", "edges_tcp.rst", "edges_tls.rst", "endpoints.rst", "errors.rst", "event_destinations.rst", "event_sources.rst", "event_subscriptions.rst", "failover_backends.rst", "http_response_backends.rst", "https_edge_mutual_tls_module.rst", "https_edge_tls_termination_module.rst", "index.rst", "ip_policies.rst", "ip_policy_rules.rst", "ip_restrictions.rst", "reserved_addrs.rst", "reserved_domains.rst", "secrets.rst", "ssh_certificate_authorities.rst", "ssh_credentials.rst", "ssh_host_certificates.rst", "ssh_user_certificates.rst", "static_backends.rst", "tcp_edge_backend_module.rst", "tcp_edge_ip_restriction_module.rst", "tcp_edge_policy_module.rst", "tcp_edge_traffic_policy_module.rst", "tls_certificates.rst", "tls_edge_backend_module.rst", "tls_edge_ip_restriction_module.rst", "tls_edge_mutual_tls_module.rst", "tls_edge_policy_module.rst", "tls_edge_tls_termination_module.rst", "tls_edge_traffic_policy_module.rst", "tunnel_group_backends.rst", "tunnel_sessions.rst", "tunnels.rst", "vaults.rst", "weighted_backends.rst"], "titles": ["Abuse Reports", "Agent Ingresses", "API Keys", "Application Sessions", "Application Users", "Bot Users", "Certificate Authorities", "Client", "Tunnel Credentials", "Datatypes", "HTTPS Edge Route Backend Module", "HTTPS Edge Route Circuit Breaker Module", "HTTPS Edge Route Compression Module", "HTTPS Edge Route IP Restriction Module", "HTTPS Edge Route OAuth Module", "HTTPS Edge Route OIDC Module", "HTTPS Edge Route Policies Module", "HTTPS Edge Route Request Headers Module", "HTTPS Edge Route Response Headers Module", "HTTPS Edge Route SAML Module", "HTTPS Edge Route Traffic Policy Module", "HTTPS Edge Route User Agent Filter Module", "HTTPS Edge Route Webhook Verification Module", "HTTPS Edge Route Websocket TCP Converter Module", "HTTPS Edges", "HTTPS Edge Routes", "TCP Edges", "TLS Edges", "Endpoints", "Errors", "Event Destinations", "Event Sources", "Event Subscriptions", "Failover Backends", "HTTP Response Backends", "HTTPS Edge Mutual TLS Module", "HTTPS Edge TLS Termination Module", "ngrok-api", "IP Policies", "IP Policy Rules", "IP Restrictions", "Reserved Addresses", "Reserved Domains", "Secrets", "SSH Certificate Authorities", "SSH Credentials", "SSH Host Certificates", "SSH User Certificates", "Static Backends", "TCP Edge Backend Module", "TCP Edge IP Restriction Module", "TCP Edge Policy Module", "TCP Edge Traffic Policy Module", "TLS Certificates", "TLS Edge Backend Module", "TLS Edge IP Restriction Module", "TLS Edge Mutual TLS Module", "TLS Edge Policy Module", "TLS Edge TLS Termination Module", "TLS Edge Traffic Policy ModuLine truncated
|
||||
Search.setIndex({"docnames": ["abuse_reports", "agent_ingresses", "api_keys", "application_sessions", "application_users", "bot_users", "certificate_authorities", "client", "credentials", "datatypes", "edge_route_backend_module", "edge_route_circuit_breaker_module", "edge_route_compression_module", "edge_route_ip_restriction_module", "edge_route_o_auth_module", "edge_route_oidc_module", "edge_route_policy_module", "edge_route_request_headers_module", "edge_route_response_headers_module", "edge_route_saml_module", "edge_route_traffic_policy_module", "edge_route_user_agent_filter_module", "edge_route_webhook_verification_module", "edge_route_websocket_tcp_converter_module", "edges_https", "edges_https_routes", "edges_tcp", "edges_tls", "endpoints", "errors", "event_destinations", "event_sources", "event_subscriptions", "failover_backends", "http_response_backends", "https_edge_mutual_tls_module", "https_edge_tls_termination_module", "index", "ip_policies", "ip_policy_rules", "ip_restrictions", "reserved_addrs", "reserved_domains", "secrets", "ssh_certificate_authorities", "ssh_credentials", "ssh_host_certificates", "ssh_user_certificates", "static_backends", "tcp_edge_backend_module", "tcp_edge_ip_restriction_module", "tcp_edge_policy_module", "tcp_edge_traffic_policy_module", "tls_certificates", "tls_edge_backend_module", "tls_edge_ip_restriction_module", "tls_edge_mutual_tls_module", "tls_edge_policy_module", "tls_edge_tls_termination_module", "tls_edge_traffic_policy_module", "tunnel_group_backends", "tunnel_sessions", "tunnels", "vaults", "weighted_backends"], "filenames": ["abuse_reports.rst", "agent_ingresses.rst", "api_keys.rst", "application_sessions.rst", "application_users.rst", "bot_users.rst", "certificate_authorities.rst", "client.rst", "credentials.rst", "datatypes.rst", "edge_route_backend_module.rst", "edge_route_circuit_breaker_module.rst", "edge_route_compression_module.rst", "edge_route_ip_restriction_module.rst", "edge_route_o_auth_module.rst", "edge_route_oidc_module.rst", "edge_route_policy_module.rst", "edge_route_request_headers_module.rst", "edge_route_response_headers_module.rst", "edge_route_saml_module.rst", "edge_route_traffic_policy_module.rst", "edge_route_user_agent_filter_module.rst", "edge_route_webhook_verification_module.rst", "edge_route_websocket_tcp_converter_module.rst", "edges_https.rst", "edges_https_routes.rst", "edges_tcp.rst", "edges_tls.rst", "endpoints.rst", "errors.rst", "event_destinations.rst", "event_sources.rst", "event_subscriptions.rst", "failover_backends.rst", "http_response_backends.rst", "https_edge_mutual_tls_module.rst", "https_edge_tls_termination_module.rst", "index.rst", "ip_policies.rst", "ip_policy_rules.rst", "ip_restrictions.rst", "reserved_addrs.rst", "reserved_domains.rst", "secrets.rst", "ssh_certificate_authorities.rst", "ssh_credentials.rst", "ssh_host_certificates.rst", "ssh_user_certificates.rst", "static_backends.rst", "tcp_edge_backend_module.rst", "tcp_edge_ip_restriction_module.rst", "tcp_edge_policy_module.rst", "tcp_edge_traffic_policy_module.rst", "tls_certificates.rst", "tls_edge_backend_module.rst", "tls_edge_ip_restriction_module.rst", "tls_edge_mutual_tls_module.rst", "tls_edge_policy_module.rst", "tls_edge_tls_termination_module.rst", "tls_edge_traffic_policy_module.rst", "tunnel_group_backends.rst", "tunnel_sessions.rst", "tunnels.rst", "vaults.rst", "weighted_backends.rst"], "titles": ["Abuse Reports", "Agent Ingresses", "API Keys", "Application Sessions", "Application Users", "Bot Users", "Certificate Authorities", "Client", "Tunnel Credentials", "Datatypes", "HTTPS Edge Route Backend Module", "HTTPS Edge Route Circuit Breaker Module", "HTTPS Edge Route Compression Module", "HTTPS Edge Route IP Restriction Module", "HTTPS Edge Route OAuth Module", "HTTPS Edge Route OIDC Module", "HTTPS Edge Route Policies Module", "HTTPS Edge Route Request Headers Module", "HTTPS Edge Route Response Headers Module", "HTTPS Edge Route SAML Module", "HTTPS Edge Route Traffic Policy Module", "HTTPS Edge Route User Agent Filter Module", "HTTPS Edge Route Webhook Verification Module", "HTTPS Edge Route Websocket TCP Converter Module", "HTTPS Edges", "HTTPS Edge Routes", "TCP Edges", "TLS Edges", "Endpoints", "Errors", "Event Destinations", "Event Sources", "Event Subscriptions", "Failover Backends", "HTTP Response Backends", "HTTPS Edge Mutual TLS Module", "HTTPS Edge TLS Termination Module", "ngrok-api", "IP Policies", "IP Policy Rules", "IP Restrictions", "Reserved Addresses", "Reserved Domains", "Secrets", "SSH Certificate Authorities", "SSH Credentials", "SSH Host Certificates", "SSH User Certificates", "Static Backends", "TCP Edge Backend Module", "TCP Edge IP Restriction Module", "TCP Edge Policy Module", "TCP Edge Traffic Policy Module", "TLS Certificates", "TLS Edge Backend Module", "TLS Edge IP Restriction Module", "TLS Edge Mutual TLS Module", "TLS Edge Policy Module", "TLS Edge TLS Termination Module", "TLS Edge Traffic Policy ModuLine truncated
|
||||
+1
-1
@@ -3824,7 +3824,7 @@ class Endpoint(object):
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the clep API resource"""
|
||||
"""URI of the Cloud Endpoint API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
|
||||
@@ -3556,11 +3556,15 @@ class EndpointsClient(object):
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
ids: Sequence[str] = [],
|
||||
urls: Sequence[str] = [],
|
||||
) -> EndpointList:
|
||||
"""List all active endpoints on the account
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
:param ids:
|
||||
:param urls:
|
||||
|
||||
https://ngrok.com/docs/api#api-endpoints-list
|
||||
"""
|
||||
@@ -3568,6 +3572,8 @@ class EndpointsClient(object):
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
ids=ids,
|
||||
urls=urls,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return EndpointList(self._client, result)
|
||||
|
||||
Reference in new issue
Block a user