ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2023-05-08 20:06:56 +00:00
parent f933b716f4
commit fa2b411b78
2603 changed files with 36412 additions and 35438 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
docs/html/_autosummary/kittycad.api.users.get_user.html
View File

@ -1,15 +1,21 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta property="og:title" content="kittycad.api.users.get_user" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.users.get_user.html" />
<meta property="og:site_name" content="kittycad" />
<meta property="og:description" content="Functions" />
<meta property="og:image:width" content="1146" />
<meta property="og:image:height" content="600" />
<meta property="og:image" content="/_images/social_previews/summary__autosummary_kittycad.api.users.get_user_c016e717.png" />
<meta property="og:image:alt" content="Functions" />
<meta name="description" content="Functions" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:title" content="kittycad.api.users.get_user" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.users.get_user.html" />
<meta property="og:description" content="Functions" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.users.get_user &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.users.get_user &mdash; 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" />
@ -19,10 +25,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>
@ -44,7 +51,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,6 +85,13 @@
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.users.get_user.asyncio_detailed.html">kittycad.api.users.get_user.asyncio_detailed</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.users.get_user.sync.html">kittycad.api.users.get_user.sync</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.users.get_user.sync_detailed.html">kittycad.api.users.get_user.sync_detailed</a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user._build_response"><code class="docutils literal notranslate"><span class="pre">_build_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user._get_kwargs"><code class="docutils literal notranslate"><span class="pre">_get_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user._parse_response"><code class="docutils literal notranslate"><span class="pre">_parse_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user.asyncio"><code class="docutils literal notranslate"><span class="pre">asyncio()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user.asyncio_detailed"><code class="docutils literal notranslate"><span class="pre">asyncio_detailed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user.sync"><code class="docutils literal notranslate"><span class="pre">sync()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.users.get_user.sync_detailed"><code class="docutils literal notranslate"><span class="pre">sync_detailed()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.users.get_user_extended.html">kittycad.api.users.get_user_extended</a></li>
@ -123,32 +137,28 @@
<div itemprop="articleBody">
<section id="module-kittycad.api.users.get_user">
<span id="kittycad-api-users-get-user"></span><h1>kittycad.api.users.get_user<a class="headerlink" href="#module-kittycad.api.users.get_user" title="Permalink to this headline"></a></h1>
<span id="kittycad-api-users-get-user"></span><h1>kittycad.api.users.get_user<a class="headerlink" href="#module-kittycad.api.users.get_user" title="Permalink to this heading"></a></h1>
<p class="rubric">Functions</p>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.users.get_user.asyncio.html#kittycad.api.users.get_user.asyncio" title="kittycad.api.users.get_user.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(id, *, client)</p></td>
<td><p>To get information about yourself, use <code class="xref any docutils literal notranslate"><span class="pre">/users/me</span></code> as the endpoint.</p></td>
<td><p>To get information about yourself, use <cite>/users/me</cite> as the endpoint.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.users.get_user.asyncio_detailed.html#kittycad.api.users.get_user.asyncio_detailed" title="kittycad.api.users.get_user.asyncio_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio_detailed</span></code></a>(id, *, client)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype</dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</p>
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]]</p>
</dd>
</dl>
</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.users.get_user.sync.html#kittycad.api.users.get_user.sync" title="kittycad.api.users.get_user.sync"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync</span></code></a>(id, *, client)</p></td>
<td><p>To get information about yourself, use <code class="xref any docutils literal notranslate"><span class="pre">/users/me</span></code> as the endpoint.</p></td>
<td><p>To get information about yourself, use <cite>/users/me</cite> as the endpoint.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.users.get_user.sync_detailed.html#kittycad.api.users.get_user.sync_detailed" title="kittycad.api.users.get_user.sync_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync_detailed</span></code></a>(id, *, client)</p></td>
<td><p><dl class="field-list simple">
<dt class="field-odd">rtype</dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</p>
<dt class="field-odd">rtype<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]]</p>
</dd>
</dl>
</p></td>
@ -159,8 +169,8 @@
<dt class="sig sig-object py" id="kittycad.api.users.get_user._build_response">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">_build_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#_build_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user._build_response" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]]</p>
</dd>
</dl>
</dd></dl>
@ -169,7 +179,7 @@
<dt class="sig sig-object py" id="kittycad.api.users.get_user._get_kwargs">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">_get_kwargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#_get_kwargs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user._get_kwargs" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
</dd>
</dl>
@ -179,8 +189,8 @@
<dt class="sig sig-object py" id="kittycad.api.users.get_user._parse_response">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">_parse_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#_parse_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user._parse_response" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
@ -188,12 +198,12 @@
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.users.get_user.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>To get information about yourself, use <code class="xref any docutils literal notranslate"><span class="pre">/users/me</span></code> as the endpoint. By doing so you will get the user information for the authenticated user.
Alternatively, to get information about the authenticated user, use <code class="xref any docutils literal notranslate"><span class="pre">/user</span></code> endpoint.
<dd><p>To get information about yourself, use <cite>/users/me</cite> as the endpoint. By doing so you will get the user information for the authenticated user.
Alternatively, to get information about the authenticated user, use <cite>/user</cite> endpoint.
To get information about any KittyCAD user, you must be a KittyCAD employee.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
@ -202,8 +212,8 @@ To get information about any KittyCAD user, you must be a KittyCAD employee.</p>
<dt class="sig sig-object py" id="kittycad.api.users.get_user.asyncio_detailed">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">asyncio_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#asyncio_detailed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user.asyncio_detailed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]]</p>
</dd>
</dl>
</dd></dl>
@ -211,12 +221,12 @@ To get information about any KittyCAD user, you must be a KittyCAD employee.</p>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.users.get_user.sync">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user.sync" title="Permalink to this definition"></a></dt>
<dd><p>To get information about yourself, use <code class="xref any docutils literal notranslate"><span class="pre">/users/me</span></code> as the endpoint. By doing so you will get the user information for the authenticated user.
Alternatively, to get information about the authenticated user, use <code class="xref any docutils literal notranslate"><span class="pre">/user</span></code> endpoint.
<dd><p>To get information about yourself, use <cite>/users/me</cite> as the endpoint. By doing so you will get the user information for the authenticated user.
Alternatively, to get information about the authenticated user, use <cite>/user</cite> endpoint.
To get information about any KittyCAD user, you must be a KittyCAD employee.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>
@ -225,8 +235,8 @@ To get information about any KittyCAD user, you must be a KittyCAD employee.</p>
<dt class="sig sig-object py" id="kittycad.api.users.get_user.sync_detailed">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.users.get_user.</span></span><span class="sig-name descname"><span class="pre">sync_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/users/get_user.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/users/get_user.html#sync_detailed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.users.get_user.sync_detailed" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.user.User.html#kittycad.models.user.User" title="kittycad.models.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]]</p>
</dd>
</dl>
</dd></dl>