Files
kittycad.py/docs/html/kittycad.models.html
2021-12-15 11:56:44 +00:00

209 lines
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.models Package &mdash; kittycad v0.0.3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="AuthSession" href="api/kittycad.models.AuthSession.html" />
<link rel="prev" title="Client" href="api/kittycad.client.Client.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> kittycad
</a>
<div class="version">
v0.0.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api Package</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client Module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">kittycad.models Package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#classes">Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.AuthSession.html">AuthSession</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.Environment.html">Environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.ErrorMessage.html">ErrorMessage</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.FileConversion.html">FileConversion</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.FileConversionStatus.html">FileConversionStatus</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.InstanceMetadata.html">InstanceMetadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.Message.html">Message</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.models.ValidFileTypes.html">ValidFileTypes</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.auth_session.html">kittycad.models.auth_session Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.environment.html">kittycad.models.environment Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.error_message.html">kittycad.models.error_message Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.file_conversion.html">kittycad.models.file_conversion Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.file_conversion_status.html">kittycad.models.file_conversion_status Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.instance_metadata.html">kittycad.models.instance_metadata Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.message.html">kittycad.models.message Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.valid_file_types.html">kittycad.models.valid_file_types Module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types Module</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/kittycad.AuthenticatedClient.html">AuthenticatedClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/kittycad.Client.html">Client</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">kittycad</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>kittycad.models Package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/kittycad.models.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-kittycad.models">
<span id="kittycad-models-package"></span><h1>kittycad.models Package<a class="headerlink" href="#module-kittycad.models" title="Permalink to this headline"></a></h1>
<p>Contains all the data models used in inputs/outputs</p>
<section id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline"></a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.models.AuthSession.html#kittycad.models.AuthSession" title="kittycad.models.AuthSession"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AuthSession</span></code></a>([created_at, email, id, ...])</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.models.Environment.html#kittycad.models.Environment" title="kittycad.models.Environment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Environment</span></code></a>(value)</p></td>
<td><p>An enumeration.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.models.ErrorMessage.html#kittycad.models.ErrorMessage" title="kittycad.models.ErrorMessage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ErrorMessage</span></code></a>([message])</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.models.FileConversion.html#kittycad.models.FileConversion" title="kittycad.models.FileConversion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FileConversion</span></code></a>([completed_at, created_at, ...])</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.models.FileConversionStatus.html#kittycad.models.FileConversionStatus" title="kittycad.models.FileConversionStatus"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FileConversionStatus</span></code></a>(value)</p></td>
<td><p>An enumeration.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.models.InstanceMetadata.html#kittycad.models.InstanceMetadata" title="kittycad.models.InstanceMetadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InstanceMetadata</span></code></a>([cpu_platform, ...])</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="api/kittycad.models.Message.html#kittycad.models.Message" title="kittycad.models.Message"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Message</span></code></a>([message])</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.models.ValidFileTypes.html#kittycad.models.ValidFileTypes" title="kittycad.models.ValidFileTypes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValidFileTypes</span></code></a>(value)</p></td>
<td><p>An enumeration.</p></td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.auth_session.html">kittycad.models.auth_session Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.auth_session.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.environment.html">kittycad.models.environment Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.environment.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.error_message.html">kittycad.models.error_message Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.error_message.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.file_conversion.html">kittycad.models.file_conversion Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_conversion.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.file_conversion_status.html">kittycad.models.file_conversion_status Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_conversion_status.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.instance_metadata.html">kittycad.models.instance_metadata Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.instance_metadata.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.message.html">kittycad.models.message Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.message.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.valid_file_types.html">kittycad.models.valid_file_types Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.valid_file_types.html#classes">Classes</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api/kittycad.client.Client.html" class="btn btn-neutral float-left" title="Client" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api/kittycad.models.AuthSession.html" class="btn btn-neutral float-right" title="AuthSession" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright KittyCAD Team Members.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>