deploy: 2492e4b

fal-ai · Oct 23, 2024 · a81239f · a81239f
1 parent 8db3958
commit a81239f
Show file tree

Hide file tree

Showing 5 changed files with 133 additions and 9 deletions.
diff --git a/client/fal_client.html b/client/fal_client.html
@@ -94,6 +94,22 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="fal_client.client.AsyncCDNTokenManager">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fal_client.client.</span></span><span class="sig-name descname"><span class="pre">AsyncCDNTokenManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.AsyncCDNTokenManager" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="fal_client.client.AsyncCDNTokenManager.get_token">
+<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_token</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.AsyncCDNTokenManager.get_token" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#fal_client.client.CDNToken" title="fal_client.client.CDNToken"><code class="xref py py-class docutils literal notranslate"><span class="pre">CDNToken</span></code></a></span></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="py class">
 <dt class="sig sig-object py" id="fal_client.client.AsyncClient">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fal_client.client.</span></span><span class="sig-name descname"><span class="pre">AsyncClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">120.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.AsyncClient" title="Link to this definition">¶</a></dt>
@@ -184,7 +200,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="fal_client.client.AsyncClient.upload">
-<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.AsyncClient.upload" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</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="#fal_client.client.AsyncClient.upload" title="Link to this definition">¶</a></dt>
 <dd><p>Upload the given data blob to the CDN and return the access URL. The content type should be specified
 as the second argument. Use upload_file or upload_image for convenience.</p>
 <dl class="field-list simple">
@@ -275,6 +291,58 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fal_client.client.</span></span><span class="sig-name descname"><span class="pre">CDNToken</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_upload_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_at</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.CDNToken" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken.base_upload_url">
+<span class="sig-name descname"><span class="pre">base_upload_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></em><a class="headerlink" href="#fal_client.client.CDNToken.base_upload_url" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken.expires_at">
+<span class="sig-name descname"><span class="pre">expires_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></em><a class="headerlink" href="#fal_client.client.CDNToken.expires_at" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken.is_expired">
+<span class="sig-name descname"><span class="pre">is_expired</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.CDNToken.is_expired" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken.token">
+<span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></em><a class="headerlink" href="#fal_client.client.CDNToken.token" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="fal_client.client.CDNToken.token_type">
+<span class="sig-name descname"><span class="pre">token_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></em><a class="headerlink" href="#fal_client.client.CDNToken.token_type" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="fal_client.client.CDNTokenManager">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fal_client.client.</span></span><span class="sig-name descname"><span class="pre">CDNTokenManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.CDNTokenManager" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="fal_client.client.CDNTokenManager.get_token">
+<span class="sig-name descname"><span class="pre">get_token</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.CDNTokenManager.get_token" title="Link to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#fal_client.client.CDNToken" title="fal_client.client.CDNToken"><code class="xref py py-class docutils literal notranslate"><span class="pre">CDNToken</span></code></a></span></p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="py class">
 <dt class="sig sig-object py" id="fal_client.client.Completed">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fal_client.client.</span></span><span class="sig-name descname"><span class="pre">Completed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.Completed" title="Link to this definition">¶</a></dt>
@@ -424,7 +492,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="fal_client.client.SyncClient.upload">
-<span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.client.SyncClient.upload" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</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="#fal_client.client.SyncClient.upload" title="Link to this definition">¶</a></dt>
 <dd><p>Upload the given data blob to the CDN and return the access URL. The content type should be specified
 as the second argument. Use upload_file or upload_image for convenience.</p>
 <dl class="field-list simple">
@@ -641,7 +709,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="fal_client.AsyncClient.upload">
-<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.AsyncClient.upload" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</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="#fal_client.AsyncClient.upload" title="Link to this definition">¶</a></dt>
 <dd><p>Upload the given data blob to the CDN and return the access URL. The content type should be specified
 as the second argument. Use upload_file or upload_image for convenience.</p>
 <dl class="field-list simple">
@@ -895,7 +963,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="fal_client.SyncClient.upload">
-<span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fal_client.SyncClient.upload" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">upload</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</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="#fal_client.SyncClient.upload" title="Link to this definition">¶</a></dt>
 <dd><p>Upload the given data blob to the CDN and return the access URL. The content type should be specified
 as the second argument. Use upload_file or upload_image for convenience.</p>
 <dl class="field-list simple">

