I HAVE GENERATED YOUR NEW DOCS!
This commit is contained in:
github-actions[bot]
23
docs/html/kittycad.api.html
Normal file
23
docs/html/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>
|
||||
171
docs/html/kittycad.client.html
Normal file
171
docs/html/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
docs/html/kittycad.html
Normal file
25
docs/html/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>
|
||||
29
docs/html/kittycad.models.html
Normal file
29
docs/html/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>
|
||||
161
docs/html/kittycad.types.html
Normal file
161
docs/html/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