0.0.2 release

BUILD

@@ -12,7 +12,7 @@ python_distribution(
     output_path="optimeering-python-sdk",
     provides=python_artifact(
         name="optimeering",
-        version="0.0.1",
+        version="0.0.2",
         description="Optimeering Python Client",
         long_description_content_type="text/markdown",
         author="Optimeering",

docs/site/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 143f8b9043ef24cde4998130e88e6890
+config: 9fd982162fb37c7fa8c607e65db8c4ef
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/site/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.1',
+    VERSION: '0.0.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/site/access.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>AccessApi &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>AccessApi &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -99,7 +99,8 @@ <h1>AccessApi<a class="headerlink" href="#accessapi" title="Link to this heading
 <dt class="sig sig-object py" id="optimeering.AccessApi.create_api_key">
 <span class="sig-name descname"><span class="pre">create_api_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">access_post_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_request_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#optimeering.AccessApi.create_api_key" title="Link to this definition"></a></dt>
 <dd><p>Post Access</p>
-<p>Creates a new access key</p>
+<p>Creates a new access key.
+Guide on Authentication: <a class="reference external" href="https://docs.optimeering.com/getting-started/auth/">https://docs.optimeering.com/getting-started/auth/</a></p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>access_post_key</strong> (<a class="reference internal" href="models.html#optimeering.models.AccessPostKey" title="optimeering.models.AccessPostKey"><em>AccessPostKey</em></a>) – (required)</p>
@@ -126,7 +127,7 @@ <h1>AccessApi<a class="headerlink" href="#accessapi" title="Link to this heading
 <dt class="sig sig-object py" id="optimeering.AccessApi.delete_key">
 <span class="sig-name descname"><span class="pre">delete_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_request_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#optimeering.AccessApi.delete_key" title="Link to this definition"></a></dt>
 <dd><p>Drop Key</p>
-<p>Deletes an api key.</p>
+<p>Deletes an api key by its id.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>id</strong> (<em>int</em>) – (required)</p>
@@ -152,8 +153,8 @@ <h1>AccessApi<a class="headerlink" href="#accessapi" title="Link to this heading
 <dl class="py method">
 <dt class="sig sig-object py" id="optimeering.AccessApi.list_my_keys">
 <span class="sig-name descname"><span class="pre">list_my_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_request_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#optimeering.AccessApi.list_my_keys" title="Link to this definition"></a></dt>
-<dd><p>Get Access</p>
-<p>Lists all the keys owned by the user.</p>
+<dd><p>List Keys</p>
+<p>Lists all the created keys.</p>
 <dl class="field-list">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>Returns the result object.</p>

docs/site/authentication.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Authentication &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Authentication &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/site/client.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Client &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Client &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/site/configuration.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Configuration &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Configuration &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/site/examples.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Code Examples &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Code Examples &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/site/genindex.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Index &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -172,6 +172,10 @@ <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="models.html#optimeering.models.End">End (class in optimeering.models)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="models.html#optimeering.models.ExpiresAt">ExpiresAt (class in optimeering.models)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -233,6 +237,8 @@ <h2 id="F">F</h2>
         <li><a href="models.html#optimeering.models.AccessPostKey.from_json">(optimeering.models.AccessPostKey class method)</a>
 </li>
         <li><a href="models.html#optimeering.models.End.from_json">(optimeering.models.End class method)</a>
+</li>
+        <li><a href="models.html#optimeering.models.ExpiresAt.from_json">(optimeering.models.ExpiresAt class method)</a>
 </li>
         <li><a href="models.html#optimeering.models.HTTPValidationError.from_json">(optimeering.models.HTTPValidationError class method)</a>
 </li>
@@ -481,6 +487,8 @@ <h2 id="T">T</h2>
         <li><a href="models.html#optimeering.models.AccessPostKey.to_dict">(optimeering.models.AccessPostKey method)</a>
 </li>
         <li><a href="models.html#optimeering.models.End.to_dict">(optimeering.models.End method)</a>
+</li>
+        <li><a href="models.html#optimeering.models.ExpiresAt.to_dict">(optimeering.models.ExpiresAt method)</a>
 </li>
         <li><a href="models.html#optimeering.models.HTTPValidationError.to_dict">(optimeering.models.HTTPValidationError method)</a>
 </li>
@@ -519,6 +527,8 @@ <h2 id="T">T</h2>
         <li><a href="models.html#optimeering.models.AccessPostKey.to_json">(optimeering.models.AccessPostKey method)</a>
 </li>
         <li><a href="models.html#optimeering.models.End.to_json">(optimeering.models.End method)</a>
+</li>
+        <li><a href="models.html#optimeering.models.ExpiresAt.to_json">(optimeering.models.ExpiresAt method)</a>
 </li>
         <li><a href="models.html#optimeering.models.HTTPValidationError.to_json">(optimeering.models.HTTPValidationError method)</a>
 </li>
@@ -589,6 +599,8 @@ <h2 id="T">T</h2>
         <li><a href="models.html#optimeering.models.AccessPostKey.to_str">(optimeering.models.AccessPostKey method)</a>
 </li>
         <li><a href="models.html#optimeering.models.End.to_str">(optimeering.models.End method)</a>
+</li>
+        <li><a href="models.html#optimeering.models.ExpiresAt.to_str">(optimeering.models.ExpiresAt method)</a>
 </li>
         <li><a href="models.html#optimeering.models.HTTPValidationError.to_str">(optimeering.models.HTTPValidationError method)</a>
 </li>

docs/site/index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Getting Started &mdash; Optimeering Python Client 0.0.1 documentation</title>
+  <title>Getting Started &mdash; Optimeering Python Client 0.0.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=6e83718d" />
 
@@ -16,7 +16,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=d45e8c67"></script>
+        <script src="_static/documentation_options.js?v=e3a6060d"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -220,6 +220,13 @@ <h2>Contents<a class="headerlink" href="#id1" title="Link to this heading"></
 <li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.End.to_str"><code class="docutils literal notranslate"><span class="pre">End.to_str()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="models.html#optimeering.models.ExpiresAt"><code class="docutils literal notranslate"><span class="pre">ExpiresAt</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.ExpiresAt.from_json"><code class="docutils literal notranslate"><span class="pre">ExpiresAt.from_json()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.ExpiresAt.to_json"><code class="docutils literal notranslate"><span class="pre">ExpiresAt.to_json()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.ExpiresAt.to_dict"><code class="docutils literal notranslate"><span class="pre">ExpiresAt.to_dict()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.ExpiresAt.to_str"><code class="docutils literal notranslate"><span class="pre">ExpiresAt.to_str()</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="models.html#optimeering.models.HTTPValidationError"><code class="docutils literal notranslate"><span class="pre">HTTPValidationError</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.HTTPValidationError.to_str"><code class="docutils literal notranslate"><span class="pre">HTTPValidationError.to_str()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="models.html#optimeering.models.HTTPValidationError.to_json"><code class="docutils literal notranslate"><span class="pre">HTTPValidationError.to_json()</span></code></a></li>