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

140 lines
6.2 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.types Module &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="File" href="api/kittycad.types.File.html" />
<link rel="prev" title="ValidFileTypes" href="api/kittycad.models.valid_file_types.ValidFileTypes.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"><a class="reference internal" href="kittycad.models.html">kittycad.models Package</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">kittycad.types Module</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.types.File.html">File</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/kittycad.types.Response.html">Response</a></li>
</ul>
</li>
</ul>
</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.types Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/kittycad.types.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.types">
<span id="kittycad-types-module"></span><h1>kittycad.types Module<a class="headerlink" href="#module-kittycad.types" title="Permalink to this headline"></a></h1>
<p>Contains some shared types for properties</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.types.File.html#kittycad.types.File" title="kittycad.types.File"><code class="xref py py-obj docutils literal notranslate"><span class="pre">File</span></code></a>(payload[, file_name, mime_type])</p></td>
<td><p>Contains information for file uploads</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Response</span></code></a>(status_code, content, headers, parsed)</p></td>
<td><p>A response from an endpoint</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api/kittycad.models.valid_file_types.ValidFileTypes.html" class="btn btn-neutral float-left" title="ValidFileTypes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api/kittycad.types.File.html" class="btn btn-neutral float-right" title="File" 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>