diff --git a/client/genindex.html b/client/genindex.html
@@ -35,6 +35,7 @@ <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
  <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
@@ -50,6 +51,7 @@ <h1 id="index">Index</h1>
  | <a href="#Q"><strong>Q</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
  | <a href="#U"><strong>U</strong></a>
 
 </div>
@@ -60,14 +62,16 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="fal_client.html#fal_client.client.AppId">AppId (class in fal_client.client)</a>
 </li>
+      <li><a href="fal_client.html#fal_client.client.AsyncCDNTokenManager">AsyncCDNTokenManager (class in fal_client.client)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="fal_client.html#fal_client.AsyncClient">AsyncClient (class in fal_client)</a>
 
       <ul>
         <li><a href="fal_client.html#fal_client.client.AsyncClient">(class in fal_client.client)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="fal_client.html#fal_client.AsyncRequestHandle">AsyncRequestHandle (class in fal_client)</a>
 
       <ul>
@@ -77,6 +81,14 @@ <h2 id="A">A</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="fal_client.html#fal_client.client.CDNToken.base_upload_url">base_upload_url (fal_client.client.CDNToken attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -86,6 +98,10 @@ <h2 id="C">C</h2>
         <li><a href="fal_client.html#fal_client.SyncRequestHandle.cancel_url">(fal_client.SyncRequestHandle attribute)</a>
 </li>
       </ul></li>
+      <li><a href="fal_client.html#fal_client.client.CDNToken">CDNToken (class in fal_client.client)</a>
+</li>
+      <li><a href="fal_client.html#fal_client.client.CDNTokenManager">CDNTokenManager (class in fal_client.client)</a>
+</li>
       <li><a href="fal_client.html#fal_client.AsyncRequestHandle.client">client (fal_client.AsyncRequestHandle attribute)</a>
 
       <ul>
@@ -146,6 +162,8 @@ <h2 id="E">E</h2>
         <li><a href="fal_client.html#fal_client.client.encode_image">(in module fal_client.client)</a>
 </li>
       </ul></li>
+      <li><a href="fal_client.html#fal_client.client.CDNToken.expires_at">expires_at (fal_client.client.CDNToken attribute)</a>
+</li>
   </ul></td>
 </tr></table>
 
@@ -207,8 +225,6 @@ <h2 id="G">G</h2>
         <li><a href="fal_client.html#fal_client.SyncRequestHandle.get">(fal_client.SyncRequestHandle method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="fal_client.html#fal_client.AsyncClient.get_handle">get_handle() (fal_client.AsyncClient method)</a>
 
       <ul>
@@ -217,6 +233,14 @@ <h2 id="G">G</h2>
         <li><a href="fal_client.html#fal_client.client.SyncClient.get_handle">(fal_client.client.SyncClient method)</a>
 </li>
         <li><a href="fal_client.html#fal_client.SyncClient.get_handle">(fal_client.SyncClient method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="fal_client.html#fal_client.client.AsyncCDNTokenManager.get_token">get_token() (fal_client.client.AsyncCDNTokenManager method)</a>
+
+      <ul>
+        <li><a href="fal_client.html#fal_client.client.CDNTokenManager.get_token">(fal_client.client.CDNTokenManager method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -231,6 +255,10 @@ <h2 id="I">I</h2>
         <li><a href="fal_client.html#fal_client.client.InProgress">(class in fal_client.client)</a>
 </li>
       </ul></li>
+      <li><a href="fal_client.html#fal_client.client.CDNToken.is_expired">is_expired() (fal_client.client.CDNToken method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="fal_client.html#fal_client.AsyncRequestHandle.iter_events">iter_events() (fal_client.AsyncRequestHandle method)</a>
 
       <ul>
@@ -483,6 +511,18 @@ <h2 id="S">S</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="fal_client.html#fal_client.client.CDNToken.token">token (fal_client.client.CDNToken attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="fal_client.html#fal_client.client.CDNToken.token_type">token_type (fal_client.client.CDNToken attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="U">U</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>