I HAVE GENERATED YOUR NEW DOCS!
This commit is contained in:
github-actions[bot]
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_tokens.create_api_token_for_user — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.api.api_tokens.create_api_token_for_user — kittycad v0.4.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
|
||||
@ -13,10 +13,11 @@
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
@ -36,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.9
|
||||
v0.4.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -105,9 +106,7 @@
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.html#kittycad.api.api_tokens.create_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.html#kittycad.api.api_tokens.create_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
|
||||
<span class="n">response_201</span> <span class="o">=</span> <span class="n">ApiToken</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_201</span>
|
||||
@ -117,12 +116,12 @@
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.html#kittycad.api.api_tokens.create_api_token_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
@ -134,7 +133,7 @@
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.sync_detailed.html#kittycad.api.api_tokens.create_api_token_for_user.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
@ -150,7 +149,7 @@
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.sync.html#kittycad.api.api_tokens.create_api_token_for_user.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
@ -161,7 +160,7 @@
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.asyncio_detailed.html#kittycad.api.api_tokens.create_api_token_for_user.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
@ -175,7 +174,7 @@
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.create_api_token_for_user.asyncio.html#kittycad.api.api_tokens.create_api_token_for_user.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_tokens.delete_api_token_for_user — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.api.api_tokens.delete_api_token_for_user — kittycad v0.4.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
|
||||
@ -13,10 +13,11 @@
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
@ -36,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.9
|
||||
v0.4.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -78,7 +79,7 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_tokens.delete_api_token_for_user</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">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
<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">Dict</span><span class="p">,</span> <span class="n">Optional</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
@ -107,20 +108,18 @@
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html#kittycad.api.api_tokens.delete_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">204</span><span class="p">:</span>
|
||||
<span class="n">response_204</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="k">return</span> <span class="n">response_204</span>
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html#kittycad.api.api_tokens.delete_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html#kittycad.api.api_tokens.delete_api_token_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html#kittycad.api.api_tokens.delete_api_token_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
@ -133,7 +132,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
@ -151,7 +150,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.</span>
|
||||
<span class="sd"> This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
@ -165,7 +164,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
@ -181,7 +180,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Error</span><span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.</span>
|
||||
<span class="sd"> This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_tokens.get_api_token_for_user — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.api.api_tokens.get_api_token_for_user — kittycad v0.4.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
|
||||
@ -13,10 +13,11 @@
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
@ -36,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.9
|
||||
v0.4.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -108,9 +109,7 @@
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.get_api_token_for_user.html#kittycad.api.api_tokens.get_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.get_api_token_for_user.html#kittycad.api.api_tokens.get_api_token_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiToken</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
@ -120,12 +119,12 @@
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.get_api_token_for_user.html#kittycad.api.api_tokens.get_api_token_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
@ -138,7 +137,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
@ -156,7 +155,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
@ -169,7 +168,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
@ -185,7 +184,7 @@
|
||||
<span class="n">token</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">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiToken</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_tokens.list_api_tokens_for_user — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.api.api_tokens.list_api_tokens_for_user — kittycad v0.4.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
|
||||
@ -13,10 +13,11 @@
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
@ -36,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.9
|
||||
v0.4.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -126,7 +127,7 @@
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.list_api_tokens_for_user.html#kittycad.api.api_tokens.list_api_tokens_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiTokenResultsPage</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
@ -136,12 +137,12 @@
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_tokens.list_api_tokens_for_user.html#kittycad.api.api_tokens.list_api_tokens_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
@ -156,7 +157,7 @@
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</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">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
@ -178,7 +179,7 @@
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.</span>
|
||||
<span class="sd"> The API tokens are returned in order of creation, with the most recently created API tokens first."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
@ -196,7 +197,7 @@
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</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">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
@ -216,7 +217,7 @@
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">ApiTokenResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.</span>
|
||||
<span class="sd"> The API tokens are returned in order of creation, with the most recently created API tokens first."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user