ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2023-07-08 02:27:32 +00:00
parent f5da088b67
commit 021595ed07
1128 changed files with 21762 additions and 2419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/html/_autosummary/kittycad.api.file.create_file_conversion.html
View File

@ -15,7 +15,7 @@
<meta name="twitter:card" content="summary_large_image" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.3 documentation</title>
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.4 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" />
@ -51,7 +51,7 @@
kittycad
</a>
<div class="version">
v0.4.3
v0.4.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@ -139,7 +139,7 @@
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.file.create_file_conversion.asyncio.html#kittycad.api.file.create_file_conversion.asyncio" title="kittycad.api.file.create_file_conversion.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(output_format, src_format, body, *, ...)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
<td><p>If you wish to specify the conversion options, use the <cite>/file/conversion</cite> endpoint instead.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.file.create_file_conversion.asyncio_detailed.html#kittycad.api.file.create_file_conversion.asyncio_detailed" title="kittycad.api.file.create_file_conversion.asyncio_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio_detailed</span></code></a>(output_format, src_format, ...)</p></td>
<td><p><dl class="field-list simple">
@ -150,7 +150,7 @@
</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.file.create_file_conversion.sync.html#kittycad.api.file.create_file_conversion.sync" title="kittycad.api.file.create_file_conversion.sync"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync</span></code></a>(output_format, src_format, body, *, client)</p></td>
<td><p>Convert a CAD file from one format to another.</p></td>
<td><p>If you wish to specify the conversion options, use the <cite>/file/conversion</cite> endpoint instead.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.file.create_file_conversion.sync_detailed.html#kittycad.api.file.create_file_conversion.sync_detailed" title="kittycad.api.file.create_file_conversion.sync_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync_detailed</span></code></a>(output_format, src_format, ...)</p></td>
<td><p><dl class="field-list simple">
@ -195,7 +195,8 @@
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.create_file_conversion.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.file.create_file_conversion.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/create_file_conversion.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/file/create_file_conversion.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.create_file_conversion.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.
<dd><p>If you wish to specify the conversion options, use the <cite>/file/conversion</cite> endpoint instead.
Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.
If the conversion is performed synchronously, the contents of the converted file (<cite>output</cite>) will be returned as a base64 encoded string.
If the operation is performed asynchronously, the <cite>id</cite> of the operation will be returned. You can use the <cite>id</cite> returned from the request to get status information about the async operation from the <cite>/async/operations/{id}</cite> endpoint.</p>
<dl class="field-list simple">
@ -218,7 +219,8 @@ If the operation is performed asynchronously, the <cite>id</cite> of the operati
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.create_file_conversion.sync">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.file.create_file_conversion.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/create_file_conversion.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/file/create_file_conversion.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.create_file_conversion.sync" title="Permalink to this definition"></a></dt>
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.
<dd><p>If you wish to specify the conversion options, use the <cite>/file/conversion</cite> endpoint instead.
Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.
If the conversion is performed synchronously, the contents of the converted file (<cite>output</cite>) will be returned as a base64 encoded string.
If the operation is performed asynchronously, the <cite>id</cite> of the operation will be returned. You can use the <cite>id</cite> returned from the request to get status information about the async operation from the <cite>/async/operations/{id}</cite> endpoint.</p>
<dl class="field-list simple">