Skip to content

Commit

Permalink
deploy: 9b58ce5
Browse files Browse the repository at this point in the history
  • Loading branch information
@marksie1988
marksie1988 committed May 13, 2024
1 parent 7fcf70d commit 1a95d1a
Show file tree
Hide file tree
Showing 68 changed files with 8,877 additions and 880 deletions.
Binary file modified .doctrees/apis/media.doctree
View file
Binary file not shown.
Binary file added .doctrees/apis/movie.doctree
View file
Binary file not shown.
Binary file added .doctrees/apis/request.doctree
View file
Binary file not shown.
Binary file modified .doctrees/apis/search.doctree
View file
Binary file not shown.
Binary file modified .doctrees/apis/status.doctree
View file
Binary file not shown.
Binary file added .doctrees/apis/tv.doctree
View file
Binary file not shown.
Binary file added .doctrees/apis/user.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/models/common.doctree
View file
Binary file not shown.
Binary file added .doctrees/models/issue.doctree
View file
Binary file not shown.
Binary file modified .doctrees/models/media.doctree
View file
Binary file not shown.
Binary file added .doctrees/models/request.doctree
View file
Binary file not shown.
Binary file added .doctrees/models/tv.doctree
View file
Binary file not shown.
Binary file added .doctrees/models/user.doctree
View file
Binary file not shown.
Binary file modified .doctrees/toc.doctree
View file
Binary file not shown.
29 changes: 23 additions & 6 deletions _modules/asyncpow/apis/media.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

</a>
<div class="version">
0.4.1
0.4.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
Expand All @@ -52,16 +52,24 @@
<p class="caption" role="heading"><span class="caption-text">APIs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/media.html">Media</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/movie.html">Movie</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/request.html">Request</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/search.html">Search</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/status.html">Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/tv.html">Tv</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apis/user.html">User</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../models/common.html">Common Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/issue.html">Issue Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/media.html">Media Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/movie.html">Movie Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/request.html">Request Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/search.html">Search Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/status.html">Status Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/tv.html">TV Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../models/user.html">User Models</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Utils</span></p>
<ul>
Expand Down Expand Up @@ -134,21 +142,25 @@ <h1>Source code for asyncpow.apis.media</h1><div class="highlight"><pre>
<span class="sd"> Initialize the Media object with the base URL, API key, and session.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_url</span><span class="p">:</span> <span class="n">URL</span><span class="p">,</span> <span class="n">api_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">session</span><span class="p">:</span> <span class="n">ClientSession</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">base_url</span><span class="p">:</span> <span class="n">URL</span><span class="p">,</span> <span class="n">api_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">session</span><span class="p">:</span> <span class="n">ClientSession</span><span class="p">,</span> <span class="n">raw_response</span><span class="p">:</span> <span class="nb">bool</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initialize the MediaAPI object with the base URL and API key.</span>

<span class="sd"> Args:</span>
<span class="sd"> base_url (str): The base URL for the media API.</span>
<span class="sd"> api_key (str): The API key for authentication.</span>
<span class="sd"> session (ClientSession): HTTP Session</span>
<span class="sd"> raw_response (bool): Return json if True.</span>

<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">media_url</span> <span class="o">=</span> <span class="n">base_url</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s2">&quot;media&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_key</span> <span class="o">=</span> <span class="n">api_key</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="n">session</span>
<span class="bp">self</span><span class="o">.</span><span class="n">raw_response</span> <span class="o">=</span> <span class="n">raw_response</span>

<div class="viewcode-block" id="Media.async_get_media">
<a class="viewcode-back" href="../../../apis/media.html#asyncpow.apis.media.Media.async_get_media">[docs]</a>
Expand All @@ -158,7 +170,7 @@ <h1>Source code for asyncpow.apis.media</h1><div class="highlight"><pre>
<span class="n">skip</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
<span class="nb">filter</span><span class="p">:</span> <span class="n">MediaFilterOptions</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">sort</span><span class="p">:</span> <span class="n">SortOptions</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">raw_response</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">raw_response</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="n">MediaModel</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get media items based on specified parameters.</span>
Expand All @@ -168,11 +180,14 @@ <h1>Source code for asyncpow.apis.media</h1><div class="highlight"><pre>
<span class="sd"> skip (int): The number of items to skip (default is 0).</span>
<span class="sd"> filter (MediaFilterOptions): The filter option for media items (default is None).</span>
<span class="sd"> sort (SortOptions): The sorting option for media items (default is None).</span>
<span class="sd"> raw_response (bool): Flag to determine whether to return the raw response (True) or an object (False). Default is False.</span>
<span class="sd"> raw_response (bool, optional): return raw json. Defaults to None.</span>

<span class="sd"> Returns:</span>
<span class="sd"> dict | MediaModel: The media model object retrieved based on the parameters.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">raw_response</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">raw_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_response</span>

<span class="n">params</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;take&quot;</span><span class="p">:</span> <span class="n">take</span><span class="p">,</span> <span class="s2">&quot;skip&quot;</span><span class="p">:</span> <span class="n">skip</span><span class="p">}</span>
<span class="k">if</span> <span class="nb">filter</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;filter&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">filter</span>
Expand All @@ -191,7 +206,7 @@ <h1>Source code for asyncpow.apis.media</h1><div class="highlight"><pre>
<span class="n">mediaId</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<span class="n">status</span><span class="p">:</span> <span class="n">MediaStatusOptions</span><span class="p">,</span>
<span class="n">is4k</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">raw_response</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="n">raw_response</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="n">MediaModel2</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Update the status of a media item with optional 4k flag.</span>
Expand All @@ -200,11 +215,13 @@ <h1>Source code for asyncpow.apis.media</h1><div class="highlight"><pre>
<span class="sd"> mediaId (int): The ID of the media item.</span>
<span class="sd"> status (MediaStatusOptions): The status to set for the media item.</span>
<span class="sd"> is4k (Optional[bool]): Optional flag indicating 4k status.</span>
<span class="sd"> raw_response (bool): Flag to determine whether to return the raw response (True) or an object (False). Default is False.</span>
<span class="sd"> raw_response (bool, optional): return raw json. Defaults to None.</span>

<span class="sd"> Returns:</span>
<span class="sd"> dict | MediaModel2: The model object representing the updated media item.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">raw_response</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">raw_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_response</span>

<span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">media_url</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">mediaId</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">status</span><span class="p">))</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;is4k&quot;</span><span class="p">:</span> <span class="n">is4k</span><span class="p">}</span> <span class="k">if</span> <span class="n">is4k</span> <span class="k">else</span> <span class="p">{}</span>
Expand Down
Loading

0 comments on commit 1a95d1a

Please sign in to comment.