I HAVE GENERATED YOUR NEW DOCS!
This commit is contained in:
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -79,7 +79,7 @@
|
|||||||
<h1>asyncio<a class="headerlink" href="#asyncio" title="Permalink to this headline"></a></h1>
|
<h1>asyncio<a class="headerlink" href="#asyncio" title="Permalink to this headline"></a></h1>
|
||||||
<dl class="py function">
|
<dl class="py function">
|
||||||
<dt class="sig sig-object py" id="kittycad.api.file.file_convert.asyncio">
|
<dt class="sig sig-object py" id="kittycad.api.file.file_convert.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.file.file_convert.</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">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</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/file/file_convert.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert.asyncio" title="Permalink to this definition"></a></dt>
|
<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.file.file_convert.</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">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</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/file/file_convert.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert.asyncio" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.</p>
|
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.</p>
|
||||||
<dl class="field-list simple">
|
<dl class="field-list simple">
|
||||||
<dt class="field-odd">Return type</dt>
|
<dt class="field-odd">Return type</dt>
|
||||||
|
@ -79,7 +79,7 @@
|
|||||||
<h1>asyncio_detailed<a class="headerlink" href="#asyncio-detailed" title="Permalink to this headline"></a></h1>
|
<h1>asyncio_detailed<a class="headerlink" href="#asyncio-detailed" title="Permalink to this headline"></a></h1>
|
||||||
<dl class="py function">
|
<dl class="py function">
|
||||||
<dt class="sig sig-object py" id="kittycad.api.file.file_convert.asyncio_detailed">
|
<dt class="sig sig-object py" id="kittycad.api.file.file_convert.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.file.file_convert.</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">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</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/file/file_convert.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert.asyncio_detailed" title="Permalink to this definition"></a></dt>
|
<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.file.file_convert.</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">source_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content</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/file/file_convert.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.file_convert.asyncio_detailed" title="Permalink to this definition"></a></dt>
|
||||||
<dd><dl class="field-list simple">
|
<dd><dl class="field-list simple">
|
||||||
<dt class="field-odd">Return type</dt>
|
<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://python.readthedocs.io/en/latest/library/typing.html#typing.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>]]</p>
|
<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://python.readthedocs.io/en/latest/library/typing.html#typing.Union" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Any" title="(in Python v3.7)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>]]</p>
|
||||||
|
@ -85,7 +85,7 @@
|
|||||||
<col style="width: 90%" />
|
<col style="width: 90%" />
|
||||||
</colgroup>
|
</colgroup>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.api.file.file_convert.asyncio.html#kittycad.api.file.file_convert.asyncio" title="kittycad.api.file.file_convert.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(source_format, output_format, *, client)</p></td>
|
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.api.file.file_convert.asyncio.html#kittycad.api.file.file_convert.asyncio" title="kittycad.api.file.file_convert.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(source_format, output_format, ...)</p></td>
|
||||||
<td><p>Convert a CAD file from one format to another.</p></td>
|
<td><p>Convert a CAD file from one format to another.</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.api.file.file_convert.asyncio_detailed.html#kittycad.api.file.file_convert.asyncio_detailed" title="kittycad.api.file.file_convert.asyncio_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio_detailed</span></code></a>(source_format, ...)</p></td>
|
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.api.file.file_convert.asyncio_detailed.html#kittycad.api.file.file_convert.asyncio_detailed" title="kittycad.api.file.file_convert.asyncio_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio_detailed</span></code></a>(source_format, ...)</p></td>
|
||||||
|
File diff suppressed because one or more lines are too long
43
kittycad.api.file.file_conversion_by_id.html
Normal file
43
kittycad.api.file.file_conversion_by_id.html
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.file.file_conversion_by_id</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.file.html"><font color="#ffffff">file</font></a>.file_conversion_by_id</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Get the status of a file conversion.</tt></dd></dl>
|
||||||
|
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Get the status of a file conversion.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
43
kittycad.api.file.file_convert.html
Normal file
43
kittycad.api.file.file_convert.html
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.file.file_convert</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.file.html"><font color="#ffffff">file</font></a>.file_convert</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.</tt></dd></dl>
|
||||||
|
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
41
kittycad.api.file.file_convert_with_base64_helper.html
Normal file
41
kittycad.api.file.file_convert_with_base64_helper.html
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.file.file_convert_with_base64_helper</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.file.html"><font color="#ffffff">file</font></a>.file_convert_with_base64_helper</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.</tt></dd></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
24
kittycad.api.file.html
Normal file
24
kittycad.api.file.html
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: package kittycad.api.file</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.file</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.file.file_conversion_by_id.html">file_conversion_by_id</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.api.file.file_convert.html">file_convert</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.api.file.file_convert_with_base64_helper.html">file_convert_with_base64_helper</a><br>
|
||||||
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
23
kittycad.api.html
Normal file
23
kittycad.api.html
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: package kittycad.api</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.api</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py</a></font></td></tr></table>
|
||||||
|
<p><tt>Contains methods for accessing the API</tt></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.file.html"><strong>file</strong> (package)</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.api.meta.html"><strong>meta</strong> (package)</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
24
kittycad.api.meta.html
Normal file
24
kittycad.api.meta.html
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: package kittycad.api.meta</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.meta</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.meta.meta_debug_instance.html">meta_debug_instance</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.api.meta.meta_debug_session.html">meta_debug_session</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.api.meta.ping.html">ping</a><br>
|
||||||
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
43
kittycad.api.meta.meta_debug_instance.html
Normal file
43
kittycad.api.meta.meta_debug_instance.html
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.meta.meta_debug_instance</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.meta_debug_instance</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]</dt><dd><tt>Get information about this specific API server instance. This is primarily used for debugging.</tt></dd></dl>
|
||||||
|
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]</dt></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]</dt><dd><tt>Get information about this specific API server instance. This is primarily used for debugging.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]</dt></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
43
kittycad.api.meta.meta_debug_session.html
Normal file
43
kittycad.api.meta.meta_debug_session.html
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.meta.meta_debug_session</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.meta_debug_session</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]</dt><dd><tt>Get information about your API request session. This is primarily used for debugging.</tt></dd></dl>
|
||||||
|
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]</dt></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]</dt><dd><tt>Get information about your API request session. This is primarily used for debugging.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]</dt></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
42
kittycad.api.meta.ping.html
Normal file
42
kittycad.api.meta.ping.html
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.api.meta.ping</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.ping</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#eeaa77">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]</dt><dd><tt>Simple ping to the server.</tt></dd></dl>
|
||||||
|
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]</dt></dl>
|
||||||
|
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]</dt><dd><tt>Simple ping to the server.</tt></dd></dl>
|
||||||
|
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]</dt></dl>
|
||||||
|
</td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Optional</strong> = typing.Optional</td></tr></table>
|
||||||
|
</body></html>
|
171
kittycad.client.html
Normal file
171
kittycad.client.html
Normal file
@ -0,0 +1,171 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.client</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.client</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="ssl.html">ssl</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.client.html#Client">Client</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.client.html#AuthenticatedClient">AuthenticatedClient</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="AuthenticatedClient">class <strong>AuthenticatedClient</strong></a>(<a href="kittycad.client.html#Client">Client</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#AuthenticatedClient">AuthenticatedClient</a>(base_url: str = '<a href="https://api.kittycad.io">https://api.kittycad.io</a>', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
A <a href="#Client">Client</a> which has been authenticated for use on secured endpoints<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="kittycad.client.html#AuthenticatedClient">AuthenticatedClient</a></dd>
|
||||||
|
<dd><a href="kittycad.client.html#Client">Client</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Methods defined here:<br>
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__init__"><strong>__init__</strong></a>(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -> None</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-get_headers"><strong>get_headers</strong></a>(self) -> Dict[str, str]</dt><dd><tt>Get headers to be used in authenticated endpoints</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'token': <class 'str'>}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Methods inherited from <a href="kittycad.client.html#Client">Client</a>:<br>
|
||||||
|
<dl><dt><a name="AuthenticatedClient-get_cookies"><strong>get_cookies</strong></a>(self) -> Dict[str, str]</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-get_timeout"><strong>get_timeout</strong></a>(self) -> float</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-with_cookies"><strong>with_cookies</strong></a>(self, cookies: Dict[str, str]) -> 'Client'</dt><dd><tt>Get a new client matching this one with additional cookies</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-with_headers"><strong>with_headers</strong></a>(self, headers: Dict[str, str]) -> 'Client'</dt><dd><tt>Get a new client matching this one with additional headers</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthenticatedClient-with_timeout"><strong>with_timeout</strong></a>(self, timeout: float) -> 'Client'</dt><dd><tt>Get a new client matching this one with a new timeout (in seconds)</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="kittycad.client.html#Client">Client</a>:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table> <p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="Client">class <strong>Client</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#Client">Client</a>(base_url: str = '<a href="https://api.kittycad.io">https://api.kittycad.io</a>', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
A class for keeping track of data related to the API<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="Client-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__init__"><strong>__init__</strong></a>(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -> None</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#Client">Client</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-get_cookies"><strong>get_cookies</strong></a>(self) -> Dict[str, str]</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-get_headers"><strong>get_headers</strong></a>(self) -> Dict[str, str]</dt><dd><tt>Get headers to be used in all endpoints</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-get_timeout"><strong>get_timeout</strong></a>(self) -> float</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-with_cookies"><strong>with_cookies</strong></a>(self, cookies: Dict[str, str]) -> 'Client'</dt><dd><tt>Get a new client matching this one with additional cookies</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-with_headers"><strong>with_headers</strong></a>(self, headers: Dict[str, str]) -> 'Client'</dt><dd><tt>Get a new client matching this one with additional headers</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Client-with_timeout"><strong>with_timeout</strong></a>(self, timeout: float) -> 'Client'</dt><dd><tt>Get a new client matching this one with a new timeout (in seconds)</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'base_url': <class 'str'>, 'cookies': typing.Dict[str, str], 'headers': typing.Dict[str, str], 'timeout': <class 'float'>, 'verify_ssl': typing.Union[str, bool, ssl.SSLContext]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
25
kittycad.html
Normal file
25
kittycad.html
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: package kittycad</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>kittycad</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py</a></font></td></tr></table>
|
||||||
|
<p><tt>A client library for accessing KittyCAD</tt></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.html"><strong>api</strong> (package)</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.client.html">client</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.models.html"><strong>models</strong> (package)</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.types.html">types</a><br>
|
||||||
|
</td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
113
kittycad.models.auth_session.html
Normal file
113
kittycad.models.auth_session.html
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.auth_session</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.auth_session</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="datetime.html">datetime</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.auth_session.html#AuthSession">AuthSession</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="AuthSession">class <strong>AuthSession</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#AuthSession">AuthSession</a>(created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;, email: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;, user_id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f7de094df00&gt;) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="AuthSession-__contains__"><strong>__contains__</strong></a>(self, key: str) -> bool</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -> Any</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__init__"><strong>__init__</strong></a>(self, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f7de094df00>, email: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, user_id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>) -> None</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="AuthSession-to_dict"><strong>to_dict</strong></a>(self) -> Dict[str, Any]</dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods defined here:<br>
|
||||||
|
<dl><dt><a name="AuthSession-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -> ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Readonly properties defined here:<br>
|
||||||
|
<dl><dt><strong>additional_keys</strong></dt>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'email': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'is_valid': typing.Union[kittycad.types.Unset, bool], 'token': typing.Union[kittycad.types.Unset, str], 'user_id': typing.Union[kittycad.types.Unset, str]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='created_at', default=<kittycad....kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>List</strong> = typing.List<br>
|
||||||
|
<strong>T</strong> = ~T<br>
|
||||||
|
<strong>Type</strong> = typing.Type<br>
|
||||||
|
<strong>UNSET</strong> = <kittycad.types.Unset object><br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
76
kittycad.models.environment.html
Normal file
76
kittycad.models.environment.html
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.environment</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.environment</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.environment.html#Environment">Environment</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.environment.html#Environment">Environment</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="Environment">class <strong>Environment</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#Environment">Environment</a>(value, names=None, *, module=None, qualname=None, type=None, start=1)<br>
|
||||||
|
<br>
|
||||||
|
An enumeration.<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="kittycad.models.environment.html#Environment">Environment</a></dd>
|
||||||
|
<dd><a href="builtins.html#str">builtins.str</a></dd>
|
||||||
|
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>DEVELOPMENT</strong> = <Environment.DEVELOPMENT: 'DEVELOPMENT'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>PREVIEW</strong> = <Environment.PREVIEW: 'PREVIEW'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>PRODUCTION</strong> = <Environment.PRODUCTION: 'PRODUCTION'></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
|
||||||
|
<dl><dt><strong>name</strong></dt>
|
||||||
|
<dd><tt>The name of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>value</strong></dt>
|
||||||
|
<dd><tt>The value of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
|
||||||
|
<dl><dt><strong>__members__</strong></dt>
|
||||||
|
<dd><tt>Returns a mapping of member name->value.<br>
|
||||||
|
<br>
|
||||||
|
This mapping lists all enum members, including aliases. Note that this<br>
|
||||||
|
is a read-only view of the internal mapping.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
112
kittycad.models.error_message.html
Normal file
112
kittycad.models.error_message.html
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.error_message</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.error_message</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.error_message.html#ErrorMessage">ErrorMessage</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="ErrorMessage">class <strong>ErrorMessage</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#ErrorMessage">ErrorMessage</a>(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7ffadb4edf60&gt;) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="ErrorMessage-__contains__"><strong>__contains__</strong></a>(self, key: str) -> bool</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -> Any</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__init__"><strong>__init__</strong></a>(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7ffadb4edf60>) -> None</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="ErrorMessage-to_dict"><strong>to_dict</strong></a>(self) -> Dict[str, Any]</dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods defined here:<br>
|
||||||
|
<dl><dt><a name="ErrorMessage-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -> ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Readonly properties defined here:<br>
|
||||||
|
<dl><dt><strong>additional_keys</strong></dt>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>List</strong> = typing.List<br>
|
||||||
|
<strong>T</strong> = ~T<br>
|
||||||
|
<strong>Type</strong> = typing.Type<br>
|
||||||
|
<strong>UNSET</strong> = <kittycad.types.Unset object><br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
113
kittycad.models.file_conversion.html
Normal file
113
kittycad.models.file_conversion.html
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.file_conversion</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.file_conversion</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="datetime.html">datetime</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion.html#FileConversion">FileConversion</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="FileConversion">class <strong>FileConversion</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#FileConversion">FileConversion</a>(completed_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, output: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f1916e0df60&gt;) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="FileConversion-__contains__"><strong>__contains__</strong></a>(self, key: str) -> bool</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -> Any</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__init__"><strong>__init__</strong></a>(self, completed_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = <kittycad.types.Unset object at 0x7f1916e0df60>) -> None</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="FileConversion-to_dict"><strong>to_dict</strong></a>(self) -> Dict[str, Any]</dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods defined here:<br>
|
||||||
|
<dl><dt><a name="FileConversion-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -> ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Readonly properties defined here:<br>
|
||||||
|
<dl><dt><strong>additional_keys</strong></dt>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'completed_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'id': typing.Union[kittycad.types.Unset, str], 'output': typing.Union[kittycad.types.Unset, str], 'output_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'src_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'status': typing.Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='completed_at', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>List</strong> = typing.List<br>
|
||||||
|
<strong>T</strong> = ~T<br>
|
||||||
|
<strong>Type</strong> = typing.Type<br>
|
||||||
|
<strong>UNSET</strong> = <kittycad.types.Unset object><br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
80
kittycad.models.file_conversion_status.html
Normal file
80
kittycad.models.file_conversion_status.html
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.file_conversion_status</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.file_conversion_status</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="FileConversionStatus">class <strong>FileConversionStatus</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#FileConversionStatus">FileConversionStatus</a>(value, names=None, *, module=None, qualname=None, type=None, start=1)<br>
|
||||||
|
<br>
|
||||||
|
An enumeration.<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a></dd>
|
||||||
|
<dd><a href="builtins.html#str">builtins.str</a></dd>
|
||||||
|
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>COMPLETED</strong> = <FileConversionStatus.COMPLETED: 'Completed'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>FAILED</strong> = <FileConversionStatus.FAILED: 'Failed'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>IN_PROGRESS</strong> = <FileConversionStatus.IN_PROGRESS: 'In Progress'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>QUEUED</strong> = <FileConversionStatus.QUEUED: 'Queued'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>UPLOADED</strong> = <FileConversionStatus.UPLOADED: 'Uploaded'></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
|
||||||
|
<dl><dt><strong>name</strong></dt>
|
||||||
|
<dd><tt>The name of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>value</strong></dt>
|
||||||
|
<dd><tt>The value of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
|
||||||
|
<dl><dt><strong>__members__</strong></dt>
|
||||||
|
<dd><tt>Returns a mapping of member name->value.<br>
|
||||||
|
<br>
|
||||||
|
This mapping lists all enum members, including aliases. Note that this<br>
|
||||||
|
is a read-only view of the internal mapping.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
29
kittycad.models.html
Normal file
29
kittycad.models.html
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: package kittycad.models</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.models</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py</a></font></td></tr></table>
|
||||||
|
<p><tt>Contains all the data models used in inputs/outputs</tt></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.models.auth_session.html">auth_session</a><br>
|
||||||
|
<a href="kittycad.models.environment.html">environment</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.models.error_message.html">error_message</a><br>
|
||||||
|
<a href="kittycad.models.file_conversion.html">file_conversion</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.models.file_conversion_status.html">file_conversion_status</a><br>
|
||||||
|
<a href="kittycad.models.instance_metadata.html">instance_metadata</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="kittycad.models.message.html">message</a><br>
|
||||||
|
<a href="kittycad.models.valid_file_types.html">valid_file_types</a><br>
|
||||||
|
</td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
112
kittycad.models.instance_metadata.html
Normal file
112
kittycad.models.instance_metadata.html
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.instance_metadata</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.instance_metadata</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.instance_metadata.html#InstanceMetadata">InstanceMetadata</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="InstanceMetadata">class <strong>InstanceMetadata</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#InstanceMetadata">InstanceMetadata</a>(cpu_platform: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, description: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, git_hash: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, hostname: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, image: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, machine_type: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, name: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;, zone: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f0df2f31f60&gt;) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="InstanceMetadata-__contains__"><strong>__contains__</strong></a>(self, key: str) -> bool</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -> Any</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__init__"><strong>__init__</strong></a>(self, cpu_platform: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, description: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = <kittycad.types.Unset object at 0x7f0df2f31f60>, git_hash: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, hostname: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, image: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, machine_type: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, name: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, zone: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>) -> None</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InstanceMetadata-to_dict"><strong>to_dict</strong></a>(self) -> Dict[str, Any]</dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods defined here:<br>
|
||||||
|
<dl><dt><a name="InstanceMetadata-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -> ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Readonly properties defined here:<br>
|
||||||
|
<dl><dt><strong>additional_keys</strong></dt>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'cpu_platform': typing.Union[kittycad.types.Unset, str], 'description': typing.Union[kittycad.types.Unset, str], 'environment': typing.Union[kittycad.types.Unset, kittycad.models.environment.Environment], 'git_hash': typing.Union[kittycad.types.Unset, str], 'hostname': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'image': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'machine_type': typing.Union[kittycad.types.Unset, str], ...}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='cpu_platform', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>List</strong> = typing.List<br>
|
||||||
|
<strong>T</strong> = ~T<br>
|
||||||
|
<strong>Type</strong> = typing.Type<br>
|
||||||
|
<strong>UNSET</strong> = <kittycad.types.Unset object><br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
112
kittycad.models.message.html
Normal file
112
kittycad.models.message.html
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.message</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.message</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.message.html#Message">Message</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="Message">class <strong>Message</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#Message">Message</a>(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset <a href="builtins.html#object">object</a> at 0x7f10e92f9f60&gt;) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="Message-__contains__"><strong>__contains__</strong></a>(self, key: str) -> bool</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -> Any</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__init__"><strong>__init__</strong></a>(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f10e92f9f60>) -> None</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#Message">Message</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -> None</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Message-to_dict"><strong>to_dict</strong></a>(self) -> Dict[str, Any]</dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods defined here:<br>
|
||||||
|
<dl><dt><a name="Message-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -> ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Readonly properties defined here:<br>
|
||||||
|
<dl><dt><strong>additional_keys</strong></dt>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>Any</strong> = typing.Any<br>
|
||||||
|
<strong>Dict</strong> = typing.Dict<br>
|
||||||
|
<strong>List</strong> = typing.List<br>
|
||||||
|
<strong>T</strong> = ~T<br>
|
||||||
|
<strong>Type</strong> = typing.Type<br>
|
||||||
|
<strong>UNSET</strong> = <kittycad.types.Unset object><br>
|
||||||
|
<strong>Union</strong> = typing.Union</td></tr></table>
|
||||||
|
</body></html>
|
80
kittycad.models.valid_file_types.html
Normal file
80
kittycad.models.valid_file_types.html
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.models.valid_file_types</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.valid_file_types</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="ValidFileTypes">class <strong>ValidFileTypes</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#ValidFileTypes">ValidFileTypes</a>(value, names=None, *, module=None, qualname=None, type=None, start=1)<br>
|
||||||
|
<br>
|
||||||
|
An enumeration.<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a></dd>
|
||||||
|
<dd><a href="builtins.html#str">builtins.str</a></dd>
|
||||||
|
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>DWG</strong> = <ValidFileTypes.DWG: 'dwg'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>DXF</strong> = <ValidFileTypes.DXF: 'dxf'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>OBJ</strong> = <ValidFileTypes.OBJ: 'obj'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>STEP</strong> = <ValidFileTypes.STEP: 'step'></dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>STL</strong> = <ValidFileTypes.STL: 'stl'></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
|
||||||
|
<dl><dt><strong>name</strong></dt>
|
||||||
|
<dd><tt>The name of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>value</strong></dt>
|
||||||
|
<dd><tt>The value of the Enum member.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
|
||||||
|
<dl><dt><strong>__members__</strong></dt>
|
||||||
|
<dd><tt>Returns a mapping of member name->value.<br>
|
||||||
|
<br>
|
||||||
|
This mapping lists all enum members, including aliases. Note that this<br>
|
||||||
|
is a read-only view of the internal mapping.</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table></td></tr></table>
|
||||||
|
</body></html>
|
161
kittycad.types.html
Normal file
161
kittycad.types.html
Normal file
@ -0,0 +1,161 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module kittycad.types</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.types</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py</a></font></td></tr></table>
|
||||||
|
<p><tt>Contains some shared types for properties</tt></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
|
||||||
|
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.types.html#File">File</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
<dt><font face="helvetica, arial"><a href="typing.html#Generic">typing.Generic</a>(<a href="builtins.html#object">builtins.object</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="kittycad.types.html#Response">Response</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="File">class <strong>File</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#File">File</a>(payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
Contains information for file uploads<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%">Methods defined here:<br>
|
||||||
|
<dl><dt><a name="File-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__init__"><strong>__init__</strong></a>(self, payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -> None</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#File">File</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="File-to_tuple"><strong>to_tuple</strong></a>(self) -> Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]</dt><dd><tt>Return a tuple representation that httpx will accept for multipart/form-data</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'file_name': typing.Optional[str], 'mime_type': typing.Optional[str], 'payload': typing.Union[typing.BinaryIO, typing.TextIO]}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='payload', default=NOTHING, vali...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
</td></tr></table> <p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="Response">class <strong>Response</strong></a>(<a href="typing.html#Generic">typing.Generic</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||||
|
<td colspan=2><tt><a href="#Response">Response</a>(status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -&gt; None<br>
|
||||||
|
<br>
|
||||||
|
A response from an endpoint<br> </tt></td></tr>
|
||||||
|
<tr><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="kittycad.types.html#Response">Response</a></dd>
|
||||||
|
<dd><a href="typing.html#Generic">typing.Generic</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Methods defined here:<br>
|
||||||
|
<dl><dt><a name="Response-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__init__"><strong>__init__</strong></a>(self, status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -> None</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method generated by attrs for class <a href="#Response">Response</a>.</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors defined here:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Data and other attributes defined here:<br>
|
||||||
|
<dl><dt><strong>__annotations__</strong> = {'content': <class 'bytes'>, 'headers': typing.MutableMapping[str, str], 'parsed': typing.Optional[~T], 'status_code': <class 'int'>}</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='status_code', default=NOTHING, ...kw_only=False, inherited=False, on_setattr=None))</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__hash__</strong> = None</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__orig_bases__</strong> = (typing.Generic[~T],)</dl>
|
||||||
|
|
||||||
|
<dl><dt><strong>__parameters__</strong> = (~T,)</dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Class methods inherited from <a href="typing.html#Generic">typing.Generic</a>:<br>
|
||||||
|
<dl><dt><a name="Response-__class_getitem__"><strong>__class_getitem__</strong></a>(params)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="Response-__init_subclass__"><strong>__init_subclass__</strong></a>(*args, **kwargs)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt><dd><tt>This method is called when a class is subclassed.<br>
|
||||||
|
<br>
|
||||||
|
The default implementation does nothing. It may be<br>
|
||||||
|
overridden to extend subclasses.</tt></dd></dl>
|
||||||
|
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>FileJsonType</strong> = typing.Tuple[typing.Optional[str], typing.Union[...g.BinaryIO, typing.TextIO], typing.Optional[str]]<br>
|
||||||
|
<strong>__all__</strong> = ['File', 'Response', 'FileJsonType']<br>
|
||||||
|
<strong>__annotations__</strong> = {'UNSET': <class 'kittycad.types.Unset'>}</td></tr></table>
|
||||||
|
</body></html>
|
Reference in New Issue
Block a user