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-31 19:56:37 +00:00
parent 4c3f497d73
commit 20b2a188dc
747 changed files with 11530 additions and 2634 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/_modules/kittycad/api/file/create_file_center_of_mass.html
View File

@ -87,16 +87,23 @@
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_center_of_mass</span> <span class="kn">import</span> <span class="n">FileCenterOfMass</span>
<span class="kn">from</span> <span class="nn">...models.file_import_format</span> <span class="kn">import</span> <span class="n">FileImportFormat</span>
<span class="kn">from</span> <span class="nn">...models.unit_length</span> <span class="kn">import</span> <span class="n">UnitLength</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.html#kittycad.api.file.create_file_center_of_mass._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/file/center-of-mass&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
<span class="k">if</span> <span class="n">output_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;src_format=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_format</span><span class="p">)</span>
@ -142,12 +149,14 @@
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.sync_detailed.html#kittycad.api.file.create_file_center_of_mass.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -162,6 +171,7 @@
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.sync.html#kittycad.api.file.create_file_center_of_mass.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -171,9 +181,11 @@
<span class="sd"> Currently, this endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -181,12 +193,14 @@
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.asyncio_detailed.html#kittycad.api.file.create_file_center_of_mass.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -199,6 +213,7 @@
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_center_of_mass.asyncio.html#kittycad.api.file.create_file_center_of_mass.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -208,10 +223,12 @@
<span class="sd"> Currently, this endpoint returns the cartesian co-ordinate in world space measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>

6
docs/html/_modules/kittycad/api/file/create_file_conversion.html
View File

@ -172,7 +172,8 @@
<span class="w"> </span><span class="sd">&quot;&quot;&quot;If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</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>
@ -212,7 +213,8 @@
<span class="w"> </span><span class="sd">&quot;&quot;&quot;If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>

36
docs/html/_modules/kittycad/api/file/create_file_density.html
View File

@ -87,11 +87,15 @@
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_density</span> <span class="kn">import</span> <span class="n">FileDensity</span>
<span class="kn">from</span> <span class="nn">...models.file_import_format</span> <span class="kn">import</span> <span class="n">FileImportFormat</span>
<span class="kn">from</span> <span class="nn">...models.unit_density</span> <span class="kn">import</span> <span class="n">UnitDensity</span>
<span class="kn">from</span> <span class="nn">...models.unit_mass</span> <span class="kn">import</span> <span class="n">UnitMass</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.html#kittycad.api.file.create_file_density._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -103,6 +107,16 @@
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;material_mass=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_mass</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?material_mass=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_mass</span><span class="p">)</span>
<span class="k">if</span> <span class="n">material_mass_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;material_mass_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_mass_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?material_mass_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_mass_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">output_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;src_format=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_format</span><span class="p">)</span>
@ -147,6 +161,8 @@
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.sync_detailed.html#kittycad.api.file.create_file_density.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -154,6 +170,8 @@
<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">material_mass_unit</span><span class="o">=</span><span class="n">material_mass_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -169,6 +187,8 @@
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.sync.html#kittycad.api.file.create_file_density.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -178,10 +198,13 @@
<span class="sd"> Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</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">material_mass_unit</span><span class="o">=</span><span class="n">material_mass_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -190,6 +213,8 @@
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.asyncio_detailed.html#kittycad.api.file.create_file_density.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -197,6 +222,8 @@
<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">material_mass_unit</span><span class="o">=</span><span class="n">material_mass_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -210,6 +237,8 @@
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_density.asyncio.html#kittycad.api.file.create_file_density.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -219,11 +248,14 @@
<span class="sd"> Currently, this endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</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">material_mass_unit</span><span class="o">=</span><span class="n">material_mass_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>

36
docs/html/_modules/kittycad/api/file/create_file_mass.html
View File

