I HAVE GENERATED YOUR NEW DOCS!

This commit is contained in:
github-actions[bot]
2023-05-08 20:06:56 +00:00
parent f933b716f4
commit fa2b411b78
2603 changed files with 36412 additions and 35438 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_center_of_mass &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_center_of_mass &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -116,7 +117,7 @@
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.html#kittycad.api.file.create_file_center_of_mass._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileCenterOfMass</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -126,12 +127,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.html#kittycad.api.file.create_file_center_of_mass._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -145,7 +146,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -165,7 +166,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -181,7 +182,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -199,7 +200,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileCenterOfMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -115,7 +116,7 @@
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileConversion</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -125,12 +126,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -145,7 +146,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -167,7 +168,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -186,7 +187,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -206,7 +207,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion_with_base64_helper &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_conversion_with_base64_helper &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_density &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_density &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -120,9 +121,7 @@
<span class="p">}</span></div>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.html#kittycad.api.file.create_file_density._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.html#kittycad.api.file.create_file_density._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileDensity</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -132,12 +131,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.html#kittycad.api.file.create_file_density._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -152,7 +151,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">material_mass</span><span class="o">=</span><span class="n">material_mass</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -174,7 +173,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -192,7 +191,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">material_mass</span><span class="o">=</span><span class="n">material_mass</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -212,7 +211,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileDensity</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_mass &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_mass &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -120,9 +121,7 @@
<span class="p">}</span></div>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.html#kittycad.api.file.create_file_mass._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.html#kittycad.api.file.create_file_mass._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileMass</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -132,12 +131,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.html#kittycad.api.file.create_file_mass._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -152,7 +151,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">material_density</span><span class="o">=</span><span class="n">material_density</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -174,7 +173,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -192,7 +191,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">material_density</span><span class="o">=</span><span class="n">material_density</span><span class="p">,</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
@ -212,7 +211,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileMass</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_surface_area &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_surface_area &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -116,7 +117,7 @@
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileSurfaceArea</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -126,12 +127,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -145,7 +146,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -165,7 +166,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -181,7 +182,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -199,7 +200,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileSurfaceArea</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_volume &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_volume &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -114,9 +115,7 @@
<span class="p">}</span></div>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.html#kittycad.api.file.create_file_volume._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.html#kittycad.api.file.create_file_volume._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">201</span><span class="p">:</span>
<span class="n">response_201</span> <span class="o">=</span> <span class="n">FileVolume</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_201</span>
@ -126,12 +125,12 @@
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.html#kittycad.api.file.create_file_volume._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
@ -145,7 +144,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -165,7 +164,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
@ -181,7 +180,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
@ -199,7 +198,7 @@
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">FileVolume</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.</span>
<span class="sd"> If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.get_file_conversion_with_base64_helper &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.get_file_conversion_with_base64_helper &mdash; kittycad v0.4.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
@ -13,10 +13,11 @@
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/sphinx_highlight.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
@ -36,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">