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

Merge pull request #49 from ngrok/pr/generated-32797567ac

Browse Source 
Update generated files
This commit is contained in:
Benjamin Pollack
2025-08-15 10:04:48 -04:00
committed by GitHub
parent dc15fe7005 11431f4b55
commit b892a82d00
9 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+6
View File
@@ -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`
docs/_modules/ngrok/datatypes.html
+1 -1
View File
@@ -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">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI of the clep API resource&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI of the Cloud Endpoint API resource&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>
docs/_modules/ngrok/services.html
+6
View File
@@ -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">-&gt;</span> <span class="n">EndpointList</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;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"> &quot;&quot;&quot;</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>
docs/datatypes.html
+1 -1
View File
@@ -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>
docs/endpoints.html
+3 -1
View File
@@ -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>
docs/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
ngrok/datatypes.py
+1 -1
View File
@@ -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
ngrok/services.py
+6
View File
@@ -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)
setup.py
+1 -1
View File
@@ -13,7 +13,7 @@ def read_file(filename):
setup(
name="ngrok-api",
version="0.15.0",
version="0.16.0",
description="ngrok HTTP API client library",
long_description=read_file("README.md"),
long_description_content_type="text/markdown",