@ -87,11 +87,15 @@
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_import_format</span> <span class="kn">import</span> <span class="n">FileImportFormat</span>
<span class="kn">from</span> <span class="nn">...models.file_mass</span> <span class="kn">import</span> <span class="n">FileMass</span>
<span class="kn">from</span> <span class="nn">...models.unit_density</span> <span class="kn">import</span> <span class="n">UnitDensity</span>
<span class="kn">from</span> <span class="nn">...models.unit_mass</span> <span class="kn">import</span> <span class="n">UnitMass</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.html#kittycad.api.file.create_file_mass._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -103,6 +107,16 @@
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;material_density=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_density</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?material_density=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_density</span><span class="p">)</span>
<span class="k">if</span> <span class="n">material_density_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;material_density_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_density_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?material_density_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">material_density_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">output_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;src_format=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_format</span><span class="p">)</span>
@ -147,6 +161,8 @@
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.sync_detailed.html#kittycad.api.file.create_file_mass.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -154,6 +170,8 @@
<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">material_density_unit</span><span class="o">=</span><span class="n">material_density_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -169,6 +187,8 @@
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.sync.html#kittycad.api.file.create_file_mass.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -178,10 +198,13 @@
<span class="sd"> Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</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">material_density_unit</span><span class="o">=</span><span class="n">material_density_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -190,6 +213,8 @@
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.asyncio_detailed.html#kittycad.api.file.create_file_mass.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -197,6 +222,8 @@
<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">material_density_unit</span><span class="o">=</span><span class="n">material_density_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -210,6 +237,8 @@
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_mass.asyncio.html#kittycad.api.file.create_file_mass.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span><span class="p">,</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -219,11 +248,14 @@
<span class="sd"> Currently, this endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</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">material_density_unit</span><span class="o">=</span><span class="n">material_density_unit</span><span class="p">,</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>

21
docs/html/_modules/kittycad/api/file/create_file_surface_area.html
View File

@ -87,16 +87,23 @@
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_import_format</span> <span class="kn">import</span> <span class="n">FileImportFormat</span>
<span class="kn">from</span> <span class="nn">...models.file_surface_area</span> <span class="kn">import</span> <span class="n">FileSurfaceArea</span>
<span class="kn">from</span> <span class="nn">...models.unit_area</span> <span class="kn">import</span> <span class="n">UnitArea</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.html#kittycad.api.file.create_file_surface_area._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/file/surface-area&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
<span class="k">if</span> <span class="n">output_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;src_format=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_format</span><span class="p">)</span>
@ -142,12 +149,14 @@
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.sync_detailed.html#kittycad.api.file.create_file_surface_area.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -162,6 +171,7 @@
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.sync.html#kittycad.api.file.create_file_surface_area.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -171,9 +181,11 @@
<span class="sd"> Currently, this endpoint returns the square measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -181,12 +193,14 @@
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.asyncio_detailed.html#kittycad.api.file.create_file_surface_area.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -199,6 +213,7 @@
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_surface_area.asyncio.html#kittycad.api.file.create_file_surface_area.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -208,10 +223,12 @@
<span class="sd"> Currently, this endpoint returns the square measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>

21
docs/html/_modules/kittycad/api/file/create_file_volume.html
View File

@ -87,16 +87,23 @@
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_import_format</span> <span class="kn">import</span> <span class="n">FileImportFormat</span>
<span class="kn">from</span> <span class="nn">...models.file_volume</span> <span class="kn">import</span> <span class="n">FileVolume</span>
<span class="kn">from</span> <span class="nn">...models.unit_volume</span> <span class="kn">import</span> <span class="n">UnitVolume</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.html#kittycad.api.file.create_file_volume._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/file/volume&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
<span class="k">if</span> <span class="n">output_unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?output_unit=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output_unit</span><span class="p">)</span>
<span class="k">if</span> <span class="n">src_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;src_format=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_format</span><span class="p">)</span>
@ -140,12 +147,14 @@
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.sync_detailed.html#kittycad.api.file.create_file_volume.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -160,6 +169,7 @@
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.sync.html#kittycad.api.file.create_file_volume.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -169,9 +179,11 @@
<span class="sd"> Currently, this endpoint returns the cubic measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -179,12 +191,14 @@
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.asyncio_detailed.html#kittycad.api.file.create_file_volume.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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">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">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
@ -197,6 +211,7 @@
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.file.create_file_volume.asyncio.html#kittycad.api.file.create_file_volume.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span><span class="p">,</span>
<span class="n">src_format</span><span class="p">:</span> <span class="n">FileImportFormat</span><span class="p">,</span>
<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>
@ -206,10 +221,12 @@
<span class="sd"> Currently, this endpoint returns the cubic measure units.</span>
<span class="sd"> In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.</span>
<span class="sd"> 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>
<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.</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_unit</span><span class="o">=</span><span class="n">output_unit</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>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>