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-05-23 21:30:43 +00:00
parent c111c3813f
commit 9c726ee5da
1337 changed files with 16201 additions and 9160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/html/_modules/kittycad/api/file/create_file_center_of_mass.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_center_of_mass &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -167,7 +167,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
@ -201,7 +204,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="p">(</span>

4
docs/html/_modules/kittycad/api/file/create_file_conversion.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_conversion &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

4
docs/html/_modules/kittycad/api/file/create_file_conversion_with_base64_helper.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_conversion_with_base64_helper &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

14
docs/html/_modules/kittycad/api/file/create_file_density.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_density &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -174,7 +174,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
@ -212,7 +215,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="p">(</span>

14
docs/html/_modules/kittycad/api/file/create_file_mass.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_mass &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -174,7 +174,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
@ -212,7 +215,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="p">(</span>

14
docs/html/_modules/kittycad/api/file/create_file_surface_area.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_surface_area &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -167,7 +167,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
@ -201,7 +204,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="p">(</span>

14
docs/html/_modules/kittycad/api/file/create_file_volume.html
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.4.1 documentation</title>
<title>kittycad.api.file.create_file_volume &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@ -165,7 +165,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
@ -199,7 +202,10 @@
<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">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="w"> </span><span class="sd">&quot;&quot;&quot;We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.</span>
<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="k">return</span> <span class="p">(</span>

4
docs/html/_modules/kittycad/api/file/get_file_conversion_with_base64_helper.html
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.4.1 documentation</title>
<title>kittycad.api.file.get_file_conversion_with_base64_helper &mdash; kittycad v0.4.2 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" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.1
v0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">