bump (#80)
* bump Signed-off-by: Jess Frazelle <github@jessfraz.com> * some fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * YOYO NEW API SPEC! * reformat Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * for now force true Signed-off-by: Jess Frazelle <github@jessfraz.com> * run the tests on generations Signed-off-by: Jess Frazelle <github@jessfraz.com> * add tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix some types Signed-off-by: Jess Frazelle <github@jessfraz.com> * float to top Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * more noqa Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * ruff pass Signed-off-by: Jess Frazelle <github@jessfraz.com> * add docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * even less mypy errors Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add test Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * new path Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes for mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * skip tests Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Jess Frazelle
GitHub
228
docs/html/_modules/kittycad/api/api_calls/get_api_call.html
Normal file
228
docs/html/_modules/kittycad/api/api_calls/get_api_call.html
Normal file
@ -0,0 +1,228 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.get_api_call — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.get_api_call</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.get_api_call</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_with_price</span> <span class="kn">import</span> <span class="n">ApiCallWithPrice</span>
|
||||
<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">...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.api_calls.get_api_call.html#kittycad.api.api_calls.get_api_call._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></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">"</span><span class="si">{}</span><span class="s2">/api-calls/</span><span class="si">{id}</span><span class="s2">"</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.html#kittycad.api.api_calls.get_api_call._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiCallWithPrice</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.html#kittycad.api.api_calls.get_api_call._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.sync_detailed.html#kittycad.api.api_calls.get_api_call.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.sync.html#kittycad.api.api_calls.get_api_call.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.</span>
|
||||
<span class="sd"> If the user is not authenticated to view the specified API call, then it is not returned.</span>
|
||||
<span class="sd"> Only KittyCAD employees can view API calls for other users."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.asyncio_detailed.html#kittycad.api.api_calls.get_api_call.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="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call.asyncio.html#kittycad.api.api_calls.get_api_call.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.</span>
|
||||
<span class="sd"> If the user is not authenticated to view the specified API call, then it is not returned.</span>
|
||||
<span class="sd"> Only KittyCAD employees can view API calls for other users."""</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,224 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.get_api_call_for_user — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.get_api_call_for_user</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.get_api_call_for_user</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_with_price</span> <span class="kn">import</span> <span class="n">ApiCallWithPrice</span>
|
||||
<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">...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.api_calls.get_api_call_for_user.html#kittycad.api.api_calls.get_api_call_for_user._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></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">"</span><span class="si">{}</span><span class="s2">/user/api-calls/</span><span class="si">{id}</span><span class="s2">"</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.html#kittycad.api.api_calls.get_api_call_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiCallWithPrice</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.html#kittycad.api.api_calls.get_api_call_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.sync_detailed.html#kittycad.api.api_calls.get_api_call_for_user.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.sync.html#kittycad.api.api_calls.get_api_call_for_user.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.asyncio_detailed.html#kittycad.api.api_calls.get_api_call_for_user.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="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_for_user.asyncio.html#kittycad.api.api_calls.get_api_call_for_user.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPrice</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user."""</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,230 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.get_api_call_metrics — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.get_api_call_metrics</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.get_api_call_metrics</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_query_group</span> <span class="kn">import</span> <span class="n">ApiCallQueryGroup</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_query_group_by</span> <span class="kn">import</span> <span class="n">ApiCallQueryGroupBy</span>
|
||||
<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">...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.api_calls.get_api_call_metrics.html#kittycad.api.api_calls.get_api_call_metrics._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">group_by</span><span class="p">:</span> <span class="n">ApiCallQueryGroupBy</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">-></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">"</span><span class="si">{}</span><span class="s2">/api-call-metrics"</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">group_by</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">"?"</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">"&group_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">group_by</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">"?group_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">group_by</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.html#kittycad.api.api_calls.get_api_call_metrics._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</span><span class="p">],</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="p">[</span><span class="n">ApiCallQueryGroup</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()]</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.html#kittycad.api.api_calls.get_api_call_metrics._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</span><span class="p">],</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.sync_detailed.html#kittycad.api.api_calls.get_api_call_metrics.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">group_by</span><span class="p">:</span> <span class="n">ApiCallQueryGroupBy</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</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">group_by</span><span class="o">=</span><span class="n">group_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.sync.html#kittycad.api.api_calls.get_api_call_metrics.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">group_by</span><span class="p">:</span> <span class="n">ApiCallQueryGroupBy</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</span><span class="p">],</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed."""</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">group_by</span><span class="o">=</span><span class="n">group_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.asyncio_detailed.html#kittycad.api.api_calls.get_api_call_metrics.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">group_by</span><span class="p">:</span> <span class="n">ApiCallQueryGroupBy</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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</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">group_by</span><span class="o">=</span><span class="n">group_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_api_call_metrics.asyncio.html#kittycad.api.api_calls.get_api_call_metrics.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">group_by</span><span class="p">:</span> <span class="n">ApiCallQueryGroupBy</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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="n">ApiCallQueryGroup</span><span class="p">],</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed."""</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">group_by</span><span class="o">=</span><span class="n">group_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,354 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.get_async_operation — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.get_async_operation</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.get_async_operation</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<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_conversion</span> <span class="kn">import</span> <span class="n">FileConversion</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_mass</span> <span class="kn">import</span> <span class="n">FileMass</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.file_volume</span> <span class="kn">import</span> <span class="n">FileVolume</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.api_calls.get_async_operation.html#kittycad.api.api_calls.get_async_operation._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></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">"</span><span class="si">{}</span><span class="s2">/async/operations/</span><span class="si">{id}</span><span class="s2">"</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.html#kittycad.api.api_calls.get_async_operation._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_conversion</span> <span class="o">=</span> <span class="n">FileConversion</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_conversion</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_center_of_mass</span> <span class="o">=</span> <span class="n">FileCenterOfMass</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_center_of_mass</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_mass</span> <span class="o">=</span> <span class="n">FileMass</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_mass</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_volume</span> <span class="o">=</span> <span class="n">FileVolume</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_volume</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_density</span> <span class="o">=</span> <span class="n">FileDensity</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_density</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">()</span>
|
||||
<span class="n">option_file_surface_area</span> <span class="o">=</span> <span class="n">FileSurfaceArea</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">option_file_surface_area</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">raise</span>
|
||||
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||
<span class="k">raise</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.html#kittycad.api.api_calls.get_async_operation._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.sync_detailed.html#kittycad.api.api_calls.get_async_operation.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.sync.html#kittycad.api.api_calls.get_async_operation.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get the status and output of an async operation.</span>
|
||||
<span class="sd"> This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.</span>
|
||||
<span class="sd"> If the user is not authenticated to view the specified async operation, then it is not returned.</span>
|
||||
<span class="sd"> Only KittyCAD employees with the proper access can view async operations for other users."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.asyncio_detailed.html#kittycad.api.api_calls.get_async_operation.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="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Response</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.get_async_operation.asyncio.html#kittycad.api.api_calls.get_async_operation.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</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">-></span> <span class="n">Optional</span><span class="p">[</span>
|
||||
<span class="n">Union</span><span class="p">[</span>
|
||||
<span class="n">Any</span><span class="p">,</span>
|
||||
<span class="n">FileConversion</span><span class="p">,</span>
|
||||
<span class="n">FileCenterOfMass</span><span class="p">,</span>
|
||||
<span class="n">FileMass</span><span class="p">,</span>
|
||||
<span class="n">FileVolume</span><span class="p">,</span>
|
||||
<span class="n">FileDensity</span><span class="p">,</span>
|
||||
<span class="n">FileSurfaceArea</span><span class="p">,</span>
|
||||
<span class="n">Error</span><span class="p">,</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Get the status and output of an async operation.</span>
|
||||
<span class="sd"> This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.</span>
|
||||
<span class="sd"> If the user is not authenticated to view the specified async operation, then it is not returned.</span>
|
||||
<span class="sd"> Only KittyCAD employees with the proper access can view async operations for other users."""</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
258
docs/html/_modules/kittycad/api/api_calls/list_api_calls.html
Normal file
258
docs/html/_modules/kittycad/api/api_calls/list_api_calls.html
Normal file
@ -0,0 +1,258 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.list_api_calls — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.list_api_calls</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.list_api_calls</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_with_price_results_page</span> <span class="kn">import</span> <span class="n">ApiCallWithPriceResultsPage</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.created_at_sort_mode</span> <span class="kn">import</span> <span class="n">CreatedAtSortMode</span>
|
||||
<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">...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.api_calls.list_api_calls.html#kittycad.api.api_calls.list_api_calls._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></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">"</span><span class="si">{}</span><span class="s2">/api-calls"</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">limit</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">"?"</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">"&limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</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">"?limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">page_token</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">"?"</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">"&page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</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">"?page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">sort_by</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">"?"</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">"&sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</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">"?sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.html#kittycad.api.api_calls.list_api_calls._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.html#kittycad.api.api_calls.list_api_calls._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.sync_detailed.html#kittycad.api.api_calls.list_api_calls.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.sync.html#kittycad.api.api_calls.list_api_calls.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.asyncio_detailed.html#kittycad.api.api_calls.list_api_calls.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls.asyncio.html#kittycad.api.api_calls.list_api_calls.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,273 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.list_api_calls_for_user — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.list_api_calls_for_user</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.list_api_calls_for_user</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_with_price_results_page</span> <span class="kn">import</span> <span class="n">ApiCallWithPriceResultsPage</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.created_at_sort_mode</span> <span class="kn">import</span> <span class="n">CreatedAtSortMode</span>
|
||||
<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">...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.api_calls.list_api_calls_for_user.html#kittycad.api.api_calls.list_api_calls_for_user._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></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">"</span><span class="si">{}</span><span class="s2">/users/</span><span class="si">{id}</span><span class="s2">/api-calls"</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">limit</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">"?"</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">"&limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</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">"?limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">page_token</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">"?"</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">"&page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</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">"?page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">sort_by</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">"?"</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">"&sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</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">"?sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.html#kittycad.api.api_calls.list_api_calls_for_user._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.html#kittycad.api.api_calls.list_api_calls_for_user._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.sync_detailed.html#kittycad.api.api_calls.list_api_calls_for_user.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.sync.html#kittycad.api.api_calls.list_api_calls_for_user.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if "me" is passed as the user id.</span>
|
||||
<span class="sd"> Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.</span>
|
||||
<span class="sd"> If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.</span>
|
||||
<span class="sd"> The API calls are returned in order of creation, with the most recently created API calls first."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.asyncio_detailed.html#kittycad.api.api_calls.list_api_calls_for_user.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="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_api_calls_for_user.asyncio.html#kittycad.api.api_calls.list_api_calls_for_user.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if "me" is passed as the user id.</span>
|
||||
<span class="sd"> Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.</span>
|
||||
<span class="sd"> If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.</span>
|
||||
<span class="sd"> The API calls are returned in order of creation, with the most recently created API calls first."""</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="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
|
||||
<span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,275 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.list_async_operations — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.list_async_operations</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.list_async_operations</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_status</span> <span class="kn">import</span> <span class="n">ApiCallStatus</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.async_api_call_results_page</span> <span class="kn">import</span> <span class="n">AsyncApiCallResultsPage</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.created_at_sort_mode</span> <span class="kn">import</span> <span class="n">CreatedAtSortMode</span>
|
||||
<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">...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.api_calls.list_async_operations.html#kittycad.api.api_calls.list_async_operations._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="p">:</span> <span class="n">ApiCallStatus</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></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">"</span><span class="si">{}</span><span class="s2">/async/operations"</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">limit</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">"?"</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">"&limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</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">"?limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">page_token</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">"?"</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">"&page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</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">"?page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">sort_by</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">"?"</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">"&sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</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">"?sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">status</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">"?"</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">"&status="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">status</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">"?status="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">status</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.html#kittycad.api.api_calls.list_async_operations._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">AsyncApiCallResultsPage</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.html#kittycad.api.api_calls.list_async_operations._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.sync_detailed.html#kittycad.api.api_calls.list_async_operations.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="p">:</span> <span class="n">ApiCallStatus</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.sync.html#kittycad.api.api_calls.list_async_operations.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="p">:</span> <span class="n">ApiCallStatus</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.</span>
|
||||
<span class="sd"> This endpoint requires authentication by a KittyCAD employee."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.asyncio_detailed.html#kittycad.api.api_calls.list_async_operations.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="p">:</span> <span class="n">ApiCallStatus</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.list_async_operations.asyncio.html#kittycad.api.api_calls.list_async_operations.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="p">:</span> <span class="n">ApiCallStatus</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">AsyncApiCallResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.</span>
|
||||
<span class="sd"> This endpoint requires authentication by a KittyCAD employee."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">status</span><span class="o">=</span><span class="n">status</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,260 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.api_calls.user_list_api_calls — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../../../../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.api_calls.user_list_api_calls</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.api_calls.user_list_api_calls</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.api_call_with_price_results_page</span> <span class="kn">import</span> <span class="n">ApiCallWithPriceResultsPage</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.created_at_sort_mode</span> <span class="kn">import</span> <span class="n">CreatedAtSortMode</span>
|
||||
<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">...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.api_calls.user_list_api_calls.html#kittycad.api.api_calls.user_list_api_calls._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></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">"</span><span class="si">{}</span><span class="s2">/user/api-calls"</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">limit</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">"?"</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">"&limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</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">"?limit="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">limit</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">page_token</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">"?"</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">"&page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</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">"?page_token="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">page_token</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">sort_by</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">"?"</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">"&sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</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">"?sort_by="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">sort_by</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</span><span class="p">:</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="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.html#kittycad.api.api_calls.user_list_api_calls._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
|
||||
<span class="n">response_200</span> <span class="o">=</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_200</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
|
||||
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_4XX</span>
|
||||
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
|
||||
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.html#kittycad.api.api_calls.user_list_api_calls._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.sync_detailed.html#kittycad.api.api_calls.user_list_api_calls.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.sync.html#kittycad.api.api_calls.user_list_api_calls.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.</span>
|
||||
<span class="sd"> The API calls are returned in order of creation, with the most recently created API calls first."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.asyncio_detailed.html#kittycad.api.api_calls.user_list_api_calls.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.api_calls.user_list_api_calls.asyncio.html#kittycad.api.api_calls.user_list_api_calls.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">sort_by</span><span class="p">:</span> <span class="n">CreatedAtSortMode</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="n">limit</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">ApiCallWithPriceResultsPage</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.</span>
|
||||
<span class="sd"> The API calls are returned in order of creation, with the most recently created API calls first."""</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">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span>
|
||||
<span class="n">page_token</span><span class="o">=</span><span class="n">page_token</span><span class="p">,</span>
|
||||
<span class="n">sort_by</span><span class="o">=</span><span class="n">sort_by</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user