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.users.get_user — kittycad v0.3.9 documentation</title>
|
||||
<title>kittycad.api.users.get_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">
|
||||
@ -106,7 +107,7 @@
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.users.get_user.html#kittycad.api.users.get_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">User</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.users.get_user.html#kittycad.api.users.get_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">User</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">User</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>
|
||||
@ -116,10 +117,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.users.get_user.html#kittycad.api.users.get_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">User</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.users.get_user.html#kittycad.api.users.get_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">Union</span><span class="p">[</span><span class="n">User</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>
|
||||
@ -132,7 +135,7 @@
|
||||
<span class="nb">id</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">User</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">User</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
@ -150,7 +153,7 @@
|
||||
<span class="nb">id</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">User</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">User</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.</span>
|
||||
<span class="sd"> Alternatively, to get information about the authenticated user, use `/user` endpoint.</span>
|
||||
<span class="sd"> To get information about any KittyCAD user, you must be a KittyCAD employee."""</span> <span class="c1"># noqa: E501</span>
|
||||
@ -165,7 +168,7 @@
|
||||
<span class="nb">id</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">User</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">User</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="nb">id</span><span class="o">=</span><span class="nb">id</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 +184,7 @@
|
||||
<span class="nb">id</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">User</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">User</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.</span>
|
||||
<span class="sd"> Alternatively, to get information about the authenticated user, use `/user` endpoint.</span>
|
||||
<span class="sd"> To get information about any KittyCAD user, you must be a KittyCAD employee."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
Reference in New Issue
Block